node-zendesk / Exports / clients/core/permissiongroups / PermissionGroups

Class: PermissionGroups

clients/core/permissiongroups.PermissionGroups

Client for the Zendesk Permission Groups API.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/

Hierarchy

• Client

  ↳ PermissionGroups

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 PermissionGroups(options): PermissionGroups

Parameters

Name	Type
options	any

Returns

PermissionGroups

Overrides

Client.constructor

Defined in

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

Create a new permission group.

Parameters

Name	Type	Description
group	Object	The permission group details.
group.edit?	number[]	Array of user segments that have edit privileges.
group.name	string	Name of the permission group.
group.publish?	number[]	Array of user segments that have publish privileges.

Returns

Promise<object>

Newly created permission group object.

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#create-permission-group

Example

const newGroup = await client.permissiongroups.create({
  name: "Printer Experts",
  edit: [12],
  publish: [34]
});

Defined in

clients/core/permissiongroups.d.ts:46

---

delete

▸ delete(groupID): Promise<void>

Delete a permission group.

Parameters

Name	Type	Description
groupID	number	The ID of the permission group.

Returns

Promise<void>

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#delete-permission-group

Example

await client.permissiongroups.delete(42);

Overrides

Client.delete

Defined in

clients/core/permissiongroups.d.ts:82

---

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 permission groups.

Returns

Promise<object[]>

Array of permission group objects.

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#list-permission-groups

Example

const groups = await client.permissiongroups.list();

Defined in

clients/core/permissiongroups.d.ts:17

---

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

Retrieve details of a specific permission group.

Parameters

Name	Type	Description
groupID	number	The ID of the permission group.

Returns

Promise<object>

Permission group object.

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#show-permission-group

Example

const group = await client.permissiongroups.show(42);

Defined in

clients/core/permissiongroups.d.ts:28

---

update

▸ update(groupID, group): Promise<object>

Update an existing permission group.

Parameters

Name	Type	Description
groupID	number	The ID of the permission group.
group	Object	The permission group details to update.
group.edit?	number[]	Array of user segments that have edit privileges.
group.name?	string	Name of the permission group.
group.publish?	number[]	Array of user segments that have publish privileges.

Returns

Promise<object>

Updated permission group object.

Async

Throws

Throws an error if the API call fails.

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#update-permission-group

Example

const updatedGroup = await client.permissiongroups.update(42, {
  name: "Super Printer Experts"
});

Defined in

clients/core/permissiongroups.d.ts:67