node-zendesk / Exports / clients/core/sideconversations

Module: clients/core/sideconversations

Table of contents

Classes

• SideConversations

Type Aliases

• CreateSideConversation
• Message
• Participant
• SideConversation
• SideConversationAttachment
• SideConversationResponse
• UpdateSideConversation

Type Aliases

CreateSideConversation

Ƭ CreateSideConversation: Object

Type declaration

Name	Type	Description
external_ids?	{ [key: string]: string; }	- A key-value object where all values are strings. Used for conversation metadata
message	Message	- The side conversation object.

Defined in

clients/core/sideconversations.d.ts:159

---

Message

Ƭ Message: Object

Type declaration

Name	Type	Description
attachment_ids?	string[]	- List of tokens received from uploading files for comment attachments. The files are attached by creating or updating tickets with the tokens. See Attaching files in Tickets
body?	string	- The plain text version of the body of the message
external_ids?	{ [key: string]: string; }	- A key-value object where all values are strings. Used for message metadata
from?	Participant	- The participant who sent the message. See Participants
html_body?	string	- The HTML version of the body of the message
preview_text?	string	- A plain text string describing the message
subject?	string	- The subject of the message
to	Participant[]	- The list of participants the message was sent to. See Participants

Defined in

clients/core/sideconversations.d.ts:35

---

Participant

Ƭ Participant: Object

Type declaration

Name	Type	Description
email?	string	- The email address of the participant
msteams_channel_id?	string	- If the participant is a Microsoft teams channel, the Teams channel id
name?	string	- The name of the participant
slack_channel_id?	string	- If the participant is a Slack channel, the Slack channel id
slack_workspace_id?	string	- If the participant is a Slack user or channel, the Slack workspace id
support_agent_id?	string	- If the participant is a Support ticket, the support agent id
support_group_id?	string	- If the participant is a Support ticket, the support group id
user_id?	number	- If the participant is an agent, the agent's user id

Defined in

clients/core/sideconversations.d.ts:1

---

SideConversation

Ƭ SideConversation: Object

Type declaration

Name	Type	Description
created_at	string	- The time the side conversation was created
external_ids?	{ [key: string]: string; }	- A key-value store of metadata. All values must be strings
id	string	- Automatically assigned when the side conversation is created
message_added_at	string	- The time of the last message on the side conversation
participants	Participant[]	- An array of participants in the side conversation. See Participants
preview_text	string	- A plain text text describing the side conversation
state?	string	- The state of the side conversation
state_updated_at	string	- The time of the update of the state of the side conversation
subject?	string	- The subject of the side conversation
ticket_id	number	- The parent ticket id of the side conversation
updated_at	string	- The time of the last update of the side conversation
url	string	- The API url of the side conversation

Defined in

clients/core/sideconversations.d.ts:81

---

SideConversationAttachment

Ƭ SideConversationAttachment: Object

Type declaration

Name	Type	Description
content_type	string	- The content type of the attachment. This is read-only.
height	number	- The height of the attachment image. This is read-only.
id	string	- The id of the side conversation attachment. This is read-only.
name	string	- The name of the attachment.
size	number	- The size of the attachment. This is read-only.
width	number	- The width of the attachment image. This is read-only.

Defined in

clients/core/sideconversations.d.ts:133

---

SideConversationResponse

Ƭ SideConversationResponse: Object

Type declaration

Name	Type	Description
side_conversation	SideConversation	- The side conversation object.

Defined in

clients/core/sideconversations.d.ts:171

---

UpdateSideConversation

Ƭ UpdateSideConversation: Object

Type declaration

Name	Type	Description
state?	"open" | "closed"	- A plain text string describing the side conversation
subject?	string	- The subject of the side conversation

Defined in

clients/core/sideconversations.d.ts:71