node-zendesk • Docs

---

node-zendesk / clients/core/sideconversations / SideConversations

Class: SideConversations

Extends

• Client

Constructors

new SideConversations()

new SideConversations(options): SideConversations

Parameters

• options: ZendeskClientOptions

The client options.

Returns

SideConversations

Overrides

Client.constructor

Defined in

clients/core/sideconversations.d.ts:241

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/sideconversations.d.ts:242

---

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

---

attachments()

attachments(file, options): Promise<SideConversationAttachment>

Upload a file to be attached to a ticket comment.

Parameters

• file: ArrayBuffer

The file data.

• options

The file options.

• options.filename: string

The name of the file.

Returns

Promise<SideConversationAttachment>

The attachment details.

Defined in

clients/core/sideconversations.d.ts:315

---

create()

create(ticketId, message): Promise<object>

Create a Side Conversation.

Parameters

• ticketId: number

The ID of the ticket.

• message: CreateSideConversation

The side conversation object.

Returns

Promise<object>

The created ticket details.

response

response: object

result

result: SideConversationResponse

Throws

If the details are not provided or invalid.

See

https://developer.zendesk.com/api-reference/ticketing/side_conversation/side_conversation/#create-side-conversation

Defined in

clients/core/sideconversations.d.ts:251

---

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

---

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

List all the Side Conversations tickets.

Parameters

• ticketID: number

the Id of the ticket.

Returns

Promise<SideConversation[]>

An array of side conversation objects.

See

https://developer.zendesk.com/api-reference/ticketing/side_conversation/side_conversation/#list-side-conversations

Example

const tickets = await client.sideconversations.list(123);

Defined in

clients/core/sideconversations.d.ts:293

---

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

---

reply()

reply(ticketId, sideConversationId, message): Promise<object>

Reply to a Side Conversation.

Parameters

• ticketId: number

The ID of the ticket.

• sideConversationId: string

The ID of the side conversation.

• message

The reply object.

• message.message: Message

Returns

Promise<object>

The created ticket details.

response

response: object

result

result: SideConversationResponse

Throws

If the details are not provided or invalid.

See

https://developer.zendesk.com/api-reference/ticketing/side_conversation/side_conversation/#reply-to-side-conversation

Defined in

clients/core/sideconversations.d.ts:264

---

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(ticketId, sideConversationId): Promise<object>

Retrieve a specific ticket by its ID.

Parameters

• ticketId: number

The ID of the ticket.

• sideConversationId: string

The ID of the side conversation.

Returns

Promise<object>

Details of the side conversation.

response

response: object

result

result: SideConversation

Throws

If the ticket ID is not provided or invalid.

See

https://developer.zendesk.com/api-reference/ticketing/side_conversation/side_conversation/#show-side-conversation

Example

const ticket = await client.sideconversations.show(12345, 12333);

Defined in

clients/core/sideconversations.d.ts:304

---

update()

update(ticketId, sideConversationId, update): Promise<object>

Update to a Side Conversation.

Parameters

• ticketId: number

The ID of the ticket.

• sideConversationId: string

The ID of the side conversation.

• update

The update object.

• update.side_conversation: Partial<UpdateSideConversation>

Returns

Promise<object>

The updated ticket details.

response

response: object

result

result: SideConversationResponse

Throws

If the details are not provided or invalid.

See

https://developer.zendesk.com/api-reference/ticketing/side_conversation/side_conversation/#update-side-conversation

Defined in

clients/core/sideconversations.d.ts:279