@wildix/stream-client 0.0.4 → 0.0.6
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 +255 -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 +243 -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} +27 -28
- 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 +5 -6
- 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 +6 -7
- package/dist-types/commands/ListMessagesCommand.d.ts +5 -6
- 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 +5 -6
- 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} +41 -42
- package/dist-types/commands/SendMessageCommand.d.ts +53 -13
- package/dist-types/commands/{AddReactionCommand.d.ts → SendMessageReactionCommand.d.ts} +28 -29
- 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 +5 -6
- 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 +3077 -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,2736 @@ 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 DELETED: "deleted";
|
|
1508
|
+
readonly REGULAR: "regular";
|
|
1509
|
+
readonly SYSTEM: "system";
|
|
1510
|
+
};
|
|
1511
|
+
/**
|
|
1512
|
+
* @public
|
|
1513
|
+
*/
|
|
1514
|
+
export type MessageType = typeof MessageType[keyof typeof MessageType];
|
|
1515
|
+
/**
|
|
1516
|
+
* Reference to a quoted message.
|
|
1517
|
+
* @public
|
|
1518
|
+
*/
|
|
1519
|
+
export interface MessageQuote {
|
|
1520
|
+
channelId: string;
|
|
1521
|
+
messageId: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* Author of the quoted message.
|
|
1524
|
+
* @public
|
|
1525
|
+
*/
|
|
1526
|
+
userId: string;
|
|
1527
|
+
/**
|
|
1528
|
+
* Text body captured at quote time.
|
|
1529
|
+
* @public
|
|
1530
|
+
*/
|
|
1531
|
+
text?: string | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1536
|
+
createdAt: string;
|
|
1537
|
+
}
|
|
1538
|
+
/**
|
|
1539
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1540
|
+
* @public
|
|
1541
|
+
*/
|
|
1542
|
+
export interface Message {
|
|
1543
|
+
messageId: string;
|
|
1544
|
+
/**
|
|
1545
|
+
* Author of the message.
|
|
1546
|
+
* @public
|
|
1547
|
+
*/
|
|
1548
|
+
userId: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Type of message row.
|
|
1551
|
+
* @public
|
|
1552
|
+
*/
|
|
1553
|
+
messageType: MessageType;
|
|
1554
|
+
/**
|
|
1555
|
+
* Text body. Empty for attachment-only or deleted messages.
|
|
1556
|
+
* @public
|
|
1557
|
+
*/
|
|
1558
|
+
text?: string | undefined;
|
|
1559
|
+
/**
|
|
1560
|
+
* Attached files.
|
|
1561
|
+
* @public
|
|
1562
|
+
*/
|
|
1563
|
+
attachments: (MessageAttachment)[];
|
|
1564
|
+
/**
|
|
1565
|
+
* Users directly mentioned in the message.
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
mentions: (string)[];
|
|
1569
|
+
/**
|
|
1570
|
+
* Quoted message reference.
|
|
1571
|
+
* @public
|
|
1572
|
+
*/
|
|
1573
|
+
quote?: MessageQuote | undefined;
|
|
1574
|
+
/**
|
|
1575
|
+
* Forwarded message reference.
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
forward?: MessageForward | undefined;
|
|
1579
|
+
/**
|
|
1580
|
+
* Per-emoji reaction counters. Keys are reaction type ids (e.g. `thumbsup`).
|
|
1581
|
+
* @public
|
|
1582
|
+
*/
|
|
1583
|
+
reactionCounts: Record<string, number>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Most recent reactions per type. Fetch the full list on demand.
|
|
1586
|
+
* @public
|
|
1587
|
+
*/
|
|
1588
|
+
latestReactions?: (Reaction)[] | undefined;
|
|
1589
|
+
/**
|
|
1590
|
+
* True when the message is currently pinned at channel scope.
|
|
1591
|
+
* @public
|
|
1592
|
+
*/
|
|
1593
|
+
pinned: boolean;
|
|
1594
|
+
/**
|
|
1595
|
+
* Timestamp at which the message was pinned. Absent when not pinned.
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1598
|
+
pinnedAt?: string | undefined;
|
|
1599
|
+
/**
|
|
1600
|
+
* User that pinned the message. Absent when not pinned.
|
|
1601
|
+
* @public
|
|
1602
|
+
*/
|
|
1603
|
+
pinnedBy?: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* True when the message is system-generated.
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
system: boolean;
|
|
1609
|
+
/**
|
|
1610
|
+
* Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
|
|
1611
|
+
* @public
|
|
1612
|
+
*/
|
|
1613
|
+
timelineSeq: number;
|
|
1614
|
+
/**
|
|
1615
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
visibleSeq: number;
|
|
1619
|
+
/**
|
|
1620
|
+
* Channel version. Increments on every channel mutation.
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
channelVersion: number;
|
|
1624
|
+
/**
|
|
1625
|
+
* Message version. Increments on every message mutation.
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
messageVersion: number;
|
|
1629
|
+
/**
|
|
1630
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
createdAt: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* Timestamp of the most recent edit.
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
editedAt?: string | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* Tombstone timestamp.
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
deletedAt?: string | undefined;
|
|
1644
|
+
elements?: (Element)[] | undefined;
|
|
1645
|
+
whatsapp?: boolean | undefined;
|
|
1646
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1647
|
+
sms?: boolean | undefined;
|
|
1648
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1649
|
+
markdown?: boolean | undefined;
|
|
1650
|
+
giphy?: MessageGiphy | undefined;
|
|
1651
|
+
silent?: boolean | undefined;
|
|
1652
|
+
/**
|
|
1653
|
+
* System event identifier for client rendering.
|
|
1654
|
+
* @public
|
|
1655
|
+
*/
|
|
1656
|
+
event?: string | undefined;
|
|
1657
|
+
}
|
|
1658
|
+
/**
|
|
1659
|
+
* @public
|
|
1660
|
+
*/
|
|
1661
|
+
export interface DeleteMessageReactionOutput {
|
|
1662
|
+
/**
|
|
1663
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1666
|
+
message: Message;
|
|
1667
|
+
}
|
|
1668
|
+
/**
|
|
1669
|
+
* @public
|
|
1670
|
+
*/
|
|
1671
|
+
export interface DeleteSectionInput {
|
|
1672
|
+
/**
|
|
1673
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
companyId?: string | undefined;
|
|
1677
|
+
/**
|
|
1678
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1679
|
+
* @public
|
|
1680
|
+
*/
|
|
1681
|
+
userId?: string | undefined;
|
|
1682
|
+
/**
|
|
1683
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
sectionId: string;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* @public
|
|
1690
|
+
*/
|
|
1691
|
+
export interface DeleteSectionOutput {
|
|
1692
|
+
}
|
|
1693
|
+
/**
|
|
1694
|
+
* @public
|
|
1695
|
+
*/
|
|
1696
|
+
export declare class SectionNotFoundException extends __BaseException {
|
|
1697
|
+
readonly name: "SectionNotFoundException";
|
|
1698
|
+
readonly $fault: "client";
|
|
1699
|
+
/**
|
|
1700
|
+
* @internal
|
|
1701
|
+
*/
|
|
1702
|
+
constructor(opts: __ExceptionOptionType<SectionNotFoundException, __BaseException>);
|
|
1703
|
+
}
|
|
1704
|
+
export declare enum DownloadStrategy {
|
|
1705
|
+
DEFAULT = 0,
|
|
1706
|
+
DOWNLOAD = 1
|
|
1707
|
+
}
|
|
1708
|
+
/**
|
|
1709
|
+
* @public
|
|
1710
|
+
* @enum
|
|
1711
|
+
*/
|
|
1712
|
+
export declare const FileCategory: {
|
|
1713
|
+
/**
|
|
1714
|
+
* Channel-attached files. Default.
|
|
1715
|
+
*/
|
|
1716
|
+
readonly GENERAL: "channels";
|
|
1717
|
+
/**
|
|
1718
|
+
* Conference recordings.
|
|
1719
|
+
*/
|
|
1720
|
+
readonly RECORDING: "recordings";
|
|
1721
|
+
/**
|
|
1722
|
+
* Wizy conference recordings.
|
|
1723
|
+
*/
|
|
1724
|
+
readonly WIZY_RECORDING: "wizyconfRecordings";
|
|
1725
|
+
};
|
|
1726
|
+
/**
|
|
1727
|
+
* @public
|
|
1728
|
+
*/
|
|
1729
|
+
export type FileCategory = typeof FileCategory[keyof typeof FileCategory];
|
|
1730
|
+
/**
|
|
1731
|
+
* @public
|
|
1732
|
+
*/
|
|
1733
|
+
export declare class FileNotFoundException extends __BaseException {
|
|
1734
|
+
readonly name: "FileNotFoundException";
|
|
1735
|
+
readonly $fault: "client";
|
|
1736
|
+
/**
|
|
1737
|
+
* @internal
|
|
1738
|
+
*/
|
|
1739
|
+
constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
|
|
1740
|
+
}
|
|
1741
|
+
/**
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
export interface GetChannelInput {
|
|
1745
|
+
/**
|
|
1746
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1747
|
+
* @public
|
|
1748
|
+
*/
|
|
1749
|
+
companyId?: string | undefined;
|
|
1750
|
+
/**
|
|
1751
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
userId?: string | undefined;
|
|
1755
|
+
channelId: string;
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* @public
|
|
1759
|
+
*/
|
|
1760
|
+
export interface GetChannelOutput {
|
|
1761
|
+
channel: Channel;
|
|
1762
|
+
}
|
|
1763
|
+
/**
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
export interface GetChannelMemberInput {
|
|
1767
|
+
/**
|
|
1768
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1769
|
+
* @public
|
|
1770
|
+
*/
|
|
1771
|
+
companyId?: string | undefined;
|
|
1772
|
+
/**
|
|
1773
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1774
|
+
* @public
|
|
1775
|
+
*/
|
|
1776
|
+
userId?: string | undefined;
|
|
1777
|
+
channelId: string;
|
|
1778
|
+
memberId: string;
|
|
1779
|
+
}
|
|
1780
|
+
/**
|
|
1781
|
+
* @public
|
|
1782
|
+
*/
|
|
1783
|
+
export interface GetChannelMemberOutput {
|
|
1784
|
+
/**
|
|
1785
|
+
* Channel membership row.
|
|
1786
|
+
* @public
|
|
1787
|
+
*/
|
|
1788
|
+
member: ChannelMember;
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1793
|
+
export interface GetDirectChannelIdInput {
|
|
1794
|
+
/**
|
|
1795
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1796
|
+
* @public
|
|
1797
|
+
*/
|
|
1798
|
+
companyId?: string | undefined;
|
|
1799
|
+
/**
|
|
1800
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1801
|
+
* @public
|
|
1802
|
+
*/
|
|
1803
|
+
userId?: string | undefined;
|
|
1804
|
+
memberId?: string | undefined;
|
|
1805
|
+
/**
|
|
1806
|
+
* User invitation payload used when creating channels or adding members.
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1810
|
+
}
|
|
1811
|
+
/**
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
export interface GetDirectChannelIdOutput {
|
|
1815
|
+
channelId: string;
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* @public
|
|
1819
|
+
*/
|
|
1820
|
+
export interface GetFilePresignedDownloadUrlInput {
|
|
1821
|
+
/**
|
|
1822
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1823
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
companyId?: string | undefined;
|
|
1826
|
+
/**
|
|
1827
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
userId?: string | undefined;
|
|
1831
|
+
channelId: string;
|
|
1832
|
+
messageId: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* File service identifier of the attachment to download.
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
fsId: string;
|
|
1838
|
+
/**
|
|
1839
|
+
* File storage category.
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
category?: FileCategory | undefined;
|
|
1843
|
+
/**
|
|
1844
|
+
* Download behavior. `0` opens inline for audio/video when supported; `1` always forces download.
|
|
1845
|
+
* @public
|
|
1846
|
+
*/
|
|
1847
|
+
download?: DownloadStrategy | undefined;
|
|
1848
|
+
}
|
|
1849
|
+
/**
|
|
1850
|
+
* @public
|
|
1851
|
+
*/
|
|
1852
|
+
export interface GetFilePresignedDownloadUrlOutput {
|
|
1853
|
+
/**
|
|
1854
|
+
* Presigned URL for downloading the file.
|
|
1855
|
+
* @public
|
|
1856
|
+
*/
|
|
1857
|
+
presignedDownloadUrl: string;
|
|
1858
|
+
}
|
|
1859
|
+
/**
|
|
1860
|
+
* @public
|
|
1861
|
+
*/
|
|
1862
|
+
export interface GetInboxInput {
|
|
1863
|
+
/**
|
|
1864
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1865
|
+
* @public
|
|
1866
|
+
*/
|
|
1867
|
+
companyId?: string | undefined;
|
|
1868
|
+
/**
|
|
1869
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1870
|
+
* @public
|
|
1871
|
+
*/
|
|
1872
|
+
userId?: string | undefined;
|
|
1873
|
+
}
|
|
1874
|
+
/**
|
|
1875
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
export interface InboxState {
|
|
1879
|
+
/**
|
|
1880
|
+
* Sections that include this channel.
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1883
|
+
sectionIds: (string)[];
|
|
1884
|
+
/**
|
|
1885
|
+
* Number of unread visible messages.
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
unreadCount: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* Number of unread mentions of the current user.
|
|
1891
|
+
* @public
|
|
1892
|
+
*/
|
|
1893
|
+
mentionUnreadCount: number;
|
|
1894
|
+
/**
|
|
1895
|
+
* Highest `visibleSeq` the user has read in this channel.
|
|
1896
|
+
* @public
|
|
1897
|
+
*/
|
|
1898
|
+
lastReadVisibleSeq?: number | undefined;
|
|
1899
|
+
/**
|
|
1900
|
+
* Timestamp of the most recent read event.
|
|
1901
|
+
* @public
|
|
1902
|
+
*/
|
|
1903
|
+
lastReadAt?: string | undefined;
|
|
1904
|
+
/**
|
|
1905
|
+
* True when the channel is hidden (archived).
|
|
1906
|
+
* @public
|
|
1907
|
+
*/
|
|
1908
|
+
hidden: boolean;
|
|
1909
|
+
/**
|
|
1910
|
+
* True when the channel is muted.
|
|
1911
|
+
* @public
|
|
1912
|
+
*/
|
|
1913
|
+
muted: boolean;
|
|
1914
|
+
/**
|
|
1915
|
+
* Expiry timestamp for a temporary mute.
|
|
1916
|
+
* @public
|
|
1917
|
+
*/
|
|
1918
|
+
mutedUntil?: string | undefined;
|
|
1919
|
+
/**
|
|
1920
|
+
* `visibleSeq` from which the user manually marked the channel as unread.
|
|
1921
|
+
* @public
|
|
1922
|
+
*/
|
|
1923
|
+
unreadMarkAt?: number | undefined;
|
|
1924
|
+
}
|
|
1925
|
+
/**
|
|
1926
|
+
* Channel item returned by inbox and channel listings. Includes per-user inbox state and last-message preview.
|
|
1927
|
+
* @public
|
|
1928
|
+
*/
|
|
1929
|
+
export interface InboxChannel {
|
|
1930
|
+
channelId: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* Type of channel.
|
|
1933
|
+
* @public
|
|
1934
|
+
*/
|
|
1935
|
+
channelType: ChannelType;
|
|
1936
|
+
/**
|
|
1937
|
+
* Current number of members.
|
|
1938
|
+
* @public
|
|
1939
|
+
*/
|
|
1940
|
+
membersCount: number;
|
|
1941
|
+
/**
|
|
1942
|
+
* Channel creation timestamp.
|
|
1943
|
+
* @public
|
|
1944
|
+
*/
|
|
1945
|
+
createdAt: string;
|
|
1946
|
+
/**
|
|
1947
|
+
* User that created the channel.
|
|
1948
|
+
* @public
|
|
1949
|
+
*/
|
|
1950
|
+
createdBy: string;
|
|
1951
|
+
/**
|
|
1952
|
+
* Timestamp of the last channel mutation.
|
|
1953
|
+
* @public
|
|
1954
|
+
*/
|
|
1955
|
+
updatedAt?: string | undefined;
|
|
1956
|
+
/**
|
|
1957
|
+
* Channel version. Increments on every channel mutation.
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
channelVersion: number;
|
|
1961
|
+
/**
|
|
1962
|
+
* Timestamp of the last activity. Drives inbox ordering.
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
lastActivityAt: string;
|
|
1966
|
+
/**
|
|
1967
|
+
* Last visible message preview. Absent for empty channels.
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
lastMessage?: LastMessagePreview | undefined;
|
|
1971
|
+
company?: string | undefined;
|
|
1972
|
+
kite?: boolean | undefined;
|
|
1973
|
+
kiteTarget?: string | undefined;
|
|
1974
|
+
kiteVariant?: string | undefined;
|
|
1975
|
+
kiteServiceName?: string | undefined;
|
|
1976
|
+
kiteDefaultSubject?: string | undefined;
|
|
1977
|
+
service?: string | undefined;
|
|
1978
|
+
serviceRecipient?: string | undefined;
|
|
1979
|
+
telephony?: boolean | undefined;
|
|
1980
|
+
external?: boolean | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* The subject of the channel.
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
subject?: string | undefined;
|
|
1986
|
+
/**
|
|
1987
|
+
* The description of the channel.
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
description?: string | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* The URL of the channel's picture.
|
|
1993
|
+
* @public
|
|
1994
|
+
*/
|
|
1995
|
+
picture?: string | undefined;
|
|
1996
|
+
/**
|
|
1997
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
1998
|
+
* @public
|
|
1999
|
+
*/
|
|
2000
|
+
pictureColor?: string | undefined;
|
|
2001
|
+
/**
|
|
2002
|
+
* Channel access level.
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
2005
|
+
access?: ChannelAccess | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
2008
|
+
* @public
|
|
2009
|
+
*/
|
|
2010
|
+
broadcast?: boolean | undefined;
|
|
2011
|
+
context?: ChannelContext | undefined;
|
|
2012
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
2013
|
+
/**
|
|
2014
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
2015
|
+
* @public
|
|
2016
|
+
*/
|
|
2017
|
+
sms?: boolean | undefined;
|
|
2018
|
+
/**
|
|
2019
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
2020
|
+
* @public
|
|
2021
|
+
*/
|
|
2022
|
+
mms?: boolean | undefined;
|
|
2023
|
+
/**
|
|
2024
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
whatsapp?: boolean | undefined;
|
|
2028
|
+
/**
|
|
2029
|
+
* The unique identifier of the assignee.
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
kiteAssign?: string | undefined;
|
|
2033
|
+
/**
|
|
2034
|
+
* The title of the service.
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
serviceTitle?: string | undefined;
|
|
2038
|
+
/**
|
|
2039
|
+
* Assignee user id.
|
|
2040
|
+
* @public
|
|
2041
|
+
*/
|
|
2042
|
+
assigneeId?: string | undefined;
|
|
2043
|
+
/**
|
|
2044
|
+
* Indicates if the channel supports auto start recording.
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
autoRecord?: boolean | undefined;
|
|
2048
|
+
/**
|
|
2049
|
+
* Transcription language.
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
2052
|
+
transcriptionLanguage?: string | undefined;
|
|
2053
|
+
/**
|
|
2054
|
+
* 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.
|
|
2055
|
+
* @public
|
|
2056
|
+
*/
|
|
2057
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
2058
|
+
/**
|
|
2059
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2060
|
+
* @public
|
|
2061
|
+
*/
|
|
2062
|
+
inbox: InboxState;
|
|
2063
|
+
}
|
|
2064
|
+
/**
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
2067
|
+
export interface GetInboxOutput {
|
|
2068
|
+
/**
|
|
2069
|
+
* Recent channels with per-user state and last-message preview.
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
channels: (InboxChannel)[];
|
|
2073
|
+
/**
|
|
2074
|
+
* Inbox sections with channel counts and unread counters.
|
|
2075
|
+
* @public
|
|
2076
|
+
*/
|
|
2077
|
+
sections: (Section)[];
|
|
2078
|
+
}
|
|
2079
|
+
/**
|
|
2080
|
+
* @public
|
|
2081
|
+
*/
|
|
2082
|
+
export interface GetMessageInput {
|
|
2083
|
+
/**
|
|
2084
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2085
|
+
* @public
|
|
2086
|
+
*/
|
|
2087
|
+
companyId?: string | undefined;
|
|
2088
|
+
/**
|
|
2089
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2090
|
+
* @public
|
|
2091
|
+
*/
|
|
2092
|
+
userId?: string | undefined;
|
|
2093
|
+
channelId: string;
|
|
2094
|
+
messageId: string;
|
|
2095
|
+
}
|
|
2096
|
+
/**
|
|
2097
|
+
* @public
|
|
2098
|
+
*/
|
|
2099
|
+
export interface GetMessageOutput {
|
|
2100
|
+
/**
|
|
2101
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
2102
|
+
* @public
|
|
2103
|
+
*/
|
|
2104
|
+
message: Message;
|
|
2105
|
+
}
|
|
2106
|
+
/**
|
|
2107
|
+
* @public
|
|
2108
|
+
*/
|
|
2109
|
+
export interface GetOrCreateDirectChannelInput {
|
|
2110
|
+
/**
|
|
2111
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2112
|
+
* @public
|
|
2113
|
+
*/
|
|
2114
|
+
companyId?: string | undefined;
|
|
2115
|
+
/**
|
|
2116
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2117
|
+
* @public
|
|
2118
|
+
*/
|
|
2119
|
+
userId?: string | undefined;
|
|
2120
|
+
memberId?: string | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* User invitation payload used when creating channels or adding members.
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
2125
|
+
memberToInvite?: UserToInvite | undefined;
|
|
2126
|
+
}
|
|
2127
|
+
/**
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
export interface GetOrCreateDirectChannelOutput {
|
|
2131
|
+
channel: Channel;
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
export interface GetOrCreateSmsChannelInput {
|
|
2137
|
+
/**
|
|
2138
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2139
|
+
* @public
|
|
2140
|
+
*/
|
|
2141
|
+
companyId?: string | undefined;
|
|
2142
|
+
/**
|
|
2143
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2144
|
+
* @public
|
|
2145
|
+
*/
|
|
2146
|
+
userId?: string | undefined;
|
|
2147
|
+
/**
|
|
2148
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2149
|
+
* @public
|
|
2150
|
+
*/
|
|
2151
|
+
serviceUri: string;
|
|
2152
|
+
/**
|
|
2153
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
recipientId?: string | undefined;
|
|
2157
|
+
/**
|
|
2158
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
2161
|
+
recipientNumber?: string | undefined;
|
|
2162
|
+
outgoing?: boolean | undefined;
|
|
2163
|
+
}
|
|
2164
|
+
/**
|
|
2165
|
+
* @public
|
|
2166
|
+
*/
|
|
2167
|
+
export interface GetOrCreateSmsChannelOutput {
|
|
2168
|
+
channel: Channel;
|
|
2169
|
+
}
|
|
2170
|
+
/**
|
|
2171
|
+
* @public
|
|
2172
|
+
*/
|
|
2173
|
+
export interface GetOrCreateTelephonyChannelInput {
|
|
2174
|
+
/**
|
|
2175
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2176
|
+
* @public
|
|
2177
|
+
*/
|
|
2178
|
+
companyId?: string | undefined;
|
|
2179
|
+
/**
|
|
2180
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2181
|
+
* @public
|
|
2182
|
+
*/
|
|
2183
|
+
userId?: string | undefined;
|
|
2184
|
+
/**
|
|
2185
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
serviceUri: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
recipientId?: string | undefined;
|
|
2194
|
+
/**
|
|
2195
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2196
|
+
* @public
|
|
2197
|
+
*/
|
|
2198
|
+
recipientNumber?: string | undefined;
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* @public
|
|
2202
|
+
*/
|
|
2203
|
+
export interface GetOrCreateTelephonyChannelOutput {
|
|
2204
|
+
channel: Channel;
|
|
2205
|
+
}
|
|
2206
|
+
/**
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
export interface GetOrCreateWhatsAppChannelInput {
|
|
2210
|
+
/**
|
|
2211
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
companyId?: string | undefined;
|
|
2215
|
+
/**
|
|
2216
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2217
|
+
* @public
|
|
2218
|
+
*/
|
|
2219
|
+
userId?: string | undefined;
|
|
2220
|
+
/**
|
|
2221
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2222
|
+
* @public
|
|
2223
|
+
*/
|
|
2224
|
+
serviceUri: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2227
|
+
* @public
|
|
2228
|
+
*/
|
|
2229
|
+
recipientId?: string | undefined;
|
|
2230
|
+
/**
|
|
2231
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2232
|
+
* @public
|
|
2233
|
+
*/
|
|
2234
|
+
recipientNumber?: string | undefined;
|
|
2235
|
+
outgoing?: boolean | undefined;
|
|
2236
|
+
}
|
|
2237
|
+
/**
|
|
2238
|
+
* @public
|
|
2239
|
+
*/
|
|
2240
|
+
export interface GetOrCreateWhatsAppChannelOutput {
|
|
2241
|
+
channel: Channel;
|
|
2242
|
+
}
|
|
2243
|
+
/**
|
|
2244
|
+
* @public
|
|
2245
|
+
*/
|
|
2246
|
+
export interface GetSmsChannelIdInput {
|
|
2247
|
+
/**
|
|
2248
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2249
|
+
* @public
|
|
2250
|
+
*/
|
|
2251
|
+
companyId?: string | undefined;
|
|
2252
|
+
/**
|
|
2253
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2254
|
+
* @public
|
|
2255
|
+
*/
|
|
2256
|
+
userId?: string | undefined;
|
|
2257
|
+
/**
|
|
2258
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2259
|
+
* @public
|
|
2260
|
+
*/
|
|
2261
|
+
serviceUri: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2264
|
+
* @public
|
|
2265
|
+
*/
|
|
2266
|
+
recipientId?: string | undefined;
|
|
2267
|
+
/**
|
|
2268
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2269
|
+
* @public
|
|
2270
|
+
*/
|
|
2271
|
+
recipientNumber?: string | undefined;
|
|
2272
|
+
}
|
|
2273
|
+
/**
|
|
2274
|
+
* @public
|
|
2275
|
+
*/
|
|
2276
|
+
export interface GetSmsChannelIdOutput {
|
|
2277
|
+
channelId: string;
|
|
2278
|
+
}
|
|
2279
|
+
/**
|
|
2280
|
+
* @public
|
|
2281
|
+
*/
|
|
2282
|
+
export interface GetTelephonyChannelIdInput {
|
|
2283
|
+
/**
|
|
2284
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2285
|
+
* @public
|
|
2286
|
+
*/
|
|
2287
|
+
companyId?: string | undefined;
|
|
2288
|
+
/**
|
|
2289
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2290
|
+
* @public
|
|
2291
|
+
*/
|
|
2292
|
+
userId?: string | undefined;
|
|
2293
|
+
/**
|
|
2294
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2295
|
+
* @public
|
|
2296
|
+
*/
|
|
2297
|
+
serviceUri: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2300
|
+
* @public
|
|
2301
|
+
*/
|
|
2302
|
+
recipientId?: string | undefined;
|
|
2303
|
+
/**
|
|
2304
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2305
|
+
* @public
|
|
2306
|
+
*/
|
|
2307
|
+
recipientNumber?: string | undefined;
|
|
2308
|
+
}
|
|
2309
|
+
/**
|
|
2310
|
+
* @public
|
|
2311
|
+
*/
|
|
2312
|
+
export interface GetTelephonyChannelIdOutput {
|
|
2313
|
+
channelId: string;
|
|
2314
|
+
}
|
|
2315
|
+
/**
|
|
2316
|
+
* @public
|
|
2317
|
+
*/
|
|
2318
|
+
export interface GetTokenInput {
|
|
2319
|
+
/**
|
|
2320
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2321
|
+
* @public
|
|
2322
|
+
*/
|
|
2323
|
+
companyId?: string | undefined;
|
|
2324
|
+
/**
|
|
2325
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2326
|
+
* @public
|
|
2327
|
+
*/
|
|
2328
|
+
userId?: string | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* Client id used to select and sign the correct token.
|
|
2331
|
+
* @public
|
|
2332
|
+
*/
|
|
2333
|
+
clientId?: string | undefined;
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* @public
|
|
2337
|
+
*/
|
|
2338
|
+
export interface GetTokenOutput {
|
|
2339
|
+
/**
|
|
2340
|
+
* Authorization token.
|
|
2341
|
+
* @public
|
|
2342
|
+
*/
|
|
2343
|
+
token: string;
|
|
2344
|
+
/**
|
|
2345
|
+
* Token expiration time as Unix epoch seconds.
|
|
2346
|
+
* @public
|
|
2347
|
+
*/
|
|
2348
|
+
expires: number;
|
|
2349
|
+
}
|
|
2350
|
+
/**
|
|
2351
|
+
* @public
|
|
2352
|
+
*/
|
|
2353
|
+
export interface GetUploadedFileInfoInput {
|
|
2354
|
+
/**
|
|
2355
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2356
|
+
* @public
|
|
2357
|
+
*/
|
|
2358
|
+
companyId?: string | undefined;
|
|
2359
|
+
/**
|
|
2360
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2361
|
+
* @public
|
|
2362
|
+
*/
|
|
2363
|
+
userId?: string | undefined;
|
|
2364
|
+
channelId: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* File service identifier returned by `UploadFile`.
|
|
2367
|
+
* @public
|
|
2368
|
+
*/
|
|
2369
|
+
fsId: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* File category. Defaults to `channels`.
|
|
2372
|
+
* @public
|
|
2373
|
+
*/
|
|
2374
|
+
category?: FileCategory | undefined;
|
|
2375
|
+
}
|
|
2376
|
+
/**
|
|
2377
|
+
* Metadata for a file uploaded to the channel file store but not yet attached to a message.
|
|
2378
|
+
* @public
|
|
2379
|
+
*/
|
|
2380
|
+
export interface UploadedFileInfo {
|
|
2381
|
+
/**
|
|
2382
|
+
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
2383
|
+
* @public
|
|
2384
|
+
*/
|
|
2385
|
+
fsId: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* MIME type.
|
|
2388
|
+
* @public
|
|
2389
|
+
*/
|
|
2390
|
+
mime?: string | undefined;
|
|
2391
|
+
/**
|
|
2392
|
+
* Original file name.
|
|
2393
|
+
* @public
|
|
2394
|
+
*/
|
|
2395
|
+
name: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* File size in bytes.
|
|
2398
|
+
* @public
|
|
2399
|
+
*/
|
|
2400
|
+
size: number;
|
|
2401
|
+
/**
|
|
2402
|
+
* Image or video width in pixels.
|
|
2403
|
+
* @public
|
|
2404
|
+
*/
|
|
2405
|
+
width?: number | undefined;
|
|
2406
|
+
/**
|
|
2407
|
+
* Image or video height in pixels.
|
|
2408
|
+
* @public
|
|
2409
|
+
*/
|
|
2410
|
+
height?: number | undefined;
|
|
2411
|
+
/**
|
|
2412
|
+
* Thumbnail URL when available.
|
|
2413
|
+
* @public
|
|
2414
|
+
*/
|
|
2415
|
+
thumbnail?: string | undefined;
|
|
2416
|
+
}
|
|
2417
|
+
/**
|
|
2418
|
+
* @public
|
|
2419
|
+
*/
|
|
2420
|
+
export interface GetUploadedFileInfoOutput {
|
|
2421
|
+
/**
|
|
2422
|
+
* Metadata for a file uploaded to the channel file store but not yet attached to a message.
|
|
2423
|
+
* @public
|
|
2424
|
+
*/
|
|
2425
|
+
file: UploadedFileInfo;
|
|
2426
|
+
}
|
|
2427
|
+
/**
|
|
2428
|
+
* @public
|
|
2429
|
+
*/
|
|
2430
|
+
export interface GetWhatsAppChannelIdInput {
|
|
2431
|
+
/**
|
|
2432
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2433
|
+
* @public
|
|
2434
|
+
*/
|
|
2435
|
+
companyId?: string | undefined;
|
|
2436
|
+
/**
|
|
2437
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2438
|
+
* @public
|
|
2439
|
+
*/
|
|
2440
|
+
userId?: string | undefined;
|
|
2441
|
+
/**
|
|
2442
|
+
* Service URI that identifies the omnichannel endpoint.
|
|
2443
|
+
* @public
|
|
2444
|
+
*/
|
|
2445
|
+
serviceUri: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* Recipient user id. Required when `recipientNumber` is omitted.
|
|
2448
|
+
* @public
|
|
2449
|
+
*/
|
|
2450
|
+
recipientId?: string | undefined;
|
|
2451
|
+
/**
|
|
2452
|
+
* Recipient phone number. Required when `recipientId` is omitted.
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
recipientNumber?: string | undefined;
|
|
2456
|
+
}
|
|
2457
|
+
/**
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
export interface GetWhatsAppChannelIdOutput {
|
|
2461
|
+
channelId: string;
|
|
2462
|
+
}
|
|
2463
|
+
/**
|
|
2464
|
+
* @public
|
|
2465
|
+
* @enum
|
|
2466
|
+
*/
|
|
2467
|
+
export declare const GroupChannelUnsetOptions: {
|
|
2468
|
+
readonly ACCESS: "access";
|
|
2469
|
+
readonly ASSIGNEE: "assignee";
|
|
2470
|
+
readonly BROADCAST: "broadcast";
|
|
2471
|
+
readonly CONTEXT: "context";
|
|
2472
|
+
readonly CONTEXT_EVENTS: "contextEvents";
|
|
2473
|
+
readonly CONTEXT_PTT: "contextPtt";
|
|
2474
|
+
readonly DESCRIPTION: "description";
|
|
2475
|
+
readonly KITE_ASSIGN: "kiteAssign";
|
|
2476
|
+
readonly MMS: "mms";
|
|
2477
|
+
readonly PICTURE: "picture";
|
|
2478
|
+
readonly PICTURE_COLOR: "pictureColor";
|
|
2479
|
+
readonly SERVICE: "service";
|
|
2480
|
+
readonly SERVICE_TITLE: "serviceTitle";
|
|
2481
|
+
readonly SMS: "sms";
|
|
2482
|
+
readonly SUBJECT: "subject";
|
|
2483
|
+
readonly WHATSAPP: "whatsapp";
|
|
2484
|
+
readonly WHATSAPP_STATUS: "whatsappStatus";
|
|
2485
|
+
};
|
|
2486
|
+
/**
|
|
2487
|
+
* @public
|
|
2488
|
+
*/
|
|
2489
|
+
export type GroupChannelUnsetOptions = typeof GroupChannelUnsetOptions[keyof typeof GroupChannelUnsetOptions];
|
|
2490
|
+
/**
|
|
2491
|
+
* @public
|
|
2492
|
+
*/
|
|
2493
|
+
export interface HideChannelInput {
|
|
2494
|
+
/**
|
|
2495
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2496
|
+
* @public
|
|
2497
|
+
*/
|
|
2498
|
+
companyId?: string | undefined;
|
|
2499
|
+
/**
|
|
2500
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2501
|
+
* @public
|
|
2502
|
+
*/
|
|
2503
|
+
userId?: string | undefined;
|
|
2504
|
+
channelId: string;
|
|
2505
|
+
}
|
|
2506
|
+
/**
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
export interface HideChannelOutput {
|
|
2510
|
+
}
|
|
2511
|
+
/**
|
|
2512
|
+
* @public
|
|
2513
|
+
*/
|
|
2514
|
+
export interface JoinChannelInput {
|
|
2515
|
+
/**
|
|
2516
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
companyId?: string | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
userId?: string | undefined;
|
|
2525
|
+
channelId: string;
|
|
2526
|
+
silent?: boolean | undefined;
|
|
2527
|
+
}
|
|
2528
|
+
/**
|
|
2529
|
+
* @public
|
|
2530
|
+
*/
|
|
2531
|
+
export interface JoinChannelOutput {
|
|
2532
|
+
channel: Channel;
|
|
2533
|
+
}
|
|
2534
|
+
/**
|
|
2535
|
+
* @public
|
|
2536
|
+
*/
|
|
2537
|
+
export interface LeaveChannelInput {
|
|
2538
|
+
/**
|
|
2539
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2540
|
+
* @public
|
|
2541
|
+
*/
|
|
2542
|
+
companyId?: string | undefined;
|
|
2543
|
+
/**
|
|
2544
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2545
|
+
* @public
|
|
2546
|
+
*/
|
|
2547
|
+
userId?: string | undefined;
|
|
2548
|
+
channelId: string;
|
|
2549
|
+
silent?: boolean | undefined;
|
|
2550
|
+
}
|
|
2551
|
+
/**
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2554
|
+
export interface LeaveChannelOutput {
|
|
2555
|
+
}
|
|
2556
|
+
/**
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
export interface ListChannelMembersInput {
|
|
2560
|
+
/**
|
|
2561
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2562
|
+
* @public
|
|
2563
|
+
*/
|
|
2564
|
+
companyId?: string | undefined;
|
|
2565
|
+
/**
|
|
2566
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
userId?: string | undefined;
|
|
2570
|
+
channelId: string;
|
|
2571
|
+
limit?: number | undefined;
|
|
2572
|
+
offset?: number | undefined;
|
|
2573
|
+
}
|
|
2574
|
+
/**
|
|
2575
|
+
* @public
|
|
2576
|
+
*/
|
|
2577
|
+
export interface ListChannelMembersOutput {
|
|
2578
|
+
members: (ChannelMember)[];
|
|
2579
|
+
}
|
|
2580
|
+
/**
|
|
2581
|
+
* @public
|
|
2582
|
+
*/
|
|
2583
|
+
export interface ListChannelMembersReadStatusInput {
|
|
2584
|
+
/**
|
|
2585
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2586
|
+
* @public
|
|
2587
|
+
*/
|
|
2588
|
+
companyId?: string | undefined;
|
|
2589
|
+
/**
|
|
2590
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2591
|
+
* @public
|
|
2592
|
+
*/
|
|
2593
|
+
userId?: string | undefined;
|
|
2594
|
+
channelId: string;
|
|
2595
|
+
}
|
|
2596
|
+
/**
|
|
2597
|
+
* @public
|
|
2598
|
+
*/
|
|
2599
|
+
export interface ListChannelMembersReadStatusOutput {
|
|
2600
|
+
members: (ChannelMemberReadStatus)[];
|
|
2601
|
+
}
|
|
2602
|
+
/**
|
|
2603
|
+
* @public
|
|
2604
|
+
*/
|
|
2605
|
+
export interface ListChannelsInput {
|
|
2606
|
+
/**
|
|
2607
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2608
|
+
* @public
|
|
2609
|
+
*/
|
|
2610
|
+
companyId?: string | undefined;
|
|
2611
|
+
/**
|
|
2612
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2613
|
+
* @public
|
|
2614
|
+
*/
|
|
2615
|
+
userId?: string | undefined;
|
|
2616
|
+
/**
|
|
2617
|
+
* Section to list. Defaults to `all`.
|
|
2618
|
+
* @public
|
|
2619
|
+
*/
|
|
2620
|
+
section?: string | undefined;
|
|
2621
|
+
/**
|
|
2622
|
+
* Optional refinement applied on top of the section.
|
|
2623
|
+
* @public
|
|
2624
|
+
*/
|
|
2625
|
+
filter?: ChannelsFilter | undefined;
|
|
2626
|
+
/**
|
|
2627
|
+
* Opaque continuation token from the previous response.
|
|
2628
|
+
* @public
|
|
2629
|
+
*/
|
|
2630
|
+
cursor?: string | undefined;
|
|
2631
|
+
}
|
|
2632
|
+
/**
|
|
2633
|
+
* @public
|
|
2634
|
+
*/
|
|
2635
|
+
export interface ListChannelsOutput {
|
|
2636
|
+
/**
|
|
2637
|
+
* Ordered page of channels for the requested section.
|
|
2638
|
+
* @public
|
|
2639
|
+
*/
|
|
2640
|
+
channels: (InboxChannel)[];
|
|
2641
|
+
/**
|
|
2642
|
+
* Cursor for the next page. Absent when there are no more pages.
|
|
2643
|
+
* @public
|
|
2644
|
+
*/
|
|
2645
|
+
nextCursor?: string | undefined;
|
|
2646
|
+
}
|
|
2647
|
+
/**
|
|
2648
|
+
* @public
|
|
2649
|
+
* @enum
|
|
2650
|
+
*/
|
|
2651
|
+
export declare const MentionsFilter: {
|
|
2652
|
+
/**
|
|
2653
|
+
* Unread mentions only.
|
|
2654
|
+
*/
|
|
2655
|
+
readonly UNREAD: "unread";
|
|
2656
|
+
};
|
|
2657
|
+
/**
|
|
2658
|
+
* @public
|
|
2659
|
+
*/
|
|
2660
|
+
export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
|
|
2661
|
+
/**
|
|
2662
|
+
* @public
|
|
2663
|
+
*/
|
|
2664
|
+
export interface ListMentionsInput {
|
|
2665
|
+
/**
|
|
2666
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2667
|
+
* @public
|
|
2668
|
+
*/
|
|
2669
|
+
companyId?: string | undefined;
|
|
2670
|
+
/**
|
|
2671
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2672
|
+
* @public
|
|
2673
|
+
*/
|
|
2674
|
+
userId?: string | undefined;
|
|
2675
|
+
/**
|
|
2676
|
+
* Optional refinement.
|
|
2677
|
+
* @public
|
|
2678
|
+
*/
|
|
2679
|
+
filter?: MentionsFilter | undefined;
|
|
2680
|
+
/**
|
|
2681
|
+
* Opaque continuation token from the previous response.
|
|
2682
|
+
* @public
|
|
2683
|
+
*/
|
|
2684
|
+
cursor?: string | undefined;
|
|
2685
|
+
}
|
|
2686
|
+
/**
|
|
2687
|
+
* Compact channel preview returned alongside a mention entry.
|
|
2688
|
+
* @public
|
|
2689
|
+
*/
|
|
2690
|
+
export interface MentionChannelPreview {
|
|
2691
|
+
channelId: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Type of channel.
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
channelType: ChannelType;
|
|
2697
|
+
/**
|
|
2698
|
+
* Channel subject.
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
subject?: string | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* Channel picture URL.
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
picture?: string | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* Current number of members.
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
memberCount: number;
|
|
2712
|
+
/**
|
|
2713
|
+
* Channel version. Increments on every channel mutation.
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
channelVersion: number;
|
|
2717
|
+
/**
|
|
2718
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
2719
|
+
* @public
|
|
2720
|
+
*/
|
|
2721
|
+
lastActivityAt: string;
|
|
2722
|
+
}
|
|
2723
|
+
/**
|
|
2724
|
+
* 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.
|
|
2725
|
+
* @public
|
|
2726
|
+
*/
|
|
2727
|
+
export interface MentionEntry {
|
|
2728
|
+
channelId: string;
|
|
2729
|
+
messageId: string;
|
|
2730
|
+
/**
|
|
2731
|
+
* Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
|
|
2732
|
+
* @public
|
|
2733
|
+
*/
|
|
2734
|
+
timelineSeq: number;
|
|
2735
|
+
/**
|
|
2736
|
+
* Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
|
|
2737
|
+
* @public
|
|
2738
|
+
*/
|
|
2739
|
+
visibleSeq?: number | undefined;
|
|
2740
|
+
/**
|
|
2741
|
+
* Timestamp at which the mention was recorded.
|
|
2742
|
+
* @public
|
|
2743
|
+
*/
|
|
2744
|
+
mentionAddedAt: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* True when the user has read this mention.
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
read: boolean;
|
|
2750
|
+
/**
|
|
2751
|
+
* Timestamp at which the mention was read.
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
readAt?: string | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2759
|
+
message: Message;
|
|
2760
|
+
/**
|
|
2761
|
+
* Compact channel preview returned alongside a mention entry.
|
|
2762
|
+
* @public
|
|
2763
|
+
*/
|
|
2764
|
+
channel: MentionChannelPreview;
|
|
2765
|
+
}
|
|
2766
|
+
/**
|
|
2767
|
+
* @public
|
|
2768
|
+
*/
|
|
2769
|
+
export interface ListMentionsOutput {
|
|
2770
|
+
/**
|
|
2771
|
+
* Mentions ordered by most recent `mentionAddedAt` first.
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2774
|
+
mentions: (MentionEntry)[];
|
|
2775
|
+
/**
|
|
2776
|
+
* Cursor for the next page. Absent when there are no more pages.
|
|
2777
|
+
* @public
|
|
2778
|
+
*/
|
|
2779
|
+
nextCursor?: string | undefined;
|
|
2780
|
+
}
|
|
2781
|
+
/**
|
|
2782
|
+
* @public
|
|
2783
|
+
*/
|
|
2784
|
+
export interface ListMessagesInput {
|
|
2785
|
+
/**
|
|
2786
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2787
|
+
* @public
|
|
2788
|
+
*/
|
|
2789
|
+
companyId?: string | undefined;
|
|
2790
|
+
/**
|
|
2791
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
userId?: string | undefined;
|
|
2795
|
+
channelId: string;
|
|
2796
|
+
/**
|
|
2797
|
+
* Optional inclusive lower bound on `timelineSeq`. Combine with `to` for a bounded window, or use alone to scroll forward from a known anchor.
|
|
2798
|
+
* @public
|
|
2799
|
+
*/
|
|
2800
|
+
from?: number | undefined;
|
|
2801
|
+
/**
|
|
2802
|
+
* Optional inclusive upper bound on `timelineSeq`. Combine with `from` for a bounded window, or use alone to scroll back from a known anchor.
|
|
2803
|
+
* @public
|
|
2804
|
+
*/
|
|
2805
|
+
to?: number | undefined;
|
|
2806
|
+
}
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
export interface ListMessagesOutput {
|
|
2811
|
+
/**
|
|
2812
|
+
* Messages ordered newest-first by `timelineSeq`.
|
|
2813
|
+
* @public
|
|
2814
|
+
*/
|
|
2815
|
+
messages: (Message)[];
|
|
2816
|
+
}
|
|
2817
|
+
/**
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
export interface MarkReadInput {
|
|
2821
|
+
/**
|
|
2822
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
companyId?: string | undefined;
|
|
2826
|
+
/**
|
|
2827
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
userId?: string | undefined;
|
|
2831
|
+
channelId: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* Optional explicit read pointer. Defaults to the latest visible message.
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
lastReadVisibleSeq?: number | undefined;
|
|
2837
|
+
}
|
|
2838
|
+
/**
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
export interface MarkReadOutput {
|
|
2842
|
+
/**
|
|
2843
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
inbox: InboxState;
|
|
2847
|
+
}
|
|
2848
|
+
/**
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
export declare class MarkUnreadChannelsLimitReachedException extends __BaseException {
|
|
2852
|
+
readonly name: "MarkUnreadChannelsLimitReachedException";
|
|
2853
|
+
readonly $fault: "client";
|
|
2854
|
+
/**
|
|
2855
|
+
* @internal
|
|
2856
|
+
*/
|
|
2857
|
+
constructor(opts: __ExceptionOptionType<MarkUnreadChannelsLimitReachedException, __BaseException>);
|
|
2858
|
+
}
|
|
2859
|
+
/**
|
|
2860
|
+
* @public
|
|
2861
|
+
*/
|
|
2862
|
+
export interface MarkUnreadInput {
|
|
2863
|
+
/**
|
|
2864
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2865
|
+
* @public
|
|
2866
|
+
*/
|
|
2867
|
+
companyId?: string | undefined;
|
|
2868
|
+
/**
|
|
2869
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2870
|
+
* @public
|
|
2871
|
+
*/
|
|
2872
|
+
userId?: string | undefined;
|
|
2873
|
+
channelId: string;
|
|
2874
|
+
/**
|
|
2875
|
+
* Message id used to resolve the unread mark position.
|
|
2876
|
+
* @public
|
|
2877
|
+
*/
|
|
2878
|
+
messageId?: string | undefined;
|
|
2879
|
+
/**
|
|
2880
|
+
* Explicit unread mark position. Takes precedence over `messageId` when both are supplied.
|
|
2881
|
+
* @public
|
|
2882
|
+
*/
|
|
2883
|
+
unreadMarkAt?: number | undefined;
|
|
2884
|
+
/**
|
|
2885
|
+
* Replace the oldest unread mark when the per-user limit is reached.
|
|
2886
|
+
* @public
|
|
2887
|
+
*/
|
|
2888
|
+
force?: boolean | undefined;
|
|
598
2889
|
}
|
|
599
2890
|
/**
|
|
600
2891
|
* @public
|
|
601
2892
|
*/
|
|
602
|
-
export interface
|
|
2893
|
+
export interface MarkUnreadOutput {
|
|
603
2894
|
/**
|
|
604
|
-
*
|
|
2895
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
605
2896
|
* @public
|
|
606
2897
|
*/
|
|
607
|
-
|
|
2898
|
+
inbox: InboxState;
|
|
608
2899
|
}
|
|
609
2900
|
/**
|
|
610
2901
|
* @public
|
|
611
2902
|
* @enum
|
|
612
2903
|
*/
|
|
613
|
-
export declare const
|
|
614
|
-
readonly
|
|
2904
|
+
export declare const MessageUnsetFields: {
|
|
2905
|
+
readonly ATTACHMENTS: "attachments";
|
|
2906
|
+
readonly ELEMENTS: "elements";
|
|
2907
|
+
readonly FORWARD: "forward";
|
|
2908
|
+
readonly MARKDOWN: "markdown";
|
|
2909
|
+
readonly MENTIONS: "mentions";
|
|
2910
|
+
readonly QUOTE: "quote";
|
|
2911
|
+
readonly SMS: "sms";
|
|
2912
|
+
readonly SMS_STATUS: "smsStatus";
|
|
2913
|
+
readonly TEXT: "text";
|
|
2914
|
+
readonly WHATSAPP: "whatsapp";
|
|
2915
|
+
readonly WHATSAPP_STATUS: "whatsappStatus";
|
|
615
2916
|
};
|
|
616
2917
|
/**
|
|
617
2918
|
* @public
|
|
618
2919
|
*/
|
|
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
|
-
}
|
|
2920
|
+
export type MessageUnsetFields = typeof MessageUnsetFields[keyof typeof MessageUnsetFields];
|
|
629
2921
|
/**
|
|
630
2922
|
* @public
|
|
631
|
-
* @enum
|
|
632
2923
|
*/
|
|
633
|
-
export
|
|
2924
|
+
export interface MoveChannelToSectionInput {
|
|
634
2925
|
/**
|
|
635
|
-
*
|
|
2926
|
+
* The unique identifier of the tenant when a service token is used.
|
|
2927
|
+
* @public
|
|
636
2928
|
*/
|
|
637
|
-
|
|
2929
|
+
companyId?: string | undefined;
|
|
638
2930
|
/**
|
|
639
|
-
*
|
|
2931
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
2932
|
+
* @public
|
|
640
2933
|
*/
|
|
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];
|
|
2934
|
+
userId?: string | undefined;
|
|
2935
|
+
channelId: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
2938
|
+
* @public
|
|
2939
|
+
*/
|
|
2940
|
+
sectionId: string;
|
|
2941
|
+
}
|
|
660
2942
|
/**
|
|
661
2943
|
* @public
|
|
662
|
-
* @enum
|
|
663
2944
|
*/
|
|
664
|
-
export
|
|
665
|
-
|
|
666
|
-
|
|
2945
|
+
export interface MoveChannelToSectionOutput {
|
|
2946
|
+
/**
|
|
2947
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2948
|
+
* @public
|
|
2949
|
+
*/
|
|
2950
|
+
inbox: InboxState;
|
|
2951
|
+
}
|
|
667
2952
|
/**
|
|
2953
|
+
* System message emitted when multiple members join a channel.
|
|
668
2954
|
* @public
|
|
669
2955
|
*/
|
|
670
|
-
export
|
|
2956
|
+
export interface MultipleMembersJoinedSystemMessage {
|
|
2957
|
+
addedMembers: (string)[];
|
|
2958
|
+
}
|
|
671
2959
|
/**
|
|
672
2960
|
* @public
|
|
673
2961
|
*/
|
|
674
|
-
export interface
|
|
2962
|
+
export interface MuteChannelInput {
|
|
675
2963
|
/**
|
|
676
2964
|
* The unique identifier of the tenant when a service token is used.
|
|
677
2965
|
* @public
|
|
@@ -683,100 +2971,108 @@ export interface DeleteMessageInput {
|
|
|
683
2971
|
*/
|
|
684
2972
|
userId?: string | undefined;
|
|
685
2973
|
channelId: string;
|
|
686
|
-
|
|
2974
|
+
/**
|
|
2975
|
+
* Temporary mute expiry. Omit for indefinite mute.
|
|
2976
|
+
* @public
|
|
2977
|
+
*/
|
|
2978
|
+
mutedUntil?: string | undefined;
|
|
687
2979
|
}
|
|
688
2980
|
/**
|
|
689
2981
|
* @public
|
|
690
2982
|
*/
|
|
691
|
-
export interface
|
|
2983
|
+
export interface MuteChannelOutput {
|
|
2984
|
+
/**
|
|
2985
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2986
|
+
* @public
|
|
2987
|
+
*/
|
|
2988
|
+
inbox: InboxState;
|
|
692
2989
|
}
|
|
693
2990
|
/**
|
|
694
|
-
* Attachment record supplied by the client when sending or editing a message. The server assigns the attachment `id` after persistence.
|
|
695
2991
|
* @public
|
|
696
2992
|
*/
|
|
697
|
-
export interface
|
|
2993
|
+
export interface PartialUpdateChannelSetOptions {
|
|
698
2994
|
/**
|
|
699
|
-
*
|
|
2995
|
+
* The subject of the channel.
|
|
700
2996
|
* @public
|
|
701
2997
|
*/
|
|
702
|
-
|
|
2998
|
+
subject?: string | undefined;
|
|
703
2999
|
/**
|
|
704
|
-
*
|
|
3000
|
+
* The description of the channel.
|
|
705
3001
|
* @public
|
|
706
3002
|
*/
|
|
707
|
-
|
|
3003
|
+
description?: string | undefined;
|
|
708
3004
|
/**
|
|
709
|
-
*
|
|
3005
|
+
* The URL of the channel's picture.
|
|
710
3006
|
* @public
|
|
711
3007
|
*/
|
|
712
|
-
|
|
3008
|
+
picture?: string | undefined;
|
|
713
3009
|
/**
|
|
714
|
-
*
|
|
3010
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
715
3011
|
* @public
|
|
716
3012
|
*/
|
|
717
|
-
|
|
3013
|
+
pictureColor?: string | undefined;
|
|
718
3014
|
/**
|
|
719
|
-
*
|
|
3015
|
+
* Channel access level.
|
|
720
3016
|
* @public
|
|
721
3017
|
*/
|
|
722
|
-
|
|
3018
|
+
access?: ChannelAccess | undefined;
|
|
723
3019
|
/**
|
|
724
|
-
*
|
|
3020
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
725
3021
|
* @public
|
|
726
3022
|
*/
|
|
727
|
-
|
|
3023
|
+
broadcast?: boolean | undefined;
|
|
3024
|
+
context?: ChannelContext | undefined;
|
|
3025
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
728
3026
|
/**
|
|
729
|
-
*
|
|
3027
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
730
3028
|
* @public
|
|
731
3029
|
*/
|
|
732
|
-
|
|
733
|
-
}
|
|
734
|
-
/**
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export interface EditMessageInput {
|
|
3030
|
+
sms?: boolean | undefined;
|
|
738
3031
|
/**
|
|
739
|
-
*
|
|
3032
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
740
3033
|
* @public
|
|
741
3034
|
*/
|
|
742
|
-
|
|
3035
|
+
mms?: boolean | undefined;
|
|
743
3036
|
/**
|
|
744
|
-
*
|
|
3037
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
745
3038
|
* @public
|
|
746
3039
|
*/
|
|
747
|
-
|
|
748
|
-
channelId: string;
|
|
749
|
-
messageId: string;
|
|
3040
|
+
whatsapp?: boolean | undefined;
|
|
750
3041
|
/**
|
|
751
|
-
*
|
|
3042
|
+
* The unique identifier of the assignee.
|
|
752
3043
|
* @public
|
|
753
3044
|
*/
|
|
754
|
-
|
|
3045
|
+
kiteAssign?: string | undefined;
|
|
755
3046
|
/**
|
|
756
|
-
*
|
|
3047
|
+
* The title of the service.
|
|
757
3048
|
* @public
|
|
758
3049
|
*/
|
|
759
|
-
|
|
3050
|
+
serviceTitle?: string | undefined;
|
|
760
3051
|
/**
|
|
761
|
-
*
|
|
3052
|
+
* Assignee user id.
|
|
762
3053
|
* @public
|
|
763
3054
|
*/
|
|
764
|
-
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* @public
|
|
768
|
-
*/
|
|
769
|
-
export interface EditMessageOutput {
|
|
3055
|
+
assigneeId?: string | undefined;
|
|
770
3056
|
/**
|
|
771
|
-
*
|
|
3057
|
+
* Indicates if the channel supports auto start recording.
|
|
772
3058
|
* @public
|
|
773
3059
|
*/
|
|
774
|
-
|
|
3060
|
+
autoRecord?: boolean | undefined;
|
|
3061
|
+
/**
|
|
3062
|
+
* Transcription language.
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
transcriptionLanguage?: string | undefined;
|
|
3066
|
+
/**
|
|
3067
|
+
* 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.
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
775
3071
|
}
|
|
776
3072
|
/**
|
|
777
3073
|
* @public
|
|
778
3074
|
*/
|
|
779
|
-
export interface
|
|
3075
|
+
export interface PartialUpdateChannelInput {
|
|
780
3076
|
/**
|
|
781
3077
|
* The unique identifier of the tenant when a service token is used.
|
|
782
3078
|
* @public
|
|
@@ -787,269 +3083,263 @@ export interface GetInboxInput {
|
|
|
787
3083
|
* @public
|
|
788
3084
|
*/
|
|
789
3085
|
userId?: string | undefined;
|
|
3086
|
+
channelId: string;
|
|
3087
|
+
silent?: boolean | undefined;
|
|
3088
|
+
set?: PartialUpdateChannelSetOptions | undefined;
|
|
3089
|
+
unset?: (GroupChannelUnsetOptions)[] | undefined;
|
|
790
3090
|
}
|
|
791
3091
|
/**
|
|
792
|
-
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
793
3092
|
* @public
|
|
794
3093
|
*/
|
|
795
|
-
export interface
|
|
3094
|
+
export interface PartialUpdateChannelOutput {
|
|
3095
|
+
channel: Channel;
|
|
3096
|
+
}
|
|
3097
|
+
/**
|
|
3098
|
+
* @public
|
|
3099
|
+
*/
|
|
3100
|
+
export interface PartialUpdateMessageSetInput {
|
|
796
3101
|
/**
|
|
797
|
-
*
|
|
3102
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
798
3103
|
* @public
|
|
799
3104
|
*/
|
|
800
|
-
|
|
3105
|
+
text?: string | undefined;
|
|
801
3106
|
/**
|
|
802
|
-
*
|
|
3107
|
+
* Structured rich content blocks.
|
|
803
3108
|
* @public
|
|
804
3109
|
*/
|
|
805
|
-
|
|
3110
|
+
elements?: (Element)[] | undefined;
|
|
806
3111
|
/**
|
|
807
|
-
*
|
|
3112
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
808
3113
|
* @public
|
|
809
3114
|
*/
|
|
810
|
-
|
|
3115
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
811
3116
|
/**
|
|
812
|
-
*
|
|
3117
|
+
* Reply context referencing a quoted message.
|
|
813
3118
|
* @public
|
|
814
3119
|
*/
|
|
815
|
-
|
|
3120
|
+
quote?: MessageQuoteRef | undefined;
|
|
816
3121
|
/**
|
|
817
|
-
*
|
|
3122
|
+
* Source reference for a forwarded message.
|
|
818
3123
|
* @public
|
|
819
3124
|
*/
|
|
820
|
-
|
|
3125
|
+
forward?: MessageForwardRef | undefined;
|
|
821
3126
|
/**
|
|
822
|
-
*
|
|
3127
|
+
* When true, the message body is interpreted as Markdown.
|
|
823
3128
|
* @public
|
|
824
3129
|
*/
|
|
825
|
-
|
|
3130
|
+
markdown?: boolean | undefined;
|
|
826
3131
|
/**
|
|
827
|
-
*
|
|
3132
|
+
* Direct `@user` ids.
|
|
828
3133
|
* @public
|
|
829
3134
|
*/
|
|
830
|
-
|
|
3135
|
+
mentions?: (string)[] | undefined;
|
|
831
3136
|
/**
|
|
832
|
-
*
|
|
3137
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
833
3138
|
* @public
|
|
834
3139
|
*/
|
|
835
|
-
|
|
3140
|
+
whatsapp?: boolean | undefined;
|
|
3141
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
836
3142
|
/**
|
|
837
|
-
*
|
|
3143
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
838
3144
|
* @public
|
|
839
3145
|
*/
|
|
840
|
-
|
|
3146
|
+
sms?: boolean | undefined;
|
|
3147
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
841
3148
|
}
|
|
842
3149
|
/**
|
|
843
|
-
* Preview of the most recent visible message in a channel.
|
|
844
3150
|
* @public
|
|
845
3151
|
*/
|
|
846
|
-
export interface
|
|
847
|
-
messageId: string;
|
|
3152
|
+
export interface PartialUpdateMessageInput {
|
|
848
3153
|
/**
|
|
849
|
-
*
|
|
850
|
-
* @public
|
|
851
|
-
*/
|
|
852
|
-
userId: string;
|
|
853
|
-
/**
|
|
854
|
-
* Text body of the message. Absent for attachment-only or deleted messages.
|
|
3154
|
+
* The unique identifier of the tenant when a service token is used.
|
|
855
3155
|
* @public
|
|
856
3156
|
*/
|
|
857
|
-
|
|
3157
|
+
companyId?: string | undefined;
|
|
858
3158
|
/**
|
|
859
|
-
*
|
|
3159
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
860
3160
|
* @public
|
|
861
3161
|
*/
|
|
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 {
|
|
3162
|
+
userId?: string | undefined;
|
|
869
3163
|
channelId: string;
|
|
3164
|
+
messageId: string;
|
|
870
3165
|
/**
|
|
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
|
|
3166
|
+
* Fields to set during the partial update.
|
|
887
3167
|
* @public
|
|
888
3168
|
*/
|
|
889
|
-
|
|
3169
|
+
set?: PartialUpdateMessageSetInput | undefined;
|
|
890
3170
|
/**
|
|
891
|
-
*
|
|
3171
|
+
* Fields to clear during the partial update.
|
|
892
3172
|
* @public
|
|
893
3173
|
*/
|
|
894
|
-
|
|
3174
|
+
unset?: (MessageUnsetFields)[] | undefined;
|
|
895
3175
|
/**
|
|
896
|
-
*
|
|
3176
|
+
* Suppress the updated indicator for this edit.
|
|
897
3177
|
* @public
|
|
898
3178
|
*/
|
|
899
|
-
|
|
3179
|
+
silent?: boolean | undefined;
|
|
3180
|
+
}
|
|
3181
|
+
/**
|
|
3182
|
+
* @public
|
|
3183
|
+
*/
|
|
3184
|
+
export interface PartialUpdateMessageOutput {
|
|
900
3185
|
/**
|
|
901
|
-
*
|
|
3186
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
902
3187
|
* @public
|
|
903
3188
|
*/
|
|
904
|
-
|
|
3189
|
+
message: Message;
|
|
3190
|
+
}
|
|
3191
|
+
/**
|
|
3192
|
+
* @public
|
|
3193
|
+
*/
|
|
3194
|
+
export interface PinChannelInput {
|
|
905
3195
|
/**
|
|
906
|
-
*
|
|
3196
|
+
* The unique identifier of the tenant when a service token is used.
|
|
907
3197
|
* @public
|
|
908
3198
|
*/
|
|
909
|
-
|
|
3199
|
+
companyId?: string | undefined;
|
|
910
3200
|
/**
|
|
911
|
-
*
|
|
3201
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
912
3202
|
* @public
|
|
913
3203
|
*/
|
|
914
|
-
|
|
3204
|
+
userId?: string | undefined;
|
|
3205
|
+
channelId: string;
|
|
3206
|
+
force?: boolean | undefined;
|
|
3207
|
+
}
|
|
3208
|
+
/**
|
|
3209
|
+
* @public
|
|
3210
|
+
*/
|
|
3211
|
+
export interface PinChannelOutput {
|
|
3212
|
+
}
|
|
3213
|
+
/**
|
|
3214
|
+
* @public
|
|
3215
|
+
*/
|
|
3216
|
+
export declare class PinnedChannelsLimitReachedException extends __BaseException {
|
|
3217
|
+
readonly name: "PinnedChannelsLimitReachedException";
|
|
3218
|
+
readonly $fault: "client";
|
|
915
3219
|
/**
|
|
916
|
-
*
|
|
917
|
-
* @public
|
|
3220
|
+
* @internal
|
|
918
3221
|
*/
|
|
919
|
-
|
|
3222
|
+
constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
|
|
3223
|
+
}
|
|
3224
|
+
/**
|
|
3225
|
+
* @public
|
|
3226
|
+
*/
|
|
3227
|
+
export interface PinMessageInput {
|
|
920
3228
|
/**
|
|
921
|
-
*
|
|
3229
|
+
* The unique identifier of the tenant when a service token is used.
|
|
922
3230
|
* @public
|
|
923
3231
|
*/
|
|
924
|
-
|
|
3232
|
+
companyId?: string | undefined;
|
|
925
3233
|
/**
|
|
926
|
-
*
|
|
3234
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
927
3235
|
* @public
|
|
928
3236
|
*/
|
|
929
|
-
|
|
3237
|
+
userId?: string | undefined;
|
|
3238
|
+
channelId: string;
|
|
3239
|
+
messageId: string;
|
|
3240
|
+
}
|
|
3241
|
+
/**
|
|
3242
|
+
* @public
|
|
3243
|
+
*/
|
|
3244
|
+
export interface PinMessageOutput {
|
|
930
3245
|
/**
|
|
931
|
-
*
|
|
3246
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
932
3247
|
* @public
|
|
933
3248
|
*/
|
|
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;
|
|
3249
|
+
message: Message;
|
|
958
3250
|
}
|
|
959
3251
|
/**
|
|
960
3252
|
* @public
|
|
961
|
-
* @enum
|
|
962
3253
|
*/
|
|
963
|
-
export
|
|
3254
|
+
export interface QueryChannelsInput {
|
|
964
3255
|
/**
|
|
965
|
-
*
|
|
3256
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3257
|
+
* @public
|
|
966
3258
|
*/
|
|
967
|
-
|
|
3259
|
+
companyId?: string | undefined;
|
|
968
3260
|
/**
|
|
969
|
-
*
|
|
3261
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3262
|
+
* @public
|
|
970
3263
|
*/
|
|
971
|
-
|
|
972
|
-
|
|
3264
|
+
userId?: string | undefined;
|
|
3265
|
+
/**
|
|
3266
|
+
* Batch channel lookup query.
|
|
3267
|
+
* @public
|
|
3268
|
+
*/
|
|
3269
|
+
query: ChannelsQuery;
|
|
3270
|
+
}
|
|
973
3271
|
/**
|
|
974
3272
|
* @public
|
|
975
3273
|
*/
|
|
976
|
-
export
|
|
3274
|
+
export interface QueryChannelsOutput {
|
|
3275
|
+
channels: (InboxChannel)[];
|
|
3276
|
+
}
|
|
977
3277
|
/**
|
|
978
|
-
* Aggregated unread counters for an inbox section.
|
|
979
3278
|
* @public
|
|
980
3279
|
*/
|
|
981
|
-
export interface
|
|
982
|
-
/**
|
|
983
|
-
* Unmuted channels with at least one unread message.
|
|
984
|
-
* @public
|
|
985
|
-
*/
|
|
986
|
-
unmutedUnreadChannelCount: number;
|
|
3280
|
+
export interface RemoveChannelFromSectionInput {
|
|
987
3281
|
/**
|
|
988
|
-
*
|
|
3282
|
+
* The unique identifier of the tenant when a service token is used.
|
|
989
3283
|
* @public
|
|
990
3284
|
*/
|
|
991
|
-
|
|
3285
|
+
companyId?: string | undefined;
|
|
992
3286
|
/**
|
|
993
|
-
*
|
|
3287
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
994
3288
|
* @public
|
|
995
3289
|
*/
|
|
996
|
-
|
|
3290
|
+
userId?: string | undefined;
|
|
3291
|
+
channelId: string;
|
|
997
3292
|
/**
|
|
998
|
-
*
|
|
3293
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
999
3294
|
* @public
|
|
1000
3295
|
*/
|
|
1001
|
-
|
|
3296
|
+
sectionId: string;
|
|
1002
3297
|
}
|
|
1003
3298
|
/**
|
|
1004
|
-
* Inbox section with metadata, channel count, and unread counters.
|
|
1005
3299
|
* @public
|
|
1006
3300
|
*/
|
|
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;
|
|
3301
|
+
export interface RemoveChannelFromSectionOutput {
|
|
1013
3302
|
/**
|
|
1014
|
-
*
|
|
3303
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1015
3304
|
* @public
|
|
1016
3305
|
*/
|
|
1017
|
-
|
|
3306
|
+
inbox: InboxState;
|
|
3307
|
+
}
|
|
3308
|
+
/**
|
|
3309
|
+
* @public
|
|
3310
|
+
*/
|
|
3311
|
+
export interface RenameSectionInput {
|
|
1018
3312
|
/**
|
|
1019
|
-
*
|
|
3313
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1020
3314
|
* @public
|
|
1021
3315
|
*/
|
|
1022
|
-
|
|
3316
|
+
companyId?: string | undefined;
|
|
1023
3317
|
/**
|
|
1024
|
-
*
|
|
3318
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1025
3319
|
* @public
|
|
1026
3320
|
*/
|
|
1027
|
-
|
|
3321
|
+
userId?: string | undefined;
|
|
1028
3322
|
/**
|
|
1029
|
-
*
|
|
3323
|
+
* Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
|
|
1030
3324
|
* @public
|
|
1031
3325
|
*/
|
|
1032
|
-
|
|
3326
|
+
sectionId: string;
|
|
3327
|
+
name: string;
|
|
1033
3328
|
}
|
|
1034
3329
|
/**
|
|
1035
3330
|
* @public
|
|
1036
3331
|
*/
|
|
1037
|
-
export interface
|
|
1038
|
-
/**
|
|
1039
|
-
* Recent channels with per-user state and last-message preview.
|
|
1040
|
-
* @public
|
|
1041
|
-
*/
|
|
1042
|
-
channels: (InboxChannel)[];
|
|
3332
|
+
export interface RenameSectionOutput {
|
|
1043
3333
|
/**
|
|
1044
|
-
* Inbox
|
|
3334
|
+
* Inbox section with metadata, channel count, and unread counters.
|
|
1045
3335
|
* @public
|
|
1046
3336
|
*/
|
|
1047
|
-
|
|
3337
|
+
section: Section;
|
|
1048
3338
|
}
|
|
1049
3339
|
/**
|
|
1050
3340
|
* @public
|
|
1051
3341
|
*/
|
|
1052
|
-
export interface
|
|
3342
|
+
export interface SendGiphyInput {
|
|
1053
3343
|
/**
|
|
1054
3344
|
* The unique identifier of the tenant when a service token is used.
|
|
1055
3345
|
* @public
|
|
@@ -1061,12 +3351,32 @@ export interface GetMessageInput {
|
|
|
1061
3351
|
*/
|
|
1062
3352
|
userId?: string | undefined;
|
|
1063
3353
|
channelId: string;
|
|
1064
|
-
|
|
3354
|
+
/**
|
|
3355
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
3356
|
+
* @public
|
|
3357
|
+
*/
|
|
3358
|
+
messageId?: string | undefined;
|
|
3359
|
+
giphy: MessageGiphy;
|
|
3360
|
+
/**
|
|
3361
|
+
* Direct `@user` ids.
|
|
3362
|
+
* @public
|
|
3363
|
+
*/
|
|
3364
|
+
mentions?: (string)[] | undefined;
|
|
3365
|
+
/**
|
|
3366
|
+
* Reply context referencing a quoted message.
|
|
3367
|
+
* @public
|
|
3368
|
+
*/
|
|
3369
|
+
quote?: MessageQuoteRef | undefined;
|
|
3370
|
+
/**
|
|
3371
|
+
* Suppress push notifications and unread indicators.
|
|
3372
|
+
* @public
|
|
3373
|
+
*/
|
|
3374
|
+
silent?: boolean | undefined;
|
|
1065
3375
|
}
|
|
1066
3376
|
/**
|
|
1067
3377
|
* @public
|
|
1068
3378
|
*/
|
|
1069
|
-
export interface
|
|
3379
|
+
export interface SendGiphyOutput {
|
|
1070
3380
|
/**
|
|
1071
3381
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1072
3382
|
* @public
|
|
@@ -1076,7 +3386,7 @@ export interface GetMessageOutput {
|
|
|
1076
3386
|
/**
|
|
1077
3387
|
* @public
|
|
1078
3388
|
*/
|
|
1079
|
-
export interface
|
|
3389
|
+
export interface SendMessageInput {
|
|
1080
3390
|
/**
|
|
1081
3391
|
* The unique identifier of the tenant when a service token is used.
|
|
1082
3392
|
* @public
|
|
@@ -1088,54 +3398,83 @@ export interface ListChannelsInput {
|
|
|
1088
3398
|
*/
|
|
1089
3399
|
userId?: string | undefined;
|
|
1090
3400
|
/**
|
|
1091
|
-
*
|
|
3401
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
1092
3402
|
* @public
|
|
1093
3403
|
*/
|
|
1094
|
-
|
|
3404
|
+
text?: string | undefined;
|
|
1095
3405
|
/**
|
|
1096
|
-
*
|
|
3406
|
+
* Structured rich content blocks.
|
|
1097
3407
|
* @public
|
|
1098
3408
|
*/
|
|
1099
|
-
|
|
3409
|
+
elements?: (Element)[] | undefined;
|
|
1100
3410
|
/**
|
|
1101
|
-
*
|
|
3411
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1102
3412
|
* @public
|
|
1103
3413
|
*/
|
|
1104
|
-
|
|
1105
|
-
}
|
|
1106
|
-
/**
|
|
1107
|
-
* @public
|
|
1108
|
-
*/
|
|
1109
|
-
export interface ListChannelsOutput {
|
|
3414
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1110
3415
|
/**
|
|
1111
|
-
*
|
|
3416
|
+
* Reply context referencing a quoted message.
|
|
1112
3417
|
* @public
|
|
1113
3418
|
*/
|
|
1114
|
-
|
|
3419
|
+
quote?: MessageQuoteRef | undefined;
|
|
1115
3420
|
/**
|
|
1116
|
-
*
|
|
3421
|
+
* Source reference for a forwarded message.
|
|
1117
3422
|
* @public
|
|
1118
3423
|
*/
|
|
1119
|
-
|
|
3424
|
+
forward?: MessageForwardRef | undefined;
|
|
3425
|
+
/**
|
|
3426
|
+
* When true, the message body is interpreted as Markdown.
|
|
3427
|
+
* @public
|
|
3428
|
+
*/
|
|
3429
|
+
markdown?: boolean | undefined;
|
|
3430
|
+
/**
|
|
3431
|
+
* Suppress push notifications and unread indicators.
|
|
3432
|
+
* @public
|
|
3433
|
+
*/
|
|
3434
|
+
silent?: boolean | undefined;
|
|
3435
|
+
/**
|
|
3436
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
3437
|
+
* @public
|
|
3438
|
+
*/
|
|
3439
|
+
whatsapp?: boolean | undefined;
|
|
3440
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
3441
|
+
/**
|
|
3442
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
3443
|
+
* @public
|
|
3444
|
+
*/
|
|
3445
|
+
sms?: boolean | undefined;
|
|
3446
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
3447
|
+
/**
|
|
3448
|
+
* Optional client-supplied message id. Auto-generated when omitted.
|
|
3449
|
+
* @public
|
|
3450
|
+
*/
|
|
3451
|
+
messageId?: string | undefined;
|
|
3452
|
+
/**
|
|
3453
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
3454
|
+
* @public
|
|
3455
|
+
*/
|
|
3456
|
+
mentions?: (string)[] | undefined;
|
|
3457
|
+
channelId: string;
|
|
3458
|
+
/**
|
|
3459
|
+
* Rendering hint for the message.
|
|
3460
|
+
* @public
|
|
3461
|
+
*/
|
|
3462
|
+
messageType?: MessageType | undefined;
|
|
1120
3463
|
}
|
|
1121
3464
|
/**
|
|
1122
3465
|
* @public
|
|
1123
|
-
* @enum
|
|
1124
3466
|
*/
|
|
1125
|
-
export
|
|
3467
|
+
export interface SendMessageOutput {
|
|
1126
3468
|
/**
|
|
1127
|
-
*
|
|
3469
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
3470
|
+
* @public
|
|
1128
3471
|
*/
|
|
1129
|
-
|
|
1130
|
-
}
|
|
1131
|
-
/**
|
|
1132
|
-
* @public
|
|
1133
|
-
*/
|
|
1134
|
-
export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
|
|
3472
|
+
message: Message;
|
|
3473
|
+
}
|
|
1135
3474
|
/**
|
|
1136
3475
|
* @public
|
|
1137
3476
|
*/
|
|
1138
|
-
export interface
|
|
3477
|
+
export interface SendMessageReactionInput {
|
|
1139
3478
|
/**
|
|
1140
3479
|
* The unique identifier of the tenant when a service token is used.
|
|
1141
3480
|
* @public
|
|
@@ -1146,116 +3485,159 @@ export interface ListMentionsInput {
|
|
|
1146
3485
|
* @public
|
|
1147
3486
|
*/
|
|
1148
3487
|
userId?: string | undefined;
|
|
3488
|
+
channelId: string;
|
|
3489
|
+
messageId: string;
|
|
1149
3490
|
/**
|
|
1150
|
-
*
|
|
1151
|
-
* @public
|
|
1152
|
-
*/
|
|
1153
|
-
filter?: MentionsFilter | undefined;
|
|
1154
|
-
/**
|
|
1155
|
-
* Opaque continuation token from the previous response.
|
|
3491
|
+
* Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
|
|
1156
3492
|
* @public
|
|
1157
3493
|
*/
|
|
1158
|
-
|
|
3494
|
+
type: string;
|
|
1159
3495
|
}
|
|
1160
3496
|
/**
|
|
1161
|
-
* Compact channel preview returned alongside a mention entry.
|
|
1162
3497
|
* @public
|
|
1163
3498
|
*/
|
|
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;
|
|
3499
|
+
export interface SendMessageReactionOutput {
|
|
1176
3500
|
/**
|
|
1177
|
-
*
|
|
3501
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1178
3502
|
* @public
|
|
1179
3503
|
*/
|
|
1180
|
-
|
|
3504
|
+
message: Message;
|
|
3505
|
+
}
|
|
3506
|
+
/**
|
|
3507
|
+
* Empty payload for the WhatsApp 24-hour window closed system message.
|
|
3508
|
+
* @public
|
|
3509
|
+
*/
|
|
3510
|
+
export interface WhatsAppClosedSystemMessage {
|
|
3511
|
+
}
|
|
3512
|
+
/**
|
|
3513
|
+
* Typed system message payload. Each variant maps to a server-generated message template.
|
|
3514
|
+
* @public
|
|
3515
|
+
*/
|
|
3516
|
+
export type SystemMessage = SystemMessage.MultipleMembersJoinedMember | SystemMessage.WhatsAppClosedMember | SystemMessage.$UnknownMember;
|
|
3517
|
+
/**
|
|
3518
|
+
* @public
|
|
3519
|
+
*/
|
|
3520
|
+
export declare namespace SystemMessage {
|
|
1181
3521
|
/**
|
|
1182
|
-
*
|
|
3522
|
+
* WhatsApp channel closed after the 24-hour reply window.
|
|
1183
3523
|
* @public
|
|
1184
3524
|
*/
|
|
1185
|
-
|
|
3525
|
+
interface WhatsAppClosedMember {
|
|
3526
|
+
whatsAppClosed: WhatsAppClosedSystemMessage;
|
|
3527
|
+
multipleMembersJoined?: never;
|
|
3528
|
+
$unknown?: never;
|
|
3529
|
+
}
|
|
1186
3530
|
/**
|
|
1187
|
-
*
|
|
3531
|
+
* Multiple members joined the channel.
|
|
1188
3532
|
* @public
|
|
1189
3533
|
*/
|
|
1190
|
-
|
|
3534
|
+
interface MultipleMembersJoinedMember {
|
|
3535
|
+
whatsAppClosed?: never;
|
|
3536
|
+
multipleMembersJoined: MultipleMembersJoinedSystemMessage;
|
|
3537
|
+
$unknown?: never;
|
|
3538
|
+
}
|
|
1191
3539
|
/**
|
|
1192
|
-
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1193
3540
|
* @public
|
|
1194
3541
|
*/
|
|
1195
|
-
|
|
3542
|
+
interface $UnknownMember {
|
|
3543
|
+
whatsAppClosed?: never;
|
|
3544
|
+
multipleMembersJoined?: never;
|
|
3545
|
+
$unknown: [string, any];
|
|
3546
|
+
}
|
|
3547
|
+
interface Visitor<T> {
|
|
3548
|
+
whatsAppClosed: (value: WhatsAppClosedSystemMessage) => T;
|
|
3549
|
+
multipleMembersJoined: (value: MultipleMembersJoinedSystemMessage) => T;
|
|
3550
|
+
_: (name: string, value: any) => T;
|
|
3551
|
+
}
|
|
3552
|
+
const visit: <T>(value: SystemMessage, visitor: Visitor<T>) => T;
|
|
1196
3553
|
}
|
|
1197
3554
|
/**
|
|
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
3555
|
* @public
|
|
1200
3556
|
*/
|
|
1201
|
-
export interface
|
|
1202
|
-
channelId: string;
|
|
1203
|
-
messageId: string;
|
|
3557
|
+
export interface SendSystemMessageInput {
|
|
1204
3558
|
/**
|
|
1205
|
-
*
|
|
3559
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1206
3560
|
* @public
|
|
1207
3561
|
*/
|
|
1208
|
-
|
|
3562
|
+
companyId?: string | undefined;
|
|
1209
3563
|
/**
|
|
1210
|
-
*
|
|
3564
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1211
3565
|
* @public
|
|
1212
3566
|
*/
|
|
1213
|
-
|
|
3567
|
+
userId?: string | undefined;
|
|
3568
|
+
channelId: string;
|
|
1214
3569
|
/**
|
|
1215
|
-
*
|
|
3570
|
+
* Typed system message payload. Each variant maps to a server-generated message template.
|
|
1216
3571
|
* @public
|
|
1217
3572
|
*/
|
|
1218
|
-
|
|
3573
|
+
message: SystemMessage;
|
|
1219
3574
|
/**
|
|
1220
|
-
*
|
|
3575
|
+
* Optional system event identifier for client rendering.
|
|
1221
3576
|
* @public
|
|
1222
3577
|
*/
|
|
1223
|
-
|
|
3578
|
+
event?: string | undefined;
|
|
1224
3579
|
/**
|
|
1225
|
-
*
|
|
3580
|
+
* Suppress push notifications and unread indicators.
|
|
1226
3581
|
* @public
|
|
1227
3582
|
*/
|
|
1228
|
-
|
|
3583
|
+
silent?: boolean | undefined;
|
|
3584
|
+
}
|
|
3585
|
+
/**
|
|
3586
|
+
* @public
|
|
3587
|
+
*/
|
|
3588
|
+
export interface SendSystemMessageOutput {
|
|
1229
3589
|
/**
|
|
1230
3590
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1231
3591
|
* @public
|
|
1232
3592
|
*/
|
|
1233
3593
|
message: Message;
|
|
3594
|
+
}
|
|
3595
|
+
/**
|
|
3596
|
+
* @public
|
|
3597
|
+
*/
|
|
3598
|
+
export interface SendTypingStartInput {
|
|
1234
3599
|
/**
|
|
1235
|
-
*
|
|
3600
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1236
3601
|
* @public
|
|
1237
3602
|
*/
|
|
1238
|
-
|
|
3603
|
+
companyId?: string | undefined;
|
|
3604
|
+
/**
|
|
3605
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3606
|
+
* @public
|
|
3607
|
+
*/
|
|
3608
|
+
userId?: string | undefined;
|
|
3609
|
+
channelId: string;
|
|
1239
3610
|
}
|
|
1240
3611
|
/**
|
|
1241
3612
|
* @public
|
|
1242
3613
|
*/
|
|
1243
|
-
export interface
|
|
3614
|
+
export interface SendTypingStartOutput {
|
|
3615
|
+
}
|
|
3616
|
+
/**
|
|
3617
|
+
* @public
|
|
3618
|
+
*/
|
|
3619
|
+
export interface SendTypingStopInput {
|
|
1244
3620
|
/**
|
|
1245
|
-
*
|
|
3621
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1246
3622
|
* @public
|
|
1247
3623
|
*/
|
|
1248
|
-
|
|
3624
|
+
companyId?: string | undefined;
|
|
1249
3625
|
/**
|
|
1250
|
-
*
|
|
3626
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1251
3627
|
* @public
|
|
1252
3628
|
*/
|
|
1253
|
-
|
|
3629
|
+
userId?: string | undefined;
|
|
3630
|
+
channelId: string;
|
|
1254
3631
|
}
|
|
1255
3632
|
/**
|
|
1256
3633
|
* @public
|
|
1257
3634
|
*/
|
|
1258
|
-
export interface
|
|
3635
|
+
export interface SendTypingStopOutput {
|
|
3636
|
+
}
|
|
3637
|
+
/**
|
|
3638
|
+
* @public
|
|
3639
|
+
*/
|
|
3640
|
+
export interface ShowChannelInput {
|
|
1259
3641
|
/**
|
|
1260
3642
|
* The unique identifier of the tenant when a service token is used.
|
|
1261
3643
|
* @public
|
|
@@ -1267,47 +3649,63 @@ export interface ListMessagesInput {
|
|
|
1267
3649
|
*/
|
|
1268
3650
|
userId?: string | undefined;
|
|
1269
3651
|
channelId: string;
|
|
3652
|
+
}
|
|
3653
|
+
/**
|
|
3654
|
+
* @public
|
|
3655
|
+
*/
|
|
3656
|
+
export interface ShowChannelOutput {
|
|
3657
|
+
}
|
|
3658
|
+
/**
|
|
3659
|
+
* @public
|
|
3660
|
+
*/
|
|
3661
|
+
export interface UnmuteChannelInput {
|
|
1270
3662
|
/**
|
|
1271
|
-
*
|
|
3663
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1272
3664
|
* @public
|
|
1273
3665
|
*/
|
|
1274
|
-
|
|
3666
|
+
companyId?: string | undefined;
|
|
1275
3667
|
/**
|
|
1276
|
-
*
|
|
3668
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1277
3669
|
* @public
|
|
1278
3670
|
*/
|
|
1279
|
-
|
|
3671
|
+
userId?: string | undefined;
|
|
3672
|
+
channelId: string;
|
|
1280
3673
|
}
|
|
1281
3674
|
/**
|
|
1282
3675
|
* @public
|
|
1283
3676
|
*/
|
|
1284
|
-
export interface
|
|
3677
|
+
export interface UnmuteChannelOutput {
|
|
1285
3678
|
/**
|
|
1286
|
-
*
|
|
3679
|
+
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
1287
3680
|
* @public
|
|
1288
3681
|
*/
|
|
1289
|
-
|
|
3682
|
+
inbox: InboxState;
|
|
1290
3683
|
}
|
|
1291
3684
|
/**
|
|
1292
|
-
* Forward reference supplied by the client. The server resolves the original author and snapshot fields at write time.
|
|
1293
3685
|
* @public
|
|
1294
3686
|
*/
|
|
1295
|
-
export interface
|
|
3687
|
+
export interface UnpinChannelInput {
|
|
3688
|
+
/**
|
|
3689
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3690
|
+
* @public
|
|
3691
|
+
*/
|
|
3692
|
+
companyId?: string | undefined;
|
|
3693
|
+
/**
|
|
3694
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3695
|
+
* @public
|
|
3696
|
+
*/
|
|
3697
|
+
userId?: string | undefined;
|
|
1296
3698
|
channelId: string;
|
|
1297
|
-
messageId: string;
|
|
1298
3699
|
}
|
|
1299
3700
|
/**
|
|
1300
|
-
* Quote reference supplied by the client. The server resolves the author and snapshot fields at write time.
|
|
1301
3701
|
* @public
|
|
1302
3702
|
*/
|
|
1303
|
-
export interface
|
|
1304
|
-
channelId: string;
|
|
1305
|
-
messageId: string;
|
|
3703
|
+
export interface UnpinChannelOutput {
|
|
1306
3704
|
}
|
|
1307
3705
|
/**
|
|
1308
3706
|
* @public
|
|
1309
3707
|
*/
|
|
1310
|
-
export interface
|
|
3708
|
+
export interface UnpinMessageInput {
|
|
1311
3709
|
/**
|
|
1312
3710
|
* The unique identifier of the tenant when a service token is used.
|
|
1313
3711
|
* @public
|
|
@@ -1324,7 +3722,7 @@ export interface PinMessageInput {
|
|
|
1324
3722
|
/**
|
|
1325
3723
|
* @public
|
|
1326
3724
|
*/
|
|
1327
|
-
export interface
|
|
3725
|
+
export interface UnpinMessageOutput {
|
|
1328
3726
|
/**
|
|
1329
3727
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1330
3728
|
* @public
|
|
@@ -1334,7 +3732,7 @@ export interface PinMessageOutput {
|
|
|
1334
3732
|
/**
|
|
1335
3733
|
* @public
|
|
1336
3734
|
*/
|
|
1337
|
-
export interface
|
|
3735
|
+
export interface UpdateChannelInput {
|
|
1338
3736
|
/**
|
|
1339
3737
|
* The unique identifier of the tenant when a service token is used.
|
|
1340
3738
|
* @public
|
|
@@ -1345,28 +3743,96 @@ export interface RemoveReactionInput {
|
|
|
1345
3743
|
* @public
|
|
1346
3744
|
*/
|
|
1347
3745
|
userId?: string | undefined;
|
|
1348
|
-
channelId: string;
|
|
1349
|
-
messageId: string;
|
|
1350
3746
|
/**
|
|
1351
|
-
*
|
|
3747
|
+
* The subject of the channel.
|
|
1352
3748
|
* @public
|
|
1353
3749
|
*/
|
|
1354
|
-
|
|
3750
|
+
subject?: string | undefined;
|
|
3751
|
+
/**
|
|
3752
|
+
* The description of the channel.
|
|
3753
|
+
* @public
|
|
3754
|
+
*/
|
|
3755
|
+
description?: string | undefined;
|
|
3756
|
+
/**
|
|
3757
|
+
* The URL of the channel's picture.
|
|
3758
|
+
* @public
|
|
3759
|
+
*/
|
|
3760
|
+
picture?: string | undefined;
|
|
3761
|
+
/**
|
|
3762
|
+
* The dominant color of the channel's picture, represented by a hex value.
|
|
3763
|
+
* @public
|
|
3764
|
+
*/
|
|
3765
|
+
pictureColor?: string | undefined;
|
|
3766
|
+
/**
|
|
3767
|
+
* Channel access level.
|
|
3768
|
+
* @public
|
|
3769
|
+
*/
|
|
3770
|
+
access?: ChannelAccess | undefined;
|
|
3771
|
+
/**
|
|
3772
|
+
* Indicates if the channel is broadcast-only. Default is false.
|
|
3773
|
+
* @public
|
|
3774
|
+
*/
|
|
3775
|
+
broadcast?: boolean | undefined;
|
|
3776
|
+
context?: ChannelContext | undefined;
|
|
3777
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
3778
|
+
/**
|
|
3779
|
+
* Indicates if the channel supports SMS. Default is false.
|
|
3780
|
+
* @public
|
|
3781
|
+
*/
|
|
3782
|
+
sms?: boolean | undefined;
|
|
3783
|
+
/**
|
|
3784
|
+
* Indicates if the channel supports MMS. Default is false.
|
|
3785
|
+
* @public
|
|
3786
|
+
*/
|
|
3787
|
+
mms?: boolean | undefined;
|
|
3788
|
+
/**
|
|
3789
|
+
* Indicates if the channel supports WhatsApp. Default is false.
|
|
3790
|
+
* @public
|
|
3791
|
+
*/
|
|
3792
|
+
whatsapp?: boolean | undefined;
|
|
3793
|
+
/**
|
|
3794
|
+
* The unique identifier of the assignee.
|
|
3795
|
+
* @public
|
|
3796
|
+
*/
|
|
3797
|
+
kiteAssign?: string | undefined;
|
|
3798
|
+
/**
|
|
3799
|
+
* The title of the service.
|
|
3800
|
+
* @public
|
|
3801
|
+
*/
|
|
3802
|
+
serviceTitle?: string | undefined;
|
|
3803
|
+
/**
|
|
3804
|
+
* Assignee user id.
|
|
3805
|
+
* @public
|
|
3806
|
+
*/
|
|
3807
|
+
assigneeId?: string | undefined;
|
|
3808
|
+
/**
|
|
3809
|
+
* Indicates if the channel supports auto start recording.
|
|
3810
|
+
* @public
|
|
3811
|
+
*/
|
|
3812
|
+
autoRecord?: boolean | undefined;
|
|
3813
|
+
/**
|
|
3814
|
+
* Transcription language.
|
|
3815
|
+
* @public
|
|
3816
|
+
*/
|
|
3817
|
+
transcriptionLanguage?: string | undefined;
|
|
3818
|
+
/**
|
|
3819
|
+
* 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.
|
|
3820
|
+
* @public
|
|
3821
|
+
*/
|
|
3822
|
+
wizyGuestViewOnly?: boolean | undefined;
|
|
3823
|
+
channelId: string;
|
|
3824
|
+
silent?: boolean | undefined;
|
|
1355
3825
|
}
|
|
1356
3826
|
/**
|
|
1357
3827
|
* @public
|
|
1358
3828
|
*/
|
|
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;
|
|
3829
|
+
export interface UpdateChannelOutput {
|
|
3830
|
+
channel: Channel;
|
|
1365
3831
|
}
|
|
1366
3832
|
/**
|
|
1367
3833
|
* @public
|
|
1368
3834
|
*/
|
|
1369
|
-
export interface
|
|
3835
|
+
export interface UpdateMessageInput {
|
|
1370
3836
|
/**
|
|
1371
3837
|
* The unique identifier of the tenant when a service token is used.
|
|
1372
3838
|
* @public
|
|
@@ -1377,27 +3843,21 @@ export interface SendMessageInput {
|
|
|
1377
3843
|
* @public
|
|
1378
3844
|
*/
|
|
1379
3845
|
userId?: string | undefined;
|
|
1380
|
-
channelId: string;
|
|
1381
|
-
/**
|
|
1382
|
-
* Rendering hint for the message.
|
|
1383
|
-
* @public
|
|
1384
|
-
*/
|
|
1385
|
-
messageType?: MessageType | undefined;
|
|
1386
3846
|
/**
|
|
1387
3847
|
* Text body. Required unless `attachments` is non-empty.
|
|
1388
3848
|
* @public
|
|
1389
3849
|
*/
|
|
1390
3850
|
text?: string | undefined;
|
|
1391
3851
|
/**
|
|
1392
|
-
*
|
|
3852
|
+
* Structured rich content blocks.
|
|
1393
3853
|
* @public
|
|
1394
3854
|
*/
|
|
1395
|
-
|
|
3855
|
+
elements?: (Element)[] | undefined;
|
|
1396
3856
|
/**
|
|
1397
|
-
*
|
|
3857
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1398
3858
|
* @public
|
|
1399
3859
|
*/
|
|
1400
|
-
|
|
3860
|
+
attachments?: (MessageAttachmentRequest)[] | undefined;
|
|
1401
3861
|
/**
|
|
1402
3862
|
* Reply context referencing a quoted message.
|
|
1403
3863
|
* @public
|
|
@@ -1409,15 +3869,39 @@ export interface SendMessageInput {
|
|
|
1409
3869
|
*/
|
|
1410
3870
|
forward?: MessageForwardRef | undefined;
|
|
1411
3871
|
/**
|
|
1412
|
-
*
|
|
3872
|
+
* When true, the message body is interpreted as Markdown.
|
|
3873
|
+
* @public
|
|
3874
|
+
*/
|
|
3875
|
+
markdown?: boolean | undefined;
|
|
3876
|
+
/**
|
|
3877
|
+
* Direct `@user` ids.
|
|
3878
|
+
* @public
|
|
3879
|
+
*/
|
|
3880
|
+
mentions?: (string)[] | undefined;
|
|
3881
|
+
/**
|
|
3882
|
+
* Mark as a WhatsApp message. The server may infer this from the channel type.
|
|
3883
|
+
* @public
|
|
3884
|
+
*/
|
|
3885
|
+
whatsapp?: boolean | undefined;
|
|
3886
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
3887
|
+
/**
|
|
3888
|
+
* Mark as an SMS message. The server may infer this from the channel type.
|
|
3889
|
+
* @public
|
|
3890
|
+
*/
|
|
3891
|
+
sms?: boolean | undefined;
|
|
3892
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
3893
|
+
channelId: string;
|
|
3894
|
+
messageId: string;
|
|
3895
|
+
/**
|
|
3896
|
+
* Suppress the updated indicator for this edit.
|
|
1413
3897
|
* @public
|
|
1414
3898
|
*/
|
|
1415
|
-
|
|
3899
|
+
silent?: boolean | undefined;
|
|
1416
3900
|
}
|
|
1417
3901
|
/**
|
|
1418
3902
|
* @public
|
|
1419
3903
|
*/
|
|
1420
|
-
export interface
|
|
3904
|
+
export interface UpdateMessageOutput {
|
|
1421
3905
|
/**
|
|
1422
3906
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1423
3907
|
* @public
|
|
@@ -1425,9 +3909,25 @@ export interface SendMessageOutput {
|
|
|
1425
3909
|
message: Message;
|
|
1426
3910
|
}
|
|
1427
3911
|
/**
|
|
3912
|
+
* Optional parameters for the upload presign flow.
|
|
1428
3913
|
* @public
|
|
1429
3914
|
*/
|
|
1430
|
-
export interface
|
|
3915
|
+
export interface UploadFileOptions {
|
|
3916
|
+
/**
|
|
3917
|
+
* File category. Defaults to `channels`.
|
|
3918
|
+
* @public
|
|
3919
|
+
*/
|
|
3920
|
+
category?: FileCategory | undefined;
|
|
3921
|
+
/**
|
|
3922
|
+
* Target upload region. S2S only; ignored for user tokens.
|
|
3923
|
+
* @public
|
|
3924
|
+
*/
|
|
3925
|
+
region?: string | undefined;
|
|
3926
|
+
}
|
|
3927
|
+
/**
|
|
3928
|
+
* @public
|
|
3929
|
+
*/
|
|
3930
|
+
export interface UploadFileInput {
|
|
1431
3931
|
/**
|
|
1432
3932
|
* The unique identifier of the tenant when a service token is used.
|
|
1433
3933
|
* @public
|
|
@@ -1439,15 +3939,29 @@ export interface UnpinMessageInput {
|
|
|
1439
3939
|
*/
|
|
1440
3940
|
userId?: string | undefined;
|
|
1441
3941
|
channelId: string;
|
|
1442
|
-
|
|
3942
|
+
/**
|
|
3943
|
+
* Original file name. Unreadable characters are replaced with underscores.
|
|
3944
|
+
* @public
|
|
3945
|
+
*/
|
|
3946
|
+
name: string;
|
|
3947
|
+
/**
|
|
3948
|
+
* Additional upload parameters.
|
|
3949
|
+
* @public
|
|
3950
|
+
*/
|
|
3951
|
+
options?: UploadFileOptions | undefined;
|
|
1443
3952
|
}
|
|
1444
3953
|
/**
|
|
1445
3954
|
* @public
|
|
1446
3955
|
*/
|
|
1447
|
-
export interface
|
|
3956
|
+
export interface UploadFileOutput {
|
|
1448
3957
|
/**
|
|
1449
|
-
*
|
|
3958
|
+
* File service identifier. Pass this value as `attachments[].fsId` on send and edit.
|
|
1450
3959
|
* @public
|
|
1451
3960
|
*/
|
|
1452
|
-
|
|
3961
|
+
fsId: string;
|
|
3962
|
+
/**
|
|
3963
|
+
* Presigned URL for uploading the file contents.
|
|
3964
|
+
* @public
|
|
3965
|
+
*/
|
|
3966
|
+
presignedUploadUrl: string;
|
|
1453
3967
|
}
|