node-zendesk / Exports / clients/core/sideconversations / SideConversations

Class: SideConversations

clients/core/sideconversations.SideConversations

Hierarchy

• Client

  ↳ SideConversations

Table of contents

Constructors

• constructor

Properties

• _transporter
• eventTarget
• jsonAPINames
• options
• sideLoad
• useDotJson

Accessors

• transporter

Methods

• _rawRequest
• attachments
• create
• delete
• emit
• get
• getAll
• list
• on
• patch
• post
• put
• reply
• request
• requestAll
• requestUpload
• setSideLoad
• show
• update

Constructors

constructor

• new SideConversations(options): SideConversations

Parameters

Name	Type	Description
options	ClientOptions	The client options.

Returns

SideConversations

Constructs

SideConversations

Overrides

Client.constructor

Defined in

clients/core/sideconversations.d.ts:242

Properties

_transporter

• _transporter: Transporter

Inherited from

Client._transporter

Defined in

clients/client.d.ts:94

---

eventTarget

• eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from

Client.eventTarget

Defined in

clients/client.d.ts:92

---

jsonAPINames

• jsonAPINames: string[]

Array to hold names used in the JSON API.

Overrides

Client.jsonAPINames

Defined in

clients/core/sideconversations.d.ts:243

---

options

• options: ClientOptions & { get: (key: string) => any }

Configuration options for the client.

Inherited from

Client.options

Defined in

clients/client.d.ts:86

---

sideLoad

• sideLoad: any[]

Array to handle side-loaded resources.

Inherited from

Client.sideLoad

Defined in

clients/client.d.ts:89

---

useDotJson

• useDotJson: boolean

Flag to indicate if the API endpoint should use '.json' ending.

Inherited from

Client.useDotJson

Defined in

clients/client.d.ts:91

Accessors

transporter

• get transporter(): Transporter

Transporter for making requests.

Returns

Transporter

Inherited from

Client.transporter

Defined in

clients/client.d.ts:93

Methods

_rawRequest

▸ _rawRequest(method, uri, ...args): Promise<{ response: any ; result: {} }>

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<{ response: any ; result: {} }>

Inherited from

Client._rawRequest

Defined in

clients/client.d.ts:130

---

attachments

▸ attachments(file, options): Promise<SideConversationAttachment>

Upload a file to be attached to a ticket comment.

Parameters

Name	Type	Description
file	ArrayBuffer	The file data.
options	Object	The file options.
options.filename	string	The name of the file.

Returns

Promise<SideConversationAttachment>

The attachment details.

Defined in

clients/core/sideconversations.d.ts:321

---

create

▸ create(ticketId, message): Promise<{ result: SideConversationResponse }>

Create a Side Conversation.

Parameters

Name	Type	Description
ticketId	number	The ID of the ticket.
message	CreateSideConversation	The side conversation object.

Returns

Promise<{ result: SideConversationResponse }>

The created ticket details.

Async

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:253

---

delete

▸ delete(...args): Promise<void | object>

Deletes a resource.

Parameters

Name	Type	Description
...args	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:128

---

emit

▸ emit(eventType, eventData): void

Parameters

Name	Type
eventType	any
eventData	any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:95

---

get

▸ get(resource): Promise<NodeModule>

Parameters

Name	Type
resource	any

Returns

Promise<NodeModule>

Inherited from

Client.get

Defined in

clients/client.d.ts:114

---

getAll

▸ getAll(resource): Promise<any[]>

Parameters

Name	Type
resource	any

Returns

Promise<any[]>

Inherited from

Client.getAll

Defined in

clients/client.d.ts:129

---

list

▸ list(ticketID): Promise<{ result: { side_conversations: SideConversation[] }[] }>

List all the Side Conversations tickets.

Parameters

Name	Type	Description
ticketID	number	the Id of the ticket.

Returns

Promise<{ result: { side_conversations: SideConversation[] }[] }>

An array of tickets.

Async

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:295

---

on

▸ on(eventType, callback): void

Parameters

Name	Type
eventType	any
callback	any

Returns

void

Inherited from

Client.on

Defined in

clients/client.d.ts:96

---

patch

▸ patch(...args): Promise<void | object>

Patches a resource.

Parameters

Name	Type	Description
...args	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:120

---

post

▸ post(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.post

Defined in

clients/client.d.ts:122

---

put

▸ put(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.put

Defined in

clients/client.d.ts:121

---

reply

▸ reply(ticketId, sideConversationId, message): Promise<{ result: SideConversationResponse }>

Reply to a Side Conversation.

Parameters

Name	Type	Description
ticketId	number	The ID of the ticket.
sideConversationId	string	The ID of the side conversation.
message	Object	The reply object.
message.message	Message	-

Returns

Promise<{ result: SideConversationResponse }>

The created ticket details.

Async

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:266

---

request

▸ request<T>(method, uri, ...args): Promise<NodeModule>

Request method that handles various HTTP methods.

Type parameters

Name
T

Parameters

Name	Type	Description
method	string	HTTP method (e.g., 'GET', 'POST').
uri	string	The URI for the request.
...args	any[]	Additional arguments for the request.

Returns

Promise<NodeModule>

• The API response.

Inherited from

Client.request

Defined in

clients/client.d.ts:148

---

requestAll

▸ requestAll(method, uri, ...args): Promise<any[]>

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<any[]>

Inherited from

Client.requestAll

Defined in

clients/client.d.ts:149

---

requestUpload

▸ requestUpload(uri, file): Promise<any>

Parameters

Name	Type
uri	any
file	any

Returns

Promise<any>

Inherited from

Client.requestUpload

Defined in

clients/client.d.ts:150

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113

---

show

▸ show(ticketId, sideConversationId): Promise<{ result: SideConversation }>

Retrieve a specific ticket by its ID.

Parameters

Name	Type	Description
ticketId	number	The ID of the ticket.
sideConversationId	string	The ID of the side conversation.

Returns

Promise<{ result: SideConversation }>

Details of the side conversation.

Async

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:311

---

update

▸ update(ticketId, sideConversationId, update): Promise<{ result: SideConversationResponse }>

Update to a Side Conversation.

Parameters

Name	Type	Description
ticketId	number	The ID of the ticket.
sideConversationId	string	The ID of the side conversation.
update	Object	The update object.
update.side_conversation	Partial<UpdateSideConversation>	-

Returns

Promise<{ result: SideConversationResponse }>

The updated ticket details.

Async

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:281