node-zendesk / Exports / clients/core/dynamiccontentvariants / DynamicContentVariants

Class: DynamicContentVariants

clients/core/dynamiccontentvariants.DynamicContentVariants

Dynamic Content Variants client for the Zendesk REST API.

See

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

Hierarchy

• Client

  ↳ DynamicContentVariants

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

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

Constructors

constructor

• new DynamicContentVariants(options): DynamicContentVariants

Parameters

Name	Type
options	any

Returns

DynamicContentVariants

Overrides

Client.constructor

Defined in

clients/core/dynamiccontentvariants.d.ts:6

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

---

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

---

create

▸ create(itemID, variant): Promise<object>

Creates a new dynamic content variant.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variant	object	The details of the variant to create.

Returns

Promise<object>

Returns the details of the created variant.

Async

Throws

Throws an error if the API call fails or if a locale variant already exists.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#create-variant

Example

const client = createClient({...});
const newVariant = {
  locale_id: 127,
  active: true,
  default: false,
  content: "Some dynamic content"
};
const createdVariant = await client.dynamiccontentvariants.create(12345, newVariant);

Defined in

clients/core/dynamiccontentvariants.d.ts:50

---

createMany

▸ createMany(itemID, variants): Promise<object>

Creates multiple variants for a dynamic content item.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variants	object[]	Array of variant objects to be created.

Returns

Promise<object>

A confirmation of the creation.

Async

Throws

Throws an error if request fails.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#create-many-variants

Example

const newVariants = await client.dynamiccontentvariants.createMany(1234, [...variantsData]);

Defined in

clients/core/dynamiccontentvariants.d.ts:93

---

delete

▸ delete(itemID, variantID): Promise<object>

Deletes a specific variant of a dynamic content item.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variantID	number	The ID of the variant to delete.

Returns

Promise<object>

A confirmation of the deletion.

Async

Throws

Throws an error if request fails.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#delete-variant

Example

await client.dynamiccontentvariants.delete(1234, 5678);

Overrides

Client.delete

Defined in

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

---

list

▸ list(itemID): Promise<object>

Lists all variants of a specified dynamic content item.

Parameters

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

Returns

Promise<object>

The variants of the specified content item.

Async

Throws

Throws an error if request fails.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#list-variants

Example

const variants = await client.dynamiccontentvariants.list(1234);

Defined in

clients/core/dynamiccontentvariants.d.ts:18

---

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

---

show

▸ show(itemID, variantID): Promise<object>

Fetches the details of a specified dynamic content variant.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variantID	number	The ID of the variant to fetch.

Returns

Promise<object>

Returns the dynamic content variant details.

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#show-variant

Example

const client = createClient({...});
const variant = await client.dynamiccontentvariants.show(12345, 67890);

Defined in

clients/core/dynamiccontentvariants.d.ts:31

---

update

▸ update(itemID, variantID, variant): Promise<object>

Updates a specified dynamic content variant.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variantID	number	The ID of the variant to update.
variant	object	The updated details of the variant.

Returns

Promise<object>

Returns the details of the updated variant.

Async

Throws

Throws an error if the API call fails or if you try to switch the active state of the default variant.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-variant

Example

const client = createClient({...});
const updatedVariant = {
  active: false,
  default: false,
  content: "Updated dynamic content"
};
const variant = await client.dynamiccontentvariants.update(12345, 67890, updatedVariant);

Defined in

clients/core/dynamiccontentvariants.d.ts:69

---

updateMany

▸ updateMany(itemID, variants): Promise<object>

Updates multiple variants of a dynamic content item.

Parameters

Name	Type	Description
itemID	number	The ID of the dynamic content item.
variants	object[]	Array of variant objects to be updated.

Returns

Promise<object>

A confirmation of the update.

Async

Throws

Throws an error if request fails.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-many-variants

Example

const updatedVariants = await client.dynamiccontentvariants.updateMany(1234, [...variantsData]);

Defined in

clients/core/dynamiccontentvariants.d.ts:105