node-zendesknode-zendesk / Exports / index / ZendeskClient
Class: ZendeskClient
index.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.
Table of contents
Constructors
Properties
Accessors
- accountsettings
- activitystream
- agentactivity
- attachments
- automations
- availabilities
- brand
- customagentroles
- dynamiccontent
- dynamiccontentvariants
- groupmemberships
- groups
- imports
- installations
- jobstatuses
- locales
- macros
- oauthclients
- oauthtokens
- organizationfields
- organizationmemberships
- organizations
- permissiongroups
- policies
- requests
- satisfactionratings
- search
- sessions
- sharingagreement
- sideconversations
- suspendedtickets
- tags
- targets
- ticketaudits
- ticketevents
- ticketexport
- ticketfields
- ticketforms
- ticketimport
- ticketmetrics
- tickets
- triggers
- userfields
- useridentities
- users
- views
- webhooks
Constructors
constructor
• new ZendeskClient(options?): ZendeskClient
Parameters
| Name | Type | Description |
|---|---|---|
options? | ZendeskClientOptions | Configuration options for the client. |
Returns
Constructs
ZendeskClient
Example
const zendeskOptions = {
username: 'exampleUser',
token: 'exampleToken',
subdomain: 'mycompany'
};
const zendeskClient = createClient(zendeskOptions);
const data = await zendeskClient.someResource.someMethod();Defined in
index.d.ts:111
Properties
_debug
• Private _debug: any
Param
Arguments for debugging.
Defined in
index.d.ts:194
_instantiate
• Private _instantiate: any
Template
Param
The service class to instantiate.
Defined in
index.d.ts:123
config
• config: ZendeskClientOptions
Configuration options for the client.
Defined in
index.d.ts:112
helpcenter
• helpcenter: ZendeskClientHelpcenter
Defined in
index.d.ts:114
instances
• Private instances: any
Defined in
index.d.ts:127
logger
• logger: any
Logger for logging.
Defined in
index.d.ts:113
services
• services: ZendeskClientServices
Defined in
index.d.ts:115
voice
• voice: ZendeskClientVoice
Defined in
index.d.ts:116
Accessors
accountsettings
• get accountsettings(): AccountSettings
Returns
Defined in
index.d.ts:128
activitystream
• get activitystream(): ActivityStream
Returns
Defined in
index.d.ts:129
agentactivity
• get agentactivity(): AgentActivity
Returns
Defined in
index.d.ts:188
attachments
• get attachments(): Attachments
Returns
Defined in
index.d.ts:130
automations
• get automations(): Automations
Returns
Defined in
index.d.ts:131
availabilities
• get availabilities(): Availabilities
Returns
Defined in
index.d.ts:189
brand
• get brand(): Brand
Returns
Defined in
index.d.ts:132
customagentroles
• get customagentroles(): CustomAgentRoles
Returns
Defined in
index.d.ts:133
dynamiccontent
• get dynamiccontent(): DynamicContent
Returns
Defined in
index.d.ts:134
dynamiccontentvariants
• get dynamiccontentvariants(): DynamicContentVariants
Returns
Defined in
index.d.ts:135
groupmemberships
• get groupmemberships(): GroupMemberships
Returns
Defined in
index.d.ts:136
groups
• get groups(): Groups
Returns
The Group client.
Defined in
index.d.ts:140
imports
• get imports(): Imports
Returns
Defined in
index.d.ts:141
installations
• get installations(): Installations
Returns
Defined in
index.d.ts:142
jobstatuses
• get jobstatuses(): JobStatuses
Returns
Defined in
index.d.ts:143
locales
• get locales(): Locales
Returns
Defined in
index.d.ts:144
macros
• get macros(): Macros
Returns
Defined in
index.d.ts:145
oauthclients
• get oauthclients(): OAuthClients
Returns
Defined in
index.d.ts:146
oauthtokens
• get oauthtokens(): OAuthTokens
Returns
Defined in
index.d.ts:147
organizationfields
• get organizationfields(): OrganizationFields
Returns
Defined in
index.d.ts:148
organizationmemberships
• get organizationmemberships(): OrganizationMemberships
Returns
Defined in
index.d.ts:149
organizations
• get organizations(): Organizations
Returns
Defined in
index.d.ts:150
permissiongroups
• get permissiongroups(): PermissionGroups
Returns
Defined in
index.d.ts:151
policies
• get policies(): Policies
Returns
Defined in
index.d.ts:152
requests
• get requests(): Requests
Returns
Defined in
index.d.ts:153
satisfactionratings
• get satisfactionratings(): SatisfactionRatings
Returns
Defined in
index.d.ts:154
search
• get search(): Search
Returns
Defined in
index.d.ts:155
sessions
• get sessions(): Sessions
Returns
Defined in
index.d.ts:156
sharingagreement
• get sharingagreement(): SharingAgreement
Returns
Defined in
index.d.ts:157
sideconversations
• get sideconversations(): SideConversations
Returns
The SideConversations client.
Defined in
index.d.ts:161
suspendedtickets
• get suspendedtickets(): SuspendedTickets
Returns
Defined in
index.d.ts:162
tags
• get tags(): Tags
Returns
Defined in
index.d.ts:163
targets
• get targets(): Targets
Returns
Defined in
index.d.ts:164
ticketaudits
• get ticketaudits(): TicketAudits
Returns
Defined in
index.d.ts:165
ticketevents
• get ticketevents(): TicketEvents
Returns
Defined in
index.d.ts:166
ticketexport
• get ticketexport(): TicketExport
Returns
Defined in
index.d.ts:167
ticketfields
• get ticketfields(): TicketFields
Returns
Defined in
index.d.ts:168
ticketforms
• get ticketforms(): TicketForms
Returns
Defined in
index.d.ts:169
ticketimport
• get ticketimport(): TicketImport
Returns
Defined in
index.d.ts:170
ticketmetrics
• get ticketmetrics(): TicketMetrics
Returns
The TicketMetrics client
Defined in
index.d.ts:174
tickets
• get tickets(): Tickets
Returns
The Tickets client.
Defined in
index.d.ts:178
triggers
• get triggers(): Triggers
Returns
Defined in
index.d.ts:179
userfields
• get userfields(): UserFields
Returns
Defined in
index.d.ts:180
useridentities
• get useridentities(): UserIdentities
Returns
Defined in
index.d.ts:181
users
• get users(): Users
Returns
The Users Instance
Defined in
index.d.ts:185
views
• get views(): Views
Returns
Defined in
index.d.ts:186
webhooks
• get webhooks(): Webhooks
Returns
Defined in
index.d.ts:187