node-zendesk • Docs
node-zendesk / clients/core/customagentroles / CustomAgentRoles
Class: CustomAgentRoles
Client for Zendesk's Custom Agent Roles API.
See
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
Extends
Constructors
new CustomAgentRoles()
new CustomAgentRoles(
options):CustomAgentRoles
Parameters
• options: any
Returns
Overrides
Defined in
clients/core/customagentroles.d.ts:6
Properties
_transporter
_transporter:
Transporter
Inherited from
Defined in
clients/client.d.ts:42
eventTarget
eventTarget:
CustomEventTarget
Event target to handle custom events.
Inherited from
Defined in
clients/client.d.ts:40
jsonAPINames
jsonAPINames:
string[]
Array to hold names used in the JSON API.
Overrides
Defined in
clients/core/customagentroles.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
Defined in
clients/client.d.ts:34
sideLoad
sideLoad:
any[]
Array to handle side-loaded resources.
Inherited from
Defined in
clients/client.d.ts:37
useDotJson
useDotJson:
boolean
Flag to indicate if the API endpoint should use '.json' ending.
Inherited from
Defined in
clients/client.d.ts:39
Accessors
transporter
Get Signature
get transporter():
Transporter
Returns
Transporter for making requests.
Inherited from
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
Defined in
clients/client.d.ts:78
create()
create(
roleData):Promise<object>
Creates a new custom agent role.
Parameters
• roleData: object
The data for the new custom agent role.
Returns
Promise<object>
The created custom agent role.
response
response:
object
result
result:
object
Throws
Will throw an error if creation fails.
See
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:45
delete()
delete(
roleId):Promise<void>
Delete a specific Custom Agent Role by its ID.
Parameters
• roleId: number
The ID of the custom agent role to delete.
Returns
Promise<void>
Returns a promise that resolves when the role is deleted.
Throws
Will throw an error if unable to delete the role.
See
Example
const client = createClient({...});
await client.customagentroles.delete(12345);Overrides
Defined in
clients/core/customagentroles.d.ts:74
emit()
emit(
eventType,eventData):void
Parameters
• eventType: any
• eventData: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:43
get()
get(
resource):Promise<NodeModule>
Parameters
• resource: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:62
getAll()
getAll(
resource):Promise<any[]>
Parameters
• resource: any
Returns
Promise<any[]>
Inherited from
Defined in
clients/client.d.ts:77
list()
list():
Promise<object[]>
List all Custom Agent Roles.
Returns
Promise<object[]>
Returns a promise that resolves with the list of custom agent roles.
See
Example
const client = createClient({...});
const roles = await client.customagentroles.list();Defined in
clients/core/customagentroles.d.ts:16
on()
on(
eventType,callback):void
Parameters
• eventType: any
• callback: any
Returns
void
Inherited from
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
Defined in
clients/client.d.ts:68
post()
post(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:70
put()
put(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
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
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
Defined in
clients/client.d.ts:97
requestUpload()
requestUpload(
uri,file):Promise<any>
Parameters
• uri: any
• file: any
Returns
Promise<any>
Inherited from
Defined in
clients/client.d.ts:98
setSideLoad()
setSideLoad(
array):void
Parameters
• array: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:61
show()
show(
roleId):Promise<object>
Retrieve a specific Custom Agent Role by its ID.
Parameters
• 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.
response
response:
object
result
result:
object
Throws
Will throw an error if unable to retrieve the role.
See
Example
const client = createClient({...});
const role = await client.customagentroles.show(12345);Defined in
clients/core/customagentroles.d.ts:27
update()
update(
customRoleId,updatedData):Promise<object>
Updates an existing custom agent role.
Parameters
• 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.
response
response:
object
result
result:
object
Throws
Will throw an error if the update fails or custom agent role ID is not found.
See
Example
const updatedData = { name: "Updated Role", description: "Updated Description" };
const updatedRole = await client.customagentroles.update(12345, updatedData);Defined in
clients/core/customagentroles.d.ts:60