node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/ticketimport / TicketImport

Class: TicketImport ​

TicketImport: A class that provides methods to interact with Zendesk's Ticket Import API. This is a thin wrapper around the Zendesk REST API for ticket imports.

See ​

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

Extends ​

Constructors ​

new TicketImport() ​

new TicketImport(options): TicketImport

Parameters ​

• options: any

Returns ​

TicketImport

Overrides ​

Client.constructor

Defined in ​

clients/core/ticketimport.d.ts:7

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/ticketimport.d.ts:8

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

bulkImport() ​

bulkImport(tickets): Promise<object>

Bulk imports multiple tickets into Zendesk.

Parameters ​

• tickets: object[]

An array containing ticket data to be imported. Each ticket should include the following fields:

Returns ​

Promise<object>

The response from the Zendesk API, including a job status object.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request to the Zendesk API fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/#ticket-bulk-import

Example ​

ts
const ticketDataArray = [{
  assignee_id: 19,
  comments: [{ author_id: 19, value: "This is a comment" }],
  description: "A description",
  requester_id: 827,
  subject: "Help",
  tags: ["foo", "bar"]
},
{
  assignee_id: 20,
  comments: [{ author_id: 20, value: "Another comment" }],
  description: "Another description",
  requester_id: 828,
  subject: "Help Again",
  tags: ["foo2", "bar2"]
}];
const response = await client.ticketimport.bulkImport(ticketDataArray);

Defined in ​

clients/core/ticketimport.d.ts:87

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

exportAudit() ​

exportAudit(ticketID): Promise<any[]>

Parameters ​

• ticketID: number

The ID of the ticket to fetch the audits for.

Returns ​

Promise<any[]>

An array of ticket audits from the Zendesk API.

Throws ​

Throws an error if the request to the Zendesk API fails.

See ​

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

Example ​

ts
const ticketID = 12345;
const audits = await client.ticketimport.exportAudit(ticketID);

Deprecated ​

Use the list method from the TicketAudits class instead. Exports the audits of a specific ticket.

Defined in ​

clients/core/ticketimport.d.ts:54

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

import() ​

import(ticket): Promise<object>

Imports a ticket into Zendesk.

Parameters ​

• ticket

The ticket data to be imported.

• ticket.assignee_id: number

The ID of the user to assign this ticket to.

• ticket.comments: any[]

Array of comments associated with the ticket.

• ticket.description: string

The description of the ticket.

• ticket.requester_id: number

The ID of the user requesting the ticket.

• ticket.subject: string

The subject of the ticket.

• ticket.tags: any[]

Array of tags associated with the ticket.

Returns ​

Promise<object>

The response from the Zendesk API.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request to the Zendesk API fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/#ticket-import

Example ​

ts
const ticketData = {
  assignee_id: 19,
  comments: [{ author_id: 19, value: "This is a comment" }],
  description: "A description",
  requester_id: 827,
  subject: "Help",
  tags: ["foo", "bar"]
};
const response = await client.ticketimport.import(ticketData);

Defined in ​

clients/core/ticketimport.d.ts:32

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

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 ❤️