node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/ticketforms / TicketForms

Class: TicketForms ​

Client for interacting with the Zendesk TicketForms API.

See ​

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

Extends ​

Constructors ​

new TicketForms() ​

new TicketForms(options): TicketForms

Parameters ​

• options: any

Returns ​

TicketForms

Overrides ​

Client.constructor

Defined in ​

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

clone() ​

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

Clones an already existing Ticket Form by its ID.

Parameters ​

• 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.
response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/ticketforms.d.ts:96

create() ​

create(ticketForm): Promise<object>

Creates a new Ticket Form.

Parameters ​

• ticketForm: object

The ticket form object to be created.

Returns ​

Promise<object>

  • A promise that resolves to the created ticket form.
response ​

response: object

result ​

result: object

Throws ​

  • Throws an error if the API call fails.

See ​

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

Example ​

ts
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:57

delete() ​

delete(ticketFormID): Promise<void>

Deletes a Ticket Form by its ID.

Parameters ​

• ticketFormID: number

The ID of the ticket form to be deleted.

Returns ​

Promise<void>

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

Throws ​

  • Throws an error if the API call fails.

See ​

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

Example ​

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

Overrides ​

Client.delete

Defined in ​

clients/core/ticketforms.d.ts:85

emit() ​

emit(eventType, eventData): void

Parameters ​

• eventType: any

• eventData: any

Returns ​

void

Inherited from ​

Client.emit

Defined in ​

clients/client.d.ts:43

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

list() ​

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

List ticket forms based on the provided query parameters.

Parameters ​

• options?

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.

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 ​

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

Defined in ​

clients/core/ticketforms.d.ts:23

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

reorder() ​

reorder(ticketFormIDs): Promise<object>

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

Parameters ​

• 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.
response ​

response: object

result ​

result: object

Throws ​

  • Throws an error if the API call fails.

See ​

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

Example ​

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

Defined in ​

clients/core/ticketforms.d.ts:109

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

show() ​

show(ticketFormID): Promise<object>

Retrieve a specific ticket form by its ID.

Parameters ​

• ticketFormID: number

The ID of the ticket form to retrieve.

Returns ​

Promise<object>

The requested ticket form.

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/ticketforms.d.ts:39

update() ​

update(ticketFormID, ticketForm): Promise<object>

Update a specific ticket form by its ID.

Parameters ​

• ticketFormID: number

The ID of the ticket form to update.

• ticketForm: object

The updated ticket form object.

Returns ​

Promise<object>

The updated ticket form.

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/ticketforms.d.ts:72

Released under the MIT License.

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