node-zendesk / Exports / clients/core/dynamiccontent / DynamicContent

Class: DynamicContent

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

Hierarchy

Client
↳ DynamicContent

Constructors

constructor

Properties

Accessors

transporter

Methods

Constructors

constructor

• new DynamicContent(options): DynamicContent

Creates an instance of the DynamicContent.

Parameters

Name	Type	Description
`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: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/dynamiccontent.d.ts:12

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

createItem

▸ createItem(item): Promise<object>

Creates a new dynamic content item.

Parameters

Name	Type	Description
`item`	`object`	The item to create.

Returns

Promise<object>

The created dynamic content item.

Async

Throws

Throws an error if the request fails.

See

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

Example

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

Defined in

clients/core/dynamiccontent.d.ts:60

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

deleteItem

▸ deleteItem(itemID): Promise<object>

Deletes a specific dynamic content item.

Parameters

Name	Type	Description
`itemID`	`number`	The ID of the dynamic content item.

Returns

Promise<object>

The response after deletion.

Async

Throws

Throws an error if the request fails.

See

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

Example

await client.dynamiccontent.deleteItem(12345);

Defined in

clients/core/dynamiccontent.d.ts:81

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

listAllItems

▸ listAllItems(): Promise<object>

Lists all dynamic content items.

Returns

Promise<object>

All the dynamic content items.

Async

Throws

Throws an error if the request fails.

Example

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

Defined in

clients/core/dynamiccontent.d.ts:29

listItems

▸ listItems(): Promise<object>

Lists the dynamic content items.

Returns

Promise<object>

The dynamic content items.

Async

Throws

Throws an error if the request fails.

See

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

Example

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

Defined in

clients/core/dynamiccontent.d.ts:21

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

showItem

▸ showItem(itemID): Promise<object>

Shows a specific dynamic content item.

Parameters

Name	Type	Description
`itemID`	`number`	The ID of the dynamic content item.

Returns

Promise<object>

The specified dynamic content item.

Async

Throws

Throws an error if the request fails.

See

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

Example

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

Name	Type	Description
`identifiers`	`string`[]	An array of identifiers for the dynamic content items.

Returns

Promise<object>

Returns the fetched dynamic content items.

Async

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

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

Defined in

clients/core/dynamiccontent.d.ts:50

updateItem

▸ updateItem(itemID, item): Promise<object>

Updates a specific dynamic content item.

Parameters

Name	Type	Description
`itemID`	`number`	The ID of the dynamic content item.
`item`	`object`	The updated item details.

Returns

Promise<object>

The updated dynamic content item.

Async

Throws

Throws an error if the request fails.

See

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

Example

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

Defined in

clients/core/dynamiccontent.d.ts:71

Class: DynamicContent ​

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined in ​

Properties ​

_transporter ​

Inherited from ​

Defined in ​

eventTarget ​

Inherited from ​

Defined in ​

jsonAPINames ​

Overrides ​

Defined in ​

options ​

Inherited from ​

Defined in ​

sideLoad ​

Inherited from ​

Defined in ​

useDotJson ​

Inherited from ​

Defined in ​

Accessors ​

transporter ​

Returns ​

Inherited from ​

Defined in ​

Methods ​

_rawRequest ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

createItem ​

Parameters ​

Returns ​

Defined in ​

delete ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

deleteItem ​

Parameters ​

Returns ​

Defined in ​

emit ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

get ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

getAll ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

listAllItems ​

Returns ​

Defined in ​

listItems ​

Returns ​

Defined in ​

on ​

Parameters ​

Returns ​

Class: DynamicContent

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Properties

_transporter

Inherited from

Defined in

eventTarget

Inherited from

Defined in

jsonAPINames

Overrides

Defined in

options

Inherited from

Defined in

sideLoad

Inherited from

Defined in

useDotJson

Inherited from

Defined in

Accessors

transporter

Returns

Inherited from

Defined in

Methods

_rawRequest

Parameters

Returns

Inherited from

Defined in

createItem

Parameters

Returns

Defined in

delete

Parameters

Returns

Inherited from

Defined in

deleteItem

Parameters

Returns

Defined in

emit

Parameters

Returns

Inherited from

Defined in

get

Parameters

Returns

Inherited from

Defined in

getAll

Parameters

Returns

Inherited from

Defined in

listAllItems

Returns

Defined in

listItems

Returns

Defined in

on

Parameters

Returns