node-zendesk • Docs

---

node-zendesk / index / ZendeskClientOptions

Type Alias: ZendeskClientOptions

ZendeskClientOptions: object

Type declaration

apiType?

optional apiType: string[]

• Type of Zendesk API (e.g., 'core', 'helpcenter'). Determines the sub-client to use.

asUser?

optional asUser: string

• Optional header for requests on behalf of a user.

customHeaders?

optional customHeaders: object

• Additional custom headers for the request.

debug?

optional debug: boolean

• Enables or disables debug logging.

endpointUri?

optional endpointUri: string

• Base URI for the Zendesk API. Overrides subdomain if provided.

get?

optional get: Function

• Function to retrieve specific options. Defaults to accessing properties from the options.

logger?

optional logger: object

• Logger for logging. Defaults to a basic console logger.

oauth?

optional oauth: boolean

• Indicates if OAuth is used (this is the original OAuth flag).

password?

optional password: string

• Authentication password.

subdomain?

optional subdomain: string

• Subdomain for the Zendesk account (e.g., 'mycompany' for 'mycompany.zendesk.com'). If endpointUri is provided, this is ignored.

throttle?

optional throttle: boolean

• Enables request throttling.

throwOriginalException?

optional throwOriginalException: boolean

• Throw the original exception when API requests fail.

token?

optional token: string

• Authentication token.

transportConfig?

optional transportConfig: object

• Configuration for custom transport.

transportConfig.responseAdapter?

optional responseAdapter: Function

transportConfig.transportFn?

optional transportFn: Function

useOAuth?

optional useOAuth: boolean

• Indicates if OAuth is used.

username?

optional username: string

• Username for authentication.

Defined in

index.d.ts:1