node-zendesk • Docs

---

node-zendesk / clients/helpcenter/subscriptions / Subscriptions

Class: Subscriptions

Represents a client to interact with the Zendesk API, providing functionalities to make various types of requests. This client handles request construction, response processing, event emission, and more.

Extends

• Client

Constructors

new Subscriptions()

new Subscriptions(options): Subscriptions

Parameters

• options: any

Returns

Subscriptions

Overrides

Client.constructor

Defined in

clients/helpcenter/subscriptions.d.ts:2

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/helpcenter/subscriptions.d.ts:3

---

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

---

createbyArticle()

createbyArticle(articleID, subscription): Promise<NodeModule>

Parameters

• articleID: any

• subscription: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/subscriptions.d.ts:9

---

createbySection()

createbySection(sectionID, subscription): Promise<NodeModule>

Parameters

• sectionID: any

• subscription: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/subscriptions.d.ts:10

---

delete()

delete(...arguments_): Promise<void | object>

Deletes a resource.

Parameters

• ...arguments_: any[]

The resources or parts of the resource path.

Returns

Promise<void | object>

• Either void or response object

Inherited from

Client.delete

Defined in

clients/client.d.ts:76

---

deletebyArticle()

deletebyArticle(articleID, subscriptionID): Promise<any>

Parameters

• articleID: any

• subscriptionID: any

Returns

Promise<any>

Defined in

clients/helpcenter/subscriptions.d.ts:11

---

deletebySection()

deletebySection(sectionID, subscriptionID): Promise<any>

Parameters

• sectionID: any

• subscriptionID: any

Returns

Promise<any>

Defined in

clients/helpcenter/subscriptions.d.ts:12

---

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

---

listByArticle()

listByArticle(articleID): Promise<any[]>

Parameters

• articleID: any

Returns

Promise<any[]>

Defined in

clients/helpcenter/subscriptions.d.ts:5

---

listBySection()

listBySection(sectionID): Promise<any[]>

Parameters

• sectionID: any

Returns

Promise<any[]>

Defined in

clients/helpcenter/subscriptions.d.ts:6

---

listByUser()

listByUser(userID): Promise<any[]>

Parameters

• userID: any

Returns

Promise<any[]>

Defined in

clients/helpcenter/subscriptions.d.ts:4

---

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

---

showbyArticle()

showbyArticle(articleID, subscriptionID): Promise<NodeModule>

Parameters

• articleID: any

• subscriptionID: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/subscriptions.d.ts:7

---

showbySection()

showbySection(sectionID, subscriptionID): Promise<NodeModule>

Parameters

• sectionID: any

• subscriptionID: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/subscriptions.d.ts:8