node-zendesk / Exports / clients/core/ticketexport / TicketExport

Class: TicketExport

clients/core/ticketexport.TicketExport

TicketExport class for interacting with the Zendesk Ticket Export API.

See

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

Hierarchy

Client
↳ TicketExport

Constructors

constructor

Properties

Accessors

transporter

Methods

Constructors

constructor

• new TicketExport(options): TicketExport

Parameters

Name	Type
`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: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/ticketexport.d.ts:7

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

export

▸ export(start_time): Promise<object>

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

Parameters

Name	Type	Description
`start_time`	`number`	The time to start the incremental export from.

Returns

Promise<object>

Returns the response from the Zendesk API.

Async

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

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

Defined in

clients/core/ticketexport.d.ts:17

exportAudit

▸ exportAudit(ticketID): Promise<object>

Parameters

Name	Type	Description
`ticketID`	`number`	The ID of the ticket.

Returns

Promise<object>

Returns the list of audits for the ticket.

Async

Throws

Will throw an error if the request fails.

Example

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

exportCursor

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

Export tickets using the cursor-based approach.

Parameters

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

Async

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

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

Defined in

clients/core/ticketexport.d.ts:53

exportWithInclude

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

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

Parameters

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

Async

Throws

If startTime is not a valid string.

See

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

Example

// 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:42

exportWithUser

▸ exportWithUser(start_time): Promise<object>

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

Parameters

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

Async

Throws

Will throw an error if the request fails.

Example

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

Defined in

clients/core/ticketexport.d.ts:26

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

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

sample

▸ sample(startTime): Promise<object>

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

Parameters

Name	Type	Description
`startTime`	`string`	The start time for exporting the sample of tickets. *

Returns

Promise<object>

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

Async

Throws

If startTime is not a valid string. *

See

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

Example

* // 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:77

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
`array`	`any`

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113

Class: TicketExport ​

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined in ​

Properties ​

_transporter ​

Inherited from ​

Defined in ​

eventTarget ​

Inherited from ​

Defined in ​

jsonAPINames ​

Overrides ​

Defined in ​

options ​

Inherited from ​

Defined in ​

sideLoad ​

Inherited from ​

Defined in ​

useDotJson ​

Inherited from ​

Defined in ​

Accessors ​

transporter ​

Returns ​

Inherited from ​

Defined in ​

Methods ​

_rawRequest ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

delete ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

emit ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

export ​

Parameters ​

Returns ​

Defined in ​

exportAudit ​

Parameters ​

Returns ​

Defined in ​

exportCursor ​

Parameters ​

Returns ​

Defined in ​

exportWithInclude ​

Parameters ​

Returns ​

Defined in ​

exportWithUser ​

Parameters ​

Returns ​

Defined in ​

get ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

getAll ​

Parameters ​

Class: TicketExport

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Properties

_transporter

Inherited from

Defined in

eventTarget

Inherited from

Defined in

jsonAPINames

Overrides

Defined in

options

Inherited from

Defined in

sideLoad

Inherited from

Defined in

useDotJson

Inherited from

Defined in

Accessors

transporter

Returns

Inherited from

Defined in

Methods

_rawRequest

Parameters

Returns

Inherited from

Defined in

delete

Parameters

Returns

Inherited from

Defined in

emit

Parameters

Returns

Inherited from

Defined in

export

Parameters

Returns

Defined in

exportAudit

Parameters

Returns

Defined in

exportCursor

Parameters

Returns

Defined in

exportWithInclude

Parameters

Returns

Defined in

exportWithUser

Parameters

Returns

Defined in

get

Parameters

Returns

Inherited from

Defined in

getAll

Parameters