node-zendesk / Exports / clients/core/jobstatuses / JobStatuses

Class: JobStatuses

clients/core/jobstatuses.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.

Hierarchy

• Client

  ↳ JobStatuses

Table of contents

Constructors

• constructor

Properties

• _transporter
• eventTarget
• jsonAPINames
• options
• sideLoad
• useDotJson

Accessors

• transporter

Methods

• _rawRequest
• delete
• emit
• get
• getAll
• list
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad
• show
• showMany
• watch

Constructors

constructor

• new JobStatuses(options): JobStatuses

Parameters

Name	Type
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:94

---

eventTarget

• eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from

Client.eventTarget

Defined in

clients/client.d.ts:92

---

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: ClientOptions & { get: (key: string) => any }

Configuration options for the client.

Inherited from

Client.options

Defined in

clients/client.d.ts:86

---

sideLoad

• sideLoad: any[]

Array to handle side-loaded resources.

Inherited from

Client.sideLoad

Defined in

clients/client.d.ts:89

---

useDotJson

• useDotJson: boolean

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

Inherited from

Client.useDotJson

Defined in

clients/client.d.ts:91

Accessors

transporter

• get transporter(): Transporter

Transporter for making requests.

Returns

Transporter

Inherited from

Client.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: {} }>

Inherited from

Client._rawRequest

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

Inherited from

Client.delete

Defined in

clients/client.d.ts:128

---

emit

▸ emit(eventType, eventData): void

Parameters

Name	Type
eventType	any
eventData	any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:95

---

get

▸ get(resource): Promise<NodeModule>

Parameters

Name	Type
resource	any

Returns

Promise<NodeModule>

Inherited from

Client.get

Defined in

clients/client.d.ts:114

---

getAll

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

Parameters

Name	Type
resource	any

Returns

Promise<any[]>

Inherited from

Client.getAll

Defined in

clients/client.d.ts:129

---

list

▸ list(): Promise<object[]>

Retrieves a list of job statuses.

Returns

Promise<object[]>

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

Async

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:18

---

on

▸ on(eventType, callback): void

Parameters

Name	Type
eventType	any
callback	any

Returns

void

Inherited from

Client.on

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

Inherited from

Client.patch

Defined in

clients/client.d.ts:120

---

post

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

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.post

Defined in

clients/client.d.ts:122

---

put

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

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.put

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.

Inherited from

Client.request

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[]>

Inherited from

Client.requestAll

Defined in

clients/client.d.ts:149

---

requestUpload

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

Parameters

Name	Type
uri	any
file	any

Returns

Promise<any>

Inherited from

Client.requestUpload

Defined in

clients/client.d.ts:150

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113

---

show

▸ show(jobStatusID): Promise<object>

Retrieves the status of a background job.

Parameters

Name	Type	Description
jobStatusID	string	The ID of the Job status.

Returns

Promise<object>

• A promise that resolves to the job status data.

Async

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:29

---

showMany

▸ showMany(jobStatusIDs): Promise<object[]>

Retrieves the statuses of multiple background jobs.

Parameters

Name	Type	Description
jobStatusIDs	string[]	An array of job status IDs.

Returns

Promise<object[]>

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

Async

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:40

---

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

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

Async

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:52