node-zendesk / Exports / clients/core/suspendedtickets / SuspendedTickets

Class: SuspendedTickets

clients/core/suspendedtickets.SuspendedTickets

Description

A thin wrapper around the Zendesk Suspended Tickets API

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/

Hierarchy

• Client

  ↳ SuspendedTickets

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• attachments
• delete
• deleteMany
• destroyMany
• emit
• exportTickets
• get
• getAll
• list
• on
• patch
• post
• put
• recover
• recoverMany
• request
• requestAll
• requestUpload
• setSideLoad
• show

Constructors

constructor

• new SuspendedTickets(options): SuspendedTickets

Parameters

Name	Type
options	any

Returns

SuspendedTickets

Overrides

Client.constructor

Defined in

clients/core/suspendedtickets.d.ts:8

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/suspendedtickets.d.ts:9

---

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

---

attachments

▸ attachments(suspendedTicketID): Promise<any>

Get attachments for a specific suspended ticket by ID

Parameters

Name	Type	Description
suspendedTicketID	number	ID of the suspended ticket to get attachments from

Returns

Promise<any>

Returns a promise that resolves to the attachments of the suspended ticket

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#suspended-ticket-attachments

Example

const attachments = await client.suspendedtickets.attachments(12345);

Defined in

clients/core/suspendedtickets.d.ts:83

---

delete

▸ delete(suspendedTicketID): Promise<any>

Delete a specific suspended ticket by ID

Parameters

Name	Type	Description
suspendedTicketID	number	ID of the suspended ticket to delete

Returns

Promise<any>

Returns a promise that resolves once the ticket has been deleted

Async

Throws

Will throw an error if the request fails

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#delete-suspended-ticket

Example

await client.suspendedtickets.delete(12345);

Overrides

Client.delete

Defined in

clients/core/suspendedtickets.d.ts:54

---

deleteMany

▸ deleteMany(suspendedTicketIDs): Promise<any>

Parameters

Name	Type	Description
suspendedTicketIDs	number[]	An array of suspended ticket IDs to delete

Returns

Promise<any>

Returns a promise that resolves once the tickets have been deleted

Async

Throws

Will throw an error if the request fails

Example

await client.suspendedtickets.deleteMany([12345, 67890]);

Deprecated

Use destroyMany method instead. Deletes multiple suspended tickets by their IDs. This method is deprecated.

Defined in

clients/core/suspendedtickets.d.ts:74

---

destroyMany

▸ destroyMany(suspendedTicketIDs): Promise<any>

Deletes multiple suspended tickets by their IDs

Parameters

Name	Type	Description
suspendedTicketIDs	number[]	An array of suspended ticket IDs to delete

Returns

Promise<any>

Returns a promise that resolves once the tickets have been deleted

Async

Throws

Will throw an error if the request fails

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#delete-multiple-suspended-tickets

Example

await client.suspendedtickets.destroyMany([12345, 67890]);

Defined in

clients/core/suspendedtickets.d.ts:64

---

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

---

exportTickets

▸ exportTickets(): Promise<any>

Export suspended tickets for the Zendesk Support instance

Returns

Promise<any>

Returns a promise that resolves once the export request has been initiated

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#export-suspended-tickets

Example

await client.suspendedtickets.exportTickets();

Defined in

clients/core/suspendedtickets.d.ts:91

---

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<any>

List all suspended tickets

Returns

Promise<any>

Returns a promise that resolves to a list of suspended tickets

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#list-suspended-tickets

Example

const tickets = await client.suspendedtickets.list();

Defined in

clients/core/suspendedtickets.d.ts:17

---

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

---

recover

▸ recover(suspendedTicketID): Promise<any>

Recover a specific suspended ticket by ID

Parameters

Name	Type	Description
suspendedTicketID	number	ID of the suspended ticket to recover

Returns

Promise<any>

Returns a promise that resolves once the ticket has been recovered

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#recover-suspended-ticket

Example

await client.suspendedtickets.recover(12345);

Defined in

clients/core/suspendedtickets.d.ts:35

---

recoverMany

▸ recoverMany(suspendedTicketIDs): Promise<any>

Recover multiple suspended tickets by their IDs

Parameters

Name	Type	Description
suspendedTicketIDs	number[]	An array of suspended ticket IDs to recover

Returns

Promise<any>

Returns a promise that resolves once the tickets have been recovered

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#recover-multiple-suspended-tickets

Example

await client.suspendedtickets.recoverMany([12345, 67890]);

Defined in

clients/core/suspendedtickets.d.ts:44

---

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(suspendedTicketID): Promise<any>

Get details of a specific suspended ticket by ID

Parameters

Name	Type	Description
suspendedTicketID	number	ID of the suspended ticket

Returns

Promise<any>

Returns a promise that resolves to the details of the suspended ticket

Async

See

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/#show-suspended-ticket

Example

const ticket = await client.suspendedtickets.show(12345);

Defined in

clients/core/suspendedtickets.d.ts:26