node-zendesk • Docs

---

node-zendesk / clients/core/attachments / Attachments

Class: Attachments

Represents the Attachments functionality of the Zendesk API.

See

[Zendesk Attachments API]https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/

Extends

• Client

Constructors

new Attachments()

new Attachments(options, apiType): Attachments

Parameters

• options: ZendeskClientOptions

Configuration options for the client.

• apiType: string

Type of Zendesk API to initialize (e.g., 'core', 'helpcenter').

Returns

Attachments

Inherited from

Client.constructor

Defined in

clients/client.d.ts:33

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: any[]

Array to hold names used in the JSON API.

Inherited from

Client.jsonAPINames

Defined in

clients/client.d.ts:38

---

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

---

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

---

deleteUpload()

deleteUpload(token): Promise<object>

Delete an uploaded file.

Parameters

• token: string

The token of the uploaded attachment.

Returns

Promise<object>

Returns the server's response.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#delete-upload

Example

const response = await client.attachments.deleteUpload("exampleToken");

Defined in

clients/core/attachments.d.ts:31

---

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

---

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

---

redactAttachmentComment()

redactAttachmentComment(ticketID, commentID, attachmentID): Promise<object>

Redact an attachment from an existing comment on a ticket.

Parameters

• ticketID: number

The ID of the ticket.

• commentID: number

The ID of the comment.

• attachmentID: number

The ID of the attachment.

Returns

Promise<object>

Returns the server's response.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#redact-comment-attachment

Example

const response = await client.attachments.redactAttachmentComment(1, 2, 3);

Defined in

clients/core/attachments.d.ts:54

---

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

Retrieve details of a specific attachment.

Parameters

• attachmentID: number

The ID of the attachment.

Returns

Promise<object>

Returns the details of the attachment.

response

response: object

result

result: object

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#show-attachment

Example

const attachmentDetails = await client.attachments.show(12345);

Defined in

clients/core/attachments.d.ts:40

---

updateAttachmentForMalware()

updateAttachmentForMalware(attachmentID, malwareAccessOverride): Promise<object>

Toggles enabling or restricting agent access to attachments with detected malware.

Parameters

• attachmentID: number

The ID of the attachment.

• malwareAccessOverride: boolean

Whether to override malware access. If true, agent can access attachment flagged as malware.

Returns

Promise<object>

The response from the Zendesk API.

response

response: object

result

result: object

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#update-attachment-for-malware

Example

const result = await client.attachments.updateAttachmentForMalware(928374, true);
console.log(result);

Defined in

clients/core/attachments.d.ts:66

---

upload()

upload(file, fileOptions): Promise<object>

Upload a file to be attached to a ticket comment.

Parameters

• file: Buffer

The file data.

• fileOptions

Options for the file.

• fileOptions.binary: boolean

If the file is binary or not.

• fileOptions.filename: string

Name of the file when attached to the ticket comment.

• fileOptions.token?: string

Token received from previous uploads (if multiple files are being attached).

Returns

Promise<object>

Returns the server's response.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#upload-files

Example

const response = await client.attachments.upload(fileBuffer, { filename: "example.png", binary: true });

Defined in

clients/core/attachments.d.ts:18