node-zendesk / Exports / clients/client / Client

Class: Client

clients/client.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.

Hierarchy

• Client

  ↳ AccountSettings

  ↳ ActivityStream

  ↳ Attachments

  ↳ Automations

  ↳ 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

  ↳ 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

Table of contents

Constructors

• constructor

Properties

• _buildOptions
• _getEndpointUri
• _transporter
• eventTarget
• jsonAPINames
• options
• sideLoad
• useDotJson

Accessors

• transporter

Methods

• _rawRequest
• delete
• emit
• get
• getAll
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad

Constructors

constructor

• new Client(options, apiType): Client

Parameters

Name	Type	Description
options	ClientOptions	Configuration options for the client.
apiType	string	Type of Zendesk API to initialize (e.g., 'core', 'helpcenter').

Returns

Client

Constructs

Client

Defined in

clients/client.d.ts:85

Properties

_buildOptions

• Private _buildOptions: any

Helper method to build client options.

Param

Client configuration options.

Param

Type of Zendesk API.

Defined in

clients/client.d.ts:104

---

_getEndpointUri

• Private _getEndpointUri: any

Helper method to get the endpoint URI.

Param

The subdomain for the Zendesk instance.

Param

Type of Zendesk API.

Defined in

clients/client.d.ts:112

---

_transporter

• _transporter: Transporter

Defined in

clients/client.d.ts:94

---

eventTarget

• eventTarget: CustomEventTarget

Event target to handle custom events.

Defined in

clients/client.d.ts:92

---

jsonAPINames

• jsonAPINames: any[]

Array to hold names used in the JSON API.

Defined in

clients/client.d.ts:90

---

options

• options: ClientOptions & { get: (key: string) => any }

Configuration options for the client.

Defined in

clients/client.d.ts:86

---

sideLoad

• sideLoad: any[]

Array to handle side-loaded resources.

Defined in

clients/client.d.ts:89

---

useDotJson

• useDotJson: boolean

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

Defined in

clients/client.d.ts:91

Accessors

transporter

• get transporter(): Transporter

Transporter for making requests.

Returns

Transporter

Defined in

clients/client.d.ts:93

Methods

_rawRequest

▸ _rawRequest(method, uri, ...args): Promise<{ response: any ; result: {} }>

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<{ response: any ; result: {} }>

Defined in

clients/client.d.ts:130

---

delete

▸ delete(...args): Promise<void | object>

Deletes a resource.

Parameters

Name	Type	Description
...args	any[]	The resources or parts of the resource path.

Returns

Promise<void | object>

• Either void or response object

Defined in

clients/client.d.ts:128

---

emit

▸ emit(eventType, eventData): void

Parameters

Name	Type
eventType	any
eventData	any

Returns

void

Defined in

clients/client.d.ts:95

---

get

▸ get(resource): Promise<NodeModule>

Parameters

Name	Type
resource	any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:114

---

getAll

▸ getAll(resource): Promise<any[]>

Parameters

Name	Type
resource	any

Returns

Promise<any[]>

Defined in

clients/client.d.ts:129

---

on

▸ on(eventType, callback): void

Parameters

Name	Type
eventType	any
callback	any

Returns

void

Defined in

clients/client.d.ts:96

---

patch

▸ patch(...args): Promise<void | object>

Patches a resource.

Parameters

Name	Type	Description
...args	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:120

---

post

▸ post(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:122

---

put

▸ put(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Defined in

clients/client.d.ts:121

---

request

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

Request method that handles various HTTP methods.

Type parameters

Name
T

Parameters

Name	Type	Description
method	string	HTTP method (e.g., 'GET', 'POST').
uri	string	The URI for the request.
...args	any[]	Additional arguments for the request.

Returns

Promise<NodeModule>

• The API response.

Defined in

clients/client.d.ts:148

---

requestAll

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

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<any[]>

Defined in

clients/client.d.ts:149

---

requestUpload

▸ requestUpload(uri, file): Promise<any>

Parameters

Name	Type
uri	any
file	any

Returns

Promise<any>

Defined in

clients/client.d.ts:150

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Defined in

clients/client.d.ts:113