@wildix/xbees-conversations-client 1.1.12 → 1.1.14
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/Conversations.js +2 -0
- package/dist-cjs/ConversationsClient.js +4 -5
- package/dist-cjs/commands/AssignChannelCommand.js +21 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +71 -42
- package/dist-cjs/protocols/Aws_restJson1.js +142 -151
- package/dist-cjs/runtimeConfig.browser.js +1 -1
- package/dist-cjs/runtimeConfig.js +4 -3
- package/dist-cjs/runtimeExtensions.js +2 -10
- package/dist-es/Conversations.js +2 -0
- package/dist-es/ConversationsClient.js +4 -5
- package/dist-es/commands/AssignChannelCommand.js +17 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +67 -38
- package/dist-es/protocols/Aws_restJson1.js +43 -54
- package/dist-es/runtimeConfig.browser.js +2 -2
- package/dist-es/runtimeConfig.js +5 -4
- package/dist-es/runtimeExtensions.js +2 -10
- package/dist-types/Conversations.d.ts +7 -0
- package/dist-types/ConversationsClient.d.ts +4 -3
- package/dist-types/commands/AddChannelMemberCommand.d.ts +13 -0
- package/dist-types/commands/AddChannelMembersCommand.d.ts +13 -0
- package/dist-types/commands/AssignChannelCommand.d.ts +120 -0
- package/dist-types/commands/CreateGroupChannelCommand.d.ts +12 -0
- package/dist-types/commands/CreateInboxTagCommand.d.ts +12 -0
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +12 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +12 -0
- package/dist-types/commands/DeleteChannelMemberCommand.d.ts +12 -0
- package/dist-types/commands/DeleteInboxTagCommand.d.ts +12 -0
- package/dist-types/commands/DeleteMessageCommand.d.ts +12 -0
- package/dist-types/commands/DeleteMessageReactionCommand.d.ts +12 -0
- package/dist-types/commands/DescribeEventCommand.d.ts +12 -0
- package/dist-types/commands/GetActionTriggerResultCommand.d.ts +12 -0
- package/dist-types/commands/GetChannelCommand.d.ts +12 -0
- package/dist-types/commands/GetChannelMemberCommand.d.ts +12 -0
- package/dist-types/commands/GetDirectChannelIdCommand.d.ts +12 -0
- package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +12 -0
- package/dist-types/commands/GetInboxStateCommand.d.ts +12 -0
- package/dist-types/commands/GetMessageCommand.d.ts +12 -0
- package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +12 -0
- package/dist-types/commands/GetTokenCommand.d.ts +12 -0
- package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +12 -0
- package/dist-types/commands/HideChannelCommand.d.ts +12 -0
- package/dist-types/commands/InviteCommand.d.ts +12 -0
- package/dist-types/commands/JoinChannelCommand.d.ts +12 -0
- package/dist-types/commands/LeaveChannelCommand.d.ts +12 -0
- package/dist-types/commands/ListChannelMembersCommand.d.ts +12 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +12 -0
- package/dist-types/commands/ListInboxTaggedChannelsCommand.d.ts +12 -0
- package/dist-types/commands/ListInboxTagsCommand.d.ts +12 -0
- package/dist-types/commands/ListMessageReactionsCommand.d.ts +12 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +12 -0
- package/dist-types/commands/ListPinnedMessagesCommand.d.ts +12 -0
- package/dist-types/commands/MarkReadCommand.d.ts +12 -0
- package/dist-types/commands/MarkUnreadCommand.d.ts +12 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +12 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +12 -0
- package/dist-types/commands/PinChannelCommand.d.ts +12 -0
- package/dist-types/commands/PinMessageCommand.d.ts +12 -0
- package/dist-types/commands/QueryChannelsCommand.d.ts +12 -0
- package/dist-types/commands/ScheduleExternalFlagAdjustmentJobCommand.d.ts +12 -0
- package/dist-types/commands/SendActionTriggerResultCommand.d.ts +12 -0
- package/dist-types/commands/SendGiphyCommand.d.ts +12 -0
- package/dist-types/commands/SendMessageCommand.d.ts +12 -0
- package/dist-types/commands/SendMessageReactionCommand.d.ts +12 -0
- package/dist-types/commands/SendTypingStartCommand.d.ts +12 -0
- package/dist-types/commands/SendTypingStopCommand.d.ts +12 -0
- package/dist-types/commands/ShowChannelCommand.d.ts +12 -0
- package/dist-types/commands/TagChannelCommand.d.ts +12 -0
- package/dist-types/commands/TriggerMessageActionCommand.d.ts +12 -0
- package/dist-types/commands/UnpinChannelCommand.d.ts +12 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +12 -0
- package/dist-types/commands/UntagChannelCommand.d.ts +12 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +12 -0
- package/dist-types/commands/UpdateInboxTagCommand.d.ts +12 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +12 -0
- package/dist-types/commands/UploadFileCommand.d.ts +12 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +459 -284
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +4 -2
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +4 -2
- package/package.json +38 -34
|
@@ -32,22 +32,22 @@ export declare class RateLimitExceededException extends __BaseException {
|
|
|
32
32
|
* Displays the applicable rate limits for the current request.
|
|
33
33
|
* @public
|
|
34
34
|
*/
|
|
35
|
-
rateLimit?: string;
|
|
35
|
+
rateLimit?: string | undefined;
|
|
36
36
|
/**
|
|
37
37
|
* Indicates how many requests a user can still make within the current time window.
|
|
38
38
|
* @public
|
|
39
39
|
*/
|
|
40
|
-
rateLimitRemaining?: number;
|
|
40
|
+
rateLimitRemaining?: number | undefined;
|
|
41
41
|
/**
|
|
42
42
|
* Shows the time in seconds until the rate limit resets.
|
|
43
43
|
* @public
|
|
44
44
|
*/
|
|
45
|
-
rateLimitReset?: number;
|
|
45
|
+
rateLimitReset?: number | undefined;
|
|
46
46
|
/**
|
|
47
47
|
* Displays how many seconds the user agent should wait before making a follow-up request.
|
|
48
48
|
* @public
|
|
49
49
|
*/
|
|
50
|
-
retryAfter?: number;
|
|
50
|
+
retryAfter?: number | undefined;
|
|
51
51
|
/**
|
|
52
52
|
* @internal
|
|
53
53
|
*/
|
|
@@ -82,21 +82,21 @@ export declare class FileNotFoundException extends __BaseException {
|
|
|
82
82
|
*/
|
|
83
83
|
export interface User {
|
|
84
84
|
id: string;
|
|
85
|
-
name?: string;
|
|
86
|
-
email?: string;
|
|
87
|
-
phone?: string;
|
|
88
|
-
picture?: string;
|
|
89
|
-
locale?: string;
|
|
90
|
-
timeZone?: string;
|
|
91
|
-
company?: string;
|
|
92
|
-
bot?: boolean;
|
|
93
|
-
pbxDomain?: string;
|
|
94
|
-
pbxPort?: string;
|
|
95
|
-
pbxExtension?: string;
|
|
96
|
-
pbxSerial?: string;
|
|
97
|
-
pbxUserId?: string;
|
|
98
|
-
createdAt?: string;
|
|
99
|
-
updatedAt?: string;
|
|
85
|
+
name?: string | undefined;
|
|
86
|
+
email?: string | undefined;
|
|
87
|
+
phone?: string | undefined;
|
|
88
|
+
picture?: string | undefined;
|
|
89
|
+
locale?: string | undefined;
|
|
90
|
+
timeZone?: string | undefined;
|
|
91
|
+
company?: string | undefined;
|
|
92
|
+
bot?: boolean | undefined;
|
|
93
|
+
pbxDomain?: string | undefined;
|
|
94
|
+
pbxPort?: string | undefined;
|
|
95
|
+
pbxExtension?: string | undefined;
|
|
96
|
+
pbxSerial?: string | undefined;
|
|
97
|
+
pbxUserId?: string | undefined;
|
|
98
|
+
createdAt?: string | undefined;
|
|
99
|
+
updatedAt?: string | undefined;
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
102
|
* @public
|
|
@@ -130,7 +130,7 @@ export interface ButtonLinkHandler {
|
|
|
130
130
|
* @public
|
|
131
131
|
*/
|
|
132
132
|
export interface ButtonReplyHandler {
|
|
133
|
-
text?: string;
|
|
133
|
+
text?: string | undefined;
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
136
|
* @public
|
|
@@ -193,8 +193,8 @@ export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
|
|
|
193
193
|
export interface ButtonElement {
|
|
194
194
|
text: string;
|
|
195
195
|
handler: ButtonHandler;
|
|
196
|
-
variant?: ButtonVariant;
|
|
197
|
-
disabled?: boolean;
|
|
196
|
+
variant?: ButtonVariant | undefined;
|
|
197
|
+
disabled?: boolean | undefined;
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
200
|
* @public
|
|
@@ -225,7 +225,7 @@ export declare namespace ActionElement {
|
|
|
225
225
|
* @public
|
|
226
226
|
*/
|
|
227
227
|
export interface ActionTriggerResult {
|
|
228
|
-
url?: string;
|
|
228
|
+
url?: string | undefined;
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
231
|
* @public
|
|
@@ -243,10 +243,10 @@ export type ActionTriggerStatus = typeof ActionTriggerStatus[keyof typeof Action
|
|
|
243
243
|
* @public
|
|
244
244
|
*/
|
|
245
245
|
export interface UserToInvite {
|
|
246
|
-
email?: string;
|
|
247
|
-
phone?: string;
|
|
248
|
-
name?: string;
|
|
249
|
-
colleague?: boolean;
|
|
246
|
+
email?: string | undefined;
|
|
247
|
+
phone?: string | undefined;
|
|
248
|
+
name?: string | undefined;
|
|
249
|
+
colleague?: boolean | undefined;
|
|
250
250
|
}
|
|
251
251
|
/**
|
|
252
252
|
* @public
|
|
@@ -261,22 +261,27 @@ export interface AddChannelMemberInput {
|
|
|
261
261
|
* The unique identifier of the user when a service token is used.
|
|
262
262
|
* @public
|
|
263
263
|
*/
|
|
264
|
-
userId?: string;
|
|
264
|
+
userId?: string | undefined;
|
|
265
265
|
/**
|
|
266
266
|
* True to not send a system message that members added from the conversartion. Default - false.
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
silent?: boolean;
|
|
269
|
+
silent?: boolean | undefined;
|
|
270
270
|
/**
|
|
271
271
|
* A User ID of the member to be added to the channel.
|
|
272
272
|
* @public
|
|
273
273
|
*/
|
|
274
|
-
memberId?: string;
|
|
274
|
+
memberId?: string | undefined;
|
|
275
275
|
/**
|
|
276
276
|
* A user to invite to the channel, identified by email address or phone number if the member does not already exist.
|
|
277
277
|
* @public
|
|
278
278
|
*/
|
|
279
|
-
memberToInvite?: UserToInvite;
|
|
279
|
+
memberToInvite?: UserToInvite | undefined;
|
|
280
|
+
/**
|
|
281
|
+
* Set to true to hide the history of the channel for added member. Default is false.
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
hideHistory?: boolean | undefined;
|
|
280
285
|
}
|
|
281
286
|
/**
|
|
282
287
|
* @public
|
|
@@ -348,22 +353,27 @@ export interface AddChannelMembersInput {
|
|
|
348
353
|
* The unique identifier of the user when a service token is used.
|
|
349
354
|
* @public
|
|
350
355
|
*/
|
|
351
|
-
userId?: string;
|
|
356
|
+
userId?: string | undefined;
|
|
352
357
|
/**
|
|
353
358
|
* Set to true to suppress system messages that members were added to the conversation. Default is false.
|
|
354
359
|
* @public
|
|
355
360
|
*/
|
|
356
|
-
silent?: boolean;
|
|
361
|
+
silent?: boolean | undefined;
|
|
357
362
|
/**
|
|
358
363
|
* A list of user IDs to be added as members of the channel.
|
|
359
364
|
* @public
|
|
360
365
|
*/
|
|
361
|
-
members?: (string)[];
|
|
366
|
+
members?: (string)[] | undefined;
|
|
362
367
|
/**
|
|
363
368
|
* A list of users to invite to the channel, identified by their email addresses or phone numbers.
|
|
364
369
|
* @public
|
|
365
370
|
*/
|
|
366
|
-
membersToInvite?: (UserToInvite)[];
|
|
371
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* Set to true to hide the history of the channel for added member. Default is false.
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
hideHistory?: boolean | undefined;
|
|
367
377
|
}
|
|
368
378
|
/**
|
|
369
379
|
* @public
|
|
@@ -380,6 +390,171 @@ export interface AddChannelMembersOutput {
|
|
|
380
390
|
*/
|
|
381
391
|
users: (User)[];
|
|
382
392
|
}
|
|
393
|
+
/**
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
export type AssignChannelAssigneeRequest = AssignChannelAssigneeRequest.EmailMember | AssignChannelAssigneeRequest.IdMember | AssignChannelAssigneeRequest.$UnknownMember;
|
|
397
|
+
/**
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
export declare namespace AssignChannelAssigneeRequest {
|
|
401
|
+
/**
|
|
402
|
+
* A User ID of the assignee.
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
interface IdMember {
|
|
406
|
+
id: string;
|
|
407
|
+
email?: never;
|
|
408
|
+
$unknown?: never;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* An email of the assignee.
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
interface EmailMember {
|
|
415
|
+
id?: never;
|
|
416
|
+
email: string;
|
|
417
|
+
$unknown?: never;
|
|
418
|
+
}
|
|
419
|
+
/**
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
interface $UnknownMember {
|
|
423
|
+
id?: never;
|
|
424
|
+
email?: never;
|
|
425
|
+
$unknown: [string, any];
|
|
426
|
+
}
|
|
427
|
+
interface Visitor<T> {
|
|
428
|
+
id: (value: string) => T;
|
|
429
|
+
email: (value: string) => T;
|
|
430
|
+
_: (name: string, value: any) => T;
|
|
431
|
+
}
|
|
432
|
+
const visit: <T>(value: AssignChannelAssigneeRequest, visitor: Visitor<T>) => T;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
export type AssignChannelServiceRequest = AssignChannelServiceRequest.UriMember | AssignChannelServiceRequest.$UnknownMember;
|
|
438
|
+
/**
|
|
439
|
+
* @public
|
|
440
|
+
*/
|
|
441
|
+
export declare namespace AssignChannelServiceRequest {
|
|
442
|
+
/**
|
|
443
|
+
* A unique identifier of the service. URI structure - <serviceId>@<pbxDomain>:<pbxPort> (example 1@demo.wildix.com:433)
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
interface UriMember {
|
|
447
|
+
uri: string;
|
|
448
|
+
$unknown?: never;
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
interface $UnknownMember {
|
|
454
|
+
uri?: never;
|
|
455
|
+
$unknown: [string, any];
|
|
456
|
+
}
|
|
457
|
+
interface Visitor<T> {
|
|
458
|
+
uri: (value: string) => T;
|
|
459
|
+
_: (name: string, value: any) => T;
|
|
460
|
+
}
|
|
461
|
+
const visit: <T>(value: AssignChannelServiceRequest, visitor: Visitor<T>) => T;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
* @enum
|
|
466
|
+
*/
|
|
467
|
+
export declare const AssignChannelVariant: {
|
|
468
|
+
/**
|
|
469
|
+
* If service was previously assigned it uses SKIP variant, otherwise SELECTED. Default option.
|
|
470
|
+
*/
|
|
471
|
+
readonly ADAPTIVE: "ADAPTIVE";
|
|
472
|
+
/**
|
|
473
|
+
* Ensures that all agents in the service are presented in the conversation and existing members.
|
|
474
|
+
*/
|
|
475
|
+
readonly EVERYBODY: "EVERYBODY";
|
|
476
|
+
/**
|
|
477
|
+
* Ensures that only selected agent and user that made assignment are presented in the conversation.
|
|
478
|
+
*/
|
|
479
|
+
readonly SELECTED: "SELECTED";
|
|
480
|
+
/**
|
|
481
|
+
* Does not invite anyone (except the assignee if not present yet) or remove any agents from the conversation.
|
|
482
|
+
*/
|
|
483
|
+
readonly SKIP: "SKIP";
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
export type AssignChannelVariant = typeof AssignChannelVariant[keyof typeof AssignChannelVariant];
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
export interface AssignChannelInput {
|
|
493
|
+
channelId: string;
|
|
494
|
+
/**
|
|
495
|
+
* The unique identifier of the user when a service token is used.
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
userId?: string | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* True to not send a system message that channel was assigned to specific service or user. Default - false.
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
silent?: boolean | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* Service information to assign to. If service is not empty than `addAgentFromService` option could be used.
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
service?: AssignChannelServiceRequest | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* A user that should be assigned to the channel. If service was specified than this field can be optional.
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
assignee?: AssignChannelAssigneeRequest | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* Indicates when agents from specified service should be added or removed from the conversation. Default is `ADAPTIVE`. This is applicable only if the service is included in the request.
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
variant?: AssignChannelVariant | undefined;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
export interface ServicePbx {
|
|
524
|
+
domain: string;
|
|
525
|
+
port: number;
|
|
526
|
+
}
|
|
527
|
+
/**
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
export interface ServiceSettings {
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
export interface Service {
|
|
536
|
+
id: number;
|
|
537
|
+
uri: string;
|
|
538
|
+
title: string;
|
|
539
|
+
settings: ServiceSettings;
|
|
540
|
+
extensions: (string)[];
|
|
541
|
+
pbx: ServicePbx;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
export interface AssignChannelOutput {
|
|
547
|
+
/**
|
|
548
|
+
* A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
assignee?: User | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
service?: Service | undefined;
|
|
557
|
+
}
|
|
383
558
|
/**
|
|
384
559
|
* @public
|
|
385
560
|
* @enum
|
|
@@ -411,19 +586,19 @@ export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttend
|
|
|
411
586
|
*/
|
|
412
587
|
export interface ChannelContextEventAttendee {
|
|
413
588
|
email: string;
|
|
414
|
-
name?: string;
|
|
589
|
+
name?: string | undefined;
|
|
415
590
|
status: ChannelContextEventAttendeeStatus;
|
|
416
591
|
}
|
|
417
592
|
/**
|
|
418
593
|
* @public
|
|
419
594
|
*/
|
|
420
595
|
export interface ChannelContextEvent {
|
|
421
|
-
id?: string;
|
|
422
|
-
owner?: string;
|
|
423
|
-
start?: string;
|
|
424
|
-
end?: string;
|
|
425
|
-
summary?: string;
|
|
426
|
-
attendees?: (ChannelContextEventAttendee)[];
|
|
596
|
+
id?: string | undefined;
|
|
597
|
+
owner?: string | undefined;
|
|
598
|
+
start?: string | undefined;
|
|
599
|
+
end?: string | undefined;
|
|
600
|
+
summary?: string | undefined;
|
|
601
|
+
attendees?: (ChannelContextEventAttendee)[] | undefined;
|
|
427
602
|
}
|
|
428
603
|
/**
|
|
429
604
|
* @public
|
|
@@ -433,7 +608,7 @@ export interface ChannelContextPushToTalk {
|
|
|
433
608
|
* A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
|
|
434
609
|
* @public
|
|
435
610
|
*/
|
|
436
|
-
broadcastId?: string;
|
|
611
|
+
broadcastId?: string | undefined;
|
|
437
612
|
}
|
|
438
613
|
/**
|
|
439
614
|
* @public
|
|
@@ -450,10 +625,10 @@ export type ChannelContextSource = typeof ChannelContextSource[keyof typeof Chan
|
|
|
450
625
|
* @public
|
|
451
626
|
*/
|
|
452
627
|
export interface ChannelContext {
|
|
453
|
-
source?: ChannelContextSource;
|
|
454
|
-
target?: string;
|
|
455
|
-
events?: (ChannelContextEvent)[];
|
|
456
|
-
ptt?: ChannelContextPushToTalk;
|
|
628
|
+
source?: ChannelContextSource | undefined;
|
|
629
|
+
target?: string | undefined;
|
|
630
|
+
events?: (ChannelContextEvent)[] | undefined;
|
|
631
|
+
ptt?: ChannelContextPushToTalk | undefined;
|
|
457
632
|
}
|
|
458
633
|
/**
|
|
459
634
|
* @public
|
|
@@ -470,44 +645,44 @@ export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof Ch
|
|
|
470
645
|
* @public
|
|
471
646
|
*/
|
|
472
647
|
export interface Channel {
|
|
473
|
-
subject?: string;
|
|
474
|
-
description?: string;
|
|
648
|
+
subject?: string | undefined;
|
|
649
|
+
description?: string | undefined;
|
|
475
650
|
/**
|
|
476
651
|
* Picture URL
|
|
477
652
|
* @public
|
|
478
653
|
*/
|
|
479
|
-
picture?: string;
|
|
654
|
+
picture?: string | undefined;
|
|
480
655
|
/**
|
|
481
656
|
* Picture dominant color represented by a hex value.
|
|
482
657
|
* @public
|
|
483
658
|
*/
|
|
484
|
-
pictureColor?: string;
|
|
485
|
-
access?: ChannelAccess;
|
|
486
|
-
company?: string;
|
|
487
|
-
context?: ChannelContext;
|
|
488
|
-
kite?: boolean;
|
|
489
|
-
kiteTarget?: string;
|
|
490
|
-
kiteVariant?: string;
|
|
491
|
-
kiteAssign?: string;
|
|
492
|
-
kiteServiceName?: string;
|
|
493
|
-
kiteDefaultSubject?: string;
|
|
494
|
-
service?: string;
|
|
495
|
-
serviceTitle?: string;
|
|
496
|
-
serviceRecipient?: string;
|
|
497
|
-
assignee?: User;
|
|
498
|
-
telephony?: boolean;
|
|
499
|
-
sms?: boolean;
|
|
500
|
-
mms?: boolean;
|
|
501
|
-
whatsapp?: boolean;
|
|
502
|
-
whatsappStatus?: ChannelWhatsAppStatus;
|
|
503
|
-
broadcast?: boolean;
|
|
504
|
-
external?: boolean;
|
|
659
|
+
pictureColor?: string | undefined;
|
|
660
|
+
access?: ChannelAccess | undefined;
|
|
661
|
+
company?: string | undefined;
|
|
662
|
+
context?: ChannelContext | undefined;
|
|
663
|
+
kite?: boolean | undefined;
|
|
664
|
+
kiteTarget?: string | undefined;
|
|
665
|
+
kiteVariant?: string | undefined;
|
|
666
|
+
kiteAssign?: string | undefined;
|
|
667
|
+
kiteServiceName?: string | undefined;
|
|
668
|
+
kiteDefaultSubject?: string | undefined;
|
|
669
|
+
service?: string | undefined;
|
|
670
|
+
serviceTitle?: string | undefined;
|
|
671
|
+
serviceRecipient?: string | undefined;
|
|
672
|
+
assignee?: User | undefined;
|
|
673
|
+
telephony?: boolean | undefined;
|
|
674
|
+
sms?: boolean | undefined;
|
|
675
|
+
mms?: boolean | undefined;
|
|
676
|
+
whatsapp?: boolean | undefined;
|
|
677
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
678
|
+
broadcast?: boolean | undefined;
|
|
679
|
+
external?: boolean | undefined;
|
|
505
680
|
channelId: string;
|
|
506
681
|
channelType: ChannelType;
|
|
507
682
|
memberCount: number;
|
|
508
683
|
createdAt: string;
|
|
509
684
|
createdBy: string;
|
|
510
|
-
updatedAt?: string;
|
|
685
|
+
updatedAt?: string | undefined;
|
|
511
686
|
}
|
|
512
687
|
/**
|
|
513
688
|
* @public
|
|
@@ -524,7 +699,7 @@ export declare class ChannelAlreadyExistException extends __BaseException {
|
|
|
524
699
|
* @public
|
|
525
700
|
*/
|
|
526
701
|
export interface ChannelsQuery {
|
|
527
|
-
ids?: (string)[];
|
|
702
|
+
ids?: (string)[] | undefined;
|
|
528
703
|
}
|
|
529
704
|
/**
|
|
530
705
|
* @public
|
|
@@ -534,57 +709,57 @@ export interface CreateGroupChannelInput {
|
|
|
534
709
|
* The subject of the channel.
|
|
535
710
|
* @public
|
|
536
711
|
*/
|
|
537
|
-
subject?: string;
|
|
712
|
+
subject?: string | undefined;
|
|
538
713
|
/**
|
|
539
714
|
* The description of the channel.
|
|
540
715
|
* @public
|
|
541
716
|
*/
|
|
542
|
-
description?: string;
|
|
717
|
+
description?: string | undefined;
|
|
543
718
|
/**
|
|
544
719
|
* The URL of the channel's picture.
|
|
545
720
|
* @public
|
|
546
721
|
*/
|
|
547
|
-
picture?: string;
|
|
722
|
+
picture?: string | undefined;
|
|
548
723
|
/**
|
|
549
724
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
550
725
|
* @public
|
|
551
726
|
*/
|
|
552
|
-
pictureColor?: string;
|
|
727
|
+
pictureColor?: string | undefined;
|
|
553
728
|
/**
|
|
554
729
|
* The access level of the channel.
|
|
555
730
|
* @public
|
|
556
731
|
*/
|
|
557
|
-
access?: ChannelAccess;
|
|
732
|
+
access?: ChannelAccess | undefined;
|
|
558
733
|
/**
|
|
559
734
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
560
735
|
* @public
|
|
561
736
|
*/
|
|
562
|
-
broadcast?: boolean;
|
|
737
|
+
broadcast?: boolean | undefined;
|
|
563
738
|
/**
|
|
564
739
|
* An additional information that associated with this channel.
|
|
565
740
|
* @public
|
|
566
741
|
*/
|
|
567
|
-
context?: ChannelContext;
|
|
742
|
+
context?: ChannelContext | undefined;
|
|
568
743
|
/**
|
|
569
744
|
* The unique identifier of the user when a service token is used.
|
|
570
745
|
* @public
|
|
571
746
|
*/
|
|
572
|
-
userId?: string;
|
|
747
|
+
userId?: string | undefined;
|
|
573
748
|
/**
|
|
574
749
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
575
750
|
* @public
|
|
576
751
|
*/
|
|
577
|
-
channelId?: string;
|
|
752
|
+
channelId?: string | undefined;
|
|
578
753
|
/**
|
|
579
754
|
* A list of user IDs to be added as members of the group channel.
|
|
580
755
|
* @public
|
|
581
756
|
*/
|
|
582
|
-
members?: (string)[];
|
|
757
|
+
members?: (string)[] | undefined;
|
|
583
758
|
/**
|
|
584
759
|
* A list of users to invite to the group channel, identified by their email addresses or phone numbers.
|
|
585
760
|
* @public
|
|
586
761
|
*/
|
|
587
|
-
membersToInvite?: (UserToInvite)[];
|
|
762
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
588
763
|
}
|
|
589
764
|
/**
|
|
590
765
|
* @public
|
|
@@ -600,12 +775,12 @@ export interface CreateInboxTagInput {
|
|
|
600
775
|
* The unique identifier of the user when a service token is used.
|
|
601
776
|
* @public
|
|
602
777
|
*/
|
|
603
|
-
userId?: string;
|
|
778
|
+
userId?: string | undefined;
|
|
604
779
|
/**
|
|
605
780
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
606
781
|
* @public
|
|
607
782
|
*/
|
|
608
|
-
tagId?: string;
|
|
783
|
+
tagId?: string | undefined;
|
|
609
784
|
/**
|
|
610
785
|
* The name of the tag.
|
|
611
786
|
* @public
|
|
@@ -646,12 +821,12 @@ export interface MessageAttachment {
|
|
|
646
821
|
* @public
|
|
647
822
|
*/
|
|
648
823
|
fsId: string;
|
|
649
|
-
mime?: string;
|
|
824
|
+
mime?: string | undefined;
|
|
650
825
|
name: string;
|
|
651
826
|
size: number;
|
|
652
|
-
width?: number;
|
|
653
|
-
height?: number;
|
|
654
|
-
thumbnail?: string;
|
|
827
|
+
width?: number | undefined;
|
|
828
|
+
height?: number | undefined;
|
|
829
|
+
thumbnail?: string | undefined;
|
|
655
830
|
}
|
|
656
831
|
/**
|
|
657
832
|
* @public
|
|
@@ -682,10 +857,10 @@ export declare namespace Element {
|
|
|
682
857
|
* @public
|
|
683
858
|
*/
|
|
684
859
|
export interface MessageForward {
|
|
685
|
-
forwardCompany?: string;
|
|
860
|
+
forwardCompany?: string | undefined;
|
|
686
861
|
forwardDate: string;
|
|
687
|
-
forwardEmail?: string;
|
|
688
|
-
forwardName?: string;
|
|
862
|
+
forwardEmail?: string | undefined;
|
|
863
|
+
forwardName?: string | undefined;
|
|
689
864
|
messageId: string;
|
|
690
865
|
channelId: string;
|
|
691
866
|
}
|
|
@@ -706,23 +881,23 @@ export interface MessageQuote {
|
|
|
706
881
|
messageId: string;
|
|
707
882
|
channelId: string;
|
|
708
883
|
user: User;
|
|
709
|
-
text?: string;
|
|
710
|
-
attachments?: (MessageAttachment)[];
|
|
711
|
-
forward?: MessageForward;
|
|
712
|
-
mentions?: (User)[];
|
|
713
|
-
giphy?: MessageGiphy;
|
|
884
|
+
text?: string | undefined;
|
|
885
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
886
|
+
forward?: MessageForward | undefined;
|
|
887
|
+
mentions?: (User)[] | undefined;
|
|
888
|
+
giphy?: MessageGiphy | undefined;
|
|
714
889
|
createdAt: string;
|
|
715
|
-
updatedAt?: string;
|
|
890
|
+
updatedAt?: string | undefined;
|
|
716
891
|
}
|
|
717
892
|
/**
|
|
718
893
|
* @public
|
|
719
894
|
*/
|
|
720
895
|
export interface InitialMessage {
|
|
721
|
-
text?: string;
|
|
722
|
-
elements?: (Element)[];
|
|
723
|
-
attachments?: (MessageAttachment)[];
|
|
724
|
-
quote?: MessageQuote;
|
|
725
|
-
forward?: MessageForward;
|
|
896
|
+
text?: string | undefined;
|
|
897
|
+
elements?: (Element)[] | undefined;
|
|
898
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
899
|
+
quote?: MessageQuote | undefined;
|
|
900
|
+
forward?: MessageForward | undefined;
|
|
726
901
|
/**
|
|
727
902
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
728
903
|
* @public
|
|
@@ -732,17 +907,17 @@ export interface InitialMessage {
|
|
|
732
907
|
* A list of user IDs mentioned in the message.
|
|
733
908
|
* @public
|
|
734
909
|
*/
|
|
735
|
-
mentions?: (string)[];
|
|
910
|
+
mentions?: (string)[] | undefined;
|
|
736
911
|
}
|
|
737
912
|
/**
|
|
738
913
|
* @public
|
|
739
914
|
*/
|
|
740
915
|
export interface WelcomeMessage {
|
|
741
|
-
text?: string;
|
|
742
|
-
elements?: (Element)[];
|
|
743
|
-
attachments?: (MessageAttachment)[];
|
|
744
|
-
quote?: MessageQuote;
|
|
745
|
-
forward?: MessageForward;
|
|
916
|
+
text?: string | undefined;
|
|
917
|
+
elements?: (Element)[] | undefined;
|
|
918
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
919
|
+
quote?: MessageQuote | undefined;
|
|
920
|
+
forward?: MessageForward | undefined;
|
|
746
921
|
/**
|
|
747
922
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
748
923
|
* @public
|
|
@@ -752,7 +927,7 @@ export interface WelcomeMessage {
|
|
|
752
927
|
* A list of user IDs mentioned in the message.
|
|
753
928
|
* @public
|
|
754
929
|
*/
|
|
755
|
-
mentions?: (string)[];
|
|
930
|
+
mentions?: (string)[] | undefined;
|
|
756
931
|
user: User;
|
|
757
932
|
}
|
|
758
933
|
/**
|
|
@@ -763,12 +938,12 @@ export interface CreateKiteChannelInput {
|
|
|
763
938
|
* The unique identifier of the user when a service token is used.
|
|
764
939
|
* @public
|
|
765
940
|
*/
|
|
766
|
-
userId?: string;
|
|
941
|
+
userId?: string | undefined;
|
|
767
942
|
/**
|
|
768
943
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
769
944
|
* @public
|
|
770
945
|
*/
|
|
771
|
-
channelId?: string;
|
|
946
|
+
channelId?: string | undefined;
|
|
772
947
|
/**
|
|
773
948
|
* The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).
|
|
774
949
|
* @public
|
|
@@ -778,17 +953,17 @@ export interface CreateKiteChannelInput {
|
|
|
778
953
|
* The unique identifier of the route for time-based configuration.
|
|
779
954
|
* @public
|
|
780
955
|
*/
|
|
781
|
-
targetRouteId?: string;
|
|
956
|
+
targetRouteId?: string | undefined;
|
|
782
957
|
/**
|
|
783
958
|
* A list of welcome messages is created during channel creation to preserve the same state as the client has on the interface. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
|
|
784
959
|
* @public
|
|
785
960
|
*/
|
|
786
|
-
welcomeMessages?: (WelcomeMessage)[];
|
|
961
|
+
welcomeMessages?: (WelcomeMessage)[] | undefined;
|
|
787
962
|
/**
|
|
788
963
|
* A message to be added to the conversation for the user. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
|
|
789
964
|
* @public
|
|
790
965
|
*/
|
|
791
|
-
initialMessage?: InitialMessage;
|
|
966
|
+
initialMessage?: InitialMessage | undefined;
|
|
792
967
|
}
|
|
793
968
|
/**
|
|
794
969
|
* @public
|
|
@@ -813,7 +988,7 @@ export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeo
|
|
|
813
988
|
export declare class TargetNotEligibleException extends __BaseException {
|
|
814
989
|
readonly name: "TargetNotEligibleException";
|
|
815
990
|
readonly $fault: "client";
|
|
816
|
-
reason?: TargetNotEligibleReason;
|
|
991
|
+
reason?: TargetNotEligibleReason | undefined;
|
|
817
992
|
/**
|
|
818
993
|
* @internal
|
|
819
994
|
*/
|
|
@@ -858,7 +1033,7 @@ export interface DeleteChannelMemberInput {
|
|
|
858
1033
|
* The unique identifier of the user when a service token is used.
|
|
859
1034
|
* @public
|
|
860
1035
|
*/
|
|
861
|
-
userId?: string;
|
|
1036
|
+
userId?: string | undefined;
|
|
862
1037
|
/**
|
|
863
1038
|
* The unique identifier of the member to be deleted.
|
|
864
1039
|
* @public
|
|
@@ -868,7 +1043,7 @@ export interface DeleteChannelMemberInput {
|
|
|
868
1043
|
* Set to true to suppress system messages that the member was removed from the conversation. Default is false.
|
|
869
1044
|
* @public
|
|
870
1045
|
*/
|
|
871
|
-
silent?: boolean;
|
|
1046
|
+
silent?: boolean | undefined;
|
|
872
1047
|
}
|
|
873
1048
|
/**
|
|
874
1049
|
* @public
|
|
@@ -899,7 +1074,7 @@ export interface DeleteInboxTagInput {
|
|
|
899
1074
|
* The unique identifier of the user when a service token is used.
|
|
900
1075
|
* @public
|
|
901
1076
|
*/
|
|
902
|
-
userId?: string;
|
|
1077
|
+
userId?: string | undefined;
|
|
903
1078
|
}
|
|
904
1079
|
/**
|
|
905
1080
|
* @public
|
|
@@ -924,7 +1099,7 @@ export interface DeleteMessageInput {
|
|
|
924
1099
|
* The unique identifier of the user when a service token is used.
|
|
925
1100
|
* @public
|
|
926
1101
|
*/
|
|
927
|
-
userId?: string;
|
|
1102
|
+
userId?: string | undefined;
|
|
928
1103
|
}
|
|
929
1104
|
/**
|
|
930
1105
|
* @public
|
|
@@ -984,7 +1159,7 @@ export interface DeleteMessageReactionInput {
|
|
|
984
1159
|
* The unique identifier of the user when a service token is used.
|
|
985
1160
|
* @public
|
|
986
1161
|
*/
|
|
987
|
-
userId?: string;
|
|
1162
|
+
userId?: string | undefined;
|
|
988
1163
|
}
|
|
989
1164
|
/**
|
|
990
1165
|
* @public
|
|
@@ -1000,10 +1175,10 @@ export interface DescribeEventInput {
|
|
|
1000
1175
|
* @public
|
|
1001
1176
|
*/
|
|
1002
1177
|
export interface Reaction {
|
|
1003
|
-
type?: string;
|
|
1004
|
-
userId?: string;
|
|
1005
|
-
messageId?: string;
|
|
1006
|
-
user?: User;
|
|
1178
|
+
type?: string | undefined;
|
|
1179
|
+
userId?: string | undefined;
|
|
1180
|
+
messageId?: string | undefined;
|
|
1181
|
+
user?: User | undefined;
|
|
1007
1182
|
}
|
|
1008
1183
|
/**
|
|
1009
1184
|
* @public
|
|
@@ -1049,28 +1224,28 @@ export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof Me
|
|
|
1049
1224
|
* @public
|
|
1050
1225
|
*/
|
|
1051
1226
|
export interface Message {
|
|
1052
|
-
text?: string;
|
|
1053
|
-
elements?: (Element)[];
|
|
1054
|
-
attachments?: (MessageAttachment)[];
|
|
1055
|
-
quote?: MessageQuote;
|
|
1056
|
-
forward?: MessageForward;
|
|
1227
|
+
text?: string | undefined;
|
|
1228
|
+
elements?: (Element)[] | undefined;
|
|
1229
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
1230
|
+
quote?: MessageQuote | undefined;
|
|
1231
|
+
forward?: MessageForward | undefined;
|
|
1057
1232
|
type: MessageType;
|
|
1058
|
-
giphy?: MessageGiphy;
|
|
1059
|
-
silent?: boolean;
|
|
1060
|
-
event?: string;
|
|
1061
|
-
sms?: boolean;
|
|
1062
|
-
smsStatus?: MessageSmsStatus;
|
|
1063
|
-
whatsapp?: boolean;
|
|
1064
|
-
whatsappStatus?: MessageWhatsAppStatus;
|
|
1233
|
+
giphy?: MessageGiphy | undefined;
|
|
1234
|
+
silent?: boolean | undefined;
|
|
1235
|
+
event?: string | undefined;
|
|
1236
|
+
sms?: boolean | undefined;
|
|
1237
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1238
|
+
whatsapp?: boolean | undefined;
|
|
1239
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1065
1240
|
messageId: string;
|
|
1066
1241
|
channelId: string;
|
|
1067
1242
|
user: User;
|
|
1068
|
-
edit?: boolean;
|
|
1069
|
-
mentions?: (User)[];
|
|
1070
|
-
latestReactions?: (Reaction)[];
|
|
1071
|
-
reactionCounts?: Record<string, number
|
|
1243
|
+
edit?: boolean | undefined;
|
|
1244
|
+
mentions?: (User)[] | undefined;
|
|
1245
|
+
latestReactions?: (Reaction)[] | undefined;
|
|
1246
|
+
reactionCounts?: Record<string, number> | undefined;
|
|
1072
1247
|
createdAt: string;
|
|
1073
|
-
updatedAt?: string;
|
|
1248
|
+
updatedAt?: string | undefined;
|
|
1074
1249
|
}
|
|
1075
1250
|
/**
|
|
1076
1251
|
* @public
|
|
@@ -1110,8 +1285,8 @@ export interface WebhookChatActionTriggeredEvent {
|
|
|
1110
1285
|
company: string;
|
|
1111
1286
|
type: WebhookEventType;
|
|
1112
1287
|
time: number;
|
|
1113
|
-
integrationId?: string;
|
|
1114
|
-
botId?: string;
|
|
1288
|
+
integrationId?: string | undefined;
|
|
1289
|
+
botId?: string | undefined;
|
|
1115
1290
|
data: WebhookChatActionTriggeredEventData;
|
|
1116
1291
|
}
|
|
1117
1292
|
/**
|
|
@@ -1130,8 +1305,8 @@ export interface WebhookChatChannelCreatedEvent {
|
|
|
1130
1305
|
company: string;
|
|
1131
1306
|
type: WebhookEventType;
|
|
1132
1307
|
time: number;
|
|
1133
|
-
integrationId?: string;
|
|
1134
|
-
botId?: string;
|
|
1308
|
+
integrationId?: string | undefined;
|
|
1309
|
+
botId?: string | undefined;
|
|
1135
1310
|
data: WebhookChatChannelCreatedOrUpdatedEventData;
|
|
1136
1311
|
}
|
|
1137
1312
|
/**
|
|
@@ -1142,8 +1317,8 @@ export interface WebhookChatChannelUpdatedEvent {
|
|
|
1142
1317
|
company: string;
|
|
1143
1318
|
type: WebhookEventType;
|
|
1144
1319
|
time: number;
|
|
1145
|
-
integrationId?: string;
|
|
1146
|
-
botId?: string;
|
|
1320
|
+
integrationId?: string | undefined;
|
|
1321
|
+
botId?: string | undefined;
|
|
1147
1322
|
data: WebhookChatChannelCreatedOrUpdatedEventData;
|
|
1148
1323
|
}
|
|
1149
1324
|
/**
|
|
@@ -1162,8 +1337,8 @@ export interface WebhookChatMemberAddedEvent {
|
|
|
1162
1337
|
company: string;
|
|
1163
1338
|
type: WebhookEventType;
|
|
1164
1339
|
time: number;
|
|
1165
|
-
integrationId?: string;
|
|
1166
|
-
botId?: string;
|
|
1340
|
+
integrationId?: string | undefined;
|
|
1341
|
+
botId?: string | undefined;
|
|
1167
1342
|
data: WebhookChatMemberAddedOrRemovedEventData;
|
|
1168
1343
|
}
|
|
1169
1344
|
/**
|
|
@@ -1174,8 +1349,8 @@ export interface WebhookChatMemberRemovedEvent {
|
|
|
1174
1349
|
company: string;
|
|
1175
1350
|
type: WebhookEventType;
|
|
1176
1351
|
time: number;
|
|
1177
|
-
integrationId?: string;
|
|
1178
|
-
botId?: string;
|
|
1352
|
+
integrationId?: string | undefined;
|
|
1353
|
+
botId?: string | undefined;
|
|
1179
1354
|
data: WebhookChatMemberAddedOrRemovedEventData;
|
|
1180
1355
|
}
|
|
1181
1356
|
/**
|
|
@@ -1193,8 +1368,8 @@ export interface WebhookChatMessageDeletedEvent {
|
|
|
1193
1368
|
company: string;
|
|
1194
1369
|
type: WebhookEventType;
|
|
1195
1370
|
time: number;
|
|
1196
|
-
integrationId?: string;
|
|
1197
|
-
botId?: string;
|
|
1371
|
+
integrationId?: string | undefined;
|
|
1372
|
+
botId?: string | undefined;
|
|
1198
1373
|
data: WebhookChatMessageUpdatedOrDeletedEventData;
|
|
1199
1374
|
}
|
|
1200
1375
|
/**
|
|
@@ -1214,8 +1389,8 @@ export interface WebhookChatMessageNewEvent {
|
|
|
1214
1389
|
company: string;
|
|
1215
1390
|
type: WebhookEventType;
|
|
1216
1391
|
time: number;
|
|
1217
|
-
integrationId?: string;
|
|
1218
|
-
botId?: string;
|
|
1392
|
+
integrationId?: string | undefined;
|
|
1393
|
+
botId?: string | undefined;
|
|
1219
1394
|
data: WebhookChatMessageNewEventData;
|
|
1220
1395
|
}
|
|
1221
1396
|
/**
|
|
@@ -1226,8 +1401,8 @@ export interface WebhookChatMessageUpdatedEvent {
|
|
|
1226
1401
|
company: string;
|
|
1227
1402
|
type: WebhookEventType;
|
|
1228
1403
|
time: number;
|
|
1229
|
-
integrationId?: string;
|
|
1230
|
-
botId?: string;
|
|
1404
|
+
integrationId?: string | undefined;
|
|
1405
|
+
botId?: string | undefined;
|
|
1231
1406
|
data: WebhookChatMessageUpdatedOrDeletedEventData;
|
|
1232
1407
|
}
|
|
1233
1408
|
/**
|
|
@@ -1246,8 +1421,8 @@ export interface WebhookChatReactionDeletedEvent {
|
|
|
1246
1421
|
company: string;
|
|
1247
1422
|
type: WebhookEventType;
|
|
1248
1423
|
time: number;
|
|
1249
|
-
integrationId?: string;
|
|
1250
|
-
botId?: string;
|
|
1424
|
+
integrationId?: string | undefined;
|
|
1425
|
+
botId?: string | undefined;
|
|
1251
1426
|
data: WebhookChatReactionNewOrDeletedEventData;
|
|
1252
1427
|
}
|
|
1253
1428
|
/**
|
|
@@ -1258,24 +1433,24 @@ export interface WebhookChatReactionNewEvent {
|
|
|
1258
1433
|
company: string;
|
|
1259
1434
|
type: WebhookEventType;
|
|
1260
1435
|
time: number;
|
|
1261
|
-
integrationId?: string;
|
|
1262
|
-
botId?: string;
|
|
1436
|
+
integrationId?: string | undefined;
|
|
1437
|
+
botId?: string | undefined;
|
|
1263
1438
|
data: WebhookChatReactionNewOrDeletedEventData;
|
|
1264
1439
|
}
|
|
1265
1440
|
/**
|
|
1266
1441
|
* @public
|
|
1267
1442
|
*/
|
|
1268
1443
|
export interface DescribeEventOutput {
|
|
1269
|
-
WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent;
|
|
1270
|
-
WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent;
|
|
1271
|
-
WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent;
|
|
1272
|
-
WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent;
|
|
1273
|
-
WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent;
|
|
1274
|
-
WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent;
|
|
1275
|
-
WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent;
|
|
1276
|
-
WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent;
|
|
1277
|
-
WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent;
|
|
1278
|
-
WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent;
|
|
1444
|
+
WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent | undefined;
|
|
1445
|
+
WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent | undefined;
|
|
1446
|
+
WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent | undefined;
|
|
1447
|
+
WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent | undefined;
|
|
1448
|
+
WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent | undefined;
|
|
1449
|
+
WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent | undefined;
|
|
1450
|
+
WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent | undefined;
|
|
1451
|
+
WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent | undefined;
|
|
1452
|
+
WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent | undefined;
|
|
1453
|
+
WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent | undefined;
|
|
1279
1454
|
}
|
|
1280
1455
|
/**
|
|
1281
1456
|
* @public
|
|
@@ -1290,14 +1465,14 @@ export interface GetActionTriggerResultInput {
|
|
|
1290
1465
|
* The unique identifier of the user when a service token is used.
|
|
1291
1466
|
* @public
|
|
1292
1467
|
*/
|
|
1293
|
-
userId?: string;
|
|
1468
|
+
userId?: string | undefined;
|
|
1294
1469
|
}
|
|
1295
1470
|
/**
|
|
1296
1471
|
* @public
|
|
1297
1472
|
*/
|
|
1298
1473
|
export interface GetActionTriggerResultOutput {
|
|
1299
1474
|
status: ActionTriggerStatus;
|
|
1300
|
-
result?: ActionTriggerResult;
|
|
1475
|
+
result?: ActionTriggerResult | undefined;
|
|
1301
1476
|
}
|
|
1302
1477
|
/**
|
|
1303
1478
|
* @public
|
|
@@ -1364,17 +1539,17 @@ export interface GetDirectChannelIdInput {
|
|
|
1364
1539
|
* The unique identifier of the user when a service token is used.
|
|
1365
1540
|
* @public
|
|
1366
1541
|
*/
|
|
1367
|
-
userId?: string;
|
|
1542
|
+
userId?: string | undefined;
|
|
1368
1543
|
/**
|
|
1369
1544
|
* A User ID of the member to connect with the direct channel.
|
|
1370
1545
|
* @public
|
|
1371
1546
|
*/
|
|
1372
|
-
memberId?: string;
|
|
1547
|
+
memberId?: string | undefined;
|
|
1373
1548
|
/**
|
|
1374
1549
|
* A user to invite to the direct channel, identified by email addresse or phone number.
|
|
1375
1550
|
* @public
|
|
1376
1551
|
*/
|
|
1377
|
-
memberToInvite?: UserToInvite;
|
|
1552
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1378
1553
|
}
|
|
1379
1554
|
/**
|
|
1380
1555
|
* @public
|
|
@@ -1405,12 +1580,12 @@ export interface GetFilePresignedDownloadUrlInput {
|
|
|
1405
1580
|
* The category of the file, either channel files or conference recordings.
|
|
1406
1581
|
* @public
|
|
1407
1582
|
*/
|
|
1408
|
-
category?: ConversationFileCategory;
|
|
1583
|
+
category?: ConversationFileCategory | undefined;
|
|
1409
1584
|
/**
|
|
1410
1585
|
* URL behavior, 0 - open(play) for audio/video, others are downloaded; 1 — always download.
|
|
1411
1586
|
* @public
|
|
1412
1587
|
*/
|
|
1413
|
-
download?: number;
|
|
1588
|
+
download?: number | undefined;
|
|
1414
1589
|
}
|
|
1415
1590
|
/**
|
|
1416
1591
|
* @public
|
|
@@ -1430,7 +1605,7 @@ export interface GetInboxStateInput {
|
|
|
1430
1605
|
* The unique identifier of the user when a service token is used.
|
|
1431
1606
|
* @public
|
|
1432
1607
|
*/
|
|
1433
|
-
userId?: string;
|
|
1608
|
+
userId?: string | undefined;
|
|
1434
1609
|
}
|
|
1435
1610
|
/**
|
|
1436
1611
|
* @public
|
|
@@ -1456,7 +1631,7 @@ export interface InboxUnreadChannel {
|
|
|
1456
1631
|
* @public
|
|
1457
1632
|
*/
|
|
1458
1633
|
unreadAt: string;
|
|
1459
|
-
messageId?: string;
|
|
1634
|
+
messageId?: string | undefined;
|
|
1460
1635
|
}
|
|
1461
1636
|
/**
|
|
1462
1637
|
* @public
|
|
@@ -1502,17 +1677,17 @@ export interface GetOrCreateDirectChannelInput {
|
|
|
1502
1677
|
* The unique identifier of the user when a service token is used.
|
|
1503
1678
|
* @public
|
|
1504
1679
|
*/
|
|
1505
|
-
userId?: string;
|
|
1680
|
+
userId?: string | undefined;
|
|
1506
1681
|
/**
|
|
1507
1682
|
* A User ID of the member to connect with the direct channel.
|
|
1508
1683
|
* @public
|
|
1509
1684
|
*/
|
|
1510
|
-
memberId?: string;
|
|
1685
|
+
memberId?: string | undefined;
|
|
1511
1686
|
/**
|
|
1512
1687
|
* A user to invite to the direct channel, identified by email addresse or phone number.
|
|
1513
1688
|
* @public
|
|
1514
1689
|
*/
|
|
1515
|
-
memberToInvite?: UserToInvite;
|
|
1690
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1516
1691
|
}
|
|
1517
1692
|
/**
|
|
1518
1693
|
* @public
|
|
@@ -1558,7 +1733,7 @@ export interface GetUploadedFileInfoInput {
|
|
|
1558
1733
|
* The category of the file, either channel files or conference recordings. Default: channels.
|
|
1559
1734
|
* @public
|
|
1560
1735
|
*/
|
|
1561
|
-
category?: ConversationFileCategory;
|
|
1736
|
+
category?: ConversationFileCategory | undefined;
|
|
1562
1737
|
}
|
|
1563
1738
|
/**
|
|
1564
1739
|
* @public
|
|
@@ -1579,7 +1754,7 @@ export interface HideChannelInput {
|
|
|
1579
1754
|
* The unique identifier of the user when a service token is used.
|
|
1580
1755
|
* @public
|
|
1581
1756
|
*/
|
|
1582
|
-
userId?: string;
|
|
1757
|
+
userId?: string | undefined;
|
|
1583
1758
|
}
|
|
1584
1759
|
/**
|
|
1585
1760
|
* @public
|
|
@@ -1619,12 +1794,12 @@ export interface JoinChannelInput {
|
|
|
1619
1794
|
* The unique identifier of the user when a service token is used.
|
|
1620
1795
|
* @public
|
|
1621
1796
|
*/
|
|
1622
|
-
userId?: string;
|
|
1797
|
+
userId?: string | undefined;
|
|
1623
1798
|
/**
|
|
1624
1799
|
* Set to true to suppress system messages that the user joined the channel. Default is false.
|
|
1625
1800
|
* @public
|
|
1626
1801
|
*/
|
|
1627
|
-
silent?: boolean;
|
|
1802
|
+
silent?: boolean | undefined;
|
|
1628
1803
|
}
|
|
1629
1804
|
/**
|
|
1630
1805
|
* @public
|
|
@@ -1645,12 +1820,12 @@ export interface LeaveChannelInput {
|
|
|
1645
1820
|
* The unique identifier of the user when a service token is used.
|
|
1646
1821
|
* @public
|
|
1647
1822
|
*/
|
|
1648
|
-
userId?: string;
|
|
1823
|
+
userId?: string | undefined;
|
|
1649
1824
|
/**
|
|
1650
1825
|
* Set to true to suppress system messages that the user left the channel. Default is false.
|
|
1651
1826
|
* @public
|
|
1652
1827
|
*/
|
|
1653
|
-
silent?: boolean;
|
|
1828
|
+
silent?: boolean | undefined;
|
|
1654
1829
|
}
|
|
1655
1830
|
/**
|
|
1656
1831
|
* @public
|
|
@@ -1670,12 +1845,12 @@ export interface ListChannelMembersInput {
|
|
|
1670
1845
|
* The maximum number of members to return. The value must be between 1 and 100.
|
|
1671
1846
|
* @public
|
|
1672
1847
|
*/
|
|
1673
|
-
limit?: number;
|
|
1848
|
+
limit?: number | undefined;
|
|
1674
1849
|
/**
|
|
1675
1850
|
* The offset from which to start listing members. The value must be between 0 and 1000.
|
|
1676
1851
|
* @public
|
|
1677
1852
|
*/
|
|
1678
|
-
offset?: number;
|
|
1853
|
+
offset?: number | undefined;
|
|
1679
1854
|
}
|
|
1680
1855
|
/**
|
|
1681
1856
|
* @public
|
|
@@ -1700,22 +1875,22 @@ export interface ListChannelsInput {
|
|
|
1700
1875
|
* The unique identifier of the tenant when a service token is used.
|
|
1701
1876
|
* @public
|
|
1702
1877
|
*/
|
|
1703
|
-
companyId?: string;
|
|
1878
|
+
companyId?: string | undefined;
|
|
1704
1879
|
/**
|
|
1705
1880
|
* The unique identifier of the user when a service or PBX token is used.
|
|
1706
1881
|
* @public
|
|
1707
1882
|
*/
|
|
1708
|
-
userId?: string;
|
|
1883
|
+
userId?: string | undefined;
|
|
1709
1884
|
/**
|
|
1710
1885
|
* The maximum number of channels to return. The value must be between 1 and 30.
|
|
1711
1886
|
* @public
|
|
1712
1887
|
*/
|
|
1713
|
-
limit?: number;
|
|
1888
|
+
limit?: number | undefined;
|
|
1714
1889
|
/**
|
|
1715
1890
|
* The offset from which to start listing channels. The value must be between 0 and 1000.
|
|
1716
1891
|
* @public
|
|
1717
1892
|
*/
|
|
1718
|
-
offset?: number;
|
|
1893
|
+
offset?: number | undefined;
|
|
1719
1894
|
}
|
|
1720
1895
|
/**
|
|
1721
1896
|
* @public
|
|
@@ -1735,7 +1910,7 @@ export interface ListInboxTaggedChannelsInput {
|
|
|
1735
1910
|
* The unique identifier of the user when a service token is used.
|
|
1736
1911
|
* @public
|
|
1737
1912
|
*/
|
|
1738
|
-
userId?: string;
|
|
1913
|
+
userId?: string | undefined;
|
|
1739
1914
|
/**
|
|
1740
1915
|
* The unique identifier of the channel whose members are to be listed.
|
|
1741
1916
|
* @public
|
|
@@ -1767,7 +1942,7 @@ export interface ListInboxTagsInput {
|
|
|
1767
1942
|
* The unique identifier of the user when a service token is used.
|
|
1768
1943
|
* @public
|
|
1769
1944
|
*/
|
|
1770
|
-
userId?: string;
|
|
1945
|
+
userId?: string | undefined;
|
|
1771
1946
|
}
|
|
1772
1947
|
/**
|
|
1773
1948
|
* @public
|
|
@@ -1793,12 +1968,12 @@ export interface ListMessageReactionsInput {
|
|
|
1793
1968
|
* The maximum number of reactions to return. The value must be between 1 and 300.
|
|
1794
1969
|
* @public
|
|
1795
1970
|
*/
|
|
1796
|
-
limit?: number;
|
|
1971
|
+
limit?: number | undefined;
|
|
1797
1972
|
/**
|
|
1798
1973
|
* The offset from which to start listing reactions. The value must be between 0 and 1000.
|
|
1799
1974
|
* @public
|
|
1800
1975
|
*/
|
|
1801
|
-
offset?: number;
|
|
1976
|
+
offset?: number | undefined;
|
|
1802
1977
|
}
|
|
1803
1978
|
/**
|
|
1804
1979
|
* @public
|
|
@@ -1823,12 +1998,12 @@ export interface ListMessagesInput {
|
|
|
1823
1998
|
* The maximum number of messages to return. The value must be between 1 and 100.
|
|
1824
1999
|
* @public
|
|
1825
2000
|
*/
|
|
1826
|
-
limit?: number;
|
|
2001
|
+
limit?: number | undefined;
|
|
1827
2002
|
/**
|
|
1828
2003
|
* The offset from which to start listing messages. The value must be between 0 and 1000.
|
|
1829
2004
|
* @public
|
|
1830
2005
|
*/
|
|
1831
|
-
offset?: number;
|
|
2006
|
+
offset?: number | undefined;
|
|
1832
2007
|
}
|
|
1833
2008
|
/**
|
|
1834
2009
|
* @public
|
|
@@ -1853,12 +2028,12 @@ export interface ListPinnedMessagesInput {
|
|
|
1853
2028
|
* The maximum number of pinned messages to return. The value must be between 1 and 100.
|
|
1854
2029
|
* @public
|
|
1855
2030
|
*/
|
|
1856
|
-
limit?: number;
|
|
2031
|
+
limit?: number | undefined;
|
|
1857
2032
|
/**
|
|
1858
2033
|
* The offset from which to start listing pinned messages. The value must be between 0 and 1000.
|
|
1859
2034
|
* @public
|
|
1860
2035
|
*/
|
|
1861
|
-
offset?: number;
|
|
2036
|
+
offset?: number | undefined;
|
|
1862
2037
|
}
|
|
1863
2038
|
/**
|
|
1864
2039
|
* @public
|
|
@@ -1883,7 +2058,7 @@ export interface MarkReadInput {
|
|
|
1883
2058
|
* The unique identifier of the user when a service token is used.
|
|
1884
2059
|
* @public
|
|
1885
2060
|
*/
|
|
1886
|
-
userId?: string;
|
|
2061
|
+
userId?: string | undefined;
|
|
1887
2062
|
}
|
|
1888
2063
|
/**
|
|
1889
2064
|
* @public
|
|
@@ -1914,17 +2089,17 @@ export interface MarkUnreadInput {
|
|
|
1914
2089
|
* The unique identifier of the user when a service token is used.
|
|
1915
2090
|
* @public
|
|
1916
2091
|
*/
|
|
1917
|
-
userId?: string;
|
|
2092
|
+
userId?: string | undefined;
|
|
1918
2093
|
/**
|
|
1919
2094
|
* A Message ID in the channel from which to calculate the amount of unread messages.
|
|
1920
2095
|
* @public
|
|
1921
2096
|
*/
|
|
1922
|
-
messageId?: string;
|
|
2097
|
+
messageId?: string | undefined;
|
|
1923
2098
|
/**
|
|
1924
2099
|
* A flag that indicates whether the system should replace the oldest marked unread channel with a new one if the limit of unread marked channels is reached. If the force option is specified as false and the user already has the maximum limit of unread marked channels, then the system will respond with an error.
|
|
1925
2100
|
* @public
|
|
1926
2101
|
*/
|
|
1927
|
-
force?: boolean;
|
|
2102
|
+
force?: boolean | undefined;
|
|
1928
2103
|
}
|
|
1929
2104
|
/**
|
|
1930
2105
|
* @public
|
|
@@ -1939,37 +2114,37 @@ export interface PartialUpdateChannelSetOptions {
|
|
|
1939
2114
|
* The subject of the channel.
|
|
1940
2115
|
* @public
|
|
1941
2116
|
*/
|
|
1942
|
-
subject?: string;
|
|
2117
|
+
subject?: string | undefined;
|
|
1943
2118
|
/**
|
|
1944
2119
|
* The description of the channel.
|
|
1945
2120
|
* @public
|
|
1946
2121
|
*/
|
|
1947
|
-
description?: string;
|
|
2122
|
+
description?: string | undefined;
|
|
1948
2123
|
/**
|
|
1949
2124
|
* The URL of the channel's picture.
|
|
1950
2125
|
* @public
|
|
1951
2126
|
*/
|
|
1952
|
-
picture?: string;
|
|
2127
|
+
picture?: string | undefined;
|
|
1953
2128
|
/**
|
|
1954
2129
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
1955
2130
|
* @public
|
|
1956
2131
|
*/
|
|
1957
|
-
pictureColor?: string;
|
|
2132
|
+
pictureColor?: string | undefined;
|
|
1958
2133
|
/**
|
|
1959
2134
|
* The access level of the channel.
|
|
1960
2135
|
* @public
|
|
1961
2136
|
*/
|
|
1962
|
-
access?: ChannelAccess;
|
|
2137
|
+
access?: ChannelAccess | undefined;
|
|
1963
2138
|
/**
|
|
1964
2139
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
1965
2140
|
* @public
|
|
1966
2141
|
*/
|
|
1967
|
-
broadcast?: boolean;
|
|
2142
|
+
broadcast?: boolean | undefined;
|
|
1968
2143
|
/**
|
|
1969
2144
|
* An additional information that associated with this channel.
|
|
1970
2145
|
* @public
|
|
1971
2146
|
*/
|
|
1972
|
-
context?: ChannelContext;
|
|
2147
|
+
context?: ChannelContext | undefined;
|
|
1973
2148
|
}
|
|
1974
2149
|
/**
|
|
1975
2150
|
* @public
|
|
@@ -2003,22 +2178,22 @@ export interface PartialUpdateChannelInput {
|
|
|
2003
2178
|
* The unique identifier of the user when a service token is used.
|
|
2004
2179
|
* @public
|
|
2005
2180
|
*/
|
|
2006
|
-
userId?: string;
|
|
2181
|
+
userId?: string | undefined;
|
|
2007
2182
|
/**
|
|
2008
2183
|
* Set to true to suppress system messages about the updates. Default is false.
|
|
2009
2184
|
* @public
|
|
2010
2185
|
*/
|
|
2011
|
-
silent?: boolean;
|
|
2186
|
+
silent?: boolean | undefined;
|
|
2012
2187
|
/**
|
|
2013
2188
|
* Options to set specific fields in the channel.
|
|
2014
2189
|
* @public
|
|
2015
2190
|
*/
|
|
2016
|
-
set?: PartialUpdateChannelSetOptions;
|
|
2191
|
+
set?: PartialUpdateChannelSetOptions | undefined;
|
|
2017
2192
|
/**
|
|
2018
2193
|
* Options to unset specific fields in the channel.
|
|
2019
2194
|
* @public
|
|
2020
2195
|
*/
|
|
2021
|
-
unset?: (GroupChannelUnsetOptions)[];
|
|
2196
|
+
unset?: (GroupChannelUnsetOptions)[] | undefined;
|
|
2022
2197
|
}
|
|
2023
2198
|
/**
|
|
2024
2199
|
* @public
|
|
@@ -2030,16 +2205,16 @@ export interface PartialUpdateChannelOutput {
|
|
|
2030
2205
|
* @public
|
|
2031
2206
|
*/
|
|
2032
2207
|
export interface PartialUpdateMessageSetInput {
|
|
2033
|
-
text?: string;
|
|
2034
|
-
elements?: (Element)[];
|
|
2035
|
-
attachments?: (MessageAttachment)[];
|
|
2036
|
-
quote?: MessageQuote;
|
|
2037
|
-
forward?: MessageForward;
|
|
2208
|
+
text?: string | undefined;
|
|
2209
|
+
elements?: (Element)[] | undefined;
|
|
2210
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2211
|
+
quote?: MessageQuote | undefined;
|
|
2212
|
+
forward?: MessageForward | undefined;
|
|
2038
2213
|
/**
|
|
2039
2214
|
* A list of user IDs mentioned in the message.
|
|
2040
2215
|
* @public
|
|
2041
2216
|
*/
|
|
2042
|
-
mentions?: (string)[];
|
|
2217
|
+
mentions?: (string)[] | undefined;
|
|
2043
2218
|
}
|
|
2044
2219
|
/**
|
|
2045
2220
|
* @public
|
|
@@ -2075,22 +2250,22 @@ export interface PartialUpdateMessageInput {
|
|
|
2075
2250
|
* The unique identifier of the user when a service token is used.
|
|
2076
2251
|
* @public
|
|
2077
2252
|
*/
|
|
2078
|
-
userId?: string;
|
|
2253
|
+
userId?: string | undefined;
|
|
2079
2254
|
/**
|
|
2080
2255
|
* Fields to set during the partial update.
|
|
2081
2256
|
* @public
|
|
2082
2257
|
*/
|
|
2083
|
-
set?: PartialUpdateMessageSetInput;
|
|
2258
|
+
set?: PartialUpdateMessageSetInput | undefined;
|
|
2084
2259
|
/**
|
|
2085
2260
|
* Fields to unset during the partial update.
|
|
2086
2261
|
* @public
|
|
2087
2262
|
*/
|
|
2088
|
-
unset?: (MessageUnsetFields)[];
|
|
2263
|
+
unset?: (MessageUnsetFields)[] | undefined;
|
|
2089
2264
|
/**
|
|
2090
2265
|
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2091
2266
|
* @public
|
|
2092
2267
|
*/
|
|
2093
|
-
silent?: boolean;
|
|
2268
|
+
silent?: boolean | undefined;
|
|
2094
2269
|
}
|
|
2095
2270
|
/**
|
|
2096
2271
|
* @public
|
|
@@ -2111,12 +2286,12 @@ export interface PinChannelInput {
|
|
|
2111
2286
|
* The unique identifier of the user when a service token is used.
|
|
2112
2287
|
* @public
|
|
2113
2288
|
*/
|
|
2114
|
-
userId?: string;
|
|
2289
|
+
userId?: string | undefined;
|
|
2115
2290
|
/**
|
|
2116
2291
|
* A flag that indicates whether the system should replace the oldest pinned channel with a new one if the limit of pinned channels is reached. If the force option is specified as false and the user already has the maximum limit of pinned channels, then the system will respond with an error.
|
|
2117
2292
|
* @public
|
|
2118
2293
|
*/
|
|
2119
|
-
force?: boolean;
|
|
2294
|
+
force?: boolean | undefined;
|
|
2120
2295
|
}
|
|
2121
2296
|
/**
|
|
2122
2297
|
* @public
|
|
@@ -2148,22 +2323,22 @@ export interface PinMessageInput {
|
|
|
2148
2323
|
* The unique identifier of the user when a service token is used.
|
|
2149
2324
|
* @public
|
|
2150
2325
|
*/
|
|
2151
|
-
userId?: string;
|
|
2326
|
+
userId?: string | undefined;
|
|
2152
2327
|
/**
|
|
2153
2328
|
* The duration in seconds after which the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
|
|
2154
2329
|
* @public
|
|
2155
2330
|
*/
|
|
2156
|
-
expiresAfter?: number;
|
|
2331
|
+
expiresAfter?: number | undefined;
|
|
2157
2332
|
/**
|
|
2158
2333
|
* The specific date and time (in ISO 8601 format) when the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
|
|
2159
2334
|
* @public
|
|
2160
2335
|
*/
|
|
2161
|
-
expiresAt?: string;
|
|
2336
|
+
expiresAt?: string | undefined;
|
|
2162
2337
|
/**
|
|
2163
2338
|
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2164
2339
|
* @public
|
|
2165
2340
|
*/
|
|
2166
|
-
silent?: boolean;
|
|
2341
|
+
silent?: boolean | undefined;
|
|
2167
2342
|
}
|
|
2168
2343
|
/**
|
|
2169
2344
|
* @public
|
|
@@ -2178,23 +2353,23 @@ export interface QueryChannelsInput {
|
|
|
2178
2353
|
* The unique identifier of the tenant when a service token is used.
|
|
2179
2354
|
* @public
|
|
2180
2355
|
*/
|
|
2181
|
-
companyId?: string;
|
|
2356
|
+
companyId?: string | undefined;
|
|
2182
2357
|
/**
|
|
2183
2358
|
* The unique identifier of the user when a service or PBX token is used.
|
|
2184
2359
|
* @public
|
|
2185
2360
|
*/
|
|
2186
|
-
userId?: string;
|
|
2187
|
-
query?: ChannelsQuery;
|
|
2361
|
+
userId?: string | undefined;
|
|
2362
|
+
query?: ChannelsQuery | undefined;
|
|
2188
2363
|
/**
|
|
2189
2364
|
* The maximum number of channels to return. The value must be between 1 and 30.
|
|
2190
2365
|
* @public
|
|
2191
2366
|
*/
|
|
2192
|
-
limit?: number;
|
|
2367
|
+
limit?: number | undefined;
|
|
2193
2368
|
/**
|
|
2194
2369
|
* The offset from which to start listing channels. The value must be between 0 and 1000.
|
|
2195
2370
|
* @public
|
|
2196
2371
|
*/
|
|
2197
|
-
offset?: number;
|
|
2372
|
+
offset?: number | undefined;
|
|
2198
2373
|
}
|
|
2199
2374
|
/**
|
|
2200
2375
|
* @public
|
|
@@ -2262,12 +2437,12 @@ export interface SendGiphyInput {
|
|
|
2262
2437
|
* The unique identifier of the user when a service token is used.
|
|
2263
2438
|
* @public
|
|
2264
2439
|
*/
|
|
2265
|
-
userId?: string;
|
|
2440
|
+
userId?: string | undefined;
|
|
2266
2441
|
/**
|
|
2267
2442
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
2268
2443
|
* @public
|
|
2269
2444
|
*/
|
|
2270
|
-
messageId?: string;
|
|
2445
|
+
messageId?: string | undefined;
|
|
2271
2446
|
/**
|
|
2272
2447
|
* Details of the Giphy message to be sent.
|
|
2273
2448
|
* @public
|
|
@@ -2284,21 +2459,21 @@ export interface SendGiphyOutput {
|
|
|
2284
2459
|
* @public
|
|
2285
2460
|
*/
|
|
2286
2461
|
export interface SendMessageInput {
|
|
2287
|
-
text?: string;
|
|
2288
|
-
elements?: (Element)[];
|
|
2289
|
-
attachments?: (MessageAttachment)[];
|
|
2290
|
-
quote?: MessageQuote;
|
|
2291
|
-
forward?: MessageForward;
|
|
2462
|
+
text?: string | undefined;
|
|
2463
|
+
elements?: (Element)[] | undefined;
|
|
2464
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2465
|
+
quote?: MessageQuote | undefined;
|
|
2466
|
+
forward?: MessageForward | undefined;
|
|
2292
2467
|
/**
|
|
2293
2468
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
2294
2469
|
* @public
|
|
2295
2470
|
*/
|
|
2296
|
-
messageId?: string;
|
|
2471
|
+
messageId?: string | undefined;
|
|
2297
2472
|
/**
|
|
2298
2473
|
* A list of user IDs mentioned in the message.
|
|
2299
2474
|
* @public
|
|
2300
2475
|
*/
|
|
2301
|
-
mentions?: (string)[];
|
|
2476
|
+
mentions?: (string)[] | undefined;
|
|
2302
2477
|
/**
|
|
2303
2478
|
* The unique identifier of the channel to which the message is sent.
|
|
2304
2479
|
* @public
|
|
@@ -2308,7 +2483,7 @@ export interface SendMessageInput {
|
|
|
2308
2483
|
* The unique identifier of the user when a service token is used.
|
|
2309
2484
|
* @public
|
|
2310
2485
|
*/
|
|
2311
|
-
userId?: string;
|
|
2486
|
+
userId?: string | undefined;
|
|
2312
2487
|
}
|
|
2313
2488
|
/**
|
|
2314
2489
|
* @public
|
|
@@ -2339,7 +2514,7 @@ export interface SendMessageReactionInput {
|
|
|
2339
2514
|
* The unique identifier of the user when a service token is used.
|
|
2340
2515
|
* @public
|
|
2341
2516
|
*/
|
|
2342
|
-
userId?: string;
|
|
2517
|
+
userId?: string | undefined;
|
|
2343
2518
|
}
|
|
2344
2519
|
/**
|
|
2345
2520
|
* @public
|
|
@@ -2359,7 +2534,7 @@ export interface SendTypingStartInput {
|
|
|
2359
2534
|
* The unique identifier of the user when a service token is used.
|
|
2360
2535
|
* @public
|
|
2361
2536
|
*/
|
|
2362
|
-
userId?: string;
|
|
2537
|
+
userId?: string | undefined;
|
|
2363
2538
|
}
|
|
2364
2539
|
/**
|
|
2365
2540
|
* @public
|
|
@@ -2379,7 +2554,7 @@ export interface SendTypingStopInput {
|
|
|
2379
2554
|
* The unique identifier of the user when a service token is used.
|
|
2380
2555
|
* @public
|
|
2381
2556
|
*/
|
|
2382
|
-
userId?: string;
|
|
2557
|
+
userId?: string | undefined;
|
|
2383
2558
|
}
|
|
2384
2559
|
/**
|
|
2385
2560
|
* @public
|
|
@@ -2399,7 +2574,7 @@ export interface ShowChannelInput {
|
|
|
2399
2574
|
* The unique identifier of the user when a service token is used.
|
|
2400
2575
|
* @public
|
|
2401
2576
|
*/
|
|
2402
|
-
userId?: string;
|
|
2577
|
+
userId?: string | undefined;
|
|
2403
2578
|
}
|
|
2404
2579
|
/**
|
|
2405
2580
|
* @public
|
|
@@ -2419,7 +2594,7 @@ export interface TagChannelInput {
|
|
|
2419
2594
|
* The unique identifier of the user when a service token is used.
|
|
2420
2595
|
* @public
|
|
2421
2596
|
*/
|
|
2422
|
-
userId?: string;
|
|
2597
|
+
userId?: string | undefined;
|
|
2423
2598
|
/**
|
|
2424
2599
|
* The unique identifier of the tag to add to the channel.
|
|
2425
2600
|
* @public
|
|
@@ -2429,7 +2604,7 @@ export interface TagChannelInput {
|
|
|
2429
2604
|
* A flag that indicates whether the system should replace the oldest tagged channel with a new one if the limit of tagged channels is reached. If the force option is specified as false and the user already has the maximum limit of tagged channels for the tag, then the system will respond with an error.
|
|
2430
2605
|
* @public
|
|
2431
2606
|
*/
|
|
2432
|
-
force?: boolean;
|
|
2607
|
+
force?: boolean | undefined;
|
|
2433
2608
|
}
|
|
2434
2609
|
/**
|
|
2435
2610
|
* @public
|
|
@@ -2481,7 +2656,7 @@ export interface TriggerMessageActionInput {
|
|
|
2481
2656
|
* The unique identifier of the user when a service token is used.
|
|
2482
2657
|
* @public
|
|
2483
2658
|
*/
|
|
2484
|
-
userId?: string;
|
|
2659
|
+
userId?: string | undefined;
|
|
2485
2660
|
}
|
|
2486
2661
|
/**
|
|
2487
2662
|
* @public
|
|
@@ -2502,7 +2677,7 @@ export interface UnpinChannelInput {
|
|
|
2502
2677
|
* The unique identifier of the user when a service token is used.
|
|
2503
2678
|
* @public
|
|
2504
2679
|
*/
|
|
2505
|
-
userId?: string;
|
|
2680
|
+
userId?: string | undefined;
|
|
2506
2681
|
}
|
|
2507
2682
|
/**
|
|
2508
2683
|
* @public
|
|
@@ -2523,12 +2698,12 @@ export interface UnpinMessageInput {
|
|
|
2523
2698
|
* The unique identifier of the user when a service token is used.
|
|
2524
2699
|
* @public
|
|
2525
2700
|
*/
|
|
2526
|
-
userId?: string;
|
|
2701
|
+
userId?: string | undefined;
|
|
2527
2702
|
/**
|
|
2528
2703
|
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2529
2704
|
* @public
|
|
2530
2705
|
*/
|
|
2531
|
-
silent?: boolean;
|
|
2706
|
+
silent?: boolean | undefined;
|
|
2532
2707
|
}
|
|
2533
2708
|
/**
|
|
2534
2709
|
* @public
|
|
@@ -2548,7 +2723,7 @@ export interface UntagChannelInput {
|
|
|
2548
2723
|
* The unique identifier of the user when a service token is used.
|
|
2549
2724
|
* @public
|
|
2550
2725
|
*/
|
|
2551
|
-
userId?: string;
|
|
2726
|
+
userId?: string | undefined;
|
|
2552
2727
|
/**
|
|
2553
2728
|
* The unique identifier of the tag to remove from the channel.
|
|
2554
2729
|
* @public
|
|
@@ -2568,37 +2743,37 @@ export interface UpdateChannelInput {
|
|
|
2568
2743
|
* The subject of the channel.
|
|
2569
2744
|
* @public
|
|
2570
2745
|
*/
|
|
2571
|
-
subject?: string;
|
|
2746
|
+
subject?: string | undefined;
|
|
2572
2747
|
/**
|
|
2573
2748
|
* The description of the channel.
|
|
2574
2749
|
* @public
|
|
2575
2750
|
*/
|
|
2576
|
-
description?: string;
|
|
2751
|
+
description?: string | undefined;
|
|
2577
2752
|
/**
|
|
2578
2753
|
* The URL of the channel's picture.
|
|
2579
2754
|
* @public
|
|
2580
2755
|
*/
|
|
2581
|
-
picture?: string;
|
|
2756
|
+
picture?: string | undefined;
|
|
2582
2757
|
/**
|
|
2583
2758
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
2584
2759
|
* @public
|
|
2585
2760
|
*/
|
|
2586
|
-
pictureColor?: string;
|
|
2761
|
+
pictureColor?: string | undefined;
|
|
2587
2762
|
/**
|
|
2588
2763
|
* The access level of the channel.
|
|
2589
2764
|
* @public
|
|
2590
2765
|
*/
|
|
2591
|
-
access?: ChannelAccess;
|
|
2766
|
+
access?: ChannelAccess | undefined;
|
|
2592
2767
|
/**
|
|
2593
2768
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
2594
2769
|
* @public
|
|
2595
2770
|
*/
|
|
2596
|
-
broadcast?: boolean;
|
|
2771
|
+
broadcast?: boolean | undefined;
|
|
2597
2772
|
/**
|
|
2598
2773
|
* An additional information that associated with this channel.
|
|
2599
2774
|
* @public
|
|
2600
2775
|
*/
|
|
2601
|
-
context?: ChannelContext;
|
|
2776
|
+
context?: ChannelContext | undefined;
|
|
2602
2777
|
/**
|
|
2603
2778
|
* The unique identifier of the channel to be updated.
|
|
2604
2779
|
* @public
|
|
@@ -2608,12 +2783,12 @@ export interface UpdateChannelInput {
|
|
|
2608
2783
|
* The unique identifier of the user when a service token is used.
|
|
2609
2784
|
* @public
|
|
2610
2785
|
*/
|
|
2611
|
-
userId?: string;
|
|
2786
|
+
userId?: string | undefined;
|
|
2612
2787
|
/**
|
|
2613
2788
|
* Set to true to suppress system messages about the updates. Default is false.
|
|
2614
2789
|
* @public
|
|
2615
2790
|
*/
|
|
2616
|
-
silent?: boolean;
|
|
2791
|
+
silent?: boolean | undefined;
|
|
2617
2792
|
}
|
|
2618
2793
|
/**
|
|
2619
2794
|
* @public
|
|
@@ -2634,7 +2809,7 @@ export interface UpdateInboxTagInput {
|
|
|
2634
2809
|
* The unique identifier of the user when a service token is used.
|
|
2635
2810
|
* @public
|
|
2636
2811
|
*/
|
|
2637
|
-
userId?: string;
|
|
2812
|
+
userId?: string | undefined;
|
|
2638
2813
|
/**
|
|
2639
2814
|
* The name of the tag.
|
|
2640
2815
|
* @public
|
|
@@ -2651,11 +2826,11 @@ export interface UpdateInboxTagOutput {
|
|
|
2651
2826
|
* @public
|
|
2652
2827
|
*/
|
|
2653
2828
|
export interface UpdateMessageInput {
|
|
2654
|
-
text?: string;
|
|
2655
|
-
elements?: (Element)[];
|
|
2656
|
-
attachments?: (MessageAttachment)[];
|
|
2657
|
-
quote?: MessageQuote;
|
|
2658
|
-
forward?: MessageForward;
|
|
2829
|
+
text?: string | undefined;
|
|
2830
|
+
elements?: (Element)[] | undefined;
|
|
2831
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2832
|
+
quote?: MessageQuote | undefined;
|
|
2833
|
+
forward?: MessageForward | undefined;
|
|
2659
2834
|
/**
|
|
2660
2835
|
* The unique identifier of the message to update.
|
|
2661
2836
|
* @public
|
|
@@ -2665,7 +2840,7 @@ export interface UpdateMessageInput {
|
|
|
2665
2840
|
* A list of user IDs mentioned in the message.
|
|
2666
2841
|
* @public
|
|
2667
2842
|
*/
|
|
2668
|
-
mentions?: (string)[];
|
|
2843
|
+
mentions?: (string)[] | undefined;
|
|
2669
2844
|
/**
|
|
2670
2845
|
* The unique identifier of the channel containing the message.
|
|
2671
2846
|
* @public
|
|
@@ -2675,12 +2850,12 @@ export interface UpdateMessageInput {
|
|
|
2675
2850
|
* The unique identifier of the user when a service token is used.
|
|
2676
2851
|
* @public
|
|
2677
2852
|
*/
|
|
2678
|
-
userId?: string;
|
|
2853
|
+
userId?: string | undefined;
|
|
2679
2854
|
/**
|
|
2680
2855
|
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2681
2856
|
* @public
|
|
2682
2857
|
*/
|
|
2683
|
-
silent?: boolean;
|
|
2858
|
+
silent?: boolean | undefined;
|
|
2684
2859
|
}
|
|
2685
2860
|
/**
|
|
2686
2861
|
* @public
|
|
@@ -2696,12 +2871,12 @@ export interface UploadFileOptions {
|
|
|
2696
2871
|
* File category. Channel files or conference recordings. Default: channels.
|
|
2697
2872
|
* @public
|
|
2698
2873
|
*/
|
|
2699
|
-
category?: ConversationFileCategory;
|
|
2874
|
+
category?: ConversationFileCategory | undefined;
|
|
2700
2875
|
/**
|
|
2701
2876
|
* The region in which you need to upload the file. It is only for s2s, in other cases it will be ignored.
|
|
2702
2877
|
* @public
|
|
2703
2878
|
*/
|
|
2704
|
-
region?: string;
|
|
2879
|
+
region?: string | undefined;
|
|
2705
2880
|
}
|
|
2706
2881
|
/**
|
|
2707
2882
|
* @public
|
|
@@ -2721,12 +2896,12 @@ export interface UploadFileInput {
|
|
|
2721
2896
|
* The unique identifier of the user when a service token is used.
|
|
2722
2897
|
* @public
|
|
2723
2898
|
*/
|
|
2724
|
-
userId?: string;
|
|
2899
|
+
userId?: string | undefined;
|
|
2725
2900
|
/**
|
|
2726
2901
|
* Additional options for the file upload.
|
|
2727
2902
|
* @public
|
|
2728
2903
|
*/
|
|
2729
|
-
options?: UploadFileOptions;
|
|
2904
|
+
options?: UploadFileOptions | undefined;
|
|
2730
2905
|
}
|
|
2731
2906
|
/**
|
|
2732
2907
|
* @public
|