node-zendesk / Exports / clients/core/ticketimport / TicketImport

Class: TicketImport

clients/core/ticketimport.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/

Hierarchy

• Client

  ↳ TicketImport

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• bulkImport
• delete
• emit
• exportAudit
• get
• getAll
• import
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad

Constructors

constructor

• new TicketImport(options): TicketImport

Parameters

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

---

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

---

bulkImport

▸ bulkImport(tickets): Promise<object>

Bulk imports multiple tickets into Zendesk.

Parameters

Name	Type	Description
tickets	any[]	An array containing ticket data to be imported. Accepts up to 100 ticket objects.

Returns

Promise<object>

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

Async

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

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

---

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

---

exportAudit

▸ exportAudit(ticketID): Promise<any[]>

Parameters

Name	Type	Description
ticketID	number	The ID of the ticket to fetch the audits for.

Returns

Promise<any[]>

An array of ticket audits from the Zendesk API.

Async

Throws

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

See

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

Example

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

---

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

---

import

▸ import(ticket): Promise<object>

Imports a ticket into Zendesk.

Parameters

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

Async

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

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

---

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

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113