node-zendesk / Exports / clients/core/ticketforms / TicketForms

Class: TicketForms

clients/core/ticketforms.TicketForms

Classdesc

Client for interacting with the Zendesk TicketForms API.

See

https://developer.zendesk.com/rest_api/docs/support#ticket-forms

Hierarchy

• Client

  ↳ TicketForms

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• clone
• create
• delete
• emit
• get
• getAll
• list
• on
• patch
• post
• put
• reorder
• request
• requestAll
• requestUpload
• setSideLoad
• show
• update

Constructors

constructor

• new TicketForms(options): TicketForms

Parameters

Name	Type
options	any

Returns

TicketForms

Overrides

Client.constructor

Defined in

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

---

clone

▸ clone(ticketFormID, prependCloneTitle?): Promise<object>

Clones an already existing Ticket Form by its ID.

Parameters

Name	Type	Description
ticketFormID	number	The ID of the ticket form to be cloned.
prependCloneTitle?	boolean	Whether to prepend the title with "Clone of" or not.

Returns

Promise<object>

• A promise that resolves to the cloned ticket form details.

Async

Throws

• Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#clone-an-already-existing-ticket-form

Example

const clonedForm = await client.ticketforms.clone(12345, true); // Replace 12345 with the actual ticket form ID.

Defined in

clients/core/ticketforms.d.ts:94

---

create

▸ create(ticketForm): Promise<object>

Creates a new Ticket Form.

Parameters

Name	Type	Description
ticketForm	object	The ticket form object to be created.

Returns

Promise<object>

• A promise that resolves to the created ticket form.

Async

Throws

• Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#create-ticket-form

Example

const ticketFormData = {
  name: "Snowboard Problem",
  end_user_visible: true,
  // ... other properties ...
};
const newTicketForm = await client.ticketforms.create(ticketFormData);

Defined in

clients/core/ticketforms.d.ts:58

---

delete

▸ delete(ticketFormID): Promise<void>

Deletes a Ticket Form by its ID.

Parameters

Name	Type	Description
ticketFormID	number	The ID of the ticket form to be deleted.

Returns

Promise<void>

• A promise that resolves when the ticket form is deleted.

Async

Throws

• Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#delete-ticket-form

Example

await client.ticketforms.delete(12345); // Replace 12345 with the actual ticket form ID.

Overrides

Client.delete

Defined in

clients/core/ticketforms.d.ts:82

---

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

---

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

---

list

▸ list(options?): Promise<any[]>

List ticket forms based on the provided query parameters.

Parameters

Name	Type	Description
options?	Object	Optional query parameters.
options.active?	boolean	true returns active ticket forms; false returns inactive ticket forms. If not present, returns both.
options.associated_to_brand?	boolean	true returns the ticket forms of the brand specified by the url's subdomain.
options.end_user_visible?	boolean	true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both.
options.fallback_to_default?	boolean	true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms.

Returns

Promise<any[]>

An array of ticket forms.

Async

Throws

Throws an error if there is an issue with the API call.

See

https://developer.zendesk.com/rest_api/docs/support#list-ticket-forms

Example

const client = createClient({...});
const activeTicketForms = await client.ticketforms.list({ active: true });
const allTicketForms = await client.ticketforms.list();

Defined in

clients/core/ticketforms.d.ts:25

---

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

---

reorder

▸ reorder(ticketFormIDs): Promise<object>

Reorders the specified Ticket Forms based on the provided array of IDs.

Parameters

Name	Type	Description
ticketFormIDs	number[]	An array of ticket form IDs in the desired order.

Returns

Promise<object>

• A promise that resolves to the reordered ticket forms' details.

Async

Throws

• Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/#reorder-ticket-forms

Example

const reorderedForms = await client.ticketforms.reorder([2, 23, 46, 50]);

Defined in

clients/core/ticketforms.d.ts:105

---

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

---

show

▸ show(ticketFormID): Promise<object>

Retrieve a specific ticket form by its ID.

Parameters

Name	Type	Description
ticketFormID	number	The ID of the ticket form to retrieve.

Returns

Promise<object>

The requested ticket form.

Async

Throws

Throws an error if there is an issue with the API call.

See

https://developer.zendesk.com/rest_api/docs/support#show-ticket-form

Example

const client = createClient({...});
const ticketForm = await client.ticketforms.show(12345);

Defined in

clients/core/ticketforms.d.ts:42

---

update

▸ update(ticketFormID, ticketForm): Promise<object>

Update a specific ticket form by its ID.

Parameters

Name	Type	Description
ticketFormID	number	The ID of the ticket form to update.
ticketForm	object	The updated ticket form object.

Returns

Promise<object>

The updated ticket form.

Async

Throws

Throws an error if there is an issue with the API call.

See

https://developer.zendesk.com/rest_api/docs/support#update-ticket-form

Example

const client = createClient({...});
const updatedForm = await client.ticketforms.update(12345, {name: 'Updated Form'});

Defined in

clients/core/ticketforms.d.ts:71