node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/ticketexport / TicketExport

Class: TicketExport ​

TicketExport class for interacting with the Zendesk Ticket Export API.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/

Extends ​

Constructors ​

new TicketExport() ​

new TicketExport(options): TicketExport

Parameters ​

• options: any

Returns ​

TicketExport

Overrides ​

Client.constructor

Defined in ​

clients/core/ticketexport.d.ts:6

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/ticketexport.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 ​

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

export() ​

export(start_time): Promise<object>

Export tickets that changed since the provided start time using the time-based approach.

Parameters ​

• start_time: number

The time to start the incremental export from.

Returns ​

Promise<object>

Returns the response from the Zendesk API.

response ​

response: object

result ​

result: object

Throws ​

Will throw an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-export-time-based

Example ​

ts
const tickets = await client.ticketexport.export(1332034771);

Defined in ​

clients/core/ticketexport.d.ts:16

exportAudit() ​

exportAudit(ticketID): Promise<object>

Parameters ​

• ticketID: number

The ID of the ticket.

Returns ​

Promise<object>

Returns the list of audits for the ticket.

Throws ​

Will throw an error if the request fails.

Example ​

ts
const ticketAudits = await client.ticketexport.exportAudit(12345);

Deprecated ​

Use the list method from the TicketAudits class instead. Retrieve all audits for a specific ticket.

Defined in ​

clients/core/ticketexport.d.ts:67

exportCursor() ​

exportCursor(start_time, cursor?): Promise<object>

Export tickets using the cursor-based approach.

Parameters ​

• start_time: number

The time to start the incremental export from.

• cursor?: string

The cursor pointer for subsequent requests.

Returns ​

Promise<object>

Returns the response from the Zendesk API.

response ​

response: object

result ​

result: object

Throws ​

Will throw an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-export-cursor-based

Example ​

ts
const cursorTickets = await client.ticketexport.exportCursor(1332034771, 'MTU3NjYxMzUzOS4wfHw0NTF8');

Defined in ​

clients/core/ticketexport.d.ts:55

exportWithInclude() ​

exportWithInclude(startTime, include): Promise<any[]>

Export incremental tickets based on a specified start time and optional include parameters.

Parameters ​

• startTime: string

The start time for exporting incremental tickets.

• include: string

Optional parameters to include in the export.

Returns ​

Promise<any[]>

A promise that resolves with an array of exported incremental tickets.

Throws ​

If startTime is not a valid string.

See ​

https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#ticket-export-incremental-include

Example ​

ts
// Export incremental tickets based on a start time with optional include parameters
const startTime = '2023-01-01T00:00:00Z';
const include = 'users,groups';
const incrementalTickets = await client.tickets.ticketexport(startTime, include);

Defined in ​

clients/core/ticketexport.d.ts:45

exportWithUser() ​

exportWithUser(start_time): Promise<object>

Export tickets with associated users and groups since the provided start time.

Parameters ​

• start_time: number

The time to start the incremental export from.

Returns ​

Promise<object>

Returns the response from the Zendesk API with users and groups included.

response ​

response: object

result ​

result: object

Throws ​

Will throw an error if the request fails.

Example ​

ts
const ticketsWithUsers = await client.ticketexport.exportWithUser(1332034771);

Defined in ​

clients/core/ticketexport.d.ts:27

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

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

sample() ​

sample(startTime): Promise<object>

Export a sample of tickets based on a specified start time. *

Parameters ​

• startTime: string

The start time for exporting the sample of tickets. *

Returns ​

Promise<object>

A promise that resolves with the exported sample of tickets. *

response ​

response: object

result ​

result: object

Throws ​

If startTime is not a valid string. *

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-sample-export *

Example ​

ts
* // Export a sample of tickets based on a start time
* const startTime = '2023-01-01T00:00:00Z';
* const exportedSample = await client.ticketexport.sample(startTime);

Defined in ​

clients/core/ticketexport.d.ts:80

setSideLoad() ​

setSideLoad(array): void

Parameters ​

• array: any

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:61

Released under the MIT License.

Copyright © 2012-present | Made by Farrin A. Reid with ❤️