node-zendesk / Exports / clients/core/customagentroles / CustomAgentRoles

Class: CustomAgentRoles

clients/core/customagentroles.CustomAgentRoles

Classdesc

Client for Zendesk's Custom Agent Roles API.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/

Hierarchy

• Client

  ↳ CustomAgentRoles

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

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

Constructors

constructor

• new CustomAgentRoles(options): CustomAgentRoles

Parameters

Name	Type
options	any

Returns

CustomAgentRoles

Overrides

Client.constructor

Defined in

clients/core/customagentroles.d.ts:7

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

---

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

Creates a new custom agent role.

Parameters

Name	Type	Description
roleData	object	The data for the new custom agent role.

Returns

Promise<object>

The created custom agent role.

Async

Throws

Will throw an error if creation fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#create-custom-role

Example

const newRole = {
  name: "Sample Role",
  description: "Description here",
  configuration: { chat_access: true }
};
const role = await client.customagentroles.create(newRole);

Defined in

clients/core/customagentroles.d.ts:46

---

delete

▸ delete(roleId): Promise<void>

Delete a specific Custom Agent Role by its ID.

Parameters

Name	Type	Description
roleId	number	The ID of the custom agent role to delete.

Returns

Promise<void>

Returns a promise that resolves when the role is deleted.

Async

Throws

Will throw an error if unable to delete the role.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#delete-custom-role

Example

const client = createClient({...});
await client.customagentroles.delete(12345);

Overrides

Client.delete

Defined in

clients/core/customagentroles.d.ts:71

---

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

List all Custom Agent Roles.

Returns

Promise<object[]>

Returns a promise that resolves with the list of custom agent roles.

Async

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#list-custom-roles

Example

const client = createClient({...});
const roles = await client.customagentroles.list();

Defined in

clients/core/customagentroles.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(roleId): Promise<object>

Retrieve a specific Custom Agent Role by its ID.

Parameters

Name	Type	Description
roleId	number	The ID of the custom agent role to retrieve.

Returns

Promise<object>

Returns a promise that resolves with the specified custom agent role.

Async

Throws

Will throw an error if unable to retrieve the role.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#show-custom-role

Example

const client = createClient({...});
const role = await client.customagentroles.show(12345);

Defined in

clients/core/customagentroles.d.ts:30

---

update

▸ update(customRoleId, updatedData): Promise<object>

Updates an existing custom agent role.

Parameters

Name	Type	Description
customRoleId	number	The ID of the custom agent role to update.
updatedData	object	The updated data for the custom agent role.

Returns

Promise<object>

The updated custom agent role.

Async

Throws

Will throw an error if the update fails or custom agent role ID is not found.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#update-custom-role

Example

const updatedData = { name: "Updated Role", description: "Updated Description" };
const updatedRole = await client.customagentroles.update(12345, updatedData);

Defined in

clients/core/customagentroles.d.ts:59