node-zendesk • Docs
node-zendesk / clients/core/suspendedtickets / SuspendedTickets
Class: SuspendedTickets
A thin wrapper around the Zendesk Suspended Tickets API
See
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
Extends
Constructors
new SuspendedTickets()
new SuspendedTickets(
options):SuspendedTickets
Parameters
• options: any
Returns
Overrides
Defined in
clients/core/suspendedtickets.d.ts:6
Properties
_transporter
_transporter:
Transporter
Inherited from
Defined in
clients/client.d.ts:42
eventTarget
eventTarget:
CustomEventTarget
Event target to handle custom events.
Inherited from
Defined in
clients/client.d.ts:40
jsonAPINames
jsonAPINames:
string[]
Array to hold names used in the JSON API.
Overrides
Defined in
clients/core/suspendedtickets.d.ts:7
options
options:
ZendeskClientOptions&object
Configuration options for the client.
Type declaration
get()
get: (
key) =>any
Parameters
• key: string
Returns
any
Inherited from
Defined in
clients/client.d.ts:34
sideLoad
sideLoad:
any[]
Array to handle side-loaded resources.
Inherited from
Defined in
clients/client.d.ts:37
useDotJson
useDotJson:
boolean
Flag to indicate if the API endpoint should use '.json' ending.
Inherited from
Defined in
clients/client.d.ts:39
Accessors
transporter
Get Signature
get transporter():
Transporter
Returns
Transporter for making requests.
Inherited from
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
Defined in
clients/client.d.ts:78
attachments()
attachments(
suspendedTicketID):Promise<object>
Get attachments for a specific suspended ticket by ID
Parameters
• suspendedTicketID: number
ID of the suspended ticket to get attachments from
Returns
Promise<object>
Returns a promise that resolves to the attachments of the suspended ticket
response
response:
object
result
result:
object
See
Example
const attachments = await client.suspendedtickets.attachments(12345);Defined in
clients/core/suspendedtickets.d.ts:82
delete()
delete(
suspendedTicketID):Promise<any>
Delete a specific suspended ticket by ID
Parameters
• suspendedTicketID: number
ID of the suspended ticket to delete
Returns
Promise<any>
Returns a promise that resolves once the ticket has been deleted
Throws
Will throw an error if the request fails
See
Example
await client.suspendedtickets.delete(12345);Overrides
Defined in
clients/core/suspendedtickets.d.ts:56
deleteMany()
deleteMany(
suspendedTicketIDs):Promise<any>
Parameters
• suspendedTicketIDs: number[]
An array of suspended ticket IDs to delete
Returns
Promise<any>
Returns a promise that resolves once the tickets have been deleted
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
• suspendedTicketIDs: number[]
An array of suspended ticket IDs to delete
Returns
Promise<any>
Returns a promise that resolves once the tickets have been deleted
Throws
Will throw an error if the request fails
See
Example
await client.suspendedtickets.destroyMany([12345, 67890]);Defined in
clients/core/suspendedtickets.d.ts:65
emit()
emit(
eventType,eventData):void
Parameters
• eventType: any
• eventData: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:43
exportTickets()
exportTickets():
Promise<object>
Export suspended tickets for the Zendesk Support instance
Returns
Promise<object>
Returns a promise that resolves once the export request has been initiated
response
response:
object
result
result:
object
See
Example
await client.suspendedtickets.exportTickets();Defined in
clients/core/suspendedtickets.d.ts:92
get()
get(
resource):Promise<NodeModule>
Parameters
• resource: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:62
getAll()
getAll(
resource):Promise<any[]>
Parameters
• resource: any
Returns
Promise<any[]>
Inherited from
Defined in
clients/client.d.ts:77
list()
list():
Promise<any>
List all suspended tickets
Returns
Promise<any>
Returns a promise that resolves to a list of suspended tickets
See
Example
const tickets = await client.suspendedtickets.list();Defined in
clients/core/suspendedtickets.d.ts:14
on()
on(
eventType,callback):void
Parameters
• eventType: any
• callback: any
Returns
void
Inherited from
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
Defined in
clients/client.d.ts:68
post()
post(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:70
put()
put(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:69
recover()
recover(
suspendedTicketID):Promise<object>
Recover a specific suspended ticket by ID
Parameters
• suspendedTicketID: number
ID of the suspended ticket to recover
Returns
Promise<object>
Returns a promise that resolves once the ticket has been recovered
response
response:
object
result
result:
object
See
Example
await client.suspendedtickets.recover(12345);Defined in
clients/core/suspendedtickets.d.ts:33
recoverMany()
recoverMany(
suspendedTicketIDs):Promise<object>
Recover multiple suspended tickets by their IDs
Parameters
• suspendedTicketIDs: number[]
An array of suspended ticket IDs to recover
Returns
Promise<object>
Returns a promise that resolves once the tickets have been recovered
response
response:
object
result
result:
object
See
Example
await client.suspendedtickets.recoverMany([12345, 67890]);Defined in
clients/core/suspendedtickets.d.ts:44
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
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
Defined in
clients/client.d.ts:97
requestUpload()
requestUpload(
uri,file):Promise<any>
Parameters
• uri: any
• file: any
Returns
Promise<any>
Inherited from
Defined in
clients/client.d.ts:98
setSideLoad()
setSideLoad(
array):void
Parameters
• array: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:61
show()
show(
suspendedTicketID):Promise<object>
Get details of a specific suspended ticket by ID
Parameters
• suspendedTicketID: number
ID of the suspended ticket
Returns
Promise<object>
Returns a promise that resolves to the details of the suspended ticket
response
response:
object
result
result:
object
See
Example
const ticket = await client.suspendedtickets.show(12345);Defined in
clients/core/suspendedtickets.d.ts:22