node-zendesk • Docs

---

node-zendesk / index / ZendeskClient

Class: ZendeskClient

Represents the main client to interface with the Zendesk API. This class acts as a high-level interface, making it easier to interact with specific Zendesk APIs. ZendeskClient

Example

const zendeskOptions = {
    username: 'exampleUser',
    token: 'exampleToken',
    subdomain: 'mycompany'
};
const zendeskClient = createClient(zendeskOptions);
const data = await zendeskClient.someResource.someMethod();

Constructors

new ZendeskClient()

new ZendeskClient(options?): ZendeskClient

Parameters

• options?: ZendeskClientOptions

Configuration options for the client.

Returns

ZendeskClient

Defined in

index.d.ts:110

Properties

config

config: ZendeskClientOptions

Configuration options for the client.

Defined in

index.d.ts:111

---

helpcenter

helpcenter: ZendeskClientHelpcenter

Defined in

index.d.ts:113

---

logger

logger: any

Logger for logging.

Defined in

index.d.ts:112

---

services

services: ZendeskClientServices

Defined in

index.d.ts:114

---

voice

voice: ZendeskClientVoice

Defined in

index.d.ts:115

Accessors

accountsettings

Get Signature

get accountsettings(): AccountSettings

Returns

AccountSettings

Defined in

index.d.ts:123

---

activitystream

Get Signature

get activitystream(): ActivityStream

Returns

ActivityStream

Defined in

index.d.ts:124

---

agentactivity

Get Signature

get agentactivity(): AgentActivity

Returns

AgentActivity

Defined in

index.d.ts:183

---

attachments

Get Signature

get attachments(): Attachments

Returns

Attachments

Defined in

index.d.ts:125

---

automations

Get Signature

get automations(): Automations

Returns

Automations

Defined in

index.d.ts:126

---

availabilities

Get Signature

get availabilities(): Availabilities

Returns

Availabilities

Defined in

index.d.ts:184

---

brand

Get Signature

get brand(): Brands

Returns

Brands

Defined in

index.d.ts:127

---

customagentroles

Get Signature

get customagentroles(): CustomAgentRoles

Returns

CustomAgentRoles

Defined in

index.d.ts:128

---

dynamiccontent

Get Signature

get dynamiccontent(): DynamicContent

Returns

DynamicContent

Defined in

index.d.ts:129

---

dynamiccontentvariants

Get Signature

get dynamiccontentvariants(): DynamicContentVariants

Returns

DynamicContentVariants

Defined in

index.d.ts:130

---

groupmemberships

Get Signature

get groupmemberships(): GroupMemberships

Returns

GroupMemberships

Defined in

index.d.ts:131

---

groups

Get Signature

get groups(): Groups

Returns

Groups

The Group client.

Defined in

index.d.ts:135

---

imports

Get Signature

get imports(): Imports

Returns

Imports

Defined in

index.d.ts:136

---

installations

Get Signature

get installations(): Installations

Returns

Installations

Defined in

index.d.ts:137

---

jobstatuses

Get Signature

get jobstatuses(): JobStatuses

Returns

JobStatuses

Defined in

index.d.ts:138

---

locales

Get Signature

get locales(): Locales

Returns

Locales

Defined in

index.d.ts:139

---

macros

Get Signature

get macros(): Macros

Returns

Macros

Defined in

index.d.ts:140

---

oauthclients

Get Signature

get oauthclients(): OAuthClients

Returns

OAuthClients

Defined in

index.d.ts:141

---

oauthtokens

Get Signature

get oauthtokens(): OAuthTokens

Returns

OAuthTokens

Defined in

index.d.ts:142

---

organizationfields

Get Signature

get organizationfields(): OrganizationFields

Returns

OrganizationFields

Defined in

index.d.ts:143

---

organizationmemberships

Get Signature

get organizationmemberships(): OrganizationMemberships

Returns

OrganizationMemberships

Defined in

index.d.ts:144

---

organizations

Get Signature

get organizations(): Organizations

Returns

Organizations

Defined in

index.d.ts:145

---

permissiongroups

Get Signature

get permissiongroups(): PermissionGroups

Returns

PermissionGroups

Defined in

index.d.ts:146

---

policies

Get Signature

get policies(): Policies

Returns

Policies

Defined in

index.d.ts:147

---

requests

Get Signature

get requests(): Requests

Returns

Requests

Defined in

index.d.ts:148

---

satisfactionratings

Get Signature

get satisfactionratings(): SatisfactionRatings

Returns

SatisfactionRatings

Defined in

index.d.ts:149

---

search

Get Signature

get search(): Search

Returns

Search

Defined in

index.d.ts:150

---

sessions

Get Signature

get sessions(): Sessions

Returns

Sessions

Defined in

index.d.ts:151

---

sharingagreement

Get Signature

get sharingagreement(): SharingAgreement

Returns

SharingAgreement

Defined in

index.d.ts:152

---

sideconversations

Get Signature

get sideconversations(): SideConversations

Returns

SideConversations

The SideConversations client.

Defined in

index.d.ts:156

---

suspendedtickets

Get Signature

get suspendedtickets(): SuspendedTickets

Returns

SuspendedTickets

Defined in

index.d.ts:157

---

tags

Get Signature

get tags(): Tags

Returns

Tags

Defined in

index.d.ts:158

---

targets

Get Signature

get targets(): Targets

Returns

Targets

Defined in

index.d.ts:159

---

ticketaudits

Get Signature

get ticketaudits(): TicketAudits

Returns

TicketAudits

Defined in

index.d.ts:160

---

ticketevents

Get Signature

get ticketevents(): TicketEvents

Returns

TicketEvents

Defined in

index.d.ts:161

---

ticketexport

Get Signature

get ticketexport(): TicketExport

Returns

TicketExport

Defined in

index.d.ts:162

---

ticketfields

Get Signature

get ticketfields(): TicketFields

Returns

TicketFields

Defined in

index.d.ts:163

---

ticketforms

Get Signature

get ticketforms(): TicketForms

Returns

TicketForms

Defined in

index.d.ts:164

---

ticketimport

Get Signature

get ticketimport(): TicketImport

Returns

TicketImport

Defined in

index.d.ts:165

---

ticketmetrics

Get Signature

get ticketmetrics(): TicketMetrics

Returns

TicketMetrics

The TicketMetrics client

Defined in

index.d.ts:169

---

tickets

Get Signature

get tickets(): Tickets

Returns

Tickets

The Tickets client.

Defined in

index.d.ts:173

---

triggers

Get Signature

get triggers(): Triggers

Returns

Triggers

Defined in

index.d.ts:174

---

userfields

Get Signature

get userfields(): UserFields

Returns

UserFields

Defined in

index.d.ts:175

---

useridentities

Get Signature

get useridentities(): UserIdentities

Returns

UserIdentities

Defined in

index.d.ts:176

---

users

Get Signature

get users(): Users

Returns

Users

The Users Instance

Defined in

index.d.ts:180

---

views

Get Signature

get views(): Views

Returns

Views

Defined in

index.d.ts:181

---

webhooks

Get Signature

get webhooks(): Webhooks

Returns

Webhooks

Defined in

index.d.ts:182