Skip to content

node-zendesk / Exports / clients/client

Module: clients/client

Table of contents

Classes

Type Aliases

Type Aliases

ClientOptions

Ƭ ClientOptions: Object

Type declaration

NameTypeDescription
asUser?string- Optional header for making requests on behalf of a user.
customHeaders?object- Any additional custom headers for the request.
eventTargetCustomEventTarget- Event target to handle custom events.
jsonAPINamesany[]- Array to hold names used in the JSON API.
password?string- Password for authentication.
sideLoadany[]- Array to handle side-loaded resources.
subdomainstring- Subdomain for the Zendesk instance.
throttle?boolean- Flag to enable throttling of requests.
throwOriginalException?boolean- Throw the original exception when API requests fail.
token?string- Token for authentication.
useOAuth?boolean- Flag to indicate if OAuth is used.
username?string- Username for authentication.

Defined in

clients/client.d.ts:1

Released under the MIT License.