node-zendesk • Docs

---

node-zendesk / clients/helpcenter/articles / Articles

Class: Articles

Articles are content items such as help topics or tech notes contained in sections

Extends

• Client

Constructors

new Articles()

new Articles(options): Articles

Parameters

• options: any

Returns

Articles

Overrides

Client.constructor

Defined in

clients/helpcenter/articles.d.ts:136

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/articles.d.ts:137

---

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/helpcenter/articles.d.ts:138

---

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

---

associateAttachmentsInBulk()

associateAttachmentsInBulk(articleID, attachmentIDsInBulk): Promise<NodeModule>

Parameters

• articleID: any

• attachmentIDsInBulk: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:215

---

create()

create(sectionID, article): Promise<NodeModule>

Parameters

• sectionID: any

• article: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:211

---

createWithLocale()

createWithLocale(locale, sectionID, article): Promise<NodeModule>

Parameters

• locale: any

• sectionID: any

• article: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:212

---

delete()

delete(articleID): Promise<any>

Deletes a resource.

Parameters

• articleID: any

Returns

Promise<any>

• Either void or response object

Overrides

Client.delete

Defined in

clients/helpcenter/articles.d.ts:216

---

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<Article[]>

List all the articles

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.list();

Defined in

clients/helpcenter/articles.d.ts:150

---

listByCategory()

listByCategory(categoryID): Promise<Article[]>

List articles by category ID

Parameters

• categoryID: number

The category ID to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listByCategory(123456789);

Defined in

clients/helpcenter/articles.d.ts:187

---

listByCategoryByLocale()

listByCategoryByLocale(locale, categoryID): Promise<Article[]>

List articles by category ID and locale

Parameters

• locale: string

The locale to filter articles by

• categoryID: number

The category ID to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listByCategoryByLocale('en-us', 123456789);

Defined in

clients/helpcenter/articles.d.ts:197

---

listByLabelNames()

listByLabelNames(labelNames): Promise<any[]>

Parameters

• labelNames: any

Returns

Promise<any[]>

Defined in

clients/helpcenter/articles.d.ts:208

---

listByLocale()

listByLocale(locale): Promise<Article[]>

List articles by locale

Parameters

• locale: string

The locale to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listByLocale('en-us');

Defined in

clients/helpcenter/articles.d.ts:159

---

listBySection()

listBySection(sectionID): Promise<Article[]>

List articles by section ID

Parameters

• sectionID: number

The section ID to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listBySection(123456789);

Defined in

clients/helpcenter/articles.d.ts:168

---

listBySectionByLocale()

listBySectionByLocale(locale, sectionID): Promise<Article[]>

List articles by section ID and locale

Parameters

• locale: string

The locale to filter articles by

• sectionID: number

The section ID to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listBySectionByLocale('en-us', 123456789);

Defined in

clients/helpcenter/articles.d.ts:178

---

listByUser()

listByUser(userID): Promise<Article[]>

List articles by user ID

Parameters

• userID: number

The user ID to filter articles by

Returns

Promise<Article[]>

An array of articles

See

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

Example

const articles = await client.helpcenter.articles.listByUser(123456789);

Defined in

clients/helpcenter/articles.d.ts:206

---

listSinceStartTime()

listSinceStartTime(startTime): Promise<any[]>

Parameters

• startTime: any

Returns

Promise<any[]>

Defined in

clients/helpcenter/articles.d.ts:207

---

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(articleID): Promise<NodeModule>

Parameters

• articleID: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:209

---

showWithLocale()

showWithLocale(locale, articleID): Promise<NodeModule>

Parameters

• locale: any

• articleID: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:210

---

update()

update(articleID, article): Promise<NodeModule>

Parameters

• articleID: any

• article: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:213

---

updateWithLocale()

updateWithLocale(locale, articleID, article): Promise<NodeModule>

Parameters

• locale: any

• articleID: any

• article: any

Returns

Promise<NodeModule>

Defined in

clients/helpcenter/articles.d.ts:214