node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/dynamiccontent / DynamicContent

Class: DynamicContent ​

Represents the Dynamic Content section of the Zendesk API. Provides methods to interact with the Dynamic Content Items.

See ​

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

Extends ​

Constructors ​

new DynamicContent() ​

new DynamicContent(options): DynamicContent

Creates an instance of the DynamicContent.

Parameters ​

• options: object

The options for the client.

Returns ​

DynamicContent

Overrides ​

Client.constructor

Defined in ​

clients/core/dynamiccontent.d.ts:11

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/dynamiccontent.d.ts:12

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

createItem() ​

createItem(item): Promise<object>

Creates a new dynamic content item.

Parameters ​

• item: object

The item to create.

Returns ​

Promise<object>

The created dynamic content item.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#create-item

Example ​

ts
const newItem = await client.dynamiccontent.createItem({name: "Sample Item", default_locale_id: 1, variants: [...]});

Defined in ​

clients/core/dynamiccontent.d.ts:64

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

deleteItem() ​

deleteItem(itemID): Promise<object>

Deletes a specific dynamic content item.

Parameters ​

• itemID: number

The ID of the dynamic content item.

Returns ​

Promise<object>

The response after deletion.

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#delete-item

Example ​

ts
await client.dynamiccontent.deleteItem(12345);

Defined in ​

clients/core/dynamiccontent.d.ts:89

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

listAllItems() ​

listAllItems(): Promise<object>

Lists all dynamic content items.

Returns ​

Promise<object>

All the dynamic content items.

Throws ​

Throws an error if the request fails.

Example ​

ts
const allItems = await client.dynamiccontent.listAllItems();

Defined in ​

clients/core/dynamiccontent.d.ts:30

listItems() ​

listItems(): Promise<object>

Lists the dynamic content items.

Returns ​

Promise<object>

The dynamic content items.

response ​

response: object

result ​

result: object[]

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#list-items

Example ​

ts
const items = await client.dynamiccontent.listItems();

Defined in ​

clients/core/dynamiccontent.d.ts:20

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

showItem() ​

showItem(itemID): Promise<object>

Shows a specific dynamic content item.

Parameters ​

• itemID: number

The ID of the dynamic content item.

Returns ​

Promise<object>

The specified dynamic content item.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#show-item

Example ​

ts
const item = await client.dynamiccontent.showItem(12345);

Defined in ​

clients/core/dynamiccontent.d.ts:39

showManyItems() ​

showManyItems(identifiers): Promise<object>

Retrieves multiple dynamic content items using their identifiers.

Parameters ​

• identifiers: string[]

An array of identifiers for the dynamic content items.

Returns ​

Promise<object>

Returns the fetched dynamic content items.

response ​

response: object

result ​

result: object[]

Throws ​

Throws an error if the provided identifiers parameter is not a valid array or is empty.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#show-many-items

Example ​

ts
const items = await client.dynamiccontent.showManyItems(['item_one', 'item_two']);

Defined in ​

clients/core/dynamiccontent.d.ts:52

updateItem() ​

updateItem(itemID, item): Promise<object>

Updates a specific dynamic content item.

Parameters ​

• itemID: number

The ID of the dynamic content item.

• item: object

The updated item details.

Returns ​

Promise<object>

The updated dynamic content item.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/#update-item

Example ​

ts
const updatedItem = await client.dynamiccontent.updateItem(12345, {name: "Updated Name"});

Defined in ​

clients/core/dynamiccontent.d.ts:77

Released under the MIT License.

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