dist¶

Interfaces¶

ZohoDeskCredentialStatusInput¶

Properties¶

apiAccessConfigured?¶

optional apiAccessConfigured?: boolean;

orgId?¶

optional orgId?: string;

ZohoDeskJsonObject¶

Extended by¶

ZohoDeskProviderExtensionFields
ZohoDeskProviderResponse

Indexable¶

[key: string]: ZohoDeskProviderExtensionValue

ZohoDeskJsonRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

ZohoDeskLiveCheckOptions¶

Extends¶

ZohoDeskTicketingClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

ZohoDeskTicketingClientOptions.accessToken

apiBaseUrl?¶

optional apiBaseUrl?: string;

Inherited from¶

ZohoDeskTicketingClientOptions.apiBaseUrl

client?¶

optional client?: Pick<ZohoDeskTicketingClient, "readiness">;

dataCenter?¶

optional dataCenter?: string;

Inherited from¶

ZohoDeskTicketingClientOptions.dataCenter

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

ZohoDeskTicketingClientOptions.fetch

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

ZohoDeskTicketingClientOptions.headers

orgId?¶

optional orgId?: string;

Inherited from¶

ZohoDeskTicketingClientOptions.orgId

providerClient?¶

optional providerClient?: ZohoDeskProviderClient;

Inherited from¶

ZohoDeskTicketingClientOptions.providerClient

retry?¶

optional retry?: number | ZohoDeskJsonRetryOptions;

Inherited from¶

ZohoDeskTicketingClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

ZohoDeskTicketingClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

ZohoDeskTicketingClientOptions.timeoutMs

ZohoDeskProviderClient¶

Methods¶

createTicket()¶

createTicket(input): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`input`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

createTicketComment()¶

createTicketComment(ticketId, body): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`body`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

getTicket()¶

getTicket(ticketId): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTicketComments()¶

listTicketComments(ticketId, query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTickets()¶

listTickets(query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTicketThreads()¶

listTicketThreads(ticketId, query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

readiness()¶

readiness(): Promise<ZohoDeskProviderResponse>;

Returns¶

Promise\<ZohoDeskProviderResponse>

sendTicketReply()¶

sendTicketReply(ticketId, body): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`body`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

updateTicket()¶

updateTicket(ticketId, patch): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`patch`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

ZohoDeskProviderExtensionFields¶

Extends¶

ZohoDeskJsonObject

Indexable¶

[key: string]: ZohoDeskProviderExtensionValue

ZohoDeskProviderResponse¶

Extends¶

ZohoDeskJsonObject

Indexable¶

[key: string]: ZohoDeskProviderExtensionValue

ZohoDeskTicketingClient¶

Properties¶

providerClient¶

providerClient: ZohoDeskProviderClient;

Methods¶

createTicket()¶

createTicket(input): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`input`	`ZohoDeskTicketInput`

Returns¶

Promise\<ZohoDeskProviderResponse>

createTicketComment()¶

createTicketComment(ticketId, body): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`body`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

getTicket()¶

getTicket(ticketId): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTicketComments()¶

listTicketComments(ticketId, query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTickets()¶

listTickets(query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

listTicketThreads()¶

listTicketThreads(ticketId, query?): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`query?`	`ZohoDeskProviderQuery`

Returns¶

Promise\<ZohoDeskProviderResponse>

readiness()¶

readiness(): Promise<ZohoDeskProviderResponse>;

Returns¶

Promise\<ZohoDeskProviderResponse>

sendTicketReply()¶

sendTicketReply(ticketId, body): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`body`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

updateTicket()¶

updateTicket(ticketId, patch): Promise<ZohoDeskProviderResponse>;

Parameters¶

Parameter	Type
`ticketId`	`string`
`patch`	`ZohoDeskProviderPayload`

Returns¶

Promise\<ZohoDeskProviderResponse>

ZohoDeskTicketingClientOptions¶

Extended by¶

ZohoDeskLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

apiBaseUrl?¶

optional apiBaseUrl?: string;

dataCenter?¶

optional dataCenter?: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

headers?¶

optional headers?: Record<string, string>;

orgId?¶

optional orgId?: string;

providerClient?¶

optional providerClient?: ZohoDeskProviderClient;

retry?¶

optional retry?: number | ZohoDeskJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

ZohoDeskTicketInput¶

Properties¶

additionalFields?¶

optional additionalFields?: ZohoDeskProviderExtensionFields;

contactId?¶

optional contactId?: string;

departmentId¶

departmentId: string;

description?¶

optional description?: string;

email?¶

optional email?: string;

priority?¶

optional priority?: string;

status?¶

optional status?: string;

subject¶

subject: string;

Type Aliases¶

ZohoDeskJsonPrimitive¶

type ZohoDeskJsonPrimitive = string | number | boolean | null;

ZohoDeskJsonValue¶

type ZohoDeskJsonValue =
  | ZohoDeskJsonPrimitive
  | ZohoDeskJsonObject
  | readonly ZohoDeskJsonValue[];

ZohoDeskProviderExtensionValue¶

type ZohoDeskProviderExtensionValue = ZohoDeskJsonValue | object | undefined;

ZohoDeskProviderPayload¶

type ZohoDeskProviderPayload = ZohoDeskJsonObject | object;

ZohoDeskProviderQuery¶

type ZohoDeskProviderQuery = Record<string, ZohoDeskProviderExtensionValue>;

Functions¶

createUnconfiguredZohoDeskProviderClient()¶

function createUnconfiguredZohoDeskProviderClient(): ZohoDeskProviderClient;

Returns¶

ZohoDeskProviderClient

createZohoDeskRestProviderClient()¶

function createZohoDeskRestProviderClient(options): ZohoDeskProviderClient;

Parameters¶

Parameter	Type
`options`	`ZohoDeskTicketingClientOptions`

Returns¶

ZohoDeskProviderClient

createZohoDeskTicketingClient()¶

function createZohoDeskTicketingClient(options?): ZohoDeskTicketingClient;

Parameters¶

Parameter	Type
`options?`	`ZohoDeskTicketingClientOptions`

Returns¶

ZohoDeskTicketingClient

createZohoDeskTicketingLiveChecks()¶

function createZohoDeskTicketingLiveChecks(options?): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        ok: boolean;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options?`	`ZohoDeskLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { ok: boolean; }; }>; }[]

zohoDeskApiBaseUrl()¶

function zohoDeskApiBaseUrl(options): string;

Parameters¶

Parameter	Type
`options`	`Pick`\<`ZohoDeskTicketingClientOptions`, `"apiBaseUrl"` \| `"dataCenter"`>

Returns¶

string

zohoDeskTicketingCredentialStatuses()¶

function zohoDeskTicketingCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`ZohoDeskCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

References¶

zohoDeskTicketingProviderManifest¶

Re-exports zohoDeskTicketingProviderManifest