@wildix/stream-client 0.0.4 → 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 +254 -49
- package/dist-cjs/protocols/Aws_restJson1.js +1954 -130
- 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 +242 -46
- package/dist-es/protocols/Aws_restJson1.js +1842 -112
- 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/{RemoveReactionCommand.d.ts → DeleteMessageReactionCommand.d.ts} +26 -27
- 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 +35 -35
- package/dist-types/commands/GetMessageCommand.d.ts +4 -5
- 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 +35 -35
- package/dist-types/commands/ListMentionsCommand.d.ts +5 -6
- package/dist-types/commands/ListMessagesCommand.d.ts +4 -5
- 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 +4 -5
- 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/{EditMessageCommand.d.ts → SendGiphyCommand.d.ts} +40 -41
- package/dist-types/commands/SendMessageCommand.d.ts +52 -12
- package/dist-types/commands/{AddReactionCommand.d.ts → SendMessageReactionCommand.d.ts} +27 -28
- 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 +4 -5
- 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 +3076 -563
- package/dist-types/protocols/Aws_restJson1.d.ts +429 -15
- package/package.json +1 -1
|
@@ -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
|
*/
|
|
@@ -200,10 +189,36 @@ export declare namespace ActionElement {
|
|
|
200
189
|
}
|
|
201
190
|
const visit: <T>(value: ActionElement, visitor: Visitor<T>) => T;
|
|
202
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
|
+
}
|
|
203
218
|
/**
|
|
204
219
|
* @public
|
|
205
220
|
*/
|
|
206
|
-
export interface
|
|
221
|
+
export interface AddChannelMemberInput {
|
|
207
222
|
/**
|
|
208
223
|
* The unique identifier of the tenant when a service token is used.
|
|
209
224
|
* @public
|
|
@@ -215,463 +230,2735 @@ export interface AddReactionInput {
|
|
|
215
230
|
*/
|
|
216
231
|
userId?: string | undefined;
|
|
217
232
|
channelId: string;
|
|
218
|
-
|
|
233
|
+
silent?: boolean | undefined;
|
|
234
|
+
memberId?: string | undefined;
|
|
219
235
|
/**
|
|
220
|
-
*
|
|
236
|
+
* User invitation payload used when creating channels or adding members.
|
|
221
237
|
* @public
|
|
222
238
|
*/
|
|
223
|
-
|
|
239
|
+
memberToInvite?: UserToInvite | undefined;
|
|
240
|
+
hideHistory?: boolean | undefined;
|
|
224
241
|
}
|
|
225
242
|
/**
|
|
226
|
-
* File attached to a message as returned by listing and lookup endpoints.
|
|
227
243
|
* @public
|
|
244
|
+
* @enum
|
|
228
245
|
*/
|
|
229
|
-
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;
|
|
230
260
|
/**
|
|
231
|
-
*
|
|
261
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
232
262
|
* @public
|
|
233
263
|
*/
|
|
234
|
-
|
|
264
|
+
joinedAt: string;
|
|
265
|
+
role: ChannelMemberRole;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface AddChannelMemberOutput {
|
|
235
271
|
/**
|
|
236
|
-
*
|
|
272
|
+
* Channel membership row.
|
|
237
273
|
* @public
|
|
238
274
|
*/
|
|
239
|
-
|
|
275
|
+
member: ChannelMember;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export declare class ChannelNotFoundException extends __BaseException {
|
|
281
|
+
readonly name: "ChannelNotFoundException";
|
|
282
|
+
readonly $fault: "client";
|
|
240
283
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @public
|
|
284
|
+
* @internal
|
|
243
285
|
*/
|
|
244
|
-
|
|
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";
|
|
245
294
|
/**
|
|
246
|
-
*
|
|
247
|
-
* @public
|
|
295
|
+
* @internal
|
|
248
296
|
*/
|
|
249
|
-
|
|
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";
|
|
250
305
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @public
|
|
306
|
+
* @internal
|
|
253
307
|
*/
|
|
254
|
-
|
|
308
|
+
constructor(opts: __ExceptionOptionType<StreamServiceException, __BaseException>);
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
export interface AddChannelMembersInput {
|
|
255
314
|
/**
|
|
256
|
-
*
|
|
315
|
+
* The unique identifier of the tenant when a service token is used.
|
|
257
316
|
* @public
|
|
258
317
|
*/
|
|
259
|
-
|
|
318
|
+
companyId?: string | undefined;
|
|
260
319
|
/**
|
|
261
|
-
*
|
|
320
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
262
321
|
* @public
|
|
263
322
|
*/
|
|
264
|
-
|
|
323
|
+
userId?: string | undefined;
|
|
324
|
+
channelId: string;
|
|
325
|
+
silent?: boolean | undefined;
|
|
326
|
+
members?: (string)[] | undefined;
|
|
327
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
328
|
+
hideHistory?: boolean | undefined;
|
|
265
329
|
/**
|
|
266
|
-
*
|
|
330
|
+
* Message id used to seed unread state for added members.
|
|
267
331
|
* @public
|
|
268
332
|
*/
|
|
269
|
-
|
|
333
|
+
unreadMessageId?: string | undefined;
|
|
270
334
|
}
|
|
271
335
|
/**
|
|
272
336
|
* @public
|
|
273
337
|
*/
|
|
274
|
-
export interface
|
|
275
|
-
|
|
338
|
+
export interface AddChannelMembersOutput {
|
|
339
|
+
members: (ChannelMember)[];
|
|
276
340
|
}
|
|
277
341
|
/**
|
|
278
342
|
* @public
|
|
279
343
|
*/
|
|
280
|
-
export type
|
|
344
|
+
export type AssignChannelAssigneeRequest = AssignChannelAssigneeRequest.EmailMember | AssignChannelAssigneeRequest.IdMember | AssignChannelAssigneeRequest.$UnknownMember;
|
|
281
345
|
/**
|
|
282
346
|
* @public
|
|
283
347
|
*/
|
|
284
|
-
export declare namespace
|
|
285
|
-
interface
|
|
286
|
-
|
|
287
|
-
|
|
348
|
+
export declare namespace AssignChannelAssigneeRequest {
|
|
349
|
+
interface IdMember {
|
|
350
|
+
id: string;
|
|
351
|
+
email?: never;
|
|
288
352
|
$unknown?: never;
|
|
289
353
|
}
|
|
290
|
-
interface
|
|
291
|
-
|
|
292
|
-
|
|
354
|
+
interface EmailMember {
|
|
355
|
+
id?: never;
|
|
356
|
+
email: string;
|
|
293
357
|
$unknown?: never;
|
|
294
358
|
}
|
|
295
359
|
/**
|
|
296
360
|
* @public
|
|
297
361
|
*/
|
|
298
362
|
interface $UnknownMember {
|
|
299
|
-
|
|
300
|
-
|
|
363
|
+
id?: never;
|
|
364
|
+
email?: never;
|
|
301
365
|
$unknown: [string, any];
|
|
302
366
|
}
|
|
303
367
|
interface Visitor<T> {
|
|
304
|
-
|
|
305
|
-
|
|
368
|
+
id: (value: string) => T;
|
|
369
|
+
email: (value: string) => T;
|
|
306
370
|
_: (name: string, value: any) => T;
|
|
307
371
|
}
|
|
308
|
-
const visit: <T>(value:
|
|
372
|
+
const visit: <T>(value: AssignChannelAssigneeRequest, visitor: Visitor<T>) => T;
|
|
309
373
|
}
|
|
310
374
|
/**
|
|
311
|
-
* Reference to the original forwarded message.
|
|
312
375
|
* @public
|
|
313
376
|
*/
|
|
314
|
-
export
|
|
315
|
-
|
|
316
|
-
|
|
377
|
+
export type AssignChannelServiceRequest = AssignChannelServiceRequest.UriMember | AssignChannelServiceRequest.$UnknownMember;
|
|
378
|
+
/**
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
export declare namespace AssignChannelServiceRequest {
|
|
317
382
|
/**
|
|
318
|
-
*
|
|
383
|
+
* Service URI: `<serviceId>@<pbxDomain>:<pbxPort>`.
|
|
319
384
|
* @public
|
|
320
385
|
*/
|
|
321
|
-
|
|
386
|
+
interface UriMember {
|
|
387
|
+
uri: string;
|
|
388
|
+
$unknown?: never;
|
|
389
|
+
}
|
|
322
390
|
/**
|
|
323
|
-
* Creation timestamp of the original message.
|
|
324
391
|
* @public
|
|
325
392
|
*/
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
height: string;
|
|
336
|
-
width: string;
|
|
337
|
-
}
|
|
338
|
-
/**
|
|
339
|
-
* @public
|
|
340
|
-
*/
|
|
341
|
-
export interface Reaction {
|
|
342
|
-
type?: string | undefined;
|
|
343
|
-
userId?: string | undefined;
|
|
344
|
-
messageId?: string | undefined;
|
|
345
|
-
user?: string | undefined;
|
|
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;
|
|
346
402
|
}
|
|
347
403
|
/**
|
|
348
404
|
* @public
|
|
349
405
|
* @enum
|
|
350
406
|
*/
|
|
351
|
-
export declare const
|
|
352
|
-
readonly
|
|
353
|
-
readonly
|
|
407
|
+
export declare const AssignChannelVariant: {
|
|
408
|
+
readonly ADAPTIVE: "ADAPTIVE";
|
|
409
|
+
readonly EVERYBODY: "EVERYBODY";
|
|
410
|
+
readonly SELECTED: "SELECTED";
|
|
411
|
+
readonly SKIP: "SKIP";
|
|
354
412
|
};
|
|
355
413
|
/**
|
|
356
414
|
* @public
|
|
357
415
|
*/
|
|
358
|
-
export type
|
|
416
|
+
export type AssignChannelVariant = typeof AssignChannelVariant[keyof typeof AssignChannelVariant];
|
|
359
417
|
/**
|
|
360
|
-
* Reference to a quoted message.
|
|
361
418
|
* @public
|
|
362
419
|
*/
|
|
363
|
-
export interface
|
|
364
|
-
channelId: string;
|
|
365
|
-
messageId: string;
|
|
366
|
-
/**
|
|
367
|
-
* Author of the quoted message.
|
|
368
|
-
* @public
|
|
369
|
-
*/
|
|
370
|
-
userId: string;
|
|
420
|
+
export interface AssignChannelInput {
|
|
371
421
|
/**
|
|
372
|
-
*
|
|
422
|
+
* The unique identifier of the tenant when a service token is used.
|
|
373
423
|
* @public
|
|
374
424
|
*/
|
|
375
|
-
|
|
425
|
+
companyId?: string | undefined;
|
|
376
426
|
/**
|
|
377
|
-
*
|
|
427
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
378
428
|
* @public
|
|
379
429
|
*/
|
|
380
|
-
|
|
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;
|
|
381
443
|
}
|
|
382
444
|
/**
|
|
383
445
|
* @public
|
|
384
446
|
* @enum
|
|
385
447
|
*/
|
|
386
|
-
export declare const
|
|
387
|
-
readonly
|
|
388
|
-
readonly
|
|
389
|
-
readonly SENT: "sent";
|
|
390
|
-
readonly TRYING: "trying";
|
|
448
|
+
export declare const ChannelAccess: {
|
|
449
|
+
readonly PRIVATE: "private";
|
|
450
|
+
readonly PUBLIC: "public";
|
|
391
451
|
};
|
|
392
452
|
/**
|
|
393
453
|
* @public
|
|
394
454
|
*/
|
|
395
|
-
export type
|
|
455
|
+
export type ChannelAccess = typeof ChannelAccess[keyof typeof ChannelAccess];
|
|
396
456
|
/**
|
|
397
457
|
* @public
|
|
398
458
|
* @enum
|
|
399
459
|
*/
|
|
400
|
-
export declare const
|
|
401
|
-
readonly
|
|
402
|
-
readonly
|
|
403
|
-
readonly SENT: "sent";
|
|
404
|
-
readonly TRYING: "trying";
|
|
460
|
+
export declare const ChannelType: {
|
|
461
|
+
readonly DIRECT: "direct";
|
|
462
|
+
readonly GROUP: "group";
|
|
405
463
|
};
|
|
406
464
|
/**
|
|
407
465
|
* @public
|
|
408
466
|
*/
|
|
409
|
-
export type
|
|
467
|
+
export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
|
|
410
468
|
/**
|
|
411
|
-
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
412
469
|
* @public
|
|
470
|
+
* @enum
|
|
413
471
|
*/
|
|
414
|
-
export
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
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 {
|
|
436
505
|
/**
|
|
437
|
-
*
|
|
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.
|
|
438
507
|
* @public
|
|
439
508
|
*/
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
509
|
+
broadcastId?: string | undefined;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* @public
|
|
513
|
+
* @enum
|
|
514
|
+
*/
|
|
515
|
+
export declare const ChannelContextSource: {
|
|
516
|
+
readonly KITE: "kite";
|
|
517
|
+
};
|
|
518
|
+
/**
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
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 {
|
|
536
|
+
messageId: string;
|
|
446
537
|
/**
|
|
447
|
-
*
|
|
538
|
+
* Author of the message.
|
|
448
539
|
* @public
|
|
449
540
|
*/
|
|
450
|
-
|
|
541
|
+
userId: string;
|
|
451
542
|
/**
|
|
452
|
-
*
|
|
543
|
+
* Text body of the message. Absent for attachment-only or deleted messages.
|
|
453
544
|
* @public
|
|
454
545
|
*/
|
|
455
|
-
|
|
456
|
-
latestReactions?: (Reaction)[] | undefined;
|
|
546
|
+
text?: string | undefined;
|
|
457
547
|
/**
|
|
458
|
-
*
|
|
548
|
+
* Creation timestamp of the message.
|
|
459
549
|
* @public
|
|
460
550
|
*/
|
|
461
|
-
|
|
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;
|
|
462
569
|
/**
|
|
463
|
-
*
|
|
570
|
+
* Type of channel.
|
|
464
571
|
* @public
|
|
465
572
|
*/
|
|
466
|
-
|
|
573
|
+
channelType: ChannelType;
|
|
467
574
|
/**
|
|
468
|
-
*
|
|
575
|
+
* Current number of members.
|
|
469
576
|
* @public
|
|
470
577
|
*/
|
|
471
|
-
|
|
578
|
+
membersCount: number;
|
|
472
579
|
/**
|
|
473
|
-
*
|
|
580
|
+
* Channel creation timestamp.
|
|
474
581
|
* @public
|
|
475
582
|
*/
|
|
476
|
-
|
|
583
|
+
createdAt: string;
|
|
477
584
|
/**
|
|
478
|
-
*
|
|
585
|
+
* User that created the channel.
|
|
479
586
|
* @public
|
|
480
587
|
*/
|
|
481
|
-
|
|
588
|
+
createdBy: string;
|
|
482
589
|
/**
|
|
483
|
-
*
|
|
590
|
+
* Timestamp of the last channel mutation.
|
|
484
591
|
* @public
|
|
485
592
|
*/
|
|
486
|
-
|
|
593
|
+
updatedAt?: string | undefined;
|
|
487
594
|
/**
|
|
488
595
|
* Channel version. Increments on every channel mutation.
|
|
489
596
|
* @public
|
|
490
597
|
*/
|
|
491
598
|
channelVersion: number;
|
|
492
599
|
/**
|
|
493
|
-
*
|
|
600
|
+
* Timestamp of the last activity. Drives inbox ordering.
|
|
494
601
|
* @public
|
|
495
602
|
*/
|
|
496
|
-
|
|
603
|
+
lastActivityAt: string;
|
|
497
604
|
/**
|
|
498
|
-
*
|
|
605
|
+
* Last visible message preview. Absent for empty channels.
|
|
499
606
|
* @public
|
|
500
607
|
*/
|
|
501
|
-
|
|
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;
|
|
502
619
|
/**
|
|
503
|
-
*
|
|
620
|
+
* The subject of the channel.
|
|
504
621
|
* @public
|
|
505
622
|
*/
|
|
506
|
-
|
|
623
|
+
subject?: string | undefined;
|
|
507
624
|
/**
|
|
508
|
-
*
|
|
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.
|
|
509
653
|
* @public
|
|
510
654
|
*/
|
|
511
|
-
deletedAt?: string | undefined;
|
|
512
|
-
elements?: (Element)[] | undefined;
|
|
513
|
-
whatsapp?: boolean | undefined;
|
|
514
|
-
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
515
655
|
sms?: boolean | undefined;
|
|
516
|
-
smsStatus?: MessageSmsStatus | undefined;
|
|
517
|
-
markdown?: boolean | undefined;
|
|
518
|
-
giphy?: MessageGiphy | undefined;
|
|
519
|
-
silent?: boolean | undefined;
|
|
520
|
-
event?: string | undefined;
|
|
521
|
-
}
|
|
522
|
-
/**
|
|
523
|
-
* @public
|
|
524
|
-
*/
|
|
525
|
-
export interface AddReactionOutput {
|
|
526
656
|
/**
|
|
527
|
-
*
|
|
657
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
528
658
|
* @public
|
|
529
659
|
*/
|
|
530
|
-
|
|
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;
|
|
531
696
|
}
|
|
532
697
|
/**
|
|
533
698
|
* @public
|
|
534
699
|
*/
|
|
535
|
-
export declare class
|
|
536
|
-
readonly name: "
|
|
700
|
+
export declare class ChannelAlreadyExistException extends __BaseException {
|
|
701
|
+
readonly name: "ChannelAlreadyExistException";
|
|
537
702
|
readonly $fault: "client";
|
|
538
703
|
/**
|
|
539
704
|
* @internal
|
|
540
705
|
*/
|
|
541
|
-
constructor(opts: __ExceptionOptionType<
|
|
706
|
+
constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
|
|
542
707
|
}
|
|
543
708
|
/**
|
|
709
|
+
* Read pointer for one channel member.
|
|
544
710
|
* @public
|
|
545
711
|
*/
|
|
546
|
-
export
|
|
547
|
-
|
|
548
|
-
readonly $fault: "client";
|
|
712
|
+
export interface ChannelMemberReadStatus {
|
|
713
|
+
userId: string;
|
|
549
714
|
/**
|
|
550
|
-
*
|
|
715
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
716
|
+
* @public
|
|
551
717
|
*/
|
|
552
|
-
|
|
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;
|
|
553
724
|
}
|
|
554
725
|
/**
|
|
555
726
|
* @public
|
|
556
727
|
* @enum
|
|
557
728
|
*/
|
|
558
|
-
export declare const
|
|
559
|
-
|
|
560
|
-
|
|
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";
|
|
561
738
|
};
|
|
562
739
|
/**
|
|
563
740
|
* @public
|
|
564
741
|
*/
|
|
565
|
-
export type
|
|
742
|
+
export type ChannelsFilter = typeof ChannelsFilter[keyof typeof ChannelsFilter];
|
|
566
743
|
/**
|
|
744
|
+
* Batch channel lookup query.
|
|
567
745
|
* @public
|
|
568
|
-
* @enum
|
|
569
746
|
*/
|
|
570
|
-
export
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
readonly NONE: "none";
|
|
574
|
-
readonly TENTATIVE: "tentative";
|
|
575
|
-
};
|
|
747
|
+
export interface ChannelsQuery {
|
|
748
|
+
ids?: (string)[] | undefined;
|
|
749
|
+
}
|
|
576
750
|
/**
|
|
577
751
|
* @public
|
|
752
|
+
* @enum
|
|
578
753
|
*/
|
|
579
|
-
export
|
|
754
|
+
export declare const GroupChannelCreationEventType: {
|
|
755
|
+
readonly CONVERSATION_CREATED: "conversation_created";
|
|
756
|
+
readonly CONVERSATION_CREATED_WITH_NAME: "conversation_created_with_name";
|
|
757
|
+
};
|
|
580
758
|
/**
|
|
581
759
|
* @public
|
|
582
760
|
*/
|
|
583
|
-
export
|
|
584
|
-
email: string;
|
|
585
|
-
name?: string | undefined;
|
|
586
|
-
status: ChannelContextEventAttendeeStatus;
|
|
587
|
-
}
|
|
761
|
+
export type GroupChannelCreationEventType = typeof GroupChannelCreationEventType[keyof typeof GroupChannelCreationEventType];
|
|
588
762
|
/**
|
|
589
763
|
* @public
|
|
590
764
|
*/
|
|
591
|
-
export interface
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
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.
|
|
2731
|
+
* @public
|
|
2732
|
+
*/
|
|
2733
|
+
timelineSeq: number;
|
|
2734
|
+
/**
|
|
2735
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
2736
|
+
* @public
|
|
2737
|
+
*/
|
|
2738
|
+
visibleSeq?: number | undefined;
|
|
2739
|
+
/**
|
|
2740
|
+
* Timestamp at which the mention was recorded.
|
|
2741
|
+
* @public
|
|
2742
|
+
*/
|
|
2743
|
+
mentionAddedAt: string;
|
|
2744
|
+
/**
|
|
2745
|
+
* True when the user has read this mention.
|
|
2746
|
+
* @public
|
|
2747
|
+
*/
|
|
2748
|
+
read: boolean;
|
|
2749
|
+
/**
|
|
2750
|
+
* Timestamp at which the mention was read.
|
|
2751
|
+
* @public
|
|
2752
|
+
*/
|
|
2753
|
+
readAt?: string | undefined;
|
|
2754
|
+
/**
|
|
2755
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
2756
|
+
* @public
|
|
2757
|
+
*/
|
|
2758
|
+
message: Message;
|
|
2759
|
+
/**
|
|
2760
|
+
* Compact channel preview returned alongside a mention entry.
|
|
2761
|
+
* @public
|
|
2762
|
+
*/
|
|
2763
|
+
channel: MentionChannelPreview;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* @public
|
|
2767
|
+
*/
|
|
2768
|
+
export interface ListMentionsOutput {
|
|
2769
|
+
/**
|
|
2770
|
+
* Mentions ordered by most recent `mentionAddedAt` first.
|
|
2771
|
+
* @public
|
|
2772
|
+
*/
|
|
2773
|
+
mentions: (MentionEntry)[];
|
|
2774
|
+
/**
|
|
2775
|
+
* Cursor for the next page. Absent when there are no more pages.
|
|
2776
|
+
* @public
|
|
2777
|
+
*/
|
|
2778
|
+
nextCursor?: string | undefined;
|
|
2779
|
+
}
|
|
2780
|
+
/**
|
|
2781
|
+
* @public
|
|
2782
|
+
*/
|
|
2783
|
+
export interface ListMessagesInput {
|
|
2784
|
+
/**
|
|
2785
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2786
|
+
* @public
|
|
2787
|
+
*/
|
|
2788
|
+
companyId?: string | undefined;
|
|
2789
|
+
/**
|
|
2790
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2791
|
+
* @public
|
|
2792
|
+
*/
|
|
2793
|
+
userId?: string | undefined;
|
|
2794
|
+
channelId: string;
|
|
2795
|
+
/**
|
|
2796
|
+
* Optional inclusive lower bound on `timelineSeq`. Combine with `to` for a bounded window, or use alone to scroll forward from a known anchor.
|
|
2797
|
+
* @public
|
|
2798
|
+
*/
|
|
2799
|
+
from?: number | undefined;
|
|
2800
|
+
/**
|
|
2801
|
+
* Optional inclusive upper bound on `timelineSeq`. Combine with `from` for a bounded window, or use alone to scroll back from a known anchor.
|
|
2802
|
+
* @public
|
|
2803
|
+
*/
|
|
2804
|
+
to?: number | undefined;
|
|
2805
|
+
}
|
|
2806
|
+
/**
|
|
2807
|
+
* @public
|
|
2808
|
+
*/
|
|
2809
|
+
export interface ListMessagesOutput {
|
|
2810
|
+
/**
|
|
2811
|
+
* Messages ordered newest-first by `timelineSeq`.
|
|
2812
|
+
* @public
|
|
2813
|
+
*/
|
|
2814
|
+
messages: (Message)[];
|
|
2815
|
+
}
|
|
2816
|
+
/**
|
|
2817
|
+
* @public
|
|
2818
|
+
*/
|
|
2819
|
+
export interface MarkReadInput {
|
|
2820
|
+
/**
|
|
2821
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2822
|
+
* @public
|
|
2823
|
+
*/
|
|
2824
|
+
companyId?: string | undefined;
|
|
2825
|
+
/**
|
|
2826
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2827
|
+
* @public
|
|
2828
|
+
*/
|
|
2829
|
+
userId?: string | undefined;
|
|
2830
|
+
channelId: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* Optional explicit read pointer. Defaults to the latest visible message.
|
|
2833
|
+
* @public
|
|
2834
|
+
*/
|
|
2835
|
+
lastReadVisibleSeq?: number | undefined;
|
|
2836
|
+
}
|
|
2837
|
+
/**
|
|
2838
|
+
* @public
|
|
2839
|
+
*/
|
|
2840
|
+
export interface MarkReadOutput {
|
|
2841
|
+
/**
|
|
2842
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2843
|
+
* @public
|
|
2844
|
+
*/
|
|
2845
|
+
inbox: InboxState;
|
|
2846
|
+
}
|
|
2847
|
+
/**
|
|
2848
|
+
* @public
|
|
2849
|
+
*/
|
|
2850
|
+
export declare class MarkUnreadChannelsLimitReachedException extends __BaseException {
|
|
2851
|
+
readonly name: "MarkUnreadChannelsLimitReachedException";
|
|
2852
|
+
readonly $fault: "client";
|
|
2853
|
+
/**
|
|
2854
|
+
* @internal
|
|
2855
|
+
*/
|
|
2856
|
+
constructor(opts: __ExceptionOptionType<MarkUnreadChannelsLimitReachedException, __BaseException>);
|
|
2857
|
+
}
|
|
2858
|
+
/**
|
|
2859
|
+
* @public
|
|
2860
|
+
*/
|
|
2861
|
+
export interface MarkUnreadInput {
|
|
2862
|
+
/**
|
|
2863
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2864
|
+
* @public
|
|
2865
|
+
*/
|
|
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;
|
|
598
2888
|
}
|
|
599
2889
|
/**
|
|
600
2890
|
* @public
|
|
601
2891
|
*/
|
|
602
|
-
export interface
|
|
2892
|
+
export interface MarkUnreadOutput {
|
|
603
2893
|
/**
|
|
604
|
-
*
|
|
2894
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
605
2895
|
* @public
|
|
606
2896
|
*/
|
|
607
|
-
|
|
2897
|
+
inbox: InboxState;
|
|
608
2898
|
}
|
|
609
2899
|
/**
|
|
610
2900
|
* @public
|
|
611
2901
|
* @enum
|
|
612
2902
|
*/
|
|
613
|
-
export declare const
|
|
614
|
-
readonly
|
|
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";
|
|
615
2915
|
};
|
|
616
2916
|
/**
|
|
617
2917
|
* @public
|
|
618
2918
|
*/
|
|
619
|
-
export type
|
|
620
|
-
/**
|
|
621
|
-
* @public
|
|
622
|
-
*/
|
|
623
|
-
export interface ChannelContext {
|
|
624
|
-
source?: ChannelContextSource | undefined;
|
|
625
|
-
target?: string | undefined;
|
|
626
|
-
events?: (ChannelContextEvent)[] | undefined;
|
|
627
|
-
ptt?: ChannelContextPushToTalk | undefined;
|
|
628
|
-
}
|
|
2919
|
+
export type MessageUnsetFields = typeof MessageUnsetFields[keyof typeof MessageUnsetFields];
|
|
629
2920
|
/**
|
|
630
2921
|
* @public
|
|
631
|
-
* @enum
|
|
632
2922
|
*/
|
|
633
|
-
export
|
|
2923
|
+
export interface MoveChannelToSectionInput {
|
|
634
2924
|
/**
|
|
635
|
-
*
|
|
2925
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2926
|
+
* @public
|
|
636
2927
|
*/
|
|
637
|
-
|
|
2928
|
+
companyId?: string | undefined;
|
|
638
2929
|
/**
|
|
639
|
-
*
|
|
2930
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2931
|
+
* @public
|
|
640
2932
|
*/
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
* @enum
|
|
650
|
-
*/
|
|
651
|
-
export declare const ChannelType: {
|
|
652
|
-
readonly DIRECT: "direct";
|
|
653
|
-
readonly EXTERNAL: "external";
|
|
654
|
-
readonly GROUP: "group";
|
|
655
|
-
};
|
|
656
|
-
/**
|
|
657
|
-
* @public
|
|
658
|
-
*/
|
|
659
|
-
export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
|
|
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
|
+
}
|
|
660
2941
|
/**
|
|
661
2942
|
* @public
|
|
662
|
-
* @enum
|
|
663
2943
|
*/
|
|
664
|
-
export
|
|
665
|
-
|
|
666
|
-
|
|
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
|
+
}
|
|
667
2951
|
/**
|
|
2952
|
+
* System message emitted when multiple members join a channel.
|
|
668
2953
|
* @public
|
|
669
2954
|
*/
|
|
670
|
-
export
|
|
2955
|
+
export interface MultipleMembersJoinedSystemMessage {
|
|
2956
|
+
addedMembers: (string)[];
|
|
2957
|
+
}
|
|
671
2958
|
/**
|
|
672
2959
|
* @public
|
|
673
2960
|
*/
|
|
674
|
-
export interface
|
|
2961
|
+
export interface MuteChannelInput {
|
|
675
2962
|
/**
|
|
676
2963
|
* The unique identifier of the tenant when a service token is used.
|
|
677
2964
|
* @public
|
|
@@ -683,100 +2970,108 @@ export interface DeleteMessageInput {
|
|
|
683
2970
|
*/
|
|
684
2971
|
userId?: string | undefined;
|
|
685
2972
|
channelId: string;
|
|
686
|
-
|
|
2973
|
+
/**
|
|
2974
|
+
* Temporary mute expiry. Omit for indefinite mute.
|
|
2975
|
+
* @public
|
|
2976
|
+
*/
|
|
2977
|
+
mutedUntil?: string | undefined;
|
|
687
2978
|
}
|
|
688
2979
|
/**
|
|
689
2980
|
* @public
|
|
690
2981
|
*/
|
|
691
|
-
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;
|
|
692
2988
|
}
|
|
693
2989
|
/**
|
|
694
|
-
* Attachment record supplied by the client when sending or editing a message. The server assigns the attachment `id` after persistence.
|
|
695
2990
|
* @public
|
|
696
2991
|
*/
|
|
697
|
-
export interface
|
|
2992
|
+
export interface PartialUpdateChannelSetOptions {
|
|
698
2993
|
/**
|
|
699
|
-
*
|
|
2994
|
+
* The subject of the channel.
|
|
700
2995
|
* @public
|
|
701
2996
|
*/
|
|
702
|
-
|
|
2997
|
+
subject?: string | undefined;
|
|
703
2998
|
/**
|
|
704
|
-
*
|
|
2999
|
+
* The description of the channel.
|
|
705
3000
|
* @public
|
|
706
3001
|
*/
|
|
707
|
-
|
|
3002
|
+
description?: string | undefined;
|
|
708
3003
|
/**
|
|
709
|
-
*
|
|
3004
|
+
* The URL of the channel's picture.
|
|
710
3005
|
* @public
|
|
711
3006
|
*/
|
|
712
|
-
|
|
3007
|
+
picture?: string | undefined;
|
|
713
3008
|
/**
|
|
714
|
-
*
|
|
3009
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
715
3010
|
* @public
|
|
716
3011
|
*/
|
|
717
|
-
|
|
3012
|
+
pictureColor?: string | undefined;
|
|
718
3013
|
/**
|
|
719
|
-
*
|
|
3014
|
+
* Channel access level.
|
|
720
3015
|
* @public
|
|
721
3016
|
*/
|
|
722
|
-
|
|
3017
|
+
access?: ChannelAccess | undefined;
|
|
723
3018
|
/**
|
|
724
|
-
*
|
|
3019
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
725
3020
|
* @public
|
|
726
3021
|
*/
|
|
727
|
-
|
|
3022
|
+
broadcast?: boolean | undefined;
|
|
3023
|
+
context?: ChannelContext | undefined;
|
|
3024
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
728
3025
|
/**
|
|
729
|
-
*
|
|
3026
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
730
3027
|
* @public
|
|
731
3028
|
*/
|
|
732
|
-
|
|
733
|
-
}
|
|
734
|
-
/**
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export interface EditMessageInput {
|
|
3029
|
+
sms?: boolean | undefined;
|
|
738
3030
|
/**
|
|
739
|
-
*
|
|
3031
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
740
3032
|
* @public
|
|
741
3033
|
*/
|
|
742
|
-
|
|
3034
|
+
mms?: boolean | undefined;
|
|
743
3035
|
/**
|
|
744
|
-
*
|
|
3036
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
745
3037
|
* @public
|
|
746
3038
|
*/
|
|
747
|
-
|
|
748
|
-
channelId: string;
|
|
749
|
-
messageId: string;
|
|
3039
|
+
whatsapp?: boolean | undefined;
|
|
750
3040
|
/**
|
|
751
|
-
*
|
|
3041
|
+
* The unique identifier of the assignee.
|
|
752
3042
|
* @public
|
|
753
3043
|
*/
|
|
754
|
-
|
|
3044
|
+
kiteAssign?: string | undefined;
|
|
755
3045
|
/**
|
|
756
|
-
*
|
|
3046
|
+
* The title of the service.
|
|
757
3047
|
* @public
|
|
758
3048
|
*/
|
|
759
|
-
|
|
3049
|
+
serviceTitle?: string | undefined;
|
|
760
3050
|
/**
|
|
761
|
-
*
|
|
3051
|
+
* Assignee user id.
|
|
762
3052
|
* @public
|
|
763
3053
|
*/
|
|
764
|
-
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* @public
|
|
768
|
-
*/
|
|
769
|
-
export interface EditMessageOutput {
|
|
3054
|
+
assigneeId?: string | undefined;
|
|
770
3055
|
/**
|
|
771
|
-
*
|
|
3056
|
+
* Indicates if the channel supports auto start recording.
|
|
772
3057
|
* @public
|
|
773
3058
|
*/
|
|
774
|
-
|
|
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;
|
|
775
3070
|
}
|
|
776
3071
|
/**
|
|
777
3072
|
* @public
|
|
778
3073
|
*/
|
|
779
|
-
export interface
|
|
3074
|
+
export interface PartialUpdateChannelInput {
|
|
780
3075
|
/**
|
|
781
3076
|
* The unique identifier of the tenant when a service token is used.
|
|
782
3077
|
* @public
|
|
@@ -787,269 +3082,263 @@ export interface GetInboxInput {
|
|
|
787
3082
|
* @public
|
|
788
3083
|
*/
|
|
789
3084
|
userId?: string | undefined;
|
|
3085
|
+
channelId: string;
|
|
3086
|
+
silent?: boolean | undefined;
|
|
3087
|
+
set?: PartialUpdateChannelSetOptions | undefined;
|
|
3088
|
+
unset?: (GroupChannelUnsetOptions)[] | undefined;
|
|
790
3089
|
}
|
|
791
3090
|
/**
|
|
792
|
-
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
793
3091
|
* @public
|
|
794
3092
|
*/
|
|
795
|
-
export interface
|
|
3093
|
+
export interface PartialUpdateChannelOutput {
|
|
3094
|
+
channel: Channel;
|
|
3095
|
+
}
|
|
3096
|
+
/**
|
|
3097
|
+
* @public
|
|
3098
|
+
*/
|
|
3099
|
+
export interface PartialUpdateMessageSetInput {
|
|
796
3100
|
/**
|
|
797
|
-
*
|
|
3101
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
798
3102
|
* @public
|
|
799
3103
|
*/
|
|
800
|
-
|
|
3104
|
+
text?: string | undefined;
|
|
801
3105
|
/**
|
|
802
|
-
*
|
|
3106
|
+
* Structured rich content blocks.
|
|
803
3107
|
* @public
|
|
804
3108
|
*/
|
|
805
|
-
|
|
3109
|
+
elements?: (Element)[] | undefined;
|
|
806
3110
|
/**
|
|
807
|
-
*
|
|
3111
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
808
3112
|
* @public
|
|
809
3113
|
*/
|
|
810
|
-
|
|
3114
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
811
3115
|
/**
|
|
812
|
-
*
|
|
3116
|
+
* Reply context referencing a quoted message.
|
|
813
3117
|
* @public
|
|
814
3118
|
*/
|
|
815
|
-
|
|
3119
|
+
quote?: MessageQuoteRef | undefined;
|
|
816
3120
|
/**
|
|
817
|
-
*
|
|
3121
|
+
* Source reference for a forwarded message.
|
|
818
3122
|
* @public
|
|
819
3123
|
*/
|
|
820
|
-
|
|
3124
|
+
forward?: MessageForwardRef | undefined;
|
|
821
3125
|
/**
|
|
822
|
-
*
|
|
3126
|
+
* When true, the message body is interpreted as Markdown.
|
|
823
3127
|
* @public
|
|
824
3128
|
*/
|
|
825
|
-
|
|
3129
|
+
markdown?: boolean | undefined;
|
|
826
3130
|
/**
|
|
827
|
-
*
|
|
3131
|
+
* Direct `@user` ids.
|
|
828
3132
|
* @public
|
|
829
3133
|
*/
|
|
830
|
-
|
|
3134
|
+
mentions?: (string)[] | undefined;
|
|
831
3135
|
/**
|
|
832
|
-
*
|
|
3136
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
833
3137
|
* @public
|
|
834
3138
|
*/
|
|
835
|
-
|
|
3139
|
+
whatsapp?: boolean | undefined;
|
|
3140
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
836
3141
|
/**
|
|
837
|
-
*
|
|
3142
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
838
3143
|
* @public
|
|
839
3144
|
*/
|
|
840
|
-
|
|
3145
|
+
sms?: boolean | undefined;
|
|
3146
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
841
3147
|
}
|
|
842
3148
|
/**
|
|
843
|
-
* Preview of the most recent visible message in a channel.
|
|
844
3149
|
* @public
|
|
845
3150
|
*/
|
|
846
|
-
export interface
|
|
847
|
-
messageId: string;
|
|
3151
|
+
export interface PartialUpdateMessageInput {
|
|
848
3152
|
/**
|
|
849
|
-
*
|
|
850
|
-
* @public
|
|
851
|
-
*/
|
|
852
|
-
userId: string;
|
|
853
|
-
/**
|
|
854
|
-
* Text body of the message. Absent for attachment-only or deleted messages.
|
|
3153
|
+
* The unique identifier of the tenant when a service token is used.
|
|
855
3154
|
* @public
|
|
856
3155
|
*/
|
|
857
|
-
|
|
3156
|
+
companyId?: string | undefined;
|
|
858
3157
|
/**
|
|
859
|
-
*
|
|
3158
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
860
3159
|
* @public
|
|
861
3160
|
*/
|
|
862
|
-
|
|
863
|
-
}
|
|
864
|
-
/**
|
|
865
|
-
* Channel item returned by inbox and channel listings. Includes per-user inbox state and last-message preview.
|
|
866
|
-
* @public
|
|
867
|
-
*/
|
|
868
|
-
export interface InboxChannel {
|
|
3161
|
+
userId?: string | undefined;
|
|
869
3162
|
channelId: string;
|
|
3163
|
+
messageId: string;
|
|
870
3164
|
/**
|
|
871
|
-
*
|
|
872
|
-
* @public
|
|
873
|
-
*/
|
|
874
|
-
channelType: ChannelType;
|
|
875
|
-
/**
|
|
876
|
-
* Channel subject.
|
|
877
|
-
* @public
|
|
878
|
-
*/
|
|
879
|
-
subject?: string | undefined;
|
|
880
|
-
/**
|
|
881
|
-
* Channel description.
|
|
882
|
-
* @public
|
|
883
|
-
*/
|
|
884
|
-
description?: string | undefined;
|
|
885
|
-
/**
|
|
886
|
-
* Picture URL
|
|
3165
|
+
* Fields to set during the partial update.
|
|
887
3166
|
* @public
|
|
888
3167
|
*/
|
|
889
|
-
|
|
3168
|
+
set?: PartialUpdateMessageSetInput | undefined;
|
|
890
3169
|
/**
|
|
891
|
-
*
|
|
3170
|
+
* Fields to clear during the partial update.
|
|
892
3171
|
* @public
|
|
893
3172
|
*/
|
|
894
|
-
|
|
3173
|
+
unset?: (MessageUnsetFields)[] | undefined;
|
|
895
3174
|
/**
|
|
896
|
-
*
|
|
3175
|
+
* Suppress the updated indicator for this edit.
|
|
897
3176
|
* @public
|
|
898
3177
|
*/
|
|
899
|
-
|
|
3178
|
+
silent?: boolean | undefined;
|
|
3179
|
+
}
|
|
3180
|
+
/**
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
export interface PartialUpdateMessageOutput {
|
|
900
3184
|
/**
|
|
901
|
-
*
|
|
3185
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
902
3186
|
* @public
|
|
903
3187
|
*/
|
|
904
|
-
|
|
3188
|
+
message: Message;
|
|
3189
|
+
}
|
|
3190
|
+
/**
|
|
3191
|
+
* @public
|
|
3192
|
+
*/
|
|
3193
|
+
export interface PinChannelInput {
|
|
905
3194
|
/**
|
|
906
|
-
*
|
|
3195
|
+
* The unique identifier of the tenant when a service token is used.
|
|
907
3196
|
* @public
|
|
908
3197
|
*/
|
|
909
|
-
|
|
3198
|
+
companyId?: string | undefined;
|
|
910
3199
|
/**
|
|
911
|
-
*
|
|
3200
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
912
3201
|
* @public
|
|
913
3202
|
*/
|
|
914
|
-
|
|
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";
|
|
915
3218
|
/**
|
|
916
|
-
*
|
|
917
|
-
* @public
|
|
3219
|
+
* @internal
|
|
918
3220
|
*/
|
|
919
|
-
|
|
3221
|
+
constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
|
|
3222
|
+
}
|
|
3223
|
+
/**
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
export interface PinMessageInput {
|
|
920
3227
|
/**
|
|
921
|
-
*
|
|
3228
|
+
* The unique identifier of the tenant when a service token is used.
|
|
922
3229
|
* @public
|
|
923
3230
|
*/
|
|
924
|
-
|
|
3231
|
+
companyId?: string | undefined;
|
|
925
3232
|
/**
|
|
926
|
-
*
|
|
3233
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
927
3234
|
* @public
|
|
928
3235
|
*/
|
|
929
|
-
|
|
3236
|
+
userId?: string | undefined;
|
|
3237
|
+
channelId: string;
|
|
3238
|
+
messageId: string;
|
|
3239
|
+
}
|
|
3240
|
+
/**
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
export interface PinMessageOutput {
|
|
930
3244
|
/**
|
|
931
|
-
*
|
|
3245
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
932
3246
|
* @public
|
|
933
3247
|
*/
|
|
934
|
-
|
|
935
|
-
access?: ChannelAccess | undefined;
|
|
936
|
-
company?: string | undefined;
|
|
937
|
-
context?: ChannelContext | undefined;
|
|
938
|
-
kite?: boolean | undefined;
|
|
939
|
-
kiteTarget?: string | undefined;
|
|
940
|
-
kiteVariant?: string | undefined;
|
|
941
|
-
kiteAssign?: string | undefined;
|
|
942
|
-
kiteServiceName?: string | undefined;
|
|
943
|
-
kiteDefaultSubject?: string | undefined;
|
|
944
|
-
service?: string | undefined;
|
|
945
|
-
serviceTitle?: string | undefined;
|
|
946
|
-
serviceRecipient?: string | undefined;
|
|
947
|
-
assignee?: string | undefined;
|
|
948
|
-
telephony?: boolean | undefined;
|
|
949
|
-
sms?: boolean | undefined;
|
|
950
|
-
mms?: boolean | undefined;
|
|
951
|
-
whatsapp?: boolean | undefined;
|
|
952
|
-
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
953
|
-
broadcast?: boolean | undefined;
|
|
954
|
-
external?: boolean | undefined;
|
|
955
|
-
autoRecord?: boolean | undefined;
|
|
956
|
-
transcriptionLanguage?: string | undefined;
|
|
957
|
-
wizyGuestViewOnly?: boolean | undefined;
|
|
3248
|
+
message: Message;
|
|
958
3249
|
}
|
|
959
3250
|
/**
|
|
960
3251
|
* @public
|
|
961
|
-
* @enum
|
|
962
3252
|
*/
|
|
963
|
-
export
|
|
3253
|
+
export interface QueryChannelsInput {
|
|
964
3254
|
/**
|
|
965
|
-
*
|
|
3255
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3256
|
+
* @public
|
|
966
3257
|
*/
|
|
967
|
-
|
|
3258
|
+
companyId?: string | undefined;
|
|
968
3259
|
/**
|
|
969
|
-
*
|
|
3260
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3261
|
+
* @public
|
|
970
3262
|
*/
|
|
971
|
-
|
|
972
|
-
|
|
3263
|
+
userId?: string | undefined;
|
|
3264
|
+
/**
|
|
3265
|
+
* Batch channel lookup query.
|
|
3266
|
+
* @public
|
|
3267
|
+
*/
|
|
3268
|
+
query: ChannelsQuery;
|
|
3269
|
+
}
|
|
973
3270
|
/**
|
|
974
3271
|
* @public
|
|
975
3272
|
*/
|
|
976
|
-
export
|
|
3273
|
+
export interface QueryChannelsOutput {
|
|
3274
|
+
channels: (InboxChannel)[];
|
|
3275
|
+
}
|
|
977
3276
|
/**
|
|
978
|
-
* Aggregated unread counters for an inbox section.
|
|
979
3277
|
* @public
|
|
980
3278
|
*/
|
|
981
|
-
export interface
|
|
982
|
-
/**
|
|
983
|
-
* Unmuted channels with at least one unread message.
|
|
984
|
-
* @public
|
|
985
|
-
*/
|
|
986
|
-
unmutedUnreadChannelCount: number;
|
|
3279
|
+
export interface RemoveChannelFromSectionInput {
|
|
987
3280
|
/**
|
|
988
|
-
*
|
|
3281
|
+
* The unique identifier of the tenant when a service token is used.
|
|
989
3282
|
* @public
|
|
990
3283
|
*/
|
|
991
|
-
|
|
3284
|
+
companyId?: string | undefined;
|
|
992
3285
|
/**
|
|
993
|
-
*
|
|
3286
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
994
3287
|
* @public
|
|
995
3288
|
*/
|
|
996
|
-
|
|
3289
|
+
userId?: string | undefined;
|
|
3290
|
+
channelId: string;
|
|
997
3291
|
/**
|
|
998
|
-
*
|
|
3292
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
999
3293
|
* @public
|
|
1000
3294
|
*/
|
|
1001
|
-
|
|
3295
|
+
sectionId: string;
|
|
1002
3296
|
}
|
|
1003
3297
|
/**
|
|
1004
|
-
* Inbox section with metadata, channel count, and unread counters.
|
|
1005
3298
|
* @public
|
|
1006
3299
|
*/
|
|
1007
|
-
export interface
|
|
1008
|
-
/**
|
|
1009
|
-
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1010
|
-
* @public
|
|
1011
|
-
*/
|
|
1012
|
-
sectionId: string;
|
|
3300
|
+
export interface RemoveChannelFromSectionOutput {
|
|
1013
3301
|
/**
|
|
1014
|
-
*
|
|
3302
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1015
3303
|
* @public
|
|
1016
3304
|
*/
|
|
1017
|
-
|
|
3305
|
+
inbox: InboxState;
|
|
3306
|
+
}
|
|
3307
|
+
/**
|
|
3308
|
+
* @public
|
|
3309
|
+
*/
|
|
3310
|
+
export interface RenameSectionInput {
|
|
1018
3311
|
/**
|
|
1019
|
-
*
|
|
3312
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1020
3313
|
* @public
|
|
1021
3314
|
*/
|
|
1022
|
-
|
|
3315
|
+
companyId?: string | undefined;
|
|
1023
3316
|
/**
|
|
1024
|
-
*
|
|
3317
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1025
3318
|
* @public
|
|
1026
3319
|
*/
|
|
1027
|
-
|
|
3320
|
+
userId?: string | undefined;
|
|
1028
3321
|
/**
|
|
1029
|
-
*
|
|
3322
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1030
3323
|
* @public
|
|
1031
3324
|
*/
|
|
1032
|
-
|
|
3325
|
+
sectionId: string;
|
|
3326
|
+
name: string;
|
|
1033
3327
|
}
|
|
1034
3328
|
/**
|
|
1035
3329
|
* @public
|
|
1036
3330
|
*/
|
|
1037
|
-
export interface
|
|
1038
|
-
/**
|
|
1039
|
-
* Recent channels with per-user state and last-message preview.
|
|
1040
|
-
* @public
|
|
1041
|
-
*/
|
|
1042
|
-
channels: (InboxChannel)[];
|
|
3331
|
+
export interface RenameSectionOutput {
|
|
1043
3332
|
/**
|
|
1044
|
-
* Inbox
|
|
3333
|
+
* Inbox section with metadata, channel count, and unread counters.
|
|
1045
3334
|
* @public
|
|
1046
3335
|
*/
|
|
1047
|
-
|
|
3336
|
+
section: Section;
|
|
1048
3337
|
}
|
|
1049
3338
|
/**
|
|
1050
3339
|
* @public
|
|
1051
3340
|
*/
|
|
1052
|
-
export interface
|
|
3341
|
+
export interface SendGiphyInput {
|
|
1053
3342
|
/**
|
|
1054
3343
|
* The unique identifier of the tenant when a service token is used.
|
|
1055
3344
|
* @public
|
|
@@ -1061,12 +3350,32 @@ export interface GetMessageInput {
|
|
|
1061
3350
|
*/
|
|
1062
3351
|
userId?: string | undefined;
|
|
1063
3352
|
channelId: string;
|
|
1064
|
-
|
|
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;
|
|
1065
3374
|
}
|
|
1066
3375
|
/**
|
|
1067
3376
|
* @public
|
|
1068
3377
|
*/
|
|
1069
|
-
export interface
|
|
3378
|
+
export interface SendGiphyOutput {
|
|
1070
3379
|
/**
|
|
1071
3380
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1072
3381
|
* @public
|
|
@@ -1076,7 +3385,7 @@ export interface GetMessageOutput {
|
|
|
1076
3385
|
/**
|
|
1077
3386
|
* @public
|
|
1078
3387
|
*/
|
|
1079
|
-
export interface
|
|
3388
|
+
export interface SendMessageInput {
|
|
1080
3389
|
/**
|
|
1081
3390
|
* The unique identifier of the tenant when a service token is used.
|
|
1082
3391
|
* @public
|
|
@@ -1088,54 +3397,83 @@ export interface ListChannelsInput {
|
|
|
1088
3397
|
*/
|
|
1089
3398
|
userId?: string | undefined;
|
|
1090
3399
|
/**
|
|
1091
|
-
*
|
|
3400
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
1092
3401
|
* @public
|
|
1093
3402
|
*/
|
|
1094
|
-
|
|
3403
|
+
text?: string | undefined;
|
|
1095
3404
|
/**
|
|
1096
|
-
*
|
|
3405
|
+
* Structured rich content blocks.
|
|
1097
3406
|
* @public
|
|
1098
3407
|
*/
|
|
1099
|
-
|
|
3408
|
+
elements?: (Element)[] | undefined;
|
|
1100
3409
|
/**
|
|
1101
|
-
*
|
|
3410
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1102
3411
|
* @public
|
|
1103
3412
|
*/
|
|
1104
|
-
|
|
1105
|
-
}
|
|
1106
|
-
/**
|
|
1107
|
-
* @public
|
|
1108
|
-
*/
|
|
1109
|
-
export interface ListChannelsOutput {
|
|
3413
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1110
3414
|
/**
|
|
1111
|
-
*
|
|
3415
|
+
* Reply context referencing a quoted message.
|
|
1112
3416
|
* @public
|
|
1113
3417
|
*/
|
|
1114
|
-
|
|
3418
|
+
quote?: MessageQuoteRef | undefined;
|
|
1115
3419
|
/**
|
|
1116
|
-
*
|
|
3420
|
+
* Source reference for a forwarded message.
|
|
1117
3421
|
* @public
|
|
1118
3422
|
*/
|
|
1119
|
-
|
|
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;
|
|
1120
3462
|
}
|
|
1121
3463
|
/**
|
|
1122
3464
|
* @public
|
|
1123
|
-
* @enum
|
|
1124
3465
|
*/
|
|
1125
|
-
export
|
|
3466
|
+
export interface SendMessageOutput {
|
|
1126
3467
|
/**
|
|
1127
|
-
*
|
|
3468
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
3469
|
+
* @public
|
|
1128
3470
|
*/
|
|
1129
|
-
|
|
1130
|
-
}
|
|
1131
|
-
/**
|
|
1132
|
-
* @public
|
|
1133
|
-
*/
|
|
1134
|
-
export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
|
|
3471
|
+
message: Message;
|
|
3472
|
+
}
|
|
1135
3473
|
/**
|
|
1136
3474
|
* @public
|
|
1137
3475
|
*/
|
|
1138
|
-
export interface
|
|
3476
|
+
export interface SendMessageReactionInput {
|
|
1139
3477
|
/**
|
|
1140
3478
|
* The unique identifier of the tenant when a service token is used.
|
|
1141
3479
|
* @public
|
|
@@ -1146,116 +3484,159 @@ export interface ListMentionsInput {
|
|
|
1146
3484
|
* @public
|
|
1147
3485
|
*/
|
|
1148
3486
|
userId?: string | undefined;
|
|
3487
|
+
channelId: string;
|
|
3488
|
+
messageId: string;
|
|
1149
3489
|
/**
|
|
1150
|
-
*
|
|
1151
|
-
* @public
|
|
1152
|
-
*/
|
|
1153
|
-
filter?: MentionsFilter | undefined;
|
|
1154
|
-
/**
|
|
1155
|
-
* Opaque continuation token from the previous response.
|
|
3490
|
+
* Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
|
|
1156
3491
|
* @public
|
|
1157
3492
|
*/
|
|
1158
|
-
|
|
3493
|
+
type: string;
|
|
1159
3494
|
}
|
|
1160
3495
|
/**
|
|
1161
|
-
* Compact channel preview returned alongside a mention entry.
|
|
1162
3496
|
* @public
|
|
1163
3497
|
*/
|
|
1164
|
-
export interface
|
|
1165
|
-
channelId: string;
|
|
1166
|
-
/**
|
|
1167
|
-
* Type of channel.
|
|
1168
|
-
* @public
|
|
1169
|
-
*/
|
|
1170
|
-
channelType: ChannelType;
|
|
1171
|
-
/**
|
|
1172
|
-
* Channel subject.
|
|
1173
|
-
* @public
|
|
1174
|
-
*/
|
|
1175
|
-
subject?: string | undefined;
|
|
3498
|
+
export interface SendMessageReactionOutput {
|
|
1176
3499
|
/**
|
|
1177
|
-
*
|
|
3500
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1178
3501
|
* @public
|
|
1179
3502
|
*/
|
|
1180
|
-
|
|
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 {
|
|
1181
3520
|
/**
|
|
1182
|
-
*
|
|
3521
|
+
* WhatsApp channel closed after the 24-hour reply window.
|
|
1183
3522
|
* @public
|
|
1184
3523
|
*/
|
|
1185
|
-
|
|
3524
|
+
interface WhatsAppClosedMember {
|
|
3525
|
+
whatsAppClosed: WhatsAppClosedSystemMessage;
|
|
3526
|
+
multipleMembersJoined?: never;
|
|
3527
|
+
$unknown?: never;
|
|
3528
|
+
}
|
|
1186
3529
|
/**
|
|
1187
|
-
*
|
|
3530
|
+
* Multiple members joined the channel.
|
|
1188
3531
|
* @public
|
|
1189
3532
|
*/
|
|
1190
|
-
|
|
3533
|
+
interface MultipleMembersJoinedMember {
|
|
3534
|
+
whatsAppClosed?: never;
|
|
3535
|
+
multipleMembersJoined: MultipleMembersJoinedSystemMessage;
|
|
3536
|
+
$unknown?: never;
|
|
3537
|
+
}
|
|
1191
3538
|
/**
|
|
1192
|
-
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1193
3539
|
* @public
|
|
1194
3540
|
*/
|
|
1195
|
-
|
|
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;
|
|
1196
3552
|
}
|
|
1197
3553
|
/**
|
|
1198
|
-
* 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.
|
|
1199
3554
|
* @public
|
|
1200
3555
|
*/
|
|
1201
|
-
export interface
|
|
1202
|
-
channelId: string;
|
|
1203
|
-
messageId: string;
|
|
3556
|
+
export interface SendSystemMessageInput {
|
|
1204
3557
|
/**
|
|
1205
|
-
*
|
|
3558
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1206
3559
|
* @public
|
|
1207
3560
|
*/
|
|
1208
|
-
|
|
3561
|
+
companyId?: string | undefined;
|
|
1209
3562
|
/**
|
|
1210
|
-
*
|
|
3563
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1211
3564
|
* @public
|
|
1212
3565
|
*/
|
|
1213
|
-
|
|
3566
|
+
userId?: string | undefined;
|
|
3567
|
+
channelId: string;
|
|
1214
3568
|
/**
|
|
1215
|
-
*
|
|
3569
|
+
* Typed system message payload. Each variant maps to a server-generated message template.
|
|
1216
3570
|
* @public
|
|
1217
3571
|
*/
|
|
1218
|
-
|
|
3572
|
+
message: SystemMessage;
|
|
1219
3573
|
/**
|
|
1220
|
-
*
|
|
3574
|
+
* Optional system event identifier for client rendering.
|
|
1221
3575
|
* @public
|
|
1222
3576
|
*/
|
|
1223
|
-
|
|
3577
|
+
event?: string | undefined;
|
|
1224
3578
|
/**
|
|
1225
|
-
*
|
|
3579
|
+
* Suppress push notifications and unread indicators.
|
|
1226
3580
|
* @public
|
|
1227
3581
|
*/
|
|
1228
|
-
|
|
3582
|
+
silent?: boolean | undefined;
|
|
3583
|
+
}
|
|
3584
|
+
/**
|
|
3585
|
+
* @public
|
|
3586
|
+
*/
|
|
3587
|
+
export interface SendSystemMessageOutput {
|
|
1229
3588
|
/**
|
|
1230
3589
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1231
3590
|
* @public
|
|
1232
3591
|
*/
|
|
1233
3592
|
message: Message;
|
|
3593
|
+
}
|
|
3594
|
+
/**
|
|
3595
|
+
* @public
|
|
3596
|
+
*/
|
|
3597
|
+
export interface SendTypingStartInput {
|
|
1234
3598
|
/**
|
|
1235
|
-
*
|
|
3599
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1236
3600
|
* @public
|
|
1237
3601
|
*/
|
|
1238
|
-
|
|
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;
|
|
1239
3609
|
}
|
|
1240
3610
|
/**
|
|
1241
3611
|
* @public
|
|
1242
3612
|
*/
|
|
1243
|
-
export interface
|
|
3613
|
+
export interface SendTypingStartOutput {
|
|
3614
|
+
}
|
|
3615
|
+
/**
|
|
3616
|
+
* @public
|
|
3617
|
+
*/
|
|
3618
|
+
export interface SendTypingStopInput {
|
|
1244
3619
|
/**
|
|
1245
|
-
*
|
|
3620
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1246
3621
|
* @public
|
|
1247
3622
|
*/
|
|
1248
|
-
|
|
3623
|
+
companyId?: string | undefined;
|
|
1249
3624
|
/**
|
|
1250
|
-
*
|
|
3625
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1251
3626
|
* @public
|
|
1252
3627
|
*/
|
|
1253
|
-
|
|
3628
|
+
userId?: string | undefined;
|
|
3629
|
+
channelId: string;
|
|
1254
3630
|
}
|
|
1255
3631
|
/**
|
|
1256
3632
|
* @public
|
|
1257
3633
|
*/
|
|
1258
|
-
export interface
|
|
3634
|
+
export interface SendTypingStopOutput {
|
|
3635
|
+
}
|
|
3636
|
+
/**
|
|
3637
|
+
* @public
|
|
3638
|
+
*/
|
|
3639
|
+
export interface ShowChannelInput {
|
|
1259
3640
|
/**
|
|
1260
3641
|
* The unique identifier of the tenant when a service token is used.
|
|
1261
3642
|
* @public
|
|
@@ -1267,47 +3648,63 @@ export interface ListMessagesInput {
|
|
|
1267
3648
|
*/
|
|
1268
3649
|
userId?: string | undefined;
|
|
1269
3650
|
channelId: string;
|
|
3651
|
+
}
|
|
3652
|
+
/**
|
|
3653
|
+
* @public
|
|
3654
|
+
*/
|
|
3655
|
+
export interface ShowChannelOutput {
|
|
3656
|
+
}
|
|
3657
|
+
/**
|
|
3658
|
+
* @public
|
|
3659
|
+
*/
|
|
3660
|
+
export interface UnmuteChannelInput {
|
|
1270
3661
|
/**
|
|
1271
|
-
*
|
|
3662
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1272
3663
|
* @public
|
|
1273
3664
|
*/
|
|
1274
|
-
|
|
3665
|
+
companyId?: string | undefined;
|
|
1275
3666
|
/**
|
|
1276
|
-
*
|
|
3667
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1277
3668
|
* @public
|
|
1278
3669
|
*/
|
|
1279
|
-
|
|
3670
|
+
userId?: string | undefined;
|
|
3671
|
+
channelId: string;
|
|
1280
3672
|
}
|
|
1281
3673
|
/**
|
|
1282
3674
|
* @public
|
|
1283
3675
|
*/
|
|
1284
|
-
export interface
|
|
3676
|
+
export interface UnmuteChannelOutput {
|
|
1285
3677
|
/**
|
|
1286
|
-
*
|
|
3678
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1287
3679
|
* @public
|
|
1288
3680
|
*/
|
|
1289
|
-
|
|
3681
|
+
inbox: InboxState;
|
|
1290
3682
|
}
|
|
1291
3683
|
/**
|
|
1292
|
-
* Forward reference supplied by the client. The server resolves the original author and snapshot fields at write time.
|
|
1293
3684
|
* @public
|
|
1294
3685
|
*/
|
|
1295
|
-
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;
|
|
1296
3697
|
channelId: string;
|
|
1297
|
-
messageId: string;
|
|
1298
3698
|
}
|
|
1299
3699
|
/**
|
|
1300
|
-
* Quote reference supplied by the client. The server resolves the author and snapshot fields at write time.
|
|
1301
3700
|
* @public
|
|
1302
3701
|
*/
|
|
1303
|
-
export interface
|
|
1304
|
-
channelId: string;
|
|
1305
|
-
messageId: string;
|
|
3702
|
+
export interface UnpinChannelOutput {
|
|
1306
3703
|
}
|
|
1307
3704
|
/**
|
|
1308
3705
|
* @public
|
|
1309
3706
|
*/
|
|
1310
|
-
export interface
|
|
3707
|
+
export interface UnpinMessageInput {
|
|
1311
3708
|
/**
|
|
1312
3709
|
* The unique identifier of the tenant when a service token is used.
|
|
1313
3710
|
* @public
|
|
@@ -1324,7 +3721,7 @@ export interface PinMessageInput {
|
|
|
1324
3721
|
/**
|
|
1325
3722
|
* @public
|
|
1326
3723
|
*/
|
|
1327
|
-
export interface
|
|
3724
|
+
export interface UnpinMessageOutput {
|
|
1328
3725
|
/**
|
|
1329
3726
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1330
3727
|
* @public
|
|
@@ -1334,7 +3731,7 @@ export interface PinMessageOutput {
|
|
|
1334
3731
|
/**
|
|
1335
3732
|
* @public
|
|
1336
3733
|
*/
|
|
1337
|
-
export interface
|
|
3734
|
+
export interface UpdateChannelInput {
|
|
1338
3735
|
/**
|
|
1339
3736
|
* The unique identifier of the tenant when a service token is used.
|
|
1340
3737
|
* @public
|
|
@@ -1345,28 +3742,96 @@ export interface RemoveReactionInput {
|
|
|
1345
3742
|
* @public
|
|
1346
3743
|
*/
|
|
1347
3744
|
userId?: string | undefined;
|
|
1348
|
-
channelId: string;
|
|
1349
|
-
messageId: string;
|
|
1350
3745
|
/**
|
|
1351
|
-
*
|
|
3746
|
+
* The subject of the channel.
|
|
1352
3747
|
* @public
|
|
1353
3748
|
*/
|
|
1354
|
-
|
|
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;
|
|
1355
3824
|
}
|
|
1356
3825
|
/**
|
|
1357
3826
|
* @public
|
|
1358
3827
|
*/
|
|
1359
|
-
export interface
|
|
1360
|
-
|
|
1361
|
-
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1362
|
-
* @public
|
|
1363
|
-
*/
|
|
1364
|
-
message: Message;
|
|
3828
|
+
export interface UpdateChannelOutput {
|
|
3829
|
+
channel: Channel;
|
|
1365
3830
|
}
|
|
1366
3831
|
/**
|
|
1367
3832
|
* @public
|
|
1368
3833
|
*/
|
|
1369
|
-
export interface
|
|
3834
|
+
export interface UpdateMessageInput {
|
|
1370
3835
|
/**
|
|
1371
3836
|
* The unique identifier of the tenant when a service token is used.
|
|
1372
3837
|
* @public
|
|
@@ -1377,27 +3842,21 @@ export interface SendMessageInput {
|
|
|
1377
3842
|
* @public
|
|
1378
3843
|
*/
|
|
1379
3844
|
userId?: string | undefined;
|
|
1380
|
-
channelId: string;
|
|
1381
|
-
/**
|
|
1382
|
-
* Rendering hint for the message.
|
|
1383
|
-
* @public
|
|
1384
|
-
*/
|
|
1385
|
-
messageType?: MessageType | undefined;
|
|
1386
3845
|
/**
|
|
1387
3846
|
* Text body. Required unless `attachments` is non-empty.
|
|
1388
3847
|
* @public
|
|
1389
3848
|
*/
|
|
1390
3849
|
text?: string | undefined;
|
|
1391
3850
|
/**
|
|
1392
|
-
*
|
|
3851
|
+
* Structured rich content blocks.
|
|
1393
3852
|
* @public
|
|
1394
3853
|
*/
|
|
1395
|
-
|
|
3854
|
+
elements?: (Element)[] | undefined;
|
|
1396
3855
|
/**
|
|
1397
|
-
*
|
|
3856
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1398
3857
|
* @public
|
|
1399
3858
|
*/
|
|
1400
|
-
|
|
3859
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1401
3860
|
/**
|
|
1402
3861
|
* Reply context referencing a quoted message.
|
|
1403
3862
|
* @public
|
|
@@ -1409,15 +3868,39 @@ export interface SendMessageInput {
|
|
|
1409
3868
|
*/
|
|
1410
3869
|
forward?: MessageForwardRef | undefined;
|
|
1411
3870
|
/**
|
|
1412
|
-
*
|
|
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.
|
|
3888
|
+
* @public
|
|
3889
|
+
*/
|
|
3890
|
+
sms?: boolean | undefined;
|
|
3891
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
3892
|
+
channelId: string;
|
|
3893
|
+
messageId: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* Suppress the updated indicator for this edit.
|
|
1413
3896
|
* @public
|
|
1414
3897
|
*/
|
|
1415
|
-
|
|
3898
|
+
silent?: boolean | undefined;
|
|
1416
3899
|
}
|
|
1417
3900
|
/**
|
|
1418
3901
|
* @public
|
|
1419
3902
|
*/
|
|
1420
|
-
export interface
|
|
3903
|
+
export interface UpdateMessageOutput {
|
|
1421
3904
|
/**
|
|
1422
3905
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1423
3906
|
* @public
|
|
@@ -1425,9 +3908,25 @@ export interface SendMessageOutput {
|
|
|
1425
3908
|
message: Message;
|
|
1426
3909
|
}
|
|
1427
3910
|
/**
|
|
3911
|
+
* Optional parameters for the upload presign flow.
|
|
1428
3912
|
* @public
|
|
1429
3913
|
*/
|
|
1430
|
-
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 {
|
|
1431
3930
|
/**
|
|
1432
3931
|
* The unique identifier of the tenant when a service token is used.
|
|
1433
3932
|
* @public
|
|
@@ -1439,15 +3938,29 @@ export interface UnpinMessageInput {
|
|
|
1439
3938
|
*/
|
|
1440
3939
|
userId?: string | undefined;
|
|
1441
3940
|
channelId: string;
|
|
1442
|
-
|
|
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;
|
|
1443
3951
|
}
|
|
1444
3952
|
/**
|
|
1445
3953
|
* @public
|
|
1446
3954
|
*/
|
|
1447
|
-
export interface
|
|
3955
|
+
export interface UploadFileOutput {
|
|
1448
3956
|
/**
|
|
1449
|
-
*
|
|
3957
|
+
* File service identifier. Pass this value as `attachments[].fsId` on send and edit.
|
|
1450
3958
|
* @public
|
|
1451
3959
|
*/
|
|
1452
|
-
|
|
3960
|
+
fsId: string;
|
|
3961
|
+
/**
|
|
3962
|
+
* Presigned URL for uploading the file contents.
|
|
3963
|
+
* @public
|
|
3964
|
+
*/
|
|
3965
|
+
presignedUploadUrl: string;
|
|
1453
3966
|
}
|