node-zendesk • Docs

---

node-zendesk / clients/client / Client

Class: Client

Represents a client to interact with the Zendesk API, providing functionalities to make various types of requests. This client handles request construction, response processing, event emission, and more.

Extended by

• AccountSettings
• ActivityStream
• Attachments
• Automations
• Brands
• 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
• TargetFailures
• Targets
• TicketAudits
• TicketEvents
• TicketExport
• TicketFields
• TicketForms
• TicketImport
• TicketMetrics
• Tickets
• Triggers
• UserFields
• UserIdentities
• Users
• Views
• Webhooks
• AccessPolicies
• ArticleAttachments
• ArticleComments
• ArticleLabels
• Articles
• Categories
• Search
• Sections
• Subscriptions
• Translations
• UserSegments
• Votes
• Links
• AgentActivity
• Availabilities
• CurrentQueueActivity
• GreetingCategories
• Greetings
• HistoricalQueueActivity
• PhoneNumbers

Constructors

new Client()

new Client(options, apiType): Client

Parameters

• options: ZendeskClientOptions

Configuration options for the client.

• apiType: string

Type of Zendesk API to initialize (e.g., 'core', 'helpcenter').

Returns

Client

Defined in

clients/client.d.ts:33

Properties

_transporter

_transporter: Transporter

Defined in

clients/client.d.ts:42

---

eventTarget

eventTarget: CustomEventTarget

Event target to handle custom events.

Defined in

clients/client.d.ts:40

---

jsonAPINames

jsonAPINames: any[]

Array to hold names used in the JSON API.

Defined in

clients/client.d.ts:38

---

options

options: ZendeskClientOptions & object

Configuration options for the client.

Type declaration

get()

get: (key) => any

Parameters

• key: string

Returns

any

Defined in

clients/client.d.ts:34

---

sideLoad

sideLoad: any[]

Array to handle side-loaded resources.

Defined in

clients/client.d.ts:37

---

useDotJson

useDotJson: boolean

Flag to indicate if the API endpoint should use '.json' ending.

Defined in

clients/client.d.ts:39

Accessors

transporter

Get Signature

get transporter(): Transporter

Returns

Transporter

Transporter for making requests.

Defined in

clients/client.d.ts:41

Methods

_rawRequest()

_rawRequest(method, uri, ...arguments_): Promise<object>

Parameters

• method: any

• uri: any

• ...arguments_: any[]

Returns

Promise<object>

response

response: any

result

result: object

Defined in

clients/client.d.ts:78

---

delete()

delete(...arguments_): Promise<void | object>

Deletes a resource.

Parameters

• ...arguments_: any[]

The resources or parts of the resource path.

Returns

Promise<void | object>

• Either void or response object

Defined in

clients/client.d.ts:76

---

emit()

emit(eventType, eventData): void

Parameters

• eventType: any

• eventData: any

Returns

void

Defined in

clients/client.d.ts:43

---

get()

get(resource): Promise<NodeModule>

Parameters

• resource: any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:62

---

getAll()

getAll(resource): Promise<any[]>

Parameters

• resource: any

Returns

Promise<any[]>

Defined in

clients/client.d.ts:77

---

on()

on(eventType, callback): void

Parameters

• eventType: any

• callback: any

Returns

void

Defined in

clients/client.d.ts:44

---

patch()

patch(...arguments_): Promise<void | object>

Patches a resource.

Parameters

• ...arguments_: any[]

The resources or parts of the resource path followed by the body.

Returns

Promise<void | object>

• Either void or response object

Defined in

clients/client.d.ts:68

---

post()

post(resource, body): Promise<NodeModule>

Parameters

• resource: any

• body: any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:70

---

put()

put(resource, body): Promise<NodeModule>

Parameters

• resource: any

• body: any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:69

---

request()

request<T>(method, uri, ...arguments_): Promise<NodeModule>

Request method that handles various HTTP methods.

Type Parameters

• T

Parameters

• method: string

HTTP method (e.g., 'GET', 'POST').

• uri: string

The URI for the request.

• ...arguments_: any[]

Additional arguments for the request.

Returns

Promise<NodeModule>

• The API response.

Defined in

clients/client.d.ts:96

---

requestAll()

requestAll(method, uri, ...arguments_): Promise<any[]>

Parameters

• method: any

• uri: any

• ...arguments_: any[]

Returns

Promise<any[]>

Defined in

clients/client.d.ts:97

---

requestUpload()

requestUpload(uri, file): Promise<any>

Parameters

• uri: any

• file: any

Returns

Promise<any>

Defined in

clients/client.d.ts:98

---

setSideLoad()

setSideLoad(array): void

Parameters

• array: any

Returns

void

Defined in

clients/client.d.ts:61