node-zendesk • Docs

---

node-zendesk / clients/core/jobstatuses / JobStatuses

Class: JobStatuses

Represents the Job Statuses in Zendesk. A status record is created when somebody kicks off a job such as updating multiple tickets.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/ for the API documentation.

Extends

• Client

Constructors

new JobStatuses()

new JobStatuses(options): JobStatuses

Parameters

• options: any

Returns

JobStatuses

Overrides

Client.constructor

Defined in

clients/core/jobstatuses.d.ts:7

Properties

_transporter

_transporter: Transporter

Inherited from

Client._transporter

Defined in

clients/client.d.ts:42

---

eventTarget

eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from

Client.eventTarget

Defined in

clients/client.d.ts:40

---

jsonAPINames

jsonAPINames: string[]

Array to hold names used in the JSON API.

Overrides

Client.jsonAPINames

Defined in

clients/core/jobstatuses.d.ts:8

---

options

options: ZendeskClientOptions & object

Configuration options for the client.

Type declaration

get()

get: (key) => any

Parameters

• key: string

Returns

any

Inherited from

Client.options

Defined in

clients/client.d.ts:34

---

sideLoad

sideLoad: any[]

Array to handle side-loaded resources.

Inherited from

Client.sideLoad

Defined in

clients/client.d.ts:37

---

useDotJson

useDotJson: boolean

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

Inherited from

Client.useDotJson

Defined in

clients/client.d.ts:39

Accessors

transporter

Get Signature

get transporter(): Transporter

Returns

Transporter

Transporter for making requests.

Inherited from

Client.transporter

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

Inherited from

Client._rawRequest

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

Inherited from

Client.delete

Defined in

clients/client.d.ts:76

---

emit()

emit(eventType, eventData): void

Parameters

• eventType: any

• eventData: any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:43

---

get()

get(resource): Promise<NodeModule>

Parameters

• resource: any

Returns

Promise<NodeModule>

Inherited from

Client.get

Defined in

clients/client.d.ts:62

---

getAll()

getAll(resource): Promise<any[]>

Parameters

• resource: any

Returns

Promise<any[]>

Inherited from

Client.getAll

Defined in

clients/client.d.ts:77

---

list()

list(): Promise<object>

Retrieves a list of job statuses.

Returns

Promise<object>

• A promise that resolves to a list of job statuses.

response

response: object

result

result: object[]

Throws

If there's an error in the request.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#list-job-statuses for the API endpoint documentation.

Example

const jobStatusList = await client.jobstatuses.list();

Defined in

clients/core/jobstatuses.d.ts:17

---

on()

on(eventType, callback): void

Parameters

• eventType: any

• callback: any

Returns

void

Inherited from

Client.on

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

Inherited from

Client.patch

Defined in

clients/client.d.ts:68

---

post()

post(resource, body): Promise<NodeModule>

Parameters

• resource: any

• body: any

Returns

Promise<NodeModule>

Inherited from

Client.post

Defined in

clients/client.d.ts:70

---

put()

put(resource, body): Promise<NodeModule>

Parameters

• resource: any

• body: any

Returns

Promise<NodeModule>

Inherited from

Client.put

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.

Inherited from

Client.request

Defined in

clients/client.d.ts:96

---

requestAll()

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

Parameters

• method: any

• uri: any

• ...arguments_: any[]

Returns

Promise<any[]>

Inherited from

Client.requestAll

Defined in

clients/client.d.ts:97

---

requestUpload()

requestUpload(uri, file): Promise<any>

Parameters

• uri: any

• file: any

Returns

Promise<any>

Inherited from

Client.requestUpload

Defined in

clients/client.d.ts:98

---

setSideLoad()

setSideLoad(array): void

Parameters

• array: any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:61

---

show()

show(jobStatusID): Promise<object>

Retrieves the status of a background job.

Parameters

• jobStatusID: string

The ID of the Job status.

Returns

Promise<object>

• A promise that resolves to the job status data.

response

response: object

result

result: object

Throws

If the job status ID is not provided or if there's an error in the request.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-job-status for the API endpoint documentation.

Example

const jobStatus = await client.jobstatuses.show("dd9321f29967688b27bc9499ebb4ae8d");

Defined in

clients/core/jobstatuses.d.ts:30

---

showMany()

showMany(jobStatusIDs): Promise<object>

Retrieves the statuses of multiple background jobs.

Parameters

• jobStatusIDs: string[]

An array of job status IDs.

Returns

Promise<object>

• A promise that resolves to a list of job statuses.

response

response: object

result

result: object[]

Throws

If the job status IDs are not provided or if there's an error in the request.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-many-job-statuses for the API endpoint documentation.

Example

const jobStatuses = await client.jobstatuses.showMany(["dd9321f29967688b27bc9499ebb4ae8d", "82de0b044094f0c67893ac9fe64f1a99"]);

Defined in

clients/core/jobstatuses.d.ts:43

---

watch()

watch(jobID, interval, maxAttempts): Promise<object>

Monitors a specific job until it's completed, based on a provided interval and maximum number of attempts.

Parameters

• jobID: string

The ID of the job to watch.

• interval: number

The time (in milliseconds) to wait between each check.

• maxAttempts: number

The maximum number of attempts to check the job status.

Returns

Promise<object>

• A promise that resolves with the job status when the job is completed or the maximum attempts are reached.

Throws

If there's an error in the request or if the maximum attempts are reached without the job completing.

Example

await client.jobstatuses.watch("dd9321f29967688b27bc9499ebb4ae8d", 1000, 5);

Defined in

clients/core/jobstatuses.d.ts:57