@wildix/stream-client 0.0.1 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/StreamService.js +98 -6
- package/dist-cjs/commands/AddChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/AddChannelMembersCommand.js +21 -0
- package/dist-cjs/commands/AssignChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateGroupChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateKiteChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateSectionCommand.js +21 -0
- package/dist-cjs/commands/DeleteChannelCommand.js +21 -0
- package/dist-cjs/commands/DeleteChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/DeleteMessageReactionCommand.js +21 -0
- package/dist-cjs/commands/DeleteSectionCommand.js +21 -0
- package/dist-cjs/commands/GetChannelCommand.js +21 -0
- package/dist-cjs/commands/GetChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/GetDirectChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetFilePresignedDownloadUrlCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateDirectChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateSmsChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateTelephonyChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateWhatsAppChannelCommand.js +21 -0
- package/dist-cjs/commands/GetSmsChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetTelephonyChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetTokenCommand.js +21 -0
- package/dist-cjs/commands/GetUploadedFileInfoCommand.js +21 -0
- package/dist-cjs/commands/GetWhatsAppChannelIdCommand.js +21 -0
- package/dist-cjs/commands/{AddReactionCommand.js → HideChannelCommand.js} +7 -7
- package/dist-cjs/commands/{EditMessageCommand.js → JoinChannelCommand.js} +7 -7
- package/dist-cjs/commands/LeaveChannelCommand.js +21 -0
- package/dist-cjs/commands/ListChannelMembersCommand.js +21 -0
- package/dist-cjs/commands/ListChannelMembersReadStatusCommand.js +21 -0
- package/dist-cjs/commands/MarkReadCommand.js +21 -0
- package/dist-cjs/commands/MarkUnreadCommand.js +21 -0
- package/dist-cjs/commands/MoveChannelToSectionCommand.js +21 -0
- package/dist-cjs/commands/MuteChannelCommand.js +21 -0
- package/dist-cjs/commands/PartialUpdateChannelCommand.js +21 -0
- package/dist-cjs/commands/PartialUpdateMessageCommand.js +21 -0
- package/dist-cjs/commands/PinChannelCommand.js +21 -0
- package/dist-cjs/commands/QueryChannelsCommand.js +21 -0
- package/dist-cjs/commands/RemoveChannelFromSectionCommand.js +21 -0
- package/dist-cjs/commands/RenameSectionCommand.js +21 -0
- package/dist-cjs/commands/SendGiphyCommand.js +21 -0
- package/dist-cjs/commands/SendMessageReactionCommand.js +21 -0
- package/dist-cjs/commands/SendSystemMessageCommand.js +21 -0
- package/dist-cjs/commands/SendTypingStartCommand.js +21 -0
- package/dist-cjs/commands/{RemoveReactionCommand.js → SendTypingStopCommand.js} +7 -7
- package/dist-cjs/commands/ShowChannelCommand.js +21 -0
- package/dist-cjs/commands/UnmuteChannelCommand.js +21 -0
- package/dist-cjs/commands/UnpinChannelCommand.js +21 -0
- package/dist-cjs/commands/UpdateChannelCommand.js +21 -0
- package/dist-cjs/commands/UpdateMessageCommand.js +21 -0
- package/dist-cjs/commands/UploadFileCommand.js +21 -0
- package/dist-cjs/commands/index.js +49 -3
- package/dist-cjs/models/models_0.js +293 -26
- package/dist-cjs/protocols/Aws_restJson1.js +1955 -131
- package/dist-es/StreamService.js +98 -6
- package/dist-es/commands/AddChannelMemberCommand.js +17 -0
- package/dist-es/commands/AddChannelMembersCommand.js +17 -0
- package/dist-es/commands/AssignChannelCommand.js +17 -0
- package/dist-es/commands/CreateGroupChannelCommand.js +17 -0
- package/dist-es/commands/CreateKiteChannelCommand.js +17 -0
- package/dist-es/commands/CreateSectionCommand.js +17 -0
- package/dist-es/commands/DeleteChannelCommand.js +17 -0
- package/dist-es/commands/DeleteChannelMemberCommand.js +17 -0
- package/dist-es/commands/DeleteMessageReactionCommand.js +17 -0
- package/dist-es/commands/DeleteSectionCommand.js +17 -0
- package/dist-es/commands/GetChannelCommand.js +17 -0
- package/dist-es/commands/GetChannelMemberCommand.js +17 -0
- package/dist-es/commands/GetDirectChannelIdCommand.js +17 -0
- package/dist-es/commands/GetFilePresignedDownloadUrlCommand.js +17 -0
- package/dist-es/commands/GetOrCreateDirectChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateSmsChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateTelephonyChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateWhatsAppChannelCommand.js +17 -0
- package/dist-es/commands/GetSmsChannelIdCommand.js +17 -0
- package/dist-es/commands/GetTelephonyChannelIdCommand.js +17 -0
- package/dist-es/commands/GetTokenCommand.js +17 -0
- package/dist-es/commands/GetUploadedFileInfoCommand.js +17 -0
- package/dist-es/commands/GetWhatsAppChannelIdCommand.js +17 -0
- package/dist-es/commands/{EditMessageCommand.js → HideChannelCommand.js} +6 -6
- package/dist-es/commands/{AddReactionCommand.js → JoinChannelCommand.js} +6 -6
- package/dist-es/commands/LeaveChannelCommand.js +17 -0
- package/dist-es/commands/ListChannelMembersCommand.js +17 -0
- package/dist-es/commands/ListChannelMembersReadStatusCommand.js +17 -0
- package/dist-es/commands/MarkReadCommand.js +17 -0
- package/dist-es/commands/MarkUnreadCommand.js +17 -0
- package/dist-es/commands/MoveChannelToSectionCommand.js +17 -0
- package/dist-es/commands/MuteChannelCommand.js +17 -0
- package/dist-es/commands/PartialUpdateChannelCommand.js +17 -0
- package/dist-es/commands/PartialUpdateMessageCommand.js +17 -0
- package/dist-es/commands/PinChannelCommand.js +17 -0
- package/dist-es/commands/QueryChannelsCommand.js +17 -0
- package/dist-es/commands/RemoveChannelFromSectionCommand.js +17 -0
- package/dist-es/commands/RenameSectionCommand.js +17 -0
- package/dist-es/commands/SendGiphyCommand.js +17 -0
- package/dist-es/commands/SendMessageReactionCommand.js +17 -0
- package/dist-es/commands/SendSystemMessageCommand.js +17 -0
- package/dist-es/commands/SendTypingStartCommand.js +17 -0
- package/dist-es/commands/{RemoveReactionCommand.js → SendTypingStopCommand.js} +6 -6
- package/dist-es/commands/ShowChannelCommand.js +17 -0
- package/dist-es/commands/UnmuteChannelCommand.js +17 -0
- package/dist-es/commands/UnpinChannelCommand.js +17 -0
- package/dist-es/commands/UpdateChannelCommand.js +17 -0
- package/dist-es/commands/UpdateMessageCommand.js +17 -0
- package/dist-es/commands/UploadFileCommand.js +17 -0
- package/dist-es/commands/index.js +49 -3
- package/dist-es/models/models_0.js +281 -23
- package/dist-es/protocols/Aws_restJson1.js +1843 -113
- package/dist-types/StreamService.d.ts +341 -15
- package/dist-types/StreamServiceClient.d.ts +51 -5
- package/dist-types/commands/AddChannelMemberCommand.d.ts +101 -0
- package/dist-types/commands/AddChannelMembersCommand.d.ts +108 -0
- package/dist-types/commands/AssignChannelCommand.d.ts +96 -0
- package/dist-types/commands/CreateGroupChannelCommand.d.ts +201 -0
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +291 -0
- package/dist-types/commands/CreateSectionCommand.d.ts +96 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +82 -0
- package/dist-types/commands/DeleteChannelMemberCommand.d.ts +88 -0
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageReactionCommand.d.ts +193 -0
- package/dist-types/commands/DeleteSectionCommand.d.ts +84 -0
- package/dist-types/commands/GetChannelCommand.d.ts +150 -0
- package/dist-types/commands/GetChannelMemberCommand.d.ts +93 -0
- package/dist-types/commands/GetDirectChannelIdCommand.d.ts +90 -0
- package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +94 -0
- package/dist-types/commands/GetInboxCommand.d.ts +53 -6
- package/dist-types/commands/GetMessageCommand.d.ts +57 -1
- package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +154 -0
- package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +150 -0
- package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetSmsChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/GetTelephonyChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/GetTokenCommand.d.ts +85 -0
- package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +98 -0
- package/dist-types/commands/GetWhatsAppChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/HideChannelCommand.d.ts +84 -0
- package/dist-types/commands/JoinChannelCommand.d.ts +151 -0
- package/dist-types/commands/LeaveChannelCommand.d.ts +85 -0
- package/dist-types/commands/ListChannelMembersCommand.d.ts +94 -0
- package/dist-types/commands/ListChannelMembersReadStatusCommand.d.ts +92 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +53 -6
- package/dist-types/commands/ListMentionsCommand.d.ts +58 -2
- package/dist-types/commands/ListMessagesCommand.d.ts +57 -1
- package/dist-types/commands/MarkReadCommand.d.ts +99 -0
- package/dist-types/commands/MarkUnreadCommand.d.ts +103 -0
- package/dist-types/commands/MoveChannelToSectionCommand.d.ts +101 -0
- package/dist-types/commands/MuteChannelCommand.d.ts +99 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +195 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +261 -0
- package/dist-types/commands/PinChannelCommand.d.ts +87 -0
- package/dist-types/commands/PinMessageCommand.d.ts +57 -1
- package/dist-types/commands/QueryChannelsCommand.d.ts +167 -0
- package/dist-types/commands/RemoveChannelFromSectionCommand.d.ts +101 -0
- package/dist-types/commands/RenameSectionCommand.d.ts +98 -0
- package/dist-types/commands/SendGiphyCommand.d.ts +207 -0
- package/dist-types/commands/SendMessageCommand.d.ts +105 -8
- package/dist-types/commands/SendMessageReactionCommand.d.ts +193 -0
- package/dist-types/commands/SendSystemMessageCommand.d.ts +199 -0
- package/dist-types/commands/SendTypingStartCommand.d.ts +84 -0
- package/dist-types/commands/SendTypingStopCommand.d.ts +84 -0
- package/dist-types/commands/ShowChannelCommand.d.ts +84 -0
- package/dist-types/commands/UnmuteChannelCommand.d.ts +98 -0
- package/dist-types/commands/UnpinChannelCommand.d.ts +84 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +57 -1
- package/dist-types/commands/UpdateChannelCommand.d.ts +190 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +256 -0
- package/dist-types/commands/UploadFileCommand.d.ts +94 -0
- package/dist-types/commands/index.d.ts +49 -3
- package/dist-types/models/models_0.d.ts +3256 -403
- package/dist-types/protocols/Aws_restJson1.d.ts +429 -15
- package/package.json +1 -1
- package/dist-types/commands/AddReactionCommand.d.ts +0 -137
- package/dist-types/commands/EditMessageCommand.d.ts +0 -151
- package/dist-types/commands/RemoveReactionCommand.d.ts +0 -137
|
@@ -11,17 +11,6 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
11
11
|
*/
|
|
12
12
|
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
13
13
|
}
|
|
14
|
-
/**
|
|
15
|
-
* @public
|
|
16
|
-
*/
|
|
17
|
-
export declare class InternalServerError extends __BaseException {
|
|
18
|
-
readonly name: "InternalServerError";
|
|
19
|
-
readonly $fault: "server";
|
|
20
|
-
/**
|
|
21
|
-
* @internal
|
|
22
|
-
*/
|
|
23
|
-
constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
|
|
24
|
-
}
|
|
25
14
|
/**
|
|
26
15
|
* @public
|
|
27
16
|
*/
|
|
@@ -78,7 +67,158 @@ export declare class ValidationException extends __BaseException {
|
|
|
78
67
|
/**
|
|
79
68
|
* @public
|
|
80
69
|
*/
|
|
81
|
-
export interface
|
|
70
|
+
export interface TemplateParameter {
|
|
71
|
+
name: string;
|
|
72
|
+
value: string;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export interface TemplateWithParameters {
|
|
78
|
+
name: string;
|
|
79
|
+
parameters?: (TemplateParameter)[] | undefined;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export interface ButtonActionHandler {
|
|
85
|
+
/**
|
|
86
|
+
* A unique ID of the action within the message.
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
id: string;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export interface ButtonLinkHandler {
|
|
95
|
+
url: string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export interface ButtonReplyHandler {
|
|
101
|
+
text?: string | undefined;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export type ButtonHandler = ButtonHandler.ActionMember | ButtonHandler.LinkMember | ButtonHandler.ReplyMember | ButtonHandler.$UnknownMember;
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare namespace ButtonHandler {
|
|
111
|
+
interface LinkMember {
|
|
112
|
+
link: ButtonLinkHandler;
|
|
113
|
+
reply?: never;
|
|
114
|
+
action?: never;
|
|
115
|
+
$unknown?: never;
|
|
116
|
+
}
|
|
117
|
+
interface ReplyMember {
|
|
118
|
+
link?: never;
|
|
119
|
+
reply: ButtonReplyHandler;
|
|
120
|
+
action?: never;
|
|
121
|
+
$unknown?: never;
|
|
122
|
+
}
|
|
123
|
+
interface ActionMember {
|
|
124
|
+
link?: never;
|
|
125
|
+
reply?: never;
|
|
126
|
+
action: ButtonActionHandler;
|
|
127
|
+
$unknown?: never;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
interface $UnknownMember {
|
|
133
|
+
link?: never;
|
|
134
|
+
reply?: never;
|
|
135
|
+
action?: never;
|
|
136
|
+
$unknown: [string, any];
|
|
137
|
+
}
|
|
138
|
+
interface Visitor<T> {
|
|
139
|
+
link: (value: ButtonLinkHandler) => T;
|
|
140
|
+
reply: (value: ButtonReplyHandler) => T;
|
|
141
|
+
action: (value: ButtonActionHandler) => T;
|
|
142
|
+
_: (name: string, value: any) => T;
|
|
143
|
+
}
|
|
144
|
+
const visit: <T>(value: ButtonHandler, visitor: Visitor<T>) => T;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* @public
|
|
148
|
+
* @enum
|
|
149
|
+
*/
|
|
150
|
+
export declare const ButtonVariant: {
|
|
151
|
+
readonly CONTAINED: "contained";
|
|
152
|
+
readonly OUTLINED: "outlined";
|
|
153
|
+
};
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export interface ButtonElement {
|
|
162
|
+
text: string;
|
|
163
|
+
handler: ButtonHandler;
|
|
164
|
+
variant?: ButtonVariant | undefined;
|
|
165
|
+
disabled?: boolean | undefined;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
export type ActionElement = ActionElement.ButtonMember | ActionElement.$UnknownMember;
|
|
171
|
+
/**
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
export declare namespace ActionElement {
|
|
175
|
+
interface ButtonMember {
|
|
176
|
+
button: ButtonElement;
|
|
177
|
+
$unknown?: never;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
interface $UnknownMember {
|
|
183
|
+
button?: never;
|
|
184
|
+
$unknown: [string, any];
|
|
185
|
+
}
|
|
186
|
+
interface Visitor<T> {
|
|
187
|
+
button: (value: ButtonElement) => T;
|
|
188
|
+
_: (name: string, value: any) => T;
|
|
189
|
+
}
|
|
190
|
+
const visit: <T>(value: ActionElement, visitor: Visitor<T>) => T;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* User invitation payload used when creating channels or adding members.
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export interface UserToInvite {
|
|
197
|
+
/**
|
|
198
|
+
* Email of the invited user.
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
email?: string | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* Phone number used to find or create the user when email is omitted.
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
phone?: string | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* Optional display name for the invited user.
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
name?: string | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* When true, resolve the email as a PBX colleague.
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
colleague?: boolean | undefined;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
export interface AddChannelMemberInput {
|
|
82
222
|
/**
|
|
83
223
|
* The unique identifier of the tenant when a service token is used.
|
|
84
224
|
* @public
|
|
@@ -90,117 +230,309 @@ export interface AddReactionInput {
|
|
|
90
230
|
*/
|
|
91
231
|
userId?: string | undefined;
|
|
92
232
|
channelId: string;
|
|
93
|
-
|
|
233
|
+
silent?: boolean | undefined;
|
|
234
|
+
memberId?: string | undefined;
|
|
94
235
|
/**
|
|
95
|
-
*
|
|
236
|
+
* User invitation payload used when creating channels or adding members.
|
|
96
237
|
* @public
|
|
97
238
|
*/
|
|
98
|
-
|
|
239
|
+
memberToInvite?: UserToInvite | undefined;
|
|
240
|
+
hideHistory?: boolean | undefined;
|
|
99
241
|
}
|
|
100
242
|
/**
|
|
101
|
-
* File attached to a message as returned by listing and lookup endpoints.
|
|
102
243
|
* @public
|
|
244
|
+
* @enum
|
|
103
245
|
*/
|
|
104
|
-
export
|
|
246
|
+
export declare const ChannelMemberRole: {
|
|
247
|
+
readonly MEMBER: "member";
|
|
248
|
+
readonly SUPERVISOR: "supervisor";
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export type ChannelMemberRole = typeof ChannelMemberRole[keyof typeof ChannelMemberRole];
|
|
254
|
+
/**
|
|
255
|
+
* Channel membership row.
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
export interface ChannelMember {
|
|
259
|
+
userId: string;
|
|
105
260
|
/**
|
|
106
|
-
*
|
|
261
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
107
262
|
* @public
|
|
108
263
|
*/
|
|
109
|
-
|
|
264
|
+
joinedAt: string;
|
|
265
|
+
role: ChannelMemberRole;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface AddChannelMemberOutput {
|
|
110
271
|
/**
|
|
111
|
-
*
|
|
272
|
+
* Channel membership row.
|
|
112
273
|
* @public
|
|
113
274
|
*/
|
|
114
|
-
|
|
275
|
+
member: ChannelMember;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export declare class ChannelNotFoundException extends __BaseException {
|
|
281
|
+
readonly name: "ChannelNotFoundException";
|
|
282
|
+
readonly $fault: "client";
|
|
115
283
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @public
|
|
284
|
+
* @internal
|
|
118
285
|
*/
|
|
119
|
-
|
|
286
|
+
constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
export declare class MemberAlreadyExistException extends __BaseException {
|
|
292
|
+
readonly name: "MemberAlreadyExistException";
|
|
293
|
+
readonly $fault: "client";
|
|
120
294
|
/**
|
|
121
|
-
*
|
|
122
|
-
* @public
|
|
295
|
+
* @internal
|
|
123
296
|
*/
|
|
124
|
-
|
|
297
|
+
constructor(opts: __ExceptionOptionType<MemberAlreadyExistException, __BaseException>);
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
export declare class StreamServiceException extends __BaseException {
|
|
303
|
+
readonly name: "StreamServiceException";
|
|
304
|
+
readonly $fault: "server";
|
|
125
305
|
/**
|
|
126
|
-
*
|
|
127
|
-
* @public
|
|
306
|
+
* @internal
|
|
128
307
|
*/
|
|
129
|
-
|
|
308
|
+
constructor(opts: __ExceptionOptionType<StreamServiceException, __BaseException>);
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
export interface AddChannelMembersInput {
|
|
130
314
|
/**
|
|
131
|
-
*
|
|
315
|
+
* The unique identifier of the tenant when a service token is used.
|
|
132
316
|
* @public
|
|
133
317
|
*/
|
|
134
|
-
|
|
318
|
+
companyId?: string | undefined;
|
|
135
319
|
/**
|
|
136
|
-
*
|
|
320
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
137
321
|
* @public
|
|
138
322
|
*/
|
|
139
|
-
|
|
323
|
+
userId?: string | undefined;
|
|
324
|
+
channelId: string;
|
|
325
|
+
silent?: boolean | undefined;
|
|
326
|
+
members?: (string)[] | undefined;
|
|
327
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
328
|
+
hideHistory?: boolean | undefined;
|
|
140
329
|
/**
|
|
141
|
-
*
|
|
330
|
+
* Message id used to seed unread state for added members.
|
|
142
331
|
* @public
|
|
143
332
|
*/
|
|
144
|
-
|
|
333
|
+
unreadMessageId?: string | undefined;
|
|
145
334
|
}
|
|
146
335
|
/**
|
|
147
|
-
* Reference to the original forwarded message.
|
|
148
336
|
* @public
|
|
149
337
|
*/
|
|
150
|
-
export interface
|
|
151
|
-
|
|
152
|
-
|
|
338
|
+
export interface AddChannelMembersOutput {
|
|
339
|
+
members: (ChannelMember)[];
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export type AssignChannelAssigneeRequest = AssignChannelAssigneeRequest.EmailMember | AssignChannelAssigneeRequest.IdMember | AssignChannelAssigneeRequest.$UnknownMember;
|
|
345
|
+
/**
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
export declare namespace AssignChannelAssigneeRequest {
|
|
349
|
+
interface IdMember {
|
|
350
|
+
id: string;
|
|
351
|
+
email?: never;
|
|
352
|
+
$unknown?: never;
|
|
353
|
+
}
|
|
354
|
+
interface EmailMember {
|
|
355
|
+
id?: never;
|
|
356
|
+
email: string;
|
|
357
|
+
$unknown?: never;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
interface $UnknownMember {
|
|
363
|
+
id?: never;
|
|
364
|
+
email?: never;
|
|
365
|
+
$unknown: [string, any];
|
|
366
|
+
}
|
|
367
|
+
interface Visitor<T> {
|
|
368
|
+
id: (value: string) => T;
|
|
369
|
+
email: (value: string) => T;
|
|
370
|
+
_: (name: string, value: any) => T;
|
|
371
|
+
}
|
|
372
|
+
const visit: <T>(value: AssignChannelAssigneeRequest, visitor: Visitor<T>) => T;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
export type AssignChannelServiceRequest = AssignChannelServiceRequest.UriMember | AssignChannelServiceRequest.$UnknownMember;
|
|
378
|
+
/**
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
export declare namespace AssignChannelServiceRequest {
|
|
153
382
|
/**
|
|
154
|
-
*
|
|
383
|
+
* Service URI: `<serviceId>@<pbxDomain>:<pbxPort>`.
|
|
155
384
|
* @public
|
|
156
385
|
*/
|
|
157
|
-
|
|
386
|
+
interface UriMember {
|
|
387
|
+
uri: string;
|
|
388
|
+
$unknown?: never;
|
|
389
|
+
}
|
|
158
390
|
/**
|
|
159
|
-
* Creation timestamp of the original message.
|
|
160
391
|
* @public
|
|
161
392
|
*/
|
|
162
|
-
|
|
393
|
+
interface $UnknownMember {
|
|
394
|
+
uri?: never;
|
|
395
|
+
$unknown: [string, any];
|
|
396
|
+
}
|
|
397
|
+
interface Visitor<T> {
|
|
398
|
+
uri: (value: string) => T;
|
|
399
|
+
_: (name: string, value: any) => T;
|
|
400
|
+
}
|
|
401
|
+
const visit: <T>(value: AssignChannelServiceRequest, visitor: Visitor<T>) => T;
|
|
163
402
|
}
|
|
164
403
|
/**
|
|
165
404
|
* @public
|
|
166
405
|
* @enum
|
|
167
406
|
*/
|
|
168
|
-
export declare const
|
|
169
|
-
readonly
|
|
170
|
-
readonly
|
|
407
|
+
export declare const AssignChannelVariant: {
|
|
408
|
+
readonly ADAPTIVE: "ADAPTIVE";
|
|
409
|
+
readonly EVERYBODY: "EVERYBODY";
|
|
410
|
+
readonly SELECTED: "SELECTED";
|
|
411
|
+
readonly SKIP: "SKIP";
|
|
171
412
|
};
|
|
172
413
|
/**
|
|
173
414
|
* @public
|
|
174
415
|
*/
|
|
175
|
-
export type
|
|
416
|
+
export type AssignChannelVariant = typeof AssignChannelVariant[keyof typeof AssignChannelVariant];
|
|
176
417
|
/**
|
|
177
|
-
* Reference to a quoted message.
|
|
178
418
|
* @public
|
|
179
419
|
*/
|
|
180
|
-
export interface
|
|
181
|
-
channelId: string;
|
|
182
|
-
messageId: string;
|
|
420
|
+
export interface AssignChannelInput {
|
|
183
421
|
/**
|
|
184
|
-
*
|
|
422
|
+
* The unique identifier of the tenant when a service token is used.
|
|
185
423
|
* @public
|
|
186
424
|
*/
|
|
187
|
-
|
|
425
|
+
companyId?: string | undefined;
|
|
188
426
|
/**
|
|
189
|
-
*
|
|
427
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
190
428
|
* @public
|
|
191
429
|
*/
|
|
192
|
-
|
|
430
|
+
userId?: string | undefined;
|
|
431
|
+
channelId: string;
|
|
432
|
+
silent?: boolean | undefined;
|
|
433
|
+
service?: AssignChannelServiceRequest | undefined;
|
|
434
|
+
assignee?: AssignChannelAssigneeRequest | undefined;
|
|
435
|
+
variant?: AssignChannelVariant | undefined;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
export interface AssignChannelOutput {
|
|
441
|
+
assigneeId?: string | undefined;
|
|
442
|
+
serviceUri?: string | undefined;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* @public
|
|
446
|
+
* @enum
|
|
447
|
+
*/
|
|
448
|
+
export declare const ChannelAccess: {
|
|
449
|
+
readonly PRIVATE: "private";
|
|
450
|
+
readonly PUBLIC: "public";
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
export type ChannelAccess = typeof ChannelAccess[keyof typeof ChannelAccess];
|
|
456
|
+
/**
|
|
457
|
+
* @public
|
|
458
|
+
* @enum
|
|
459
|
+
*/
|
|
460
|
+
export declare const ChannelType: {
|
|
461
|
+
readonly DIRECT: "direct";
|
|
462
|
+
readonly GROUP: "group";
|
|
463
|
+
};
|
|
464
|
+
/**
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* @enum
|
|
471
|
+
*/
|
|
472
|
+
export declare const ChannelContextEventAttendeeStatus: {
|
|
473
|
+
readonly ACCEPTED: "accepted";
|
|
474
|
+
readonly DECLINED: "declined";
|
|
475
|
+
readonly NONE: "none";
|
|
476
|
+
readonly TENTATIVE: "tentative";
|
|
477
|
+
};
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttendeeStatus[keyof typeof ChannelContextEventAttendeeStatus];
|
|
482
|
+
/**
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface ChannelContextEventAttendee {
|
|
486
|
+
email: string;
|
|
487
|
+
name?: string | undefined;
|
|
488
|
+
status: ChannelContextEventAttendeeStatus;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
export interface ChannelContextEvent {
|
|
494
|
+
id?: string | undefined;
|
|
495
|
+
owner?: string | undefined;
|
|
496
|
+
start?: string | undefined;
|
|
497
|
+
end?: string | undefined;
|
|
498
|
+
summary?: string | undefined;
|
|
499
|
+
attendees?: (ChannelContextEventAttendee)[] | undefined;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
export interface ChannelContextPushToTalk {
|
|
193
505
|
/**
|
|
194
|
-
*
|
|
506
|
+
* A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
|
|
195
507
|
* @public
|
|
196
508
|
*/
|
|
197
|
-
|
|
509
|
+
broadcastId?: string | undefined;
|
|
198
510
|
}
|
|
199
511
|
/**
|
|
200
|
-
*
|
|
512
|
+
* @public
|
|
513
|
+
* @enum
|
|
514
|
+
*/
|
|
515
|
+
export declare const ChannelContextSource: {
|
|
516
|
+
readonly KITE: "kite";
|
|
517
|
+
};
|
|
518
|
+
/**
|
|
201
519
|
* @public
|
|
202
520
|
*/
|
|
203
|
-
export
|
|
521
|
+
export type ChannelContextSource = typeof ChannelContextSource[keyof typeof ChannelContextSource];
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
export interface ChannelContext {
|
|
526
|
+
source?: ChannelContextSource | undefined;
|
|
527
|
+
target?: string | undefined;
|
|
528
|
+
events?: (ChannelContextEvent)[] | undefined;
|
|
529
|
+
ptt?: ChannelContextPushToTalk | undefined;
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* Preview of the most recent visible message in a channel.
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
export interface LastMessagePreview {
|
|
204
536
|
messageId: string;
|
|
205
537
|
/**
|
|
206
538
|
* Author of the message.
|
|
@@ -208,163 +540,2425 @@ export interface Message {
|
|
|
208
540
|
*/
|
|
209
541
|
userId: string;
|
|
210
542
|
/**
|
|
211
|
-
*
|
|
543
|
+
* Text body of the message. Absent for attachment-only or deleted messages.
|
|
212
544
|
* @public
|
|
213
545
|
*/
|
|
214
|
-
|
|
546
|
+
text?: string | undefined;
|
|
215
547
|
/**
|
|
216
|
-
*
|
|
548
|
+
* Creation timestamp of the message.
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
createdAt: string;
|
|
552
|
+
}
|
|
553
|
+
/**
|
|
554
|
+
* @public
|
|
555
|
+
* @enum
|
|
556
|
+
*/
|
|
557
|
+
export declare const ChannelWhatsAppStatus: {
|
|
558
|
+
readonly CHANNEL_CLOSED: "24h_channel_closed";
|
|
559
|
+
};
|
|
560
|
+
/**
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof ChannelWhatsAppStatus];
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
export interface Channel {
|
|
568
|
+
channelId: string;
|
|
569
|
+
/**
|
|
570
|
+
* Type of channel.
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
channelType: ChannelType;
|
|
574
|
+
/**
|
|
575
|
+
* Current number of members.
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
membersCount: number;
|
|
579
|
+
/**
|
|
580
|
+
* Channel creation timestamp.
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
createdAt: string;
|
|
584
|
+
/**
|
|
585
|
+
* User that created the channel.
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
createdBy: string;
|
|
589
|
+
/**
|
|
590
|
+
* Timestamp of the last channel mutation.
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
updatedAt?: string | undefined;
|
|
594
|
+
/**
|
|
595
|
+
* Channel version. Increments on every channel mutation.
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
channelVersion: number;
|
|
599
|
+
/**
|
|
600
|
+
* Timestamp of the last activity. Drives inbox ordering.
|
|
601
|
+
* @public
|
|
602
|
+
*/
|
|
603
|
+
lastActivityAt: string;
|
|
604
|
+
/**
|
|
605
|
+
* Last visible message preview. Absent for empty channels.
|
|
606
|
+
* @public
|
|
607
|
+
*/
|
|
608
|
+
lastMessage?: LastMessagePreview | undefined;
|
|
609
|
+
company?: string | undefined;
|
|
610
|
+
kite?: boolean | undefined;
|
|
611
|
+
kiteTarget?: string | undefined;
|
|
612
|
+
kiteVariant?: string | undefined;
|
|
613
|
+
kiteServiceName?: string | undefined;
|
|
614
|
+
kiteDefaultSubject?: string | undefined;
|
|
615
|
+
service?: string | undefined;
|
|
616
|
+
serviceRecipient?: string | undefined;
|
|
617
|
+
telephony?: boolean | undefined;
|
|
618
|
+
external?: boolean | undefined;
|
|
619
|
+
/**
|
|
620
|
+
* The subject of the channel.
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
subject?: string | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* The description of the channel.
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
description?: string | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* The URL of the channel's picture.
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
picture?: string | undefined;
|
|
634
|
+
/**
|
|
635
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
pictureColor?: string | undefined;
|
|
639
|
+
/**
|
|
640
|
+
* Channel access level.
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
access?: ChannelAccess | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
broadcast?: boolean | undefined;
|
|
649
|
+
context?: ChannelContext | undefined;
|
|
650
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
651
|
+
/**
|
|
652
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
653
|
+
* @public
|
|
654
|
+
*/
|
|
655
|
+
sms?: boolean | undefined;
|
|
656
|
+
/**
|
|
657
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
mms?: boolean | undefined;
|
|
661
|
+
/**
|
|
662
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
whatsapp?: boolean | undefined;
|
|
666
|
+
/**
|
|
667
|
+
* The unique identifier of the assignee.
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
kiteAssign?: string | undefined;
|
|
671
|
+
/**
|
|
672
|
+
* The title of the service.
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
serviceTitle?: string | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* Assignee user id.
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
assigneeId?: string | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* Indicates if the channel supports auto start recording.
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
autoRecord?: boolean | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* Transcription language.
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
transcriptionLanguage?: string | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* Indicates if external users in this conversation can only join the conference as a viewer with the ability to speak by request. Default is false.
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
export declare class ChannelAlreadyExistException extends __BaseException {
|
|
701
|
+
readonly name: "ChannelAlreadyExistException";
|
|
702
|
+
readonly $fault: "client";
|
|
703
|
+
/**
|
|
704
|
+
* @internal
|
|
705
|
+
*/
|
|
706
|
+
constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
|
|
707
|
+
}
|
|
708
|
+
/**
|
|
709
|
+
* Read pointer for one channel member.
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
export interface ChannelMemberReadStatus {
|
|
713
|
+
userId: string;
|
|
714
|
+
/**
|
|
715
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
716
|
+
* @public
|
|
717
|
+
*/
|
|
718
|
+
lastReadAt?: string | undefined;
|
|
719
|
+
/**
|
|
720
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
721
|
+
* @public
|
|
722
|
+
*/
|
|
723
|
+
lastReadVisibleSeq?: number | undefined;
|
|
724
|
+
}
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* @enum
|
|
728
|
+
*/
|
|
729
|
+
export declare const ChannelsFilter: {
|
|
730
|
+
/**
|
|
731
|
+
* Archived (hidden) channels.
|
|
732
|
+
*/
|
|
733
|
+
readonly ARCHIVED: "archived";
|
|
734
|
+
/**
|
|
735
|
+
* Non-archived channels with at least one unread message.
|
|
736
|
+
*/
|
|
737
|
+
readonly UNREAD: "unread";
|
|
738
|
+
};
|
|
739
|
+
/**
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
export type ChannelsFilter = typeof ChannelsFilter[keyof typeof ChannelsFilter];
|
|
743
|
+
/**
|
|
744
|
+
* Batch channel lookup query.
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
export interface ChannelsQuery {
|
|
748
|
+
ids?: (string)[] | undefined;
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* @public
|
|
752
|
+
* @enum
|
|
753
|
+
*/
|
|
754
|
+
export declare const GroupChannelCreationEventType: {
|
|
755
|
+
readonly CONVERSATION_CREATED: "conversation_created";
|
|
756
|
+
readonly CONVERSATION_CREATED_WITH_NAME: "conversation_created_with_name";
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
export type GroupChannelCreationEventType = typeof GroupChannelCreationEventType[keyof typeof GroupChannelCreationEventType];
|
|
762
|
+
/**
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
export interface CreateGroupChannelInput {
|
|
766
|
+
/**
|
|
767
|
+
* The unique identifier of the tenant when a service token is used.
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
companyId?: string | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
userId?: string | undefined;
|
|
776
|
+
/**
|
|
777
|
+
* The subject of the channel.
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
subject?: string | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* The description of the channel.
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
description?: string | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* The URL of the channel's picture.
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
picture?: string | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
pictureColor?: string | undefined;
|
|
796
|
+
/**
|
|
797
|
+
* Channel access level.
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
access?: ChannelAccess | undefined;
|
|
801
|
+
/**
|
|
802
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
broadcast?: boolean | undefined;
|
|
806
|
+
context?: ChannelContext | undefined;
|
|
807
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
sms?: boolean | undefined;
|
|
813
|
+
/**
|
|
814
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
815
|
+
* @public
|
|
816
|
+
*/
|
|
817
|
+
mms?: boolean | undefined;
|
|
818
|
+
/**
|
|
819
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
whatsapp?: boolean | undefined;
|
|
823
|
+
/**
|
|
824
|
+
* The unique identifier of the assignee.
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
kiteAssign?: string | undefined;
|
|
828
|
+
/**
|
|
829
|
+
* The title of the service.
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
serviceTitle?: string | undefined;
|
|
833
|
+
/**
|
|
834
|
+
* Assignee user id.
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
assigneeId?: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* Indicates if the channel supports auto start recording.
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
autoRecord?: boolean | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* Transcription language.
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
transcriptionLanguage?: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* Indicates if external users in this conversation can only join the conference as a viewer with the ability to speak by request. Default is false.
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* Optional client-supplied channel id.
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
channelId?: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* Existing users to add as members.
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
members?: (string)[] | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* Users to invite by email or phone.
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* System event emitted when a group channel is created.
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
creationEventType?: GroupChannelCreationEventType | undefined;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
export interface CreateGroupChannelOutput {
|
|
878
|
+
channel: Channel;
|
|
879
|
+
}
|
|
880
|
+
/**
|
|
881
|
+
* Attachment record supplied by the client when sending or editing a message. The server assigns the attachment `id` after persistence.
|
|
882
|
+
* @public
|
|
883
|
+
*/
|
|
884
|
+
export interface MessageAttachmentRequest {
|
|
885
|
+
/**
|
|
886
|
+
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
887
|
+
* @public
|
|
888
|
+
*/
|
|
889
|
+
fsId: string;
|
|
890
|
+
/**
|
|
891
|
+
* MIME type.
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
mime?: string | undefined;
|
|
895
|
+
/**
|
|
896
|
+
* Original file name.
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
name: string;
|
|
900
|
+
/**
|
|
901
|
+
* File size in bytes.
|
|
902
|
+
* @public
|
|
903
|
+
*/
|
|
904
|
+
size: number;
|
|
905
|
+
/**
|
|
906
|
+
* Image or video width in pixels.
|
|
907
|
+
* @public
|
|
908
|
+
*/
|
|
909
|
+
width?: number | undefined;
|
|
910
|
+
/**
|
|
911
|
+
* Image or video height in pixels.
|
|
912
|
+
* @public
|
|
913
|
+
*/
|
|
914
|
+
height?: number | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* Thumbnail URL when available.
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
thumbnail?: string | undefined;
|
|
920
|
+
}
|
|
921
|
+
/**
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
924
|
+
export interface MessageTemplateConfig {
|
|
925
|
+
whatsapp?: TemplateWithParameters | undefined;
|
|
926
|
+
}
|
|
927
|
+
/**
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
930
|
+
export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
export declare namespace Element {
|
|
935
|
+
interface TemplateMember {
|
|
936
|
+
template: MessageTemplateConfig;
|
|
937
|
+
actions?: never;
|
|
938
|
+
$unknown?: never;
|
|
939
|
+
}
|
|
940
|
+
interface ActionsMember {
|
|
941
|
+
template?: never;
|
|
942
|
+
actions: (ActionElement)[];
|
|
943
|
+
$unknown?: never;
|
|
944
|
+
}
|
|
945
|
+
/**
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
interface $UnknownMember {
|
|
949
|
+
template?: never;
|
|
950
|
+
actions?: never;
|
|
951
|
+
$unknown: [string, any];
|
|
952
|
+
}
|
|
953
|
+
interface Visitor<T> {
|
|
954
|
+
template: (value: MessageTemplateConfig) => T;
|
|
955
|
+
actions: (value: (ActionElement)[]) => T;
|
|
956
|
+
_: (name: string, value: any) => T;
|
|
957
|
+
}
|
|
958
|
+
const visit: <T>(value: Element, visitor: Visitor<T>) => T;
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
* Forward reference supplied by the client. The server resolves the original author and snapshot fields at write time.
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
export interface MessageForwardRef {
|
|
965
|
+
channelId: string;
|
|
966
|
+
messageId: string;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Quote reference supplied by the client. The server resolves the author and snapshot fields at write time.
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
export interface MessageQuoteRef {
|
|
973
|
+
channelId: string;
|
|
974
|
+
messageId: string;
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
* @enum
|
|
979
|
+
*/
|
|
980
|
+
export declare const MessageSmsStatus: {
|
|
981
|
+
readonly DELIVERED: "delivered";
|
|
982
|
+
readonly ERROR: "error";
|
|
983
|
+
readonly SENT: "sent";
|
|
984
|
+
readonly TRYING: "trying";
|
|
985
|
+
};
|
|
986
|
+
/**
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsStatus];
|
|
990
|
+
/**
|
|
991
|
+
* @public
|
|
992
|
+
* @enum
|
|
993
|
+
*/
|
|
994
|
+
export declare const MessageWhatsAppStatus: {
|
|
995
|
+
readonly DELIVERED: "delivered";
|
|
996
|
+
readonly ERROR: "error";
|
|
997
|
+
readonly SENT: "sent";
|
|
998
|
+
readonly TRYING: "trying";
|
|
999
|
+
};
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof MessageWhatsAppStatus];
|
|
1004
|
+
/**
|
|
1005
|
+
* Initial user message seeded during channel creation.
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
export interface InitialMessage {
|
|
1009
|
+
/**
|
|
1010
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
text?: string | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* Structured rich content blocks.
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
elements?: (Element)[] | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1024
|
+
/**
|
|
1025
|
+
* Reply context referencing a quoted message.
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
quote?: MessageQuoteRef | undefined;
|
|
1029
|
+
/**
|
|
1030
|
+
* Source reference for a forwarded message.
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
forward?: MessageForwardRef | undefined;
|
|
1034
|
+
/**
|
|
1035
|
+
* When true, the message body is interpreted as Markdown.
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
markdown?: boolean | undefined;
|
|
1039
|
+
/**
|
|
1040
|
+
* Suppress push notifications and unread indicators.
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
silent?: boolean | undefined;
|
|
1044
|
+
/**
|
|
1045
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
1046
|
+
* @public
|
|
1047
|
+
*/
|
|
1048
|
+
whatsapp?: boolean | undefined;
|
|
1049
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
sms?: boolean | undefined;
|
|
1055
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
messageId: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
mentions?: (string)[] | undefined;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Welcome message seeded during channel creation.
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
export interface WelcomeMessage {
|
|
1072
|
+
/**
|
|
1073
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
text?: string | undefined;
|
|
1077
|
+
/**
|
|
1078
|
+
* Structured rich content blocks.
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
elements?: (Element)[] | undefined;
|
|
1082
|
+
/**
|
|
1083
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* Reply context referencing a quoted message.
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
quote?: MessageQuoteRef | undefined;
|
|
1092
|
+
/**
|
|
1093
|
+
* Source reference for a forwarded message.
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
forward?: MessageForwardRef | undefined;
|
|
1097
|
+
/**
|
|
1098
|
+
* When true, the message body is interpreted as Markdown.
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
markdown?: boolean | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* Suppress push notifications and unread indicators.
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
silent?: boolean | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
whatsapp?: boolean | undefined;
|
|
1112
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1113
|
+
/**
|
|
1114
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
sms?: boolean | undefined;
|
|
1118
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1119
|
+
/**
|
|
1120
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
messageId: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
mentions?: (string)[] | undefined;
|
|
1129
|
+
userId: string;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
export interface CreateKiteChannelInput {
|
|
1135
|
+
/**
|
|
1136
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
companyId?: string | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
userId?: string | undefined;
|
|
1145
|
+
channelId?: string | undefined;
|
|
1146
|
+
/**
|
|
1147
|
+
* Kite widget id or agent email.
|
|
1148
|
+
* @public
|
|
1149
|
+
*/
|
|
1150
|
+
targetId: string;
|
|
1151
|
+
targetRouteId?: string | undefined;
|
|
1152
|
+
welcomeMessages?: (WelcomeMessage)[] | undefined;
|
|
1153
|
+
/**
|
|
1154
|
+
* Initial user message seeded during channel creation.
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
initialMessage?: InitialMessage | undefined;
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
export interface CreateKiteChannelOutput {
|
|
1163
|
+
channel: Channel;
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
* @public
|
|
1167
|
+
* @enum
|
|
1168
|
+
*/
|
|
1169
|
+
export declare const TargetNotEligibleReason: {
|
|
1170
|
+
readonly NO_LICENSE: "no_license";
|
|
1171
|
+
};
|
|
1172
|
+
/**
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeof TargetNotEligibleReason];
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
export declare class TargetNotEligibleException extends __BaseException {
|
|
1180
|
+
readonly name: "TargetNotEligibleException";
|
|
1181
|
+
readonly $fault: "client";
|
|
1182
|
+
reason?: TargetNotEligibleReason | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* @internal
|
|
1185
|
+
*/
|
|
1186
|
+
constructor(opts: __ExceptionOptionType<TargetNotEligibleException, __BaseException>);
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export declare class TargetNotFoundException extends __BaseException {
|
|
1192
|
+
readonly name: "TargetNotFoundException";
|
|
1193
|
+
readonly $fault: "client";
|
|
1194
|
+
/**
|
|
1195
|
+
* @internal
|
|
1196
|
+
*/
|
|
1197
|
+
constructor(opts: __ExceptionOptionType<TargetNotFoundException, __BaseException>);
|
|
1198
|
+
}
|
|
1199
|
+
/**
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
export interface CreateSectionInput {
|
|
1203
|
+
/**
|
|
1204
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
companyId?: string | undefined;
|
|
1208
|
+
/**
|
|
1209
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
userId?: string | undefined;
|
|
1213
|
+
/**
|
|
1214
|
+
* Client-supplied section id.
|
|
1215
|
+
* @public
|
|
1216
|
+
*/
|
|
1217
|
+
sectionId: string;
|
|
1218
|
+
name: string;
|
|
1219
|
+
}
|
|
1220
|
+
/**
|
|
1221
|
+
* @public
|
|
1222
|
+
* @enum
|
|
1223
|
+
*/
|
|
1224
|
+
export declare const SectionType: {
|
|
1225
|
+
/**
|
|
1226
|
+
* Custom section created by the user.
|
|
1227
|
+
*/
|
|
1228
|
+
readonly CUSTOM: "custom";
|
|
1229
|
+
/**
|
|
1230
|
+
* System section maintained by the backend.
|
|
1231
|
+
*/
|
|
1232
|
+
readonly SYSTEM: "system";
|
|
1233
|
+
};
|
|
1234
|
+
/**
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
export type SectionType = typeof SectionType[keyof typeof SectionType];
|
|
1238
|
+
/**
|
|
1239
|
+
* Aggregated unread counters for an inbox section.
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
export interface SectionUnreadCounters {
|
|
1243
|
+
/**
|
|
1244
|
+
* Unmuted channels with at least one unread message.
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
unmutedUnreadChannelCount: number;
|
|
1248
|
+
/**
|
|
1249
|
+
* Total unread messages across unmuted channels.
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
unmutedUnreadMessageCount: number;
|
|
1253
|
+
/**
|
|
1254
|
+
* Total unread messages across muted channels.
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
mutedUnreadMessageCount: number;
|
|
1258
|
+
/**
|
|
1259
|
+
* Unread direct mentions of the current user.
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
unreadMentionCount: number;
|
|
1263
|
+
}
|
|
1264
|
+
/**
|
|
1265
|
+
* Inbox section with metadata, channel count, and unread counters.
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
export interface Section {
|
|
1269
|
+
/**
|
|
1270
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
sectionId: string;
|
|
1274
|
+
/**
|
|
1275
|
+
* Display name of the section.
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
name: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Whether the section is system-managed or user-defined.
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
type: SectionType;
|
|
1284
|
+
/**
|
|
1285
|
+
* Total channels assigned to this section.
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
channelCount: number;
|
|
1289
|
+
/**
|
|
1290
|
+
* Aggregated unread counters for an inbox section.
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
unread: SectionUnreadCounters;
|
|
1294
|
+
}
|
|
1295
|
+
/**
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
export interface CreateSectionOutput {
|
|
1299
|
+
/**
|
|
1300
|
+
* Inbox section with metadata, channel count, and unread counters.
|
|
1301
|
+
* @public
|
|
1302
|
+
*/
|
|
1303
|
+
section: Section;
|
|
1304
|
+
}
|
|
1305
|
+
/**
|
|
1306
|
+
* @public
|
|
1307
|
+
*/
|
|
1308
|
+
export interface DeleteChannelInput {
|
|
1309
|
+
/**
|
|
1310
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1311
|
+
* @public
|
|
1312
|
+
*/
|
|
1313
|
+
companyId?: string | undefined;
|
|
1314
|
+
/**
|
|
1315
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1316
|
+
* @public
|
|
1317
|
+
*/
|
|
1318
|
+
userId?: string | undefined;
|
|
1319
|
+
channelId: string;
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1324
|
+
export interface DeleteChannelOutput {
|
|
1325
|
+
}
|
|
1326
|
+
/**
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
export interface DeleteChannelMemberInput {
|
|
1330
|
+
/**
|
|
1331
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
companyId?: string | undefined;
|
|
1335
|
+
/**
|
|
1336
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
userId?: string | undefined;
|
|
1340
|
+
channelId: string;
|
|
1341
|
+
memberId: string;
|
|
1342
|
+
silent?: boolean | undefined;
|
|
1343
|
+
}
|
|
1344
|
+
/**
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
export interface DeleteChannelMemberOutput {
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export declare class MemberNotFoundException extends __BaseException {
|
|
1353
|
+
readonly name: "MemberNotFoundException";
|
|
1354
|
+
readonly $fault: "client";
|
|
1355
|
+
/**
|
|
1356
|
+
* @internal
|
|
1357
|
+
*/
|
|
1358
|
+
constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
|
|
1359
|
+
}
|
|
1360
|
+
/**
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
export interface DeleteMessageInput {
|
|
1364
|
+
/**
|
|
1365
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1366
|
+
* @public
|
|
1367
|
+
*/
|
|
1368
|
+
companyId?: string | undefined;
|
|
1369
|
+
/**
|
|
1370
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
userId?: string | undefined;
|
|
1374
|
+
channelId: string;
|
|
1375
|
+
messageId: string;
|
|
1376
|
+
}
|
|
1377
|
+
/**
|
|
1378
|
+
* @public
|
|
1379
|
+
*/
|
|
1380
|
+
export interface DeleteMessageOutput {
|
|
1381
|
+
}
|
|
1382
|
+
/**
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1385
|
+
export declare class MessageNotFoundException extends __BaseException {
|
|
1386
|
+
readonly name: "MessageNotFoundException";
|
|
1387
|
+
readonly $fault: "client";
|
|
1388
|
+
/**
|
|
1389
|
+
* @internal
|
|
1390
|
+
*/
|
|
1391
|
+
constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
|
|
1392
|
+
}
|
|
1393
|
+
/**
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
export interface DeleteMessageReactionInput {
|
|
1397
|
+
/**
|
|
1398
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1399
|
+
* @public
|
|
1400
|
+
*/
|
|
1401
|
+
companyId?: string | undefined;
|
|
1402
|
+
/**
|
|
1403
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
userId?: string | undefined;
|
|
1407
|
+
channelId: string;
|
|
1408
|
+
messageId: string;
|
|
1409
|
+
/**
|
|
1410
|
+
* Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
type: string;
|
|
1414
|
+
}
|
|
1415
|
+
/**
|
|
1416
|
+
* File attached to a message as returned by listing and lookup endpoints.
|
|
1417
|
+
* @public
|
|
1418
|
+
*/
|
|
1419
|
+
export interface MessageAttachment {
|
|
1420
|
+
/**
|
|
1421
|
+
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
1422
|
+
* @public
|
|
1423
|
+
*/
|
|
1424
|
+
fsId: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* MIME type.
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
mime?: string | undefined;
|
|
1430
|
+
/**
|
|
1431
|
+
* Original file name.
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
name: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* File size in bytes.
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1439
|
+
size: number;
|
|
1440
|
+
/**
|
|
1441
|
+
* Image or video width in pixels.
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
width?: number | undefined;
|
|
1445
|
+
/**
|
|
1446
|
+
* Image or video height in pixels.
|
|
1447
|
+
* @public
|
|
1448
|
+
*/
|
|
1449
|
+
height?: number | undefined;
|
|
1450
|
+
/**
|
|
1451
|
+
* Thumbnail URL when available.
|
|
1452
|
+
* @public
|
|
1453
|
+
*/
|
|
1454
|
+
thumbnail?: string | undefined;
|
|
1455
|
+
/**
|
|
1456
|
+
* Attachment identifier within the message.
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
id: string;
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* Reference to the original forwarded message.
|
|
1463
|
+
* @public
|
|
1464
|
+
*/
|
|
1465
|
+
export interface MessageForward {
|
|
1466
|
+
channelId: string;
|
|
1467
|
+
messageId: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Author of the original message.
|
|
1470
|
+
* @public
|
|
1471
|
+
*/
|
|
1472
|
+
userId: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Creation timestamp of the original message.
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1477
|
+
forwardedAt: string;
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* @public
|
|
1481
|
+
*/
|
|
1482
|
+
export interface MessageGiphy {
|
|
1483
|
+
id: string;
|
|
1484
|
+
size: string;
|
|
1485
|
+
url: string;
|
|
1486
|
+
height: string;
|
|
1487
|
+
width: string;
|
|
1488
|
+
}
|
|
1489
|
+
/**
|
|
1490
|
+
* One reaction on a message.
|
|
1491
|
+
* @public
|
|
1492
|
+
*/
|
|
1493
|
+
export interface Reaction {
|
|
1494
|
+
/**
|
|
1495
|
+
* Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
|
|
1496
|
+
* @public
|
|
1497
|
+
*/
|
|
1498
|
+
type: string;
|
|
1499
|
+
userId: string;
|
|
1500
|
+
messageId: string;
|
|
1501
|
+
}
|
|
1502
|
+
/**
|
|
1503
|
+
* @public
|
|
1504
|
+
* @enum
|
|
1505
|
+
*/
|
|
1506
|
+
export declare const MessageType: {
|
|
1507
|
+
readonly REGULAR: "regular";
|
|
1508
|
+
readonly SYSTEM: "system";
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
export type MessageType = typeof MessageType[keyof typeof MessageType];
|
|
1514
|
+
/**
|
|
1515
|
+
* Reference to a quoted message.
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
export interface MessageQuote {
|
|
1519
|
+
channelId: string;
|
|
1520
|
+
messageId: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* Author of the quoted message.
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
userId: string;
|
|
1526
|
+
/**
|
|
1527
|
+
* Text body captured at quote time.
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
text?: string | undefined;
|
|
1531
|
+
/**
|
|
1532
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
createdAt: string;
|
|
1536
|
+
}
|
|
1537
|
+
/**
|
|
1538
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
export interface Message {
|
|
1542
|
+
messageId: string;
|
|
1543
|
+
/**
|
|
1544
|
+
* Author of the message.
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
userId: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* Type of message row.
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
messageType: MessageType;
|
|
1553
|
+
/**
|
|
1554
|
+
* Text body. Empty for attachment-only or deleted messages.
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
text?: string | undefined;
|
|
1558
|
+
/**
|
|
1559
|
+
* Attached files.
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
attachments: (MessageAttachment)[];
|
|
1563
|
+
/**
|
|
1564
|
+
* Users directly mentioned in the message.
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
mentions: (string)[];
|
|
1568
|
+
/**
|
|
1569
|
+
* Quoted message reference.
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
quote?: MessageQuote | undefined;
|
|
1573
|
+
/**
|
|
1574
|
+
* Forwarded message reference.
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
forward?: MessageForward | undefined;
|
|
1578
|
+
/**
|
|
1579
|
+
* Per-emoji reaction counters. Keys are reaction type ids (e.g. `thumbsup`).
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
reactionCounts: Record<string, number>;
|
|
1583
|
+
/**
|
|
1584
|
+
* Most recent reactions per type. Fetch the full list on demand.
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
latestReactions?: (Reaction)[] | undefined;
|
|
1588
|
+
/**
|
|
1589
|
+
* True when the message is currently pinned at channel scope.
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
pinned: boolean;
|
|
1593
|
+
/**
|
|
1594
|
+
* Timestamp at which the message was pinned. Absent when not pinned.
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
pinnedAt?: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* User that pinned the message. Absent when not pinned.
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
pinnedBy?: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* True when the message is system-generated.
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
system: boolean;
|
|
1608
|
+
/**
|
|
1609
|
+
* Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
timelineSeq: number;
|
|
1613
|
+
/**
|
|
1614
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
visibleSeq: number;
|
|
1618
|
+
/**
|
|
1619
|
+
* Channel version. Increments on every channel mutation.
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
channelVersion: number;
|
|
1623
|
+
/**
|
|
1624
|
+
* Message version. Increments on every message mutation.
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
messageVersion: number;
|
|
1628
|
+
/**
|
|
1629
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
createdAt: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* Timestamp of the most recent edit.
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
editedAt?: string | undefined;
|
|
1638
|
+
/**
|
|
1639
|
+
* Tombstone timestamp.
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1642
|
+
deletedAt?: string | undefined;
|
|
1643
|
+
elements?: (Element)[] | undefined;
|
|
1644
|
+
whatsapp?: boolean | undefined;
|
|
1645
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1646
|
+
sms?: boolean | undefined;
|
|
1647
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1648
|
+
markdown?: boolean | undefined;
|
|
1649
|
+
giphy?: MessageGiphy | undefined;
|
|
1650
|
+
silent?: boolean | undefined;
|
|
1651
|
+
/**
|
|
1652
|
+
* System event identifier for client rendering.
|
|
1653
|
+
* @public
|
|
1654
|
+
*/
|
|
1655
|
+
event?: string | undefined;
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* @public
|
|
1659
|
+
*/
|
|
1660
|
+
export interface DeleteMessageReactionOutput {
|
|
1661
|
+
/**
|
|
1662
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1663
|
+
* @public
|
|
1664
|
+
*/
|
|
1665
|
+
message: Message;
|
|
1666
|
+
}
|
|
1667
|
+
/**
|
|
1668
|
+
* @public
|
|
1669
|
+
*/
|
|
1670
|
+
export interface DeleteSectionInput {
|
|
1671
|
+
/**
|
|
1672
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
companyId?: string | undefined;
|
|
1676
|
+
/**
|
|
1677
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1678
|
+
* @public
|
|
1679
|
+
*/
|
|
1680
|
+
userId?: string | undefined;
|
|
1681
|
+
/**
|
|
1682
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
1685
|
+
sectionId: string;
|
|
1686
|
+
}
|
|
1687
|
+
/**
|
|
1688
|
+
* @public
|
|
1689
|
+
*/
|
|
1690
|
+
export interface DeleteSectionOutput {
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
export declare class SectionNotFoundException extends __BaseException {
|
|
1696
|
+
readonly name: "SectionNotFoundException";
|
|
1697
|
+
readonly $fault: "client";
|
|
1698
|
+
/**
|
|
1699
|
+
* @internal
|
|
1700
|
+
*/
|
|
1701
|
+
constructor(opts: __ExceptionOptionType<SectionNotFoundException, __BaseException>);
|
|
1702
|
+
}
|
|
1703
|
+
export declare enum DownloadStrategy {
|
|
1704
|
+
DEFAULT = 0,
|
|
1705
|
+
DOWNLOAD = 1
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* @public
|
|
1709
|
+
* @enum
|
|
1710
|
+
*/
|
|
1711
|
+
export declare const FileCategory: {
|
|
1712
|
+
/**
|
|
1713
|
+
* Channel-attached files. Default.
|
|
1714
|
+
*/
|
|
1715
|
+
readonly GENERAL: "channels";
|
|
1716
|
+
/**
|
|
1717
|
+
* Conference recordings.
|
|
1718
|
+
*/
|
|
1719
|
+
readonly RECORDING: "recordings";
|
|
1720
|
+
/**
|
|
1721
|
+
* Wizy conference recordings.
|
|
1722
|
+
*/
|
|
1723
|
+
readonly WIZY_RECORDING: "wizyconfRecordings";
|
|
1724
|
+
};
|
|
1725
|
+
/**
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
1728
|
+
export type FileCategory = typeof FileCategory[keyof typeof FileCategory];
|
|
1729
|
+
/**
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
export declare class FileNotFoundException extends __BaseException {
|
|
1733
|
+
readonly name: "FileNotFoundException";
|
|
1734
|
+
readonly $fault: "client";
|
|
1735
|
+
/**
|
|
1736
|
+
* @internal
|
|
1737
|
+
*/
|
|
1738
|
+
constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
|
|
1739
|
+
}
|
|
1740
|
+
/**
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1743
|
+
export interface GetChannelInput {
|
|
1744
|
+
/**
|
|
1745
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1746
|
+
* @public
|
|
1747
|
+
*/
|
|
1748
|
+
companyId?: string | undefined;
|
|
1749
|
+
/**
|
|
1750
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1751
|
+
* @public
|
|
1752
|
+
*/
|
|
1753
|
+
userId?: string | undefined;
|
|
1754
|
+
channelId: string;
|
|
1755
|
+
}
|
|
1756
|
+
/**
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
export interface GetChannelOutput {
|
|
1760
|
+
channel: Channel;
|
|
1761
|
+
}
|
|
1762
|
+
/**
|
|
1763
|
+
* @public
|
|
1764
|
+
*/
|
|
1765
|
+
export interface GetChannelMemberInput {
|
|
1766
|
+
/**
|
|
1767
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1768
|
+
* @public
|
|
1769
|
+
*/
|
|
1770
|
+
companyId?: string | undefined;
|
|
1771
|
+
/**
|
|
1772
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1773
|
+
* @public
|
|
1774
|
+
*/
|
|
1775
|
+
userId?: string | undefined;
|
|
1776
|
+
channelId: string;
|
|
1777
|
+
memberId: string;
|
|
1778
|
+
}
|
|
1779
|
+
/**
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
export interface GetChannelMemberOutput {
|
|
1783
|
+
/**
|
|
1784
|
+
* Channel membership row.
|
|
1785
|
+
* @public
|
|
1786
|
+
*/
|
|
1787
|
+
member: ChannelMember;
|
|
1788
|
+
}
|
|
1789
|
+
/**
|
|
1790
|
+
* @public
|
|
1791
|
+
*/
|
|
1792
|
+
export interface GetDirectChannelIdInput {
|
|
1793
|
+
/**
|
|
1794
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1795
|
+
* @public
|
|
1796
|
+
*/
|
|
1797
|
+
companyId?: string | undefined;
|
|
1798
|
+
/**
|
|
1799
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1800
|
+
* @public
|
|
1801
|
+
*/
|
|
1802
|
+
userId?: string | undefined;
|
|
1803
|
+
memberId?: string | undefined;
|
|
1804
|
+
/**
|
|
1805
|
+
* User invitation payload used when creating channels or adding members.
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1808
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1809
|
+
}
|
|
1810
|
+
/**
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
export interface GetDirectChannelIdOutput {
|
|
1814
|
+
channelId: string;
|
|
1815
|
+
}
|
|
1816
|
+
/**
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
export interface GetFilePresignedDownloadUrlInput {
|
|
1820
|
+
/**
|
|
1821
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
companyId?: string | undefined;
|
|
1825
|
+
/**
|
|
1826
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1829
|
+
userId?: string | undefined;
|
|
1830
|
+
channelId: string;
|
|
1831
|
+
messageId: string;
|
|
1832
|
+
/**
|
|
1833
|
+
* File service identifier of the attachment to download.
|
|
1834
|
+
* @public
|
|
1835
|
+
*/
|
|
1836
|
+
fsId: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* File storage category.
|
|
1839
|
+
* @public
|
|
1840
|
+
*/
|
|
1841
|
+
category?: FileCategory | undefined;
|
|
1842
|
+
/**
|
|
1843
|
+
* Download behavior. `0` opens inline for audio/video when supported; `1` always forces download.
|
|
1844
|
+
* @public
|
|
1845
|
+
*/
|
|
1846
|
+
download?: DownloadStrategy | undefined;
|
|
1847
|
+
}
|
|
1848
|
+
/**
|
|
1849
|
+
* @public
|
|
1850
|
+
*/
|
|
1851
|
+
export interface GetFilePresignedDownloadUrlOutput {
|
|
1852
|
+
/**
|
|
1853
|
+
* Presigned URL for downloading the file.
|
|
1854
|
+
* @public
|
|
1855
|
+
*/
|
|
1856
|
+
presignedDownloadUrl: string;
|
|
1857
|
+
}
|
|
1858
|
+
/**
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
export interface GetInboxInput {
|
|
1862
|
+
/**
|
|
1863
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
companyId?: string | undefined;
|
|
1867
|
+
/**
|
|
1868
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1869
|
+
* @public
|
|
1870
|
+
*/
|
|
1871
|
+
userId?: string | undefined;
|
|
1872
|
+
}
|
|
1873
|
+
/**
|
|
1874
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1875
|
+
* @public
|
|
1876
|
+
*/
|
|
1877
|
+
export interface InboxState {
|
|
1878
|
+
/**
|
|
1879
|
+
* Sections that include this channel.
|
|
1880
|
+
* @public
|
|
1881
|
+
*/
|
|
1882
|
+
sectionIds: (string)[];
|
|
1883
|
+
/**
|
|
1884
|
+
* Number of unread visible messages.
|
|
1885
|
+
* @public
|
|
1886
|
+
*/
|
|
1887
|
+
unreadCount: number;
|
|
1888
|
+
/**
|
|
1889
|
+
* Number of unread mentions of the current user.
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
mentionUnreadCount: number;
|
|
1893
|
+
/**
|
|
1894
|
+
* Highest `visibleSeq` the user has read in this channel.
|
|
1895
|
+
* @public
|
|
1896
|
+
*/
|
|
1897
|
+
lastReadVisibleSeq?: number | undefined;
|
|
1898
|
+
/**
|
|
1899
|
+
* Timestamp of the most recent read event.
|
|
1900
|
+
* @public
|
|
1901
|
+
*/
|
|
1902
|
+
lastReadAt?: string | undefined;
|
|
1903
|
+
/**
|
|
1904
|
+
* True when the channel is hidden (archived).
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
hidden: boolean;
|
|
1908
|
+
/**
|
|
1909
|
+
* True when the channel is muted.
|
|
1910
|
+
* @public
|
|
1911
|
+
*/
|
|
1912
|
+
muted: boolean;
|
|
1913
|
+
/**
|
|
1914
|
+
* Expiry timestamp for a temporary mute.
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
mutedUntil?: string | undefined;
|
|
1918
|
+
/**
|
|
1919
|
+
* `visibleSeq` from which the user manually marked the channel as unread.
|
|
1920
|
+
* @public
|
|
1921
|
+
*/
|
|
1922
|
+
unreadMarkAt?: number | undefined;
|
|
1923
|
+
}
|
|
1924
|
+
/**
|
|
1925
|
+
* Channel item returned by inbox and channel listings. Includes per-user inbox state and last-message preview.
|
|
1926
|
+
* @public
|
|
1927
|
+
*/
|
|
1928
|
+
export interface InboxChannel {
|
|
1929
|
+
channelId: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* Type of channel.
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
channelType: ChannelType;
|
|
1935
|
+
/**
|
|
1936
|
+
* Current number of members.
|
|
1937
|
+
* @public
|
|
1938
|
+
*/
|
|
1939
|
+
membersCount: number;
|
|
1940
|
+
/**
|
|
1941
|
+
* Channel creation timestamp.
|
|
1942
|
+
* @public
|
|
1943
|
+
*/
|
|
1944
|
+
createdAt: string;
|
|
1945
|
+
/**
|
|
1946
|
+
* User that created the channel.
|
|
1947
|
+
* @public
|
|
1948
|
+
*/
|
|
1949
|
+
createdBy: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* Timestamp of the last channel mutation.
|
|
1952
|
+
* @public
|
|
1953
|
+
*/
|
|
1954
|
+
updatedAt?: string | undefined;
|
|
1955
|
+
/**
|
|
1956
|
+
* Channel version. Increments on every channel mutation.
|
|
1957
|
+
* @public
|
|
1958
|
+
*/
|
|
1959
|
+
channelVersion: number;
|
|
1960
|
+
/**
|
|
1961
|
+
* Timestamp of the last activity. Drives inbox ordering.
|
|
1962
|
+
* @public
|
|
1963
|
+
*/
|
|
1964
|
+
lastActivityAt: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* Last visible message preview. Absent for empty channels.
|
|
1967
|
+
* @public
|
|
1968
|
+
*/
|
|
1969
|
+
lastMessage?: LastMessagePreview | undefined;
|
|
1970
|
+
company?: string | undefined;
|
|
1971
|
+
kite?: boolean | undefined;
|
|
1972
|
+
kiteTarget?: string | undefined;
|
|
1973
|
+
kiteVariant?: string | undefined;
|
|
1974
|
+
kiteServiceName?: string | undefined;
|
|
1975
|
+
kiteDefaultSubject?: string | undefined;
|
|
1976
|
+
service?: string | undefined;
|
|
1977
|
+
serviceRecipient?: string | undefined;
|
|
1978
|
+
telephony?: boolean | undefined;
|
|
1979
|
+
external?: boolean | undefined;
|
|
1980
|
+
/**
|
|
1981
|
+
* The subject of the channel.
|
|
1982
|
+
* @public
|
|
1983
|
+
*/
|
|
1984
|
+
subject?: string | undefined;
|
|
1985
|
+
/**
|
|
1986
|
+
* The description of the channel.
|
|
1987
|
+
* @public
|
|
1988
|
+
*/
|
|
1989
|
+
description?: string | undefined;
|
|
1990
|
+
/**
|
|
1991
|
+
* The URL of the channel's picture.
|
|
1992
|
+
* @public
|
|
1993
|
+
*/
|
|
1994
|
+
picture?: string | undefined;
|
|
1995
|
+
/**
|
|
1996
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
1997
|
+
* @public
|
|
1998
|
+
*/
|
|
1999
|
+
pictureColor?: string | undefined;
|
|
2000
|
+
/**
|
|
2001
|
+
* Channel access level.
|
|
2002
|
+
* @public
|
|
2003
|
+
*/
|
|
2004
|
+
access?: ChannelAccess | undefined;
|
|
2005
|
+
/**
|
|
2006
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
2007
|
+
* @public
|
|
2008
|
+
*/
|
|
2009
|
+
broadcast?: boolean | undefined;
|
|
2010
|
+
context?: ChannelContext | undefined;
|
|
2011
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
2012
|
+
/**
|
|
2013
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
2014
|
+
* @public
|
|
2015
|
+
*/
|
|
2016
|
+
sms?: boolean | undefined;
|
|
2017
|
+
/**
|
|
2018
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
2019
|
+
* @public
|
|
2020
|
+
*/
|
|
2021
|
+
mms?: boolean | undefined;
|
|
2022
|
+
/**
|
|
2023
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
2026
|
+
whatsapp?: boolean | undefined;
|
|
2027
|
+
/**
|
|
2028
|
+
* The unique identifier of the assignee.
|
|
2029
|
+
* @public
|
|
2030
|
+
*/
|
|
2031
|
+
kiteAssign?: string | undefined;
|
|
2032
|
+
/**
|
|
2033
|
+
* The title of the service.
|
|
2034
|
+
* @public
|
|
2035
|
+
*/
|
|
2036
|
+
serviceTitle?: string | undefined;
|
|
2037
|
+
/**
|
|
2038
|
+
* Assignee user id.
|
|
2039
|
+
* @public
|
|
2040
|
+
*/
|
|
2041
|
+
assigneeId?: string | undefined;
|
|
2042
|
+
/**
|
|
2043
|
+
* Indicates if the channel supports auto start recording.
|
|
2044
|
+
* @public
|
|
2045
|
+
*/
|
|
2046
|
+
autoRecord?: boolean | undefined;
|
|
2047
|
+
/**
|
|
2048
|
+
* Transcription language.
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
transcriptionLanguage?: string | undefined;
|
|
2052
|
+
/**
|
|
2053
|
+
* Indicates if external users in this conversation can only join the conference as a viewer with the ability to speak by request. Default is false.
|
|
2054
|
+
* @public
|
|
2055
|
+
*/
|
|
2056
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
2057
|
+
/**
|
|
2058
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
inbox: InboxState;
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* @public
|
|
2065
|
+
*/
|
|
2066
|
+
export interface GetInboxOutput {
|
|
2067
|
+
/**
|
|
2068
|
+
* Recent channels with per-user state and last-message preview.
|
|
2069
|
+
* @public
|
|
2070
|
+
*/
|
|
2071
|
+
channels: (InboxChannel)[];
|
|
2072
|
+
/**
|
|
2073
|
+
* Inbox sections with channel counts and unread counters.
|
|
2074
|
+
* @public
|
|
2075
|
+
*/
|
|
2076
|
+
sections: (Section)[];
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
export interface GetMessageInput {
|
|
2082
|
+
/**
|
|
2083
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
2086
|
+
companyId?: string | undefined;
|
|
2087
|
+
/**
|
|
2088
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
userId?: string | undefined;
|
|
2092
|
+
channelId: string;
|
|
2093
|
+
messageId: string;
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
export interface GetMessageOutput {
|
|
2099
|
+
/**
|
|
2100
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
2103
|
+
message: Message;
|
|
2104
|
+
}
|
|
2105
|
+
/**
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
export interface GetOrCreateDirectChannelInput {
|
|
2109
|
+
/**
|
|
2110
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
companyId?: string | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
2118
|
+
userId?: string | undefined;
|
|
2119
|
+
memberId?: string | undefined;
|
|
2120
|
+
/**
|
|
2121
|
+
* User invitation payload used when creating channels or adding members.
|
|
2122
|
+
* @public
|
|
2123
|
+
*/
|
|
2124
|
+
memberToInvite?: UserToInvite | undefined;
|
|
2125
|
+
}
|
|
2126
|
+
/**
|
|
2127
|
+
* @public
|
|
2128
|
+
*/
|
|
2129
|
+
export interface GetOrCreateDirectChannelOutput {
|
|
2130
|
+
channel: Channel;
|
|
2131
|
+
}
|
|
2132
|
+
/**
|
|
2133
|
+
* @public
|
|
2134
|
+
*/
|
|
2135
|
+
export interface GetOrCreateSmsChannelInput {
|
|
2136
|
+
/**
|
|
2137
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2138
|
+
* @public
|
|
2139
|
+
*/
|
|
2140
|
+
companyId?: string | undefined;
|
|
2141
|
+
/**
|
|
2142
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2143
|
+
* @public
|
|
2144
|
+
*/
|
|
2145
|
+
userId?: string | undefined;
|
|
2146
|
+
/**
|
|
2147
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2148
|
+
* @public
|
|
2149
|
+
*/
|
|
2150
|
+
serviceUri: string;
|
|
2151
|
+
/**
|
|
2152
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2153
|
+
* @public
|
|
2154
|
+
*/
|
|
2155
|
+
recipientId?: string | undefined;
|
|
2156
|
+
/**
|
|
2157
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2158
|
+
* @public
|
|
2159
|
+
*/
|
|
2160
|
+
recipientNumber?: string | undefined;
|
|
2161
|
+
outgoing?: boolean | undefined;
|
|
2162
|
+
}
|
|
2163
|
+
/**
|
|
2164
|
+
* @public
|
|
2165
|
+
*/
|
|
2166
|
+
export interface GetOrCreateSmsChannelOutput {
|
|
2167
|
+
channel: Channel;
|
|
2168
|
+
}
|
|
2169
|
+
/**
|
|
2170
|
+
* @public
|
|
2171
|
+
*/
|
|
2172
|
+
export interface GetOrCreateTelephonyChannelInput {
|
|
2173
|
+
/**
|
|
2174
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
companyId?: string | undefined;
|
|
2178
|
+
/**
|
|
2179
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2180
|
+
* @public
|
|
2181
|
+
*/
|
|
2182
|
+
userId?: string | undefined;
|
|
2183
|
+
/**
|
|
2184
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2185
|
+
* @public
|
|
2186
|
+
*/
|
|
2187
|
+
serviceUri: string;
|
|
2188
|
+
/**
|
|
2189
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2190
|
+
* @public
|
|
2191
|
+
*/
|
|
2192
|
+
recipientId?: string | undefined;
|
|
2193
|
+
/**
|
|
2194
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2195
|
+
* @public
|
|
2196
|
+
*/
|
|
2197
|
+
recipientNumber?: string | undefined;
|
|
2198
|
+
}
|
|
2199
|
+
/**
|
|
2200
|
+
* @public
|
|
2201
|
+
*/
|
|
2202
|
+
export interface GetOrCreateTelephonyChannelOutput {
|
|
2203
|
+
channel: Channel;
|
|
2204
|
+
}
|
|
2205
|
+
/**
|
|
2206
|
+
* @public
|
|
2207
|
+
*/
|
|
2208
|
+
export interface GetOrCreateWhatsAppChannelInput {
|
|
2209
|
+
/**
|
|
2210
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2211
|
+
* @public
|
|
2212
|
+
*/
|
|
2213
|
+
companyId?: string | undefined;
|
|
2214
|
+
/**
|
|
2215
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2216
|
+
* @public
|
|
2217
|
+
*/
|
|
2218
|
+
userId?: string | undefined;
|
|
2219
|
+
/**
|
|
2220
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2221
|
+
* @public
|
|
2222
|
+
*/
|
|
2223
|
+
serviceUri: string;
|
|
2224
|
+
/**
|
|
2225
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2226
|
+
* @public
|
|
2227
|
+
*/
|
|
2228
|
+
recipientId?: string | undefined;
|
|
2229
|
+
/**
|
|
2230
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2231
|
+
* @public
|
|
2232
|
+
*/
|
|
2233
|
+
recipientNumber?: string | undefined;
|
|
2234
|
+
outgoing?: boolean | undefined;
|
|
2235
|
+
}
|
|
2236
|
+
/**
|
|
2237
|
+
* @public
|
|
2238
|
+
*/
|
|
2239
|
+
export interface GetOrCreateWhatsAppChannelOutput {
|
|
2240
|
+
channel: Channel;
|
|
2241
|
+
}
|
|
2242
|
+
/**
|
|
2243
|
+
* @public
|
|
2244
|
+
*/
|
|
2245
|
+
export interface GetSmsChannelIdInput {
|
|
2246
|
+
/**
|
|
2247
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
companyId?: string | undefined;
|
|
2251
|
+
/**
|
|
2252
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2253
|
+
* @public
|
|
2254
|
+
*/
|
|
2255
|
+
userId?: string | undefined;
|
|
2256
|
+
/**
|
|
2257
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2258
|
+
* @public
|
|
2259
|
+
*/
|
|
2260
|
+
serviceUri: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2263
|
+
* @public
|
|
2264
|
+
*/
|
|
2265
|
+
recipientId?: string | undefined;
|
|
2266
|
+
/**
|
|
2267
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2268
|
+
* @public
|
|
2269
|
+
*/
|
|
2270
|
+
recipientNumber?: string | undefined;
|
|
2271
|
+
}
|
|
2272
|
+
/**
|
|
2273
|
+
* @public
|
|
2274
|
+
*/
|
|
2275
|
+
export interface GetSmsChannelIdOutput {
|
|
2276
|
+
channelId: string;
|
|
2277
|
+
}
|
|
2278
|
+
/**
|
|
2279
|
+
* @public
|
|
2280
|
+
*/
|
|
2281
|
+
export interface GetTelephonyChannelIdInput {
|
|
2282
|
+
/**
|
|
2283
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2284
|
+
* @public
|
|
2285
|
+
*/
|
|
2286
|
+
companyId?: string | undefined;
|
|
2287
|
+
/**
|
|
2288
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2289
|
+
* @public
|
|
2290
|
+
*/
|
|
2291
|
+
userId?: string | undefined;
|
|
2292
|
+
/**
|
|
2293
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2294
|
+
* @public
|
|
2295
|
+
*/
|
|
2296
|
+
serviceUri: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2299
|
+
* @public
|
|
2300
|
+
*/
|
|
2301
|
+
recipientId?: string | undefined;
|
|
2302
|
+
/**
|
|
2303
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2304
|
+
* @public
|
|
2305
|
+
*/
|
|
2306
|
+
recipientNumber?: string | undefined;
|
|
2307
|
+
}
|
|
2308
|
+
/**
|
|
2309
|
+
* @public
|
|
2310
|
+
*/
|
|
2311
|
+
export interface GetTelephonyChannelIdOutput {
|
|
2312
|
+
channelId: string;
|
|
2313
|
+
}
|
|
2314
|
+
/**
|
|
2315
|
+
* @public
|
|
2316
|
+
*/
|
|
2317
|
+
export interface GetTokenInput {
|
|
2318
|
+
/**
|
|
2319
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2320
|
+
* @public
|
|
2321
|
+
*/
|
|
2322
|
+
companyId?: string | undefined;
|
|
2323
|
+
/**
|
|
2324
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2327
|
+
userId?: string | undefined;
|
|
2328
|
+
/**
|
|
2329
|
+
* Client id used to select and sign the correct token.
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
clientId?: string | undefined;
|
|
2333
|
+
}
|
|
2334
|
+
/**
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
export interface GetTokenOutput {
|
|
2338
|
+
/**
|
|
2339
|
+
* Authorization token.
|
|
2340
|
+
* @public
|
|
2341
|
+
*/
|
|
2342
|
+
token: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Token expiration time as Unix epoch seconds.
|
|
2345
|
+
* @public
|
|
2346
|
+
*/
|
|
2347
|
+
expires: number;
|
|
2348
|
+
}
|
|
2349
|
+
/**
|
|
2350
|
+
* @public
|
|
2351
|
+
*/
|
|
2352
|
+
export interface GetUploadedFileInfoInput {
|
|
2353
|
+
/**
|
|
2354
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2355
|
+
* @public
|
|
2356
|
+
*/
|
|
2357
|
+
companyId?: string | undefined;
|
|
2358
|
+
/**
|
|
2359
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2360
|
+
* @public
|
|
2361
|
+
*/
|
|
2362
|
+
userId?: string | undefined;
|
|
2363
|
+
channelId: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* File service identifier returned by `UploadFile`.
|
|
2366
|
+
* @public
|
|
2367
|
+
*/
|
|
2368
|
+
fsId: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* File category. Defaults to `channels`.
|
|
2371
|
+
* @public
|
|
2372
|
+
*/
|
|
2373
|
+
category?: FileCategory | undefined;
|
|
2374
|
+
}
|
|
2375
|
+
/**
|
|
2376
|
+
* Metadata for a file uploaded to the channel file store but not yet attached to a message.
|
|
2377
|
+
* @public
|
|
2378
|
+
*/
|
|
2379
|
+
export interface UploadedFileInfo {
|
|
2380
|
+
/**
|
|
2381
|
+
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
2382
|
+
* @public
|
|
2383
|
+
*/
|
|
2384
|
+
fsId: string;
|
|
2385
|
+
/**
|
|
2386
|
+
* MIME type.
|
|
2387
|
+
* @public
|
|
2388
|
+
*/
|
|
2389
|
+
mime?: string | undefined;
|
|
2390
|
+
/**
|
|
2391
|
+
* Original file name.
|
|
2392
|
+
* @public
|
|
2393
|
+
*/
|
|
2394
|
+
name: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* File size in bytes.
|
|
2397
|
+
* @public
|
|
2398
|
+
*/
|
|
2399
|
+
size: number;
|
|
2400
|
+
/**
|
|
2401
|
+
* Image or video width in pixels.
|
|
2402
|
+
* @public
|
|
2403
|
+
*/
|
|
2404
|
+
width?: number | undefined;
|
|
2405
|
+
/**
|
|
2406
|
+
* Image or video height in pixels.
|
|
2407
|
+
* @public
|
|
2408
|
+
*/
|
|
2409
|
+
height?: number | undefined;
|
|
2410
|
+
/**
|
|
2411
|
+
* Thumbnail URL when available.
|
|
2412
|
+
* @public
|
|
2413
|
+
*/
|
|
2414
|
+
thumbnail?: string | undefined;
|
|
2415
|
+
}
|
|
2416
|
+
/**
|
|
2417
|
+
* @public
|
|
2418
|
+
*/
|
|
2419
|
+
export interface GetUploadedFileInfoOutput {
|
|
2420
|
+
/**
|
|
2421
|
+
* Metadata for a file uploaded to the channel file store but not yet attached to a message.
|
|
2422
|
+
* @public
|
|
2423
|
+
*/
|
|
2424
|
+
file: UploadedFileInfo;
|
|
2425
|
+
}
|
|
2426
|
+
/**
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2429
|
+
export interface GetWhatsAppChannelIdInput {
|
|
2430
|
+
/**
|
|
2431
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2432
|
+
* @public
|
|
2433
|
+
*/
|
|
2434
|
+
companyId?: string | undefined;
|
|
2435
|
+
/**
|
|
2436
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2437
|
+
* @public
|
|
2438
|
+
*/
|
|
2439
|
+
userId?: string | undefined;
|
|
2440
|
+
/**
|
|
2441
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2442
|
+
* @public
|
|
2443
|
+
*/
|
|
2444
|
+
serviceUri: string;
|
|
2445
|
+
/**
|
|
2446
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2447
|
+
* @public
|
|
2448
|
+
*/
|
|
2449
|
+
recipientId?: string | undefined;
|
|
2450
|
+
/**
|
|
2451
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2452
|
+
* @public
|
|
2453
|
+
*/
|
|
2454
|
+
recipientNumber?: string | undefined;
|
|
2455
|
+
}
|
|
2456
|
+
/**
|
|
2457
|
+
* @public
|
|
2458
|
+
*/
|
|
2459
|
+
export interface GetWhatsAppChannelIdOutput {
|
|
2460
|
+
channelId: string;
|
|
2461
|
+
}
|
|
2462
|
+
/**
|
|
2463
|
+
* @public
|
|
2464
|
+
* @enum
|
|
2465
|
+
*/
|
|
2466
|
+
export declare const GroupChannelUnsetOptions: {
|
|
2467
|
+
readonly ACCESS: "access";
|
|
2468
|
+
readonly ASSIGNEE: "assignee";
|
|
2469
|
+
readonly BROADCAST: "broadcast";
|
|
2470
|
+
readonly CONTEXT: "context";
|
|
2471
|
+
readonly CONTEXT_EVENTS: "contextEvents";
|
|
2472
|
+
readonly CONTEXT_PTT: "contextPtt";
|
|
2473
|
+
readonly DESCRIPTION: "description";
|
|
2474
|
+
readonly KITE_ASSIGN: "kiteAssign";
|
|
2475
|
+
readonly MMS: "mms";
|
|
2476
|
+
readonly PICTURE: "picture";
|
|
2477
|
+
readonly PICTURE_COLOR: "pictureColor";
|
|
2478
|
+
readonly SERVICE: "service";
|
|
2479
|
+
readonly SERVICE_TITLE: "serviceTitle";
|
|
2480
|
+
readonly SMS: "sms";
|
|
2481
|
+
readonly SUBJECT: "subject";
|
|
2482
|
+
readonly WHATSAPP: "whatsapp";
|
|
2483
|
+
readonly WHATSAPP_STATUS: "whatsappStatus";
|
|
2484
|
+
};
|
|
2485
|
+
/**
|
|
2486
|
+
* @public
|
|
2487
|
+
*/
|
|
2488
|
+
export type GroupChannelUnsetOptions = typeof GroupChannelUnsetOptions[keyof typeof GroupChannelUnsetOptions];
|
|
2489
|
+
/**
|
|
2490
|
+
* @public
|
|
2491
|
+
*/
|
|
2492
|
+
export interface HideChannelInput {
|
|
2493
|
+
/**
|
|
2494
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2495
|
+
* @public
|
|
2496
|
+
*/
|
|
2497
|
+
companyId?: string | undefined;
|
|
2498
|
+
/**
|
|
2499
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2500
|
+
* @public
|
|
2501
|
+
*/
|
|
2502
|
+
userId?: string | undefined;
|
|
2503
|
+
channelId: string;
|
|
2504
|
+
}
|
|
2505
|
+
/**
|
|
2506
|
+
* @public
|
|
2507
|
+
*/
|
|
2508
|
+
export interface HideChannelOutput {
|
|
2509
|
+
}
|
|
2510
|
+
/**
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2513
|
+
export interface JoinChannelInput {
|
|
2514
|
+
/**
|
|
2515
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2518
|
+
companyId?: string | undefined;
|
|
2519
|
+
/**
|
|
2520
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2521
|
+
* @public
|
|
2522
|
+
*/
|
|
2523
|
+
userId?: string | undefined;
|
|
2524
|
+
channelId: string;
|
|
2525
|
+
silent?: boolean | undefined;
|
|
2526
|
+
}
|
|
2527
|
+
/**
|
|
2528
|
+
* @public
|
|
2529
|
+
*/
|
|
2530
|
+
export interface JoinChannelOutput {
|
|
2531
|
+
channel: Channel;
|
|
2532
|
+
}
|
|
2533
|
+
/**
|
|
2534
|
+
* @public
|
|
2535
|
+
*/
|
|
2536
|
+
export interface LeaveChannelInput {
|
|
2537
|
+
/**
|
|
2538
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2539
|
+
* @public
|
|
2540
|
+
*/
|
|
2541
|
+
companyId?: string | undefined;
|
|
2542
|
+
/**
|
|
2543
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
userId?: string | undefined;
|
|
2547
|
+
channelId: string;
|
|
2548
|
+
silent?: boolean | undefined;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* @public
|
|
2552
|
+
*/
|
|
2553
|
+
export interface LeaveChannelOutput {
|
|
2554
|
+
}
|
|
2555
|
+
/**
|
|
2556
|
+
* @public
|
|
2557
|
+
*/
|
|
2558
|
+
export interface ListChannelMembersInput {
|
|
2559
|
+
/**
|
|
2560
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
companyId?: string | undefined;
|
|
2564
|
+
/**
|
|
2565
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2566
|
+
* @public
|
|
2567
|
+
*/
|
|
2568
|
+
userId?: string | undefined;
|
|
2569
|
+
channelId: string;
|
|
2570
|
+
limit?: number | undefined;
|
|
2571
|
+
offset?: number | undefined;
|
|
2572
|
+
}
|
|
2573
|
+
/**
|
|
2574
|
+
* @public
|
|
2575
|
+
*/
|
|
2576
|
+
export interface ListChannelMembersOutput {
|
|
2577
|
+
members: (ChannelMember)[];
|
|
2578
|
+
}
|
|
2579
|
+
/**
|
|
2580
|
+
* @public
|
|
2581
|
+
*/
|
|
2582
|
+
export interface ListChannelMembersReadStatusInput {
|
|
2583
|
+
/**
|
|
2584
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2585
|
+
* @public
|
|
2586
|
+
*/
|
|
2587
|
+
companyId?: string | undefined;
|
|
2588
|
+
/**
|
|
2589
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2590
|
+
* @public
|
|
2591
|
+
*/
|
|
2592
|
+
userId?: string | undefined;
|
|
2593
|
+
channelId: string;
|
|
2594
|
+
}
|
|
2595
|
+
/**
|
|
2596
|
+
* @public
|
|
2597
|
+
*/
|
|
2598
|
+
export interface ListChannelMembersReadStatusOutput {
|
|
2599
|
+
members: (ChannelMemberReadStatus)[];
|
|
2600
|
+
}
|
|
2601
|
+
/**
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
export interface ListChannelsInput {
|
|
2605
|
+
/**
|
|
2606
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2607
|
+
* @public
|
|
2608
|
+
*/
|
|
2609
|
+
companyId?: string | undefined;
|
|
2610
|
+
/**
|
|
2611
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2612
|
+
* @public
|
|
2613
|
+
*/
|
|
2614
|
+
userId?: string | undefined;
|
|
2615
|
+
/**
|
|
2616
|
+
* Section to list. Defaults to `all`.
|
|
2617
|
+
* @public
|
|
2618
|
+
*/
|
|
2619
|
+
section?: string | undefined;
|
|
2620
|
+
/**
|
|
2621
|
+
* Optional refinement applied on top of the section.
|
|
2622
|
+
* @public
|
|
2623
|
+
*/
|
|
2624
|
+
filter?: ChannelsFilter | undefined;
|
|
2625
|
+
/**
|
|
2626
|
+
* Opaque continuation token from the previous response.
|
|
2627
|
+
* @public
|
|
2628
|
+
*/
|
|
2629
|
+
cursor?: string | undefined;
|
|
2630
|
+
}
|
|
2631
|
+
/**
|
|
2632
|
+
* @public
|
|
2633
|
+
*/
|
|
2634
|
+
export interface ListChannelsOutput {
|
|
2635
|
+
/**
|
|
2636
|
+
* Ordered page of channels for the requested section.
|
|
2637
|
+
* @public
|
|
2638
|
+
*/
|
|
2639
|
+
channels: (InboxChannel)[];
|
|
2640
|
+
/**
|
|
2641
|
+
* Cursor for the next page. Absent when there are no more pages.
|
|
2642
|
+
* @public
|
|
2643
|
+
*/
|
|
2644
|
+
nextCursor?: string | undefined;
|
|
2645
|
+
}
|
|
2646
|
+
/**
|
|
2647
|
+
* @public
|
|
2648
|
+
* @enum
|
|
2649
|
+
*/
|
|
2650
|
+
export declare const MentionsFilter: {
|
|
2651
|
+
/**
|
|
2652
|
+
* Unread mentions only.
|
|
2653
|
+
*/
|
|
2654
|
+
readonly UNREAD: "unread";
|
|
2655
|
+
};
|
|
2656
|
+
/**
|
|
2657
|
+
* @public
|
|
2658
|
+
*/
|
|
2659
|
+
export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
|
|
2660
|
+
/**
|
|
2661
|
+
* @public
|
|
2662
|
+
*/
|
|
2663
|
+
export interface ListMentionsInput {
|
|
2664
|
+
/**
|
|
2665
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2666
|
+
* @public
|
|
2667
|
+
*/
|
|
2668
|
+
companyId?: string | undefined;
|
|
2669
|
+
/**
|
|
2670
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2671
|
+
* @public
|
|
2672
|
+
*/
|
|
2673
|
+
userId?: string | undefined;
|
|
2674
|
+
/**
|
|
2675
|
+
* Optional refinement.
|
|
2676
|
+
* @public
|
|
2677
|
+
*/
|
|
2678
|
+
filter?: MentionsFilter | undefined;
|
|
2679
|
+
/**
|
|
2680
|
+
* Opaque continuation token from the previous response.
|
|
2681
|
+
* @public
|
|
2682
|
+
*/
|
|
2683
|
+
cursor?: string | undefined;
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* Compact channel preview returned alongside a mention entry.
|
|
2687
|
+
* @public
|
|
2688
|
+
*/
|
|
2689
|
+
export interface MentionChannelPreview {
|
|
2690
|
+
channelId: string;
|
|
2691
|
+
/**
|
|
2692
|
+
* Type of channel.
|
|
2693
|
+
* @public
|
|
2694
|
+
*/
|
|
2695
|
+
channelType: ChannelType;
|
|
2696
|
+
/**
|
|
2697
|
+
* Channel subject.
|
|
2698
|
+
* @public
|
|
2699
|
+
*/
|
|
2700
|
+
subject?: string | undefined;
|
|
2701
|
+
/**
|
|
2702
|
+
* Channel picture URL.
|
|
2703
|
+
* @public
|
|
2704
|
+
*/
|
|
2705
|
+
picture?: string | undefined;
|
|
2706
|
+
/**
|
|
2707
|
+
* Current number of members.
|
|
2708
|
+
* @public
|
|
2709
|
+
*/
|
|
2710
|
+
memberCount: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* Channel version. Increments on every channel mutation.
|
|
2713
|
+
* @public
|
|
2714
|
+
*/
|
|
2715
|
+
channelVersion: number;
|
|
2716
|
+
/**
|
|
2717
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
2718
|
+
* @public
|
|
2719
|
+
*/
|
|
2720
|
+
lastActivityAt: string;
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* Mention entry. Identifies a message that mentioned the current user, with the user's read state and an embedded copy of the message and its channel.
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
export interface MentionEntry {
|
|
2727
|
+
channelId: string;
|
|
2728
|
+
messageId: string;
|
|
2729
|
+
/**
|
|
2730
|
+
* Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
|
|
217
2731
|
* @public
|
|
218
2732
|
*/
|
|
219
|
-
|
|
2733
|
+
timelineSeq: number;
|
|
220
2734
|
/**
|
|
221
|
-
*
|
|
2735
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
222
2736
|
* @public
|
|
223
2737
|
*/
|
|
224
|
-
|
|
2738
|
+
visibleSeq?: number | undefined;
|
|
225
2739
|
/**
|
|
226
|
-
*
|
|
2740
|
+
* Timestamp at which the mention was recorded.
|
|
227
2741
|
* @public
|
|
228
2742
|
*/
|
|
229
|
-
|
|
2743
|
+
mentionAddedAt: string;
|
|
230
2744
|
/**
|
|
231
|
-
*
|
|
2745
|
+
* True when the user has read this mention.
|
|
232
2746
|
* @public
|
|
233
2747
|
*/
|
|
234
|
-
|
|
2748
|
+
read: boolean;
|
|
235
2749
|
/**
|
|
236
|
-
*
|
|
2750
|
+
* Timestamp at which the mention was read.
|
|
237
2751
|
* @public
|
|
238
2752
|
*/
|
|
239
|
-
|
|
2753
|
+
readAt?: string | undefined;
|
|
240
2754
|
/**
|
|
241
|
-
*
|
|
2755
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
242
2756
|
* @public
|
|
243
2757
|
*/
|
|
244
|
-
|
|
2758
|
+
message: Message;
|
|
245
2759
|
/**
|
|
246
|
-
*
|
|
2760
|
+
* Compact channel preview returned alongside a mention entry.
|
|
247
2761
|
* @public
|
|
248
2762
|
*/
|
|
249
|
-
|
|
2763
|
+
channel: MentionChannelPreview;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* @public
|
|
2767
|
+
*/
|
|
2768
|
+
export interface ListMentionsOutput {
|
|
250
2769
|
/**
|
|
251
|
-
*
|
|
2770
|
+
* Mentions ordered by most recent `mentionAddedAt` first.
|
|
252
2771
|
* @public
|
|
253
2772
|
*/
|
|
254
|
-
|
|
2773
|
+
mentions: (MentionEntry)[];
|
|
255
2774
|
/**
|
|
256
|
-
*
|
|
2775
|
+
* Cursor for the next page. Absent when there are no more pages.
|
|
257
2776
|
* @public
|
|
258
2777
|
*/
|
|
259
|
-
|
|
2778
|
+
nextCursor?: string | undefined;
|
|
2779
|
+
}
|
|
2780
|
+
/**
|
|
2781
|
+
* @public
|
|
2782
|
+
*/
|
|
2783
|
+
export interface ListMessagesInput {
|
|
260
2784
|
/**
|
|
261
|
-
*
|
|
2785
|
+
* The unique identifier of the tenant when a service token is used.
|
|
262
2786
|
* @public
|
|
263
2787
|
*/
|
|
264
|
-
|
|
2788
|
+
companyId?: string | undefined;
|
|
265
2789
|
/**
|
|
266
|
-
*
|
|
2790
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
267
2791
|
* @public
|
|
268
2792
|
*/
|
|
269
|
-
|
|
2793
|
+
userId?: string | undefined;
|
|
2794
|
+
channelId: string;
|
|
270
2795
|
/**
|
|
271
|
-
*
|
|
2796
|
+
* Optional inclusive lower bound on `timelineSeq`. Combine with `to` for a bounded window, or use alone to scroll forward from a known anchor.
|
|
272
2797
|
* @public
|
|
273
2798
|
*/
|
|
274
|
-
|
|
2799
|
+
from?: number | undefined;
|
|
275
2800
|
/**
|
|
276
|
-
*
|
|
2801
|
+
* Optional inclusive upper bound on `timelineSeq`. Combine with `from` for a bounded window, or use alone to scroll back from a known anchor.
|
|
277
2802
|
* @public
|
|
278
2803
|
*/
|
|
279
|
-
|
|
2804
|
+
to?: number | undefined;
|
|
2805
|
+
}
|
|
2806
|
+
/**
|
|
2807
|
+
* @public
|
|
2808
|
+
*/
|
|
2809
|
+
export interface ListMessagesOutput {
|
|
280
2810
|
/**
|
|
281
|
-
*
|
|
2811
|
+
* Messages ordered newest-first by `timelineSeq`.
|
|
282
2812
|
* @public
|
|
283
2813
|
*/
|
|
284
|
-
|
|
2814
|
+
messages: (Message)[];
|
|
2815
|
+
}
|
|
2816
|
+
/**
|
|
2817
|
+
* @public
|
|
2818
|
+
*/
|
|
2819
|
+
export interface MarkReadInput {
|
|
285
2820
|
/**
|
|
286
|
-
*
|
|
2821
|
+
* The unique identifier of the tenant when a service token is used.
|
|
287
2822
|
* @public
|
|
288
2823
|
*/
|
|
289
|
-
|
|
2824
|
+
companyId?: string | undefined;
|
|
290
2825
|
/**
|
|
291
|
-
*
|
|
2826
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
292
2827
|
* @public
|
|
293
2828
|
*/
|
|
294
|
-
|
|
2829
|
+
userId?: string | undefined;
|
|
2830
|
+
channelId: string;
|
|
295
2831
|
/**
|
|
296
|
-
*
|
|
2832
|
+
* Optional explicit read pointer. Defaults to the latest visible message.
|
|
297
2833
|
* @public
|
|
298
2834
|
*/
|
|
299
|
-
|
|
2835
|
+
lastReadVisibleSeq?: number | undefined;
|
|
300
2836
|
}
|
|
301
2837
|
/**
|
|
302
2838
|
* @public
|
|
303
2839
|
*/
|
|
304
|
-
export interface
|
|
2840
|
+
export interface MarkReadOutput {
|
|
305
2841
|
/**
|
|
306
|
-
*
|
|
2842
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
307
2843
|
* @public
|
|
308
2844
|
*/
|
|
309
|
-
|
|
2845
|
+
inbox: InboxState;
|
|
310
2846
|
}
|
|
311
2847
|
/**
|
|
312
2848
|
* @public
|
|
313
2849
|
*/
|
|
314
|
-
export declare class
|
|
315
|
-
readonly name: "
|
|
2850
|
+
export declare class MarkUnreadChannelsLimitReachedException extends __BaseException {
|
|
2851
|
+
readonly name: "MarkUnreadChannelsLimitReachedException";
|
|
316
2852
|
readonly $fault: "client";
|
|
317
2853
|
/**
|
|
318
2854
|
* @internal
|
|
319
2855
|
*/
|
|
320
|
-
constructor(opts: __ExceptionOptionType<
|
|
2856
|
+
constructor(opts: __ExceptionOptionType<MarkUnreadChannelsLimitReachedException, __BaseException>);
|
|
321
2857
|
}
|
|
322
2858
|
/**
|
|
323
2859
|
* @public
|
|
324
2860
|
*/
|
|
325
|
-
export
|
|
326
|
-
readonly name: "MessageNotFoundException";
|
|
327
|
-
readonly $fault: "client";
|
|
2861
|
+
export interface MarkUnreadInput {
|
|
328
2862
|
/**
|
|
329
|
-
*
|
|
2863
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2864
|
+
* @public
|
|
330
2865
|
*/
|
|
331
|
-
|
|
2866
|
+
companyId?: string | undefined;
|
|
2867
|
+
/**
|
|
2868
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
userId?: string | undefined;
|
|
2872
|
+
channelId: string;
|
|
2873
|
+
/**
|
|
2874
|
+
* Message id used to resolve the unread mark position.
|
|
2875
|
+
* @public
|
|
2876
|
+
*/
|
|
2877
|
+
messageId?: string | undefined;
|
|
2878
|
+
/**
|
|
2879
|
+
* Explicit unread mark position. Takes precedence over `messageId` when both are supplied.
|
|
2880
|
+
* @public
|
|
2881
|
+
*/
|
|
2882
|
+
unreadMarkAt?: number | undefined;
|
|
2883
|
+
/**
|
|
2884
|
+
* Replace the oldest unread mark when the per-user limit is reached.
|
|
2885
|
+
* @public
|
|
2886
|
+
*/
|
|
2887
|
+
force?: boolean | undefined;
|
|
332
2888
|
}
|
|
333
2889
|
/**
|
|
334
2890
|
* @public
|
|
335
|
-
* @enum
|
|
336
2891
|
*/
|
|
337
|
-
export
|
|
2892
|
+
export interface MarkUnreadOutput {
|
|
338
2893
|
/**
|
|
339
|
-
*
|
|
340
|
-
|
|
341
|
-
readonly ARCHIVED: "archived";
|
|
342
|
-
/**
|
|
343
|
-
* Non-archived channels with at least one unread message.
|
|
2894
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2895
|
+
* @public
|
|
344
2896
|
*/
|
|
345
|
-
|
|
2897
|
+
inbox: InboxState;
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
* @public
|
|
2901
|
+
* @enum
|
|
2902
|
+
*/
|
|
2903
|
+
export declare const MessageUnsetFields: {
|
|
2904
|
+
readonly ATTACHMENTS: "attachments";
|
|
2905
|
+
readonly ELEMENTS: "elements";
|
|
2906
|
+
readonly FORWARD: "forward";
|
|
2907
|
+
readonly MARKDOWN: "markdown";
|
|
2908
|
+
readonly MENTIONS: "mentions";
|
|
2909
|
+
readonly QUOTE: "quote";
|
|
2910
|
+
readonly SMS: "sms";
|
|
2911
|
+
readonly SMS_STATUS: "smsStatus";
|
|
2912
|
+
readonly TEXT: "text";
|
|
2913
|
+
readonly WHATSAPP: "whatsapp";
|
|
2914
|
+
readonly WHATSAPP_STATUS: "whatsappStatus";
|
|
346
2915
|
};
|
|
347
2916
|
/**
|
|
348
2917
|
* @public
|
|
349
2918
|
*/
|
|
350
|
-
export type
|
|
2919
|
+
export type MessageUnsetFields = typeof MessageUnsetFields[keyof typeof MessageUnsetFields];
|
|
351
2920
|
/**
|
|
352
2921
|
* @public
|
|
353
|
-
* @enum
|
|
354
2922
|
*/
|
|
355
|
-
export
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
2923
|
+
export interface MoveChannelToSectionInput {
|
|
2924
|
+
/**
|
|
2925
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2926
|
+
* @public
|
|
2927
|
+
*/
|
|
2928
|
+
companyId?: string | undefined;
|
|
2929
|
+
/**
|
|
2930
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2931
|
+
* @public
|
|
2932
|
+
*/
|
|
2933
|
+
userId?: string | undefined;
|
|
2934
|
+
channelId: string;
|
|
2935
|
+
/**
|
|
2936
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
2937
|
+
* @public
|
|
2938
|
+
*/
|
|
2939
|
+
sectionId: string;
|
|
2940
|
+
}
|
|
360
2941
|
/**
|
|
361
2942
|
* @public
|
|
362
2943
|
*/
|
|
363
|
-
export
|
|
2944
|
+
export interface MoveChannelToSectionOutput {
|
|
2945
|
+
/**
|
|
2946
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2947
|
+
* @public
|
|
2948
|
+
*/
|
|
2949
|
+
inbox: InboxState;
|
|
2950
|
+
}
|
|
364
2951
|
/**
|
|
2952
|
+
* System message emitted when multiple members join a channel.
|
|
365
2953
|
* @public
|
|
366
2954
|
*/
|
|
367
|
-
export interface
|
|
2955
|
+
export interface MultipleMembersJoinedSystemMessage {
|
|
2956
|
+
addedMembers: (string)[];
|
|
2957
|
+
}
|
|
2958
|
+
/**
|
|
2959
|
+
* @public
|
|
2960
|
+
*/
|
|
2961
|
+
export interface MuteChannelInput {
|
|
368
2962
|
/**
|
|
369
2963
|
* The unique identifier of the tenant when a service token is used.
|
|
370
2964
|
* @public
|
|
@@ -376,100 +2970,108 @@ export interface DeleteMessageInput {
|
|
|
376
2970
|
*/
|
|
377
2971
|
userId?: string | undefined;
|
|
378
2972
|
channelId: string;
|
|
379
|
-
|
|
2973
|
+
/**
|
|
2974
|
+
* Temporary mute expiry. Omit for indefinite mute.
|
|
2975
|
+
* @public
|
|
2976
|
+
*/
|
|
2977
|
+
mutedUntil?: string | undefined;
|
|
380
2978
|
}
|
|
381
2979
|
/**
|
|
382
2980
|
* @public
|
|
383
2981
|
*/
|
|
384
|
-
export interface
|
|
2982
|
+
export interface MuteChannelOutput {
|
|
2983
|
+
/**
|
|
2984
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2985
|
+
* @public
|
|
2986
|
+
*/
|
|
2987
|
+
inbox: InboxState;
|
|
385
2988
|
}
|
|
386
2989
|
/**
|
|
387
|
-
* Attachment record supplied by the client when sending or editing a message. The server assigns the attachment `id` after persistence.
|
|
388
2990
|
* @public
|
|
389
2991
|
*/
|
|
390
|
-
export interface
|
|
2992
|
+
export interface PartialUpdateChannelSetOptions {
|
|
391
2993
|
/**
|
|
392
|
-
*
|
|
2994
|
+
* The subject of the channel.
|
|
393
2995
|
* @public
|
|
394
2996
|
*/
|
|
395
|
-
|
|
2997
|
+
subject?: string | undefined;
|
|
396
2998
|
/**
|
|
397
|
-
*
|
|
2999
|
+
* The description of the channel.
|
|
398
3000
|
* @public
|
|
399
3001
|
*/
|
|
400
|
-
|
|
3002
|
+
description?: string | undefined;
|
|
401
3003
|
/**
|
|
402
|
-
*
|
|
3004
|
+
* The URL of the channel's picture.
|
|
403
3005
|
* @public
|
|
404
3006
|
*/
|
|
405
|
-
|
|
3007
|
+
picture?: string | undefined;
|
|
406
3008
|
/**
|
|
407
|
-
*
|
|
3009
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
408
3010
|
* @public
|
|
409
3011
|
*/
|
|
410
|
-
|
|
3012
|
+
pictureColor?: string | undefined;
|
|
411
3013
|
/**
|
|
412
|
-
*
|
|
3014
|
+
* Channel access level.
|
|
413
3015
|
* @public
|
|
414
3016
|
*/
|
|
415
|
-
|
|
3017
|
+
access?: ChannelAccess | undefined;
|
|
416
3018
|
/**
|
|
417
|
-
*
|
|
3019
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
418
3020
|
* @public
|
|
419
3021
|
*/
|
|
420
|
-
|
|
3022
|
+
broadcast?: boolean | undefined;
|
|
3023
|
+
context?: ChannelContext | undefined;
|
|
3024
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
421
3025
|
/**
|
|
422
|
-
*
|
|
3026
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
423
3027
|
* @public
|
|
424
3028
|
*/
|
|
425
|
-
|
|
426
|
-
}
|
|
427
|
-
/**
|
|
428
|
-
* @public
|
|
429
|
-
*/
|
|
430
|
-
export interface EditMessageInput {
|
|
3029
|
+
sms?: boolean | undefined;
|
|
431
3030
|
/**
|
|
432
|
-
*
|
|
3031
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
433
3032
|
* @public
|
|
434
3033
|
*/
|
|
435
|
-
|
|
3034
|
+
mms?: boolean | undefined;
|
|
436
3035
|
/**
|
|
437
|
-
*
|
|
3036
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
438
3037
|
* @public
|
|
439
3038
|
*/
|
|
440
|
-
|
|
441
|
-
channelId: string;
|
|
442
|
-
messageId: string;
|
|
3039
|
+
whatsapp?: boolean | undefined;
|
|
443
3040
|
/**
|
|
444
|
-
*
|
|
3041
|
+
* The unique identifier of the assignee.
|
|
445
3042
|
* @public
|
|
446
3043
|
*/
|
|
447
|
-
|
|
3044
|
+
kiteAssign?: string | undefined;
|
|
448
3045
|
/**
|
|
449
|
-
*
|
|
3046
|
+
* The title of the service.
|
|
450
3047
|
* @public
|
|
451
3048
|
*/
|
|
452
|
-
|
|
3049
|
+
serviceTitle?: string | undefined;
|
|
453
3050
|
/**
|
|
454
|
-
*
|
|
3051
|
+
* Assignee user id.
|
|
455
3052
|
* @public
|
|
456
3053
|
*/
|
|
457
|
-
|
|
458
|
-
}
|
|
459
|
-
/**
|
|
460
|
-
* @public
|
|
461
|
-
*/
|
|
462
|
-
export interface EditMessageOutput {
|
|
3054
|
+
assigneeId?: string | undefined;
|
|
463
3055
|
/**
|
|
464
|
-
*
|
|
3056
|
+
* Indicates if the channel supports auto start recording.
|
|
465
3057
|
* @public
|
|
466
3058
|
*/
|
|
467
|
-
|
|
3059
|
+
autoRecord?: boolean | undefined;
|
|
3060
|
+
/**
|
|
3061
|
+
* Transcription language.
|
|
3062
|
+
* @public
|
|
3063
|
+
*/
|
|
3064
|
+
transcriptionLanguage?: string | undefined;
|
|
3065
|
+
/**
|
|
3066
|
+
* Indicates if external users in this conversation can only join the conference as a viewer with the ability to speak by request. Default is false.
|
|
3067
|
+
* @public
|
|
3068
|
+
*/
|
|
3069
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
468
3070
|
}
|
|
469
3071
|
/**
|
|
470
3072
|
* @public
|
|
471
3073
|
*/
|
|
472
|
-
export interface
|
|
3074
|
+
export interface PartialUpdateChannelInput {
|
|
473
3075
|
/**
|
|
474
3076
|
* The unique identifier of the tenant when a service token is used.
|
|
475
3077
|
* @public
|
|
@@ -480,236 +3082,263 @@ export interface GetInboxInput {
|
|
|
480
3082
|
* @public
|
|
481
3083
|
*/
|
|
482
3084
|
userId?: string | undefined;
|
|
3085
|
+
channelId: string;
|
|
3086
|
+
silent?: boolean | undefined;
|
|
3087
|
+
set?: PartialUpdateChannelSetOptions | undefined;
|
|
3088
|
+
unset?: (GroupChannelUnsetOptions)[] | undefined;
|
|
483
3089
|
}
|
|
484
3090
|
/**
|
|
485
|
-
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
486
3091
|
* @public
|
|
487
3092
|
*/
|
|
488
|
-
export interface
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
* Number of unread visible messages.
|
|
496
|
-
* @public
|
|
497
|
-
*/
|
|
498
|
-
unreadCount: number;
|
|
499
|
-
/**
|
|
500
|
-
* Number of unread mentions of the current user.
|
|
501
|
-
* @public
|
|
502
|
-
*/
|
|
503
|
-
mentionUnreadCount: number;
|
|
3093
|
+
export interface PartialUpdateChannelOutput {
|
|
3094
|
+
channel: Channel;
|
|
3095
|
+
}
|
|
3096
|
+
/**
|
|
3097
|
+
* @public
|
|
3098
|
+
*/
|
|
3099
|
+
export interface PartialUpdateMessageSetInput {
|
|
504
3100
|
/**
|
|
505
|
-
*
|
|
3101
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
506
3102
|
* @public
|
|
507
3103
|
*/
|
|
508
|
-
|
|
3104
|
+
text?: string | undefined;
|
|
509
3105
|
/**
|
|
510
|
-
*
|
|
3106
|
+
* Structured rich content blocks.
|
|
511
3107
|
* @public
|
|
512
3108
|
*/
|
|
513
|
-
|
|
3109
|
+
elements?: (Element)[] | undefined;
|
|
514
3110
|
/**
|
|
515
|
-
*
|
|
3111
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
516
3112
|
* @public
|
|
517
3113
|
*/
|
|
518
|
-
|
|
3114
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
519
3115
|
/**
|
|
520
|
-
*
|
|
3116
|
+
* Reply context referencing a quoted message.
|
|
521
3117
|
* @public
|
|
522
3118
|
*/
|
|
523
|
-
|
|
3119
|
+
quote?: MessageQuoteRef | undefined;
|
|
524
3120
|
/**
|
|
525
|
-
*
|
|
3121
|
+
* Source reference for a forwarded message.
|
|
526
3122
|
* @public
|
|
527
3123
|
*/
|
|
528
|
-
|
|
3124
|
+
forward?: MessageForwardRef | undefined;
|
|
529
3125
|
/**
|
|
530
|
-
*
|
|
3126
|
+
* When true, the message body is interpreted as Markdown.
|
|
531
3127
|
* @public
|
|
532
3128
|
*/
|
|
533
|
-
|
|
534
|
-
}
|
|
535
|
-
/**
|
|
536
|
-
* Preview of the most recent visible message in a channel.
|
|
537
|
-
* @public
|
|
538
|
-
*/
|
|
539
|
-
export interface LastMessagePreview {
|
|
540
|
-
messageId: string;
|
|
3129
|
+
markdown?: boolean | undefined;
|
|
541
3130
|
/**
|
|
542
|
-
*
|
|
3131
|
+
* Direct `@user` ids.
|
|
543
3132
|
* @public
|
|
544
3133
|
*/
|
|
545
|
-
|
|
3134
|
+
mentions?: (string)[] | undefined;
|
|
546
3135
|
/**
|
|
547
|
-
*
|
|
3136
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
548
3137
|
* @public
|
|
549
3138
|
*/
|
|
550
|
-
|
|
3139
|
+
whatsapp?: boolean | undefined;
|
|
3140
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
551
3141
|
/**
|
|
552
|
-
*
|
|
3142
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
553
3143
|
* @public
|
|
554
3144
|
*/
|
|
555
|
-
|
|
3145
|
+
sms?: boolean | undefined;
|
|
3146
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
556
3147
|
}
|
|
557
3148
|
/**
|
|
558
|
-
* Channel item returned by inbox and channel listings. Includes per-user inbox state and last-message preview.
|
|
559
3149
|
* @public
|
|
560
3150
|
*/
|
|
561
|
-
export interface
|
|
562
|
-
channelId: string;
|
|
3151
|
+
export interface PartialUpdateMessageInput {
|
|
563
3152
|
/**
|
|
564
|
-
*
|
|
3153
|
+
* The unique identifier of the tenant when a service token is used.
|
|
565
3154
|
* @public
|
|
566
3155
|
*/
|
|
567
|
-
|
|
3156
|
+
companyId?: string | undefined;
|
|
568
3157
|
/**
|
|
569
|
-
*
|
|
3158
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
570
3159
|
* @public
|
|
571
3160
|
*/
|
|
572
|
-
|
|
3161
|
+
userId?: string | undefined;
|
|
3162
|
+
channelId: string;
|
|
3163
|
+
messageId: string;
|
|
573
3164
|
/**
|
|
574
|
-
*
|
|
3165
|
+
* Fields to set during the partial update.
|
|
575
3166
|
* @public
|
|
576
3167
|
*/
|
|
577
|
-
|
|
3168
|
+
set?: PartialUpdateMessageSetInput | undefined;
|
|
578
3169
|
/**
|
|
579
|
-
*
|
|
3170
|
+
* Fields to clear during the partial update.
|
|
580
3171
|
* @public
|
|
581
3172
|
*/
|
|
582
|
-
|
|
3173
|
+
unset?: (MessageUnsetFields)[] | undefined;
|
|
583
3174
|
/**
|
|
584
|
-
*
|
|
3175
|
+
* Suppress the updated indicator for this edit.
|
|
585
3176
|
* @public
|
|
586
3177
|
*/
|
|
587
|
-
|
|
3178
|
+
silent?: boolean | undefined;
|
|
3179
|
+
}
|
|
3180
|
+
/**
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
export interface PartialUpdateMessageOutput {
|
|
588
3184
|
/**
|
|
589
|
-
*
|
|
3185
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
590
3186
|
* @public
|
|
591
3187
|
*/
|
|
592
|
-
|
|
3188
|
+
message: Message;
|
|
3189
|
+
}
|
|
3190
|
+
/**
|
|
3191
|
+
* @public
|
|
3192
|
+
*/
|
|
3193
|
+
export interface PinChannelInput {
|
|
593
3194
|
/**
|
|
594
|
-
*
|
|
3195
|
+
* The unique identifier of the tenant when a service token is used.
|
|
595
3196
|
* @public
|
|
596
3197
|
*/
|
|
597
|
-
|
|
3198
|
+
companyId?: string | undefined;
|
|
598
3199
|
/**
|
|
599
|
-
*
|
|
3200
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
600
3201
|
* @public
|
|
601
3202
|
*/
|
|
602
|
-
|
|
3203
|
+
userId?: string | undefined;
|
|
3204
|
+
channelId: string;
|
|
3205
|
+
force?: boolean | undefined;
|
|
3206
|
+
}
|
|
3207
|
+
/**
|
|
3208
|
+
* @public
|
|
3209
|
+
*/
|
|
3210
|
+
export interface PinChannelOutput {
|
|
3211
|
+
}
|
|
3212
|
+
/**
|
|
3213
|
+
* @public
|
|
3214
|
+
*/
|
|
3215
|
+
export declare class PinnedChannelsLimitReachedException extends __BaseException {
|
|
3216
|
+
readonly name: "PinnedChannelsLimitReachedException";
|
|
3217
|
+
readonly $fault: "client";
|
|
603
3218
|
/**
|
|
604
|
-
*
|
|
3219
|
+
* @internal
|
|
3220
|
+
*/
|
|
3221
|
+
constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
|
|
3222
|
+
}
|
|
3223
|
+
/**
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
export interface PinMessageInput {
|
|
3227
|
+
/**
|
|
3228
|
+
* The unique identifier of the tenant when a service token is used.
|
|
605
3229
|
* @public
|
|
606
3230
|
*/
|
|
607
|
-
|
|
3231
|
+
companyId?: string | undefined;
|
|
608
3232
|
/**
|
|
609
|
-
*
|
|
3233
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
610
3234
|
* @public
|
|
611
3235
|
*/
|
|
612
|
-
|
|
3236
|
+
userId?: string | undefined;
|
|
3237
|
+
channelId: string;
|
|
3238
|
+
messageId: string;
|
|
3239
|
+
}
|
|
3240
|
+
/**
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
export interface PinMessageOutput {
|
|
613
3244
|
/**
|
|
614
|
-
*
|
|
3245
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
615
3246
|
* @public
|
|
616
3247
|
*/
|
|
617
|
-
|
|
3248
|
+
message: Message;
|
|
618
3249
|
}
|
|
619
3250
|
/**
|
|
620
3251
|
* @public
|
|
621
|
-
* @enum
|
|
622
3252
|
*/
|
|
623
|
-
export
|
|
3253
|
+
export interface QueryChannelsInput {
|
|
624
3254
|
/**
|
|
625
|
-
*
|
|
3255
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3256
|
+
* @public
|
|
626
3257
|
*/
|
|
627
|
-
|
|
3258
|
+
companyId?: string | undefined;
|
|
628
3259
|
/**
|
|
629
|
-
*
|
|
3260
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3261
|
+
* @public
|
|
630
3262
|
*/
|
|
631
|
-
|
|
632
|
-
|
|
3263
|
+
userId?: string | undefined;
|
|
3264
|
+
/**
|
|
3265
|
+
* Batch channel lookup query.
|
|
3266
|
+
* @public
|
|
3267
|
+
*/
|
|
3268
|
+
query: ChannelsQuery;
|
|
3269
|
+
}
|
|
633
3270
|
/**
|
|
634
3271
|
* @public
|
|
635
3272
|
*/
|
|
636
|
-
export
|
|
3273
|
+
export interface QueryChannelsOutput {
|
|
3274
|
+
channels: (InboxChannel)[];
|
|
3275
|
+
}
|
|
637
3276
|
/**
|
|
638
|
-
* Aggregated unread counters for an inbox section.
|
|
639
3277
|
* @public
|
|
640
3278
|
*/
|
|
641
|
-
export interface
|
|
642
|
-
/**
|
|
643
|
-
* Unmuted channels with at least one unread message.
|
|
644
|
-
* @public
|
|
645
|
-
*/
|
|
646
|
-
unmutedUnreadChannelCount: number;
|
|
3279
|
+
export interface RemoveChannelFromSectionInput {
|
|
647
3280
|
/**
|
|
648
|
-
*
|
|
3281
|
+
* The unique identifier of the tenant when a service token is used.
|
|
649
3282
|
* @public
|
|
650
3283
|
*/
|
|
651
|
-
|
|
3284
|
+
companyId?: string | undefined;
|
|
652
3285
|
/**
|
|
653
|
-
*
|
|
3286
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
654
3287
|
* @public
|
|
655
3288
|
*/
|
|
656
|
-
|
|
3289
|
+
userId?: string | undefined;
|
|
3290
|
+
channelId: string;
|
|
657
3291
|
/**
|
|
658
|
-
*
|
|
3292
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
659
3293
|
* @public
|
|
660
3294
|
*/
|
|
661
|
-
|
|
3295
|
+
sectionId: string;
|
|
662
3296
|
}
|
|
663
3297
|
/**
|
|
664
|
-
* Inbox section with metadata, channel count, and unread counters.
|
|
665
3298
|
* @public
|
|
666
3299
|
*/
|
|
667
|
-
export interface
|
|
668
|
-
/**
|
|
669
|
-
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
670
|
-
* @public
|
|
671
|
-
*/
|
|
672
|
-
sectionId: string;
|
|
3300
|
+
export interface RemoveChannelFromSectionOutput {
|
|
673
3301
|
/**
|
|
674
|
-
*
|
|
3302
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
675
3303
|
* @public
|
|
676
3304
|
*/
|
|
677
|
-
|
|
3305
|
+
inbox: InboxState;
|
|
3306
|
+
}
|
|
3307
|
+
/**
|
|
3308
|
+
* @public
|
|
3309
|
+
*/
|
|
3310
|
+
export interface RenameSectionInput {
|
|
678
3311
|
/**
|
|
679
|
-
*
|
|
3312
|
+
* The unique identifier of the tenant when a service token is used.
|
|
680
3313
|
* @public
|
|
681
3314
|
*/
|
|
682
|
-
|
|
3315
|
+
companyId?: string | undefined;
|
|
683
3316
|
/**
|
|
684
|
-
*
|
|
3317
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
685
3318
|
* @public
|
|
686
3319
|
*/
|
|
687
|
-
|
|
3320
|
+
userId?: string | undefined;
|
|
688
3321
|
/**
|
|
689
|
-
*
|
|
3322
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
690
3323
|
* @public
|
|
691
3324
|
*/
|
|
692
|
-
|
|
3325
|
+
sectionId: string;
|
|
3326
|
+
name: string;
|
|
693
3327
|
}
|
|
694
3328
|
/**
|
|
695
3329
|
* @public
|
|
696
3330
|
*/
|
|
697
|
-
export interface
|
|
3331
|
+
export interface RenameSectionOutput {
|
|
698
3332
|
/**
|
|
699
|
-
*
|
|
700
|
-
* @public
|
|
701
|
-
*/
|
|
702
|
-
channels: (InboxChannel)[];
|
|
703
|
-
/**
|
|
704
|
-
* Inbox sections with channel counts and unread counters.
|
|
3333
|
+
* Inbox section with metadata, channel count, and unread counters.
|
|
705
3334
|
* @public
|
|
706
3335
|
*/
|
|
707
|
-
|
|
3336
|
+
section: Section;
|
|
708
3337
|
}
|
|
709
3338
|
/**
|
|
710
3339
|
* @public
|
|
711
3340
|
*/
|
|
712
|
-
export interface
|
|
3341
|
+
export interface SendGiphyInput {
|
|
713
3342
|
/**
|
|
714
3343
|
* The unique identifier of the tenant when a service token is used.
|
|
715
3344
|
* @public
|
|
@@ -721,12 +3350,32 @@ export interface GetMessageInput {
|
|
|
721
3350
|
*/
|
|
722
3351
|
userId?: string | undefined;
|
|
723
3352
|
channelId: string;
|
|
724
|
-
|
|
3353
|
+
/**
|
|
3354
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
3355
|
+
* @public
|
|
3356
|
+
*/
|
|
3357
|
+
messageId?: string | undefined;
|
|
3358
|
+
giphy: MessageGiphy;
|
|
3359
|
+
/**
|
|
3360
|
+
* Direct `@user` ids.
|
|
3361
|
+
* @public
|
|
3362
|
+
*/
|
|
3363
|
+
mentions?: (string)[] | undefined;
|
|
3364
|
+
/**
|
|
3365
|
+
* Reply context referencing a quoted message.
|
|
3366
|
+
* @public
|
|
3367
|
+
*/
|
|
3368
|
+
quote?: MessageQuoteRef | undefined;
|
|
3369
|
+
/**
|
|
3370
|
+
* Suppress push notifications and unread indicators.
|
|
3371
|
+
* @public
|
|
3372
|
+
*/
|
|
3373
|
+
silent?: boolean | undefined;
|
|
725
3374
|
}
|
|
726
3375
|
/**
|
|
727
3376
|
* @public
|
|
728
3377
|
*/
|
|
729
|
-
export interface
|
|
3378
|
+
export interface SendGiphyOutput {
|
|
730
3379
|
/**
|
|
731
3380
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
732
3381
|
* @public
|
|
@@ -736,7 +3385,7 @@ export interface GetMessageOutput {
|
|
|
736
3385
|
/**
|
|
737
3386
|
* @public
|
|
738
3387
|
*/
|
|
739
|
-
export interface
|
|
3388
|
+
export interface SendMessageInput {
|
|
740
3389
|
/**
|
|
741
3390
|
* The unique identifier of the tenant when a service token is used.
|
|
742
3391
|
* @public
|
|
@@ -748,54 +3397,83 @@ export interface ListChannelsInput {
|
|
|
748
3397
|
*/
|
|
749
3398
|
userId?: string | undefined;
|
|
750
3399
|
/**
|
|
751
|
-
*
|
|
3400
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
752
3401
|
* @public
|
|
753
3402
|
*/
|
|
754
|
-
|
|
3403
|
+
text?: string | undefined;
|
|
755
3404
|
/**
|
|
756
|
-
*
|
|
3405
|
+
* Structured rich content blocks.
|
|
757
3406
|
* @public
|
|
758
3407
|
*/
|
|
759
|
-
|
|
3408
|
+
elements?: (Element)[] | undefined;
|
|
760
3409
|
/**
|
|
761
|
-
*
|
|
3410
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
762
3411
|
* @public
|
|
763
3412
|
*/
|
|
764
|
-
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* @public
|
|
768
|
-
*/
|
|
769
|
-
export interface ListChannelsOutput {
|
|
3413
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
770
3414
|
/**
|
|
771
|
-
*
|
|
3415
|
+
* Reply context referencing a quoted message.
|
|
772
3416
|
* @public
|
|
773
3417
|
*/
|
|
774
|
-
|
|
3418
|
+
quote?: MessageQuoteRef | undefined;
|
|
775
3419
|
/**
|
|
776
|
-
*
|
|
3420
|
+
* Source reference for a forwarded message.
|
|
777
3421
|
* @public
|
|
778
3422
|
*/
|
|
779
|
-
|
|
3423
|
+
forward?: MessageForwardRef | undefined;
|
|
3424
|
+
/**
|
|
3425
|
+
* When true, the message body is interpreted as Markdown.
|
|
3426
|
+
* @public
|
|
3427
|
+
*/
|
|
3428
|
+
markdown?: boolean | undefined;
|
|
3429
|
+
/**
|
|
3430
|
+
* Suppress push notifications and unread indicators.
|
|
3431
|
+
* @public
|
|
3432
|
+
*/
|
|
3433
|
+
silent?: boolean | undefined;
|
|
3434
|
+
/**
|
|
3435
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
3436
|
+
* @public
|
|
3437
|
+
*/
|
|
3438
|
+
whatsapp?: boolean | undefined;
|
|
3439
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
3440
|
+
/**
|
|
3441
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
3442
|
+
* @public
|
|
3443
|
+
*/
|
|
3444
|
+
sms?: boolean | undefined;
|
|
3445
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
3446
|
+
/**
|
|
3447
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
3448
|
+
* @public
|
|
3449
|
+
*/
|
|
3450
|
+
messageId?: string | undefined;
|
|
3451
|
+
/**
|
|
3452
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
3453
|
+
* @public
|
|
3454
|
+
*/
|
|
3455
|
+
mentions?: (string)[] | undefined;
|
|
3456
|
+
channelId: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* Rendering hint for the message.
|
|
3459
|
+
* @public
|
|
3460
|
+
*/
|
|
3461
|
+
messageType?: MessageType | undefined;
|
|
780
3462
|
}
|
|
781
3463
|
/**
|
|
782
3464
|
* @public
|
|
783
|
-
* @enum
|
|
784
3465
|
*/
|
|
785
|
-
export
|
|
3466
|
+
export interface SendMessageOutput {
|
|
786
3467
|
/**
|
|
787
|
-
*
|
|
3468
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
3469
|
+
* @public
|
|
788
3470
|
*/
|
|
789
|
-
|
|
790
|
-
}
|
|
791
|
-
/**
|
|
792
|
-
* @public
|
|
793
|
-
*/
|
|
794
|
-
export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
|
|
3471
|
+
message: Message;
|
|
3472
|
+
}
|
|
795
3473
|
/**
|
|
796
3474
|
* @public
|
|
797
3475
|
*/
|
|
798
|
-
export interface
|
|
3476
|
+
export interface SendMessageReactionInput {
|
|
799
3477
|
/**
|
|
800
3478
|
* The unique identifier of the tenant when a service token is used.
|
|
801
3479
|
* @public
|
|
@@ -806,116 +3484,159 @@ export interface ListMentionsInput {
|
|
|
806
3484
|
* @public
|
|
807
3485
|
*/
|
|
808
3486
|
userId?: string | undefined;
|
|
3487
|
+
channelId: string;
|
|
3488
|
+
messageId: string;
|
|
809
3489
|
/**
|
|
810
|
-
*
|
|
811
|
-
* @public
|
|
812
|
-
*/
|
|
813
|
-
filter?: MentionsFilter | undefined;
|
|
814
|
-
/**
|
|
815
|
-
* Opaque continuation token from the previous response.
|
|
3490
|
+
* Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
|
|
816
3491
|
* @public
|
|
817
3492
|
*/
|
|
818
|
-
|
|
3493
|
+
type: string;
|
|
819
3494
|
}
|
|
820
3495
|
/**
|
|
821
|
-
* Compact channel preview returned alongside a mention entry.
|
|
822
3496
|
* @public
|
|
823
3497
|
*/
|
|
824
|
-
export interface
|
|
825
|
-
channelId: string;
|
|
826
|
-
/**
|
|
827
|
-
* Type of channel.
|
|
828
|
-
* @public
|
|
829
|
-
*/
|
|
830
|
-
channelType: ChannelType;
|
|
831
|
-
/**
|
|
832
|
-
* Channel subject.
|
|
833
|
-
* @public
|
|
834
|
-
*/
|
|
835
|
-
subject?: string | undefined;
|
|
3498
|
+
export interface SendMessageReactionOutput {
|
|
836
3499
|
/**
|
|
837
|
-
*
|
|
3500
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
838
3501
|
* @public
|
|
839
3502
|
*/
|
|
840
|
-
|
|
3503
|
+
message: Message;
|
|
3504
|
+
}
|
|
3505
|
+
/**
|
|
3506
|
+
* Empty payload for the WhatsApp 24-hour window closed system message.
|
|
3507
|
+
* @public
|
|
3508
|
+
*/
|
|
3509
|
+
export interface WhatsAppClosedSystemMessage {
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
* Typed system message payload. Each variant maps to a server-generated message template.
|
|
3513
|
+
* @public
|
|
3514
|
+
*/
|
|
3515
|
+
export type SystemMessage = SystemMessage.MultipleMembersJoinedMember | SystemMessage.WhatsAppClosedMember | SystemMessage.$UnknownMember;
|
|
3516
|
+
/**
|
|
3517
|
+
* @public
|
|
3518
|
+
*/
|
|
3519
|
+
export declare namespace SystemMessage {
|
|
841
3520
|
/**
|
|
842
|
-
*
|
|
3521
|
+
* WhatsApp channel closed after the 24-hour reply window.
|
|
843
3522
|
* @public
|
|
844
3523
|
*/
|
|
845
|
-
|
|
3524
|
+
interface WhatsAppClosedMember {
|
|
3525
|
+
whatsAppClosed: WhatsAppClosedSystemMessage;
|
|
3526
|
+
multipleMembersJoined?: never;
|
|
3527
|
+
$unknown?: never;
|
|
3528
|
+
}
|
|
846
3529
|
/**
|
|
847
|
-
*
|
|
3530
|
+
* Multiple members joined the channel.
|
|
848
3531
|
* @public
|
|
849
3532
|
*/
|
|
850
|
-
|
|
3533
|
+
interface MultipleMembersJoinedMember {
|
|
3534
|
+
whatsAppClosed?: never;
|
|
3535
|
+
multipleMembersJoined: MultipleMembersJoinedSystemMessage;
|
|
3536
|
+
$unknown?: never;
|
|
3537
|
+
}
|
|
851
3538
|
/**
|
|
852
|
-
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
853
3539
|
* @public
|
|
854
3540
|
*/
|
|
855
|
-
|
|
3541
|
+
interface $UnknownMember {
|
|
3542
|
+
whatsAppClosed?: never;
|
|
3543
|
+
multipleMembersJoined?: never;
|
|
3544
|
+
$unknown: [string, any];
|
|
3545
|
+
}
|
|
3546
|
+
interface Visitor<T> {
|
|
3547
|
+
whatsAppClosed: (value: WhatsAppClosedSystemMessage) => T;
|
|
3548
|
+
multipleMembersJoined: (value: MultipleMembersJoinedSystemMessage) => T;
|
|
3549
|
+
_: (name: string, value: any) => T;
|
|
3550
|
+
}
|
|
3551
|
+
const visit: <T>(value: SystemMessage, visitor: Visitor<T>) => T;
|
|
856
3552
|
}
|
|
857
3553
|
/**
|
|
858
|
-
* Mention entry. Identifies a message that mentioned the current user, with the user's read state and an embedded copy of the message and its channel.
|
|
859
3554
|
* @public
|
|
860
3555
|
*/
|
|
861
|
-
export interface
|
|
862
|
-
channelId: string;
|
|
863
|
-
messageId: string;
|
|
3556
|
+
export interface SendSystemMessageInput {
|
|
864
3557
|
/**
|
|
865
|
-
*
|
|
3558
|
+
* The unique identifier of the tenant when a service token is used.
|
|
866
3559
|
* @public
|
|
867
3560
|
*/
|
|
868
|
-
|
|
3561
|
+
companyId?: string | undefined;
|
|
869
3562
|
/**
|
|
870
|
-
*
|
|
3563
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
871
3564
|
* @public
|
|
872
3565
|
*/
|
|
873
|
-
|
|
3566
|
+
userId?: string | undefined;
|
|
3567
|
+
channelId: string;
|
|
874
3568
|
/**
|
|
875
|
-
*
|
|
3569
|
+
* Typed system message payload. Each variant maps to a server-generated message template.
|
|
876
3570
|
* @public
|
|
877
3571
|
*/
|
|
878
|
-
|
|
3572
|
+
message: SystemMessage;
|
|
879
3573
|
/**
|
|
880
|
-
*
|
|
3574
|
+
* Optional system event identifier for client rendering.
|
|
881
3575
|
* @public
|
|
882
3576
|
*/
|
|
883
|
-
|
|
3577
|
+
event?: string | undefined;
|
|
884
3578
|
/**
|
|
885
|
-
*
|
|
3579
|
+
* Suppress push notifications and unread indicators.
|
|
886
3580
|
* @public
|
|
887
3581
|
*/
|
|
888
|
-
|
|
3582
|
+
silent?: boolean | undefined;
|
|
3583
|
+
}
|
|
3584
|
+
/**
|
|
3585
|
+
* @public
|
|
3586
|
+
*/
|
|
3587
|
+
export interface SendSystemMessageOutput {
|
|
889
3588
|
/**
|
|
890
3589
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
891
3590
|
* @public
|
|
892
3591
|
*/
|
|
893
3592
|
message: Message;
|
|
3593
|
+
}
|
|
3594
|
+
/**
|
|
3595
|
+
* @public
|
|
3596
|
+
*/
|
|
3597
|
+
export interface SendTypingStartInput {
|
|
894
3598
|
/**
|
|
895
|
-
*
|
|
3599
|
+
* The unique identifier of the tenant when a service token is used.
|
|
896
3600
|
* @public
|
|
897
3601
|
*/
|
|
898
|
-
|
|
3602
|
+
companyId?: string | undefined;
|
|
3603
|
+
/**
|
|
3604
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3605
|
+
* @public
|
|
3606
|
+
*/
|
|
3607
|
+
userId?: string | undefined;
|
|
3608
|
+
channelId: string;
|
|
899
3609
|
}
|
|
900
3610
|
/**
|
|
901
3611
|
* @public
|
|
902
3612
|
*/
|
|
903
|
-
export interface
|
|
3613
|
+
export interface SendTypingStartOutput {
|
|
3614
|
+
}
|
|
3615
|
+
/**
|
|
3616
|
+
* @public
|
|
3617
|
+
*/
|
|
3618
|
+
export interface SendTypingStopInput {
|
|
904
3619
|
/**
|
|
905
|
-
*
|
|
3620
|
+
* The unique identifier of the tenant when a service token is used.
|
|
906
3621
|
* @public
|
|
907
3622
|
*/
|
|
908
|
-
|
|
3623
|
+
companyId?: string | undefined;
|
|
909
3624
|
/**
|
|
910
|
-
*
|
|
3625
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
911
3626
|
* @public
|
|
912
3627
|
*/
|
|
913
|
-
|
|
3628
|
+
userId?: string | undefined;
|
|
3629
|
+
channelId: string;
|
|
914
3630
|
}
|
|
915
3631
|
/**
|
|
916
3632
|
* @public
|
|
917
3633
|
*/
|
|
918
|
-
export interface
|
|
3634
|
+
export interface SendTypingStopOutput {
|
|
3635
|
+
}
|
|
3636
|
+
/**
|
|
3637
|
+
* @public
|
|
3638
|
+
*/
|
|
3639
|
+
export interface ShowChannelInput {
|
|
919
3640
|
/**
|
|
920
3641
|
* The unique identifier of the tenant when a service token is used.
|
|
921
3642
|
* @public
|
|
@@ -927,47 +3648,63 @@ export interface ListMessagesInput {
|
|
|
927
3648
|
*/
|
|
928
3649
|
userId?: string | undefined;
|
|
929
3650
|
channelId: string;
|
|
3651
|
+
}
|
|
3652
|
+
/**
|
|
3653
|
+
* @public
|
|
3654
|
+
*/
|
|
3655
|
+
export interface ShowChannelOutput {
|
|
3656
|
+
}
|
|
3657
|
+
/**
|
|
3658
|
+
* @public
|
|
3659
|
+
*/
|
|
3660
|
+
export interface UnmuteChannelInput {
|
|
930
3661
|
/**
|
|
931
|
-
*
|
|
3662
|
+
* The unique identifier of the tenant when a service token is used.
|
|
932
3663
|
* @public
|
|
933
3664
|
*/
|
|
934
|
-
|
|
3665
|
+
companyId?: string | undefined;
|
|
935
3666
|
/**
|
|
936
|
-
*
|
|
3667
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
937
3668
|
* @public
|
|
938
3669
|
*/
|
|
939
|
-
|
|
3670
|
+
userId?: string | undefined;
|
|
3671
|
+
channelId: string;
|
|
940
3672
|
}
|
|
941
3673
|
/**
|
|
942
3674
|
* @public
|
|
943
3675
|
*/
|
|
944
|
-
export interface
|
|
3676
|
+
export interface UnmuteChannelOutput {
|
|
945
3677
|
/**
|
|
946
|
-
*
|
|
3678
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
947
3679
|
* @public
|
|
948
3680
|
*/
|
|
949
|
-
|
|
3681
|
+
inbox: InboxState;
|
|
950
3682
|
}
|
|
951
3683
|
/**
|
|
952
|
-
* Forward reference supplied by the client. The server resolves the original author and snapshot fields at write time.
|
|
953
3684
|
* @public
|
|
954
3685
|
*/
|
|
955
|
-
export interface
|
|
3686
|
+
export interface UnpinChannelInput {
|
|
3687
|
+
/**
|
|
3688
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3689
|
+
* @public
|
|
3690
|
+
*/
|
|
3691
|
+
companyId?: string | undefined;
|
|
3692
|
+
/**
|
|
3693
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3694
|
+
* @public
|
|
3695
|
+
*/
|
|
3696
|
+
userId?: string | undefined;
|
|
956
3697
|
channelId: string;
|
|
957
|
-
messageId: string;
|
|
958
3698
|
}
|
|
959
3699
|
/**
|
|
960
|
-
* Quote reference supplied by the client. The server resolves the author and snapshot fields at write time.
|
|
961
3700
|
* @public
|
|
962
3701
|
*/
|
|
963
|
-
export interface
|
|
964
|
-
channelId: string;
|
|
965
|
-
messageId: string;
|
|
3702
|
+
export interface UnpinChannelOutput {
|
|
966
3703
|
}
|
|
967
3704
|
/**
|
|
968
3705
|
* @public
|
|
969
3706
|
*/
|
|
970
|
-
export interface
|
|
3707
|
+
export interface UnpinMessageInput {
|
|
971
3708
|
/**
|
|
972
3709
|
* The unique identifier of the tenant when a service token is used.
|
|
973
3710
|
* @public
|
|
@@ -984,7 +3721,7 @@ export interface PinMessageInput {
|
|
|
984
3721
|
/**
|
|
985
3722
|
* @public
|
|
986
3723
|
*/
|
|
987
|
-
export interface
|
|
3724
|
+
export interface UnpinMessageOutput {
|
|
988
3725
|
/**
|
|
989
3726
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
990
3727
|
* @public
|
|
@@ -994,7 +3731,7 @@ export interface PinMessageOutput {
|
|
|
994
3731
|
/**
|
|
995
3732
|
* @public
|
|
996
3733
|
*/
|
|
997
|
-
export interface
|
|
3734
|
+
export interface UpdateChannelInput {
|
|
998
3735
|
/**
|
|
999
3736
|
* The unique identifier of the tenant when a service token is used.
|
|
1000
3737
|
* @public
|
|
@@ -1005,28 +3742,96 @@ export interface RemoveReactionInput {
|
|
|
1005
3742
|
* @public
|
|
1006
3743
|
*/
|
|
1007
3744
|
userId?: string | undefined;
|
|
1008
|
-
channelId: string;
|
|
1009
|
-
messageId: string;
|
|
1010
3745
|
/**
|
|
1011
|
-
*
|
|
3746
|
+
* The subject of the channel.
|
|
1012
3747
|
* @public
|
|
1013
3748
|
*/
|
|
1014
|
-
|
|
3749
|
+
subject?: string | undefined;
|
|
3750
|
+
/**
|
|
3751
|
+
* The description of the channel.
|
|
3752
|
+
* @public
|
|
3753
|
+
*/
|
|
3754
|
+
description?: string | undefined;
|
|
3755
|
+
/**
|
|
3756
|
+
* The URL of the channel's picture.
|
|
3757
|
+
* @public
|
|
3758
|
+
*/
|
|
3759
|
+
picture?: string | undefined;
|
|
3760
|
+
/**
|
|
3761
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
3762
|
+
* @public
|
|
3763
|
+
*/
|
|
3764
|
+
pictureColor?: string | undefined;
|
|
3765
|
+
/**
|
|
3766
|
+
* Channel access level.
|
|
3767
|
+
* @public
|
|
3768
|
+
*/
|
|
3769
|
+
access?: ChannelAccess | undefined;
|
|
3770
|
+
/**
|
|
3771
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
3772
|
+
* @public
|
|
3773
|
+
*/
|
|
3774
|
+
broadcast?: boolean | undefined;
|
|
3775
|
+
context?: ChannelContext | undefined;
|
|
3776
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
3777
|
+
/**
|
|
3778
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
3779
|
+
* @public
|
|
3780
|
+
*/
|
|
3781
|
+
sms?: boolean | undefined;
|
|
3782
|
+
/**
|
|
3783
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
3784
|
+
* @public
|
|
3785
|
+
*/
|
|
3786
|
+
mms?: boolean | undefined;
|
|
3787
|
+
/**
|
|
3788
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
3789
|
+
* @public
|
|
3790
|
+
*/
|
|
3791
|
+
whatsapp?: boolean | undefined;
|
|
3792
|
+
/**
|
|
3793
|
+
* The unique identifier of the assignee.
|
|
3794
|
+
* @public
|
|
3795
|
+
*/
|
|
3796
|
+
kiteAssign?: string | undefined;
|
|
3797
|
+
/**
|
|
3798
|
+
* The title of the service.
|
|
3799
|
+
* @public
|
|
3800
|
+
*/
|
|
3801
|
+
serviceTitle?: string | undefined;
|
|
3802
|
+
/**
|
|
3803
|
+
* Assignee user id.
|
|
3804
|
+
* @public
|
|
3805
|
+
*/
|
|
3806
|
+
assigneeId?: string | undefined;
|
|
3807
|
+
/**
|
|
3808
|
+
* Indicates if the channel supports auto start recording.
|
|
3809
|
+
* @public
|
|
3810
|
+
*/
|
|
3811
|
+
autoRecord?: boolean | undefined;
|
|
3812
|
+
/**
|
|
3813
|
+
* Transcription language.
|
|
3814
|
+
* @public
|
|
3815
|
+
*/
|
|
3816
|
+
transcriptionLanguage?: string | undefined;
|
|
3817
|
+
/**
|
|
3818
|
+
* Indicates if external users in this conversation can only join the conference as a viewer with the ability to speak by request. Default is false.
|
|
3819
|
+
* @public
|
|
3820
|
+
*/
|
|
3821
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
3822
|
+
channelId: string;
|
|
3823
|
+
silent?: boolean | undefined;
|
|
1015
3824
|
}
|
|
1016
3825
|
/**
|
|
1017
3826
|
* @public
|
|
1018
3827
|
*/
|
|
1019
|
-
export interface
|
|
1020
|
-
|
|
1021
|
-
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1022
|
-
* @public
|
|
1023
|
-
*/
|
|
1024
|
-
message: Message;
|
|
3828
|
+
export interface UpdateChannelOutput {
|
|
3829
|
+
channel: Channel;
|
|
1025
3830
|
}
|
|
1026
3831
|
/**
|
|
1027
3832
|
* @public
|
|
1028
3833
|
*/
|
|
1029
|
-
export interface
|
|
3834
|
+
export interface UpdateMessageInput {
|
|
1030
3835
|
/**
|
|
1031
3836
|
* The unique identifier of the tenant when a service token is used.
|
|
1032
3837
|
* @public
|
|
@@ -1037,27 +3842,21 @@ export interface SendMessageInput {
|
|
|
1037
3842
|
* @public
|
|
1038
3843
|
*/
|
|
1039
3844
|
userId?: string | undefined;
|
|
1040
|
-
channelId: string;
|
|
1041
|
-
/**
|
|
1042
|
-
* Rendering hint for the message.
|
|
1043
|
-
* @public
|
|
1044
|
-
*/
|
|
1045
|
-
messageType?: MessageType | undefined;
|
|
1046
3845
|
/**
|
|
1047
3846
|
* Text body. Required unless `attachments` is non-empty.
|
|
1048
3847
|
* @public
|
|
1049
3848
|
*/
|
|
1050
3849
|
text?: string | undefined;
|
|
1051
3850
|
/**
|
|
1052
|
-
*
|
|
3851
|
+
* Structured rich content blocks.
|
|
1053
3852
|
* @public
|
|
1054
3853
|
*/
|
|
1055
|
-
|
|
3854
|
+
elements?: (Element)[] | undefined;
|
|
1056
3855
|
/**
|
|
1057
|
-
*
|
|
3856
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1058
3857
|
* @public
|
|
1059
3858
|
*/
|
|
1060
|
-
|
|
3859
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1061
3860
|
/**
|
|
1062
3861
|
* Reply context referencing a quoted message.
|
|
1063
3862
|
* @public
|
|
@@ -1069,15 +3868,39 @@ export interface SendMessageInput {
|
|
|
1069
3868
|
*/
|
|
1070
3869
|
forward?: MessageForwardRef | undefined;
|
|
1071
3870
|
/**
|
|
1072
|
-
*
|
|
3871
|
+
* When true, the message body is interpreted as Markdown.
|
|
3872
|
+
* @public
|
|
3873
|
+
*/
|
|
3874
|
+
markdown?: boolean | undefined;
|
|
3875
|
+
/**
|
|
3876
|
+
* Direct `@user` ids.
|
|
3877
|
+
* @public
|
|
3878
|
+
*/
|
|
3879
|
+
mentions?: (string)[] | undefined;
|
|
3880
|
+
/**
|
|
3881
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
3882
|
+
* @public
|
|
3883
|
+
*/
|
|
3884
|
+
whatsapp?: boolean | undefined;
|
|
3885
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
3886
|
+
/**
|
|
3887
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
1073
3888
|
* @public
|
|
1074
3889
|
*/
|
|
1075
|
-
|
|
3890
|
+
sms?: boolean | undefined;
|
|
3891
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
3892
|
+
channelId: string;
|
|
3893
|
+
messageId: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* Suppress the updated indicator for this edit.
|
|
3896
|
+
* @public
|
|
3897
|
+
*/
|
|
3898
|
+
silent?: boolean | undefined;
|
|
1076
3899
|
}
|
|
1077
3900
|
/**
|
|
1078
3901
|
* @public
|
|
1079
3902
|
*/
|
|
1080
|
-
export interface
|
|
3903
|
+
export interface UpdateMessageOutput {
|
|
1081
3904
|
/**
|
|
1082
3905
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1083
3906
|
* @public
|
|
@@ -1085,9 +3908,25 @@ export interface SendMessageOutput {
|
|
|
1085
3908
|
message: Message;
|
|
1086
3909
|
}
|
|
1087
3910
|
/**
|
|
3911
|
+
* Optional parameters for the upload presign flow.
|
|
1088
3912
|
* @public
|
|
1089
3913
|
*/
|
|
1090
|
-
export interface
|
|
3914
|
+
export interface UploadFileOptions {
|
|
3915
|
+
/**
|
|
3916
|
+
* File category. Defaults to `channels`.
|
|
3917
|
+
* @public
|
|
3918
|
+
*/
|
|
3919
|
+
category?: FileCategory | undefined;
|
|
3920
|
+
/**
|
|
3921
|
+
* Target upload region. S2S only; ignored for user tokens.
|
|
3922
|
+
* @public
|
|
3923
|
+
*/
|
|
3924
|
+
region?: string | undefined;
|
|
3925
|
+
}
|
|
3926
|
+
/**
|
|
3927
|
+
* @public
|
|
3928
|
+
*/
|
|
3929
|
+
export interface UploadFileInput {
|
|
1091
3930
|
/**
|
|
1092
3931
|
* The unique identifier of the tenant when a service token is used.
|
|
1093
3932
|
* @public
|
|
@@ -1099,15 +3938,29 @@ export interface UnpinMessageInput {
|
|
|
1099
3938
|
*/
|
|
1100
3939
|
userId?: string | undefined;
|
|
1101
3940
|
channelId: string;
|
|
1102
|
-
|
|
3941
|
+
/**
|
|
3942
|
+
* Original file name. Unreadable characters are replaced with underscores.
|
|
3943
|
+
* @public
|
|
3944
|
+
*/
|
|
3945
|
+
name: string;
|
|
3946
|
+
/**
|
|
3947
|
+
* Additional upload parameters.
|
|
3948
|
+
* @public
|
|
3949
|
+
*/
|
|
3950
|
+
options?: UploadFileOptions | undefined;
|
|
1103
3951
|
}
|
|
1104
3952
|
/**
|
|
1105
3953
|
* @public
|
|
1106
3954
|
*/
|
|
1107
|
-
export interface
|
|
3955
|
+
export interface UploadFileOutput {
|
|
1108
3956
|
/**
|
|
1109
|
-
*
|
|
3957
|
+
* File service identifier. Pass this value as `attachments[].fsId` on send and edit.
|
|
1110
3958
|
* @public
|
|
1111
3959
|
*/
|
|
1112
|
-
|
|
3960
|
+
fsId: string;
|
|
3961
|
+
/**
|
|
3962
|
+
* Presigned URL for uploading the file contents.
|
|
3963
|
+
* @public
|
|
3964
|
+
*/
|
|
3965
|
+
presignedUploadUrl: string;
|
|
1113
3966
|
}
|