node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/dynamiccontentvariants / DynamicContentVariants

Class: DynamicContentVariants ​

Dynamic Content Variants client for the Zendesk REST API.

See ​

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

Extends ​

Constructors ​

new DynamicContentVariants() ​

new DynamicContentVariants(options): DynamicContentVariants

Parameters ​

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

create() ​

create(itemID, variant): Promise<object>

Creates a new dynamic content variant.

Parameters ​

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

response ​

response: object

result ​

result: object

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 ​

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

createMany() ​

createMany(itemID, variants): Promise<object>

Creates multiple variants for a dynamic content item.

Parameters ​

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

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/dynamiccontentvariants.d.ts:99

delete() ​

delete(itemID, variantID): Promise<object>

Deletes a specific variant of a dynamic content item.

Parameters ​

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

Throws ​

Throws an error if request fails.

See ​

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

Example ​

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

Overrides ​

Client.delete

Defined in ​

clients/core/dynamiccontentvariants.d.ts:88

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(itemID): Promise<object>

Lists all variants of a specified dynamic content item.

Parameters ​

• itemID: number

The ID of the dynamic content item.

Returns ​

Promise<object>

The variants of the specified content item.

response ​

response: object

result ​

result: object[]

Throws ​

Throws an error if request fails.

See ​

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

Example ​

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

Defined in ​

clients/core/dynamiccontentvariants.d.ts:17

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

show() ​

show(itemID, variantID): Promise<object>

Fetches the details of a specified dynamic content variant.

Parameters ​

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

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/dynamiccontentvariants.d.ts:32

update() ​

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

Updates a specified dynamic content variant.

Parameters ​

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

response ​

response: object

result ​

result: object

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 ​

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

updateMany() ​

updateMany(itemID, variants): Promise<object>

Updates multiple variants of a dynamic content item.

Parameters ​

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

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/dynamiccontentvariants.d.ts:113

Released under the MIT License.

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