node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/groups / Groups

Class: Groups ​

A client for interfacing with the Zendesk Groups API.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/

Extends ​

Constructors ​

new Groups() ​

new Groups(options): Groups

Parameters ​

• options: any

Returns ​

Groups

Overrides ​

Client.constructor

Defined in ​

clients/core/groups.d.ts:83

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

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

sideLoadMap ​

sideLoadMap: object[]

Defined in ​

clients/core/groups.d.ts:85

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

assignable() ​

assignable(): Promise<object>

Retrieves a list of all assignable groups.

Returns ​

Promise<object>

A promise that resolves to the list of assignable groups.

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#list-assignable-groups

Example ​

ts
const assignableGroups = await client.groups.assignable();

Defined in ​

clients/core/groups.d.ts:134

count() ​

count(): Promise<object>

Retrieves an approximate count of groups. If the count exceeds 100,000, it is updated every 24 hours.

Returns ​

Promise<object>

A promise that resolves to the group count data.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#count-groups

Example ​

ts
const count = await client.groups.count();

Defined in ​

clients/core/groups.d.ts:109

countByUser() ​

countByUser(userID): Promise<object>

Retrieves the approximate count of groups for a specified user.

Parameters ​

• userID: number

The ID of the user for whom to count the groups.

Returns ​

Promise<object>

A promise that resolves to the approximate count of groups for the user.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#count-groups

Example ​

ts
const groupCount = await client.groups.countByUser(12345);

Defined in ​

clients/core/groups.d.ts:122

create() ​

create(group): Promise<object>

Creates a new group.

Parameters ​

• group: CreateOrUpdateGroup

The group details to create.

Returns ​

Promise<object>

A promise that resolves to the details of the created group.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#create-group

Example ​

ts
const newGroup = {
  name: "Support Team",
  description: "Handles support tickets"
};
const createdGroup = await client.groups.create(newGroup);

Defined in ​

clients/core/groups.d.ts:161

delete() ​

delete(groupID): Promise<object>

Deletes a specified group by its ID.

Parameters ​

• groupID: number

The ID of the group to delete.

Returns ​

Promise<object>

A promise that resolves to the response data (might be empty or a confirmation).

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#delete-group

Example ​

ts
await client.groups.delete(12345);

Overrides ​

Client.delete

Defined in ​

clients/core/groups.d.ts:191

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

Retrieves a list of all groups.

Returns ​

Promise<Group[]>

A promise that resolves to the list of groups.

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#list-groups

Example ​

ts
const allGroups = await client.groups.list();

Defined in ​

clients/core/groups.d.ts:99

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

Retrieves details of a specific group by its ID.

Parameters ​

• groupID: number

The ID of the group.

Returns ​

Promise<object>

A promise that resolves to the group's details.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#show-group

Example ​

ts
const groupDetails = await client.groups.show(12345);

Defined in ​

clients/core/groups.d.ts:144

update() ​

update(groupID, group): Promise<object>

Updates a specified group.

Parameters ​

• groupID: number

The ID of the group to update.

• group: CreateOrUpdateGroup

The updated group details.

Returns ​

Promise<object>

A promise that resolves to the details of the updated group.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/groups/groups/#update-group

Example ​

ts
const updatedInfo = {
  name: "Updated Support Team"
};
const updatedGroup = await client.groups.update(12345, updatedInfo);

Defined in ​

clients/core/groups.d.ts:178

Released under the MIT License.

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