@wildix/xbees-conversations-client 1.1.13 → 1.1.15
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/ListChannelMembersReadStatusCommand.js +21 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +48 -43
- package/dist-cjs/protocols/Aws_restJson1.js +131 -153
- 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/ListChannelMembersReadStatusCommand.js +17 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +43 -38
- package/dist-es/protocols/Aws_restJson1.js +30 -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 +16 -1
- 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/ListChannelMembersReadStatusCommand.d.ts +103 -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 +331 -291
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +3 -2
- package/dist-types/runtimeConfig.native.d.ts +3 -2
- package/package.json +37 -33
|
@@ -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
|
|
@@ -485,27 +495,27 @@ export interface AssignChannelInput {
|
|
|
485
495
|
* The unique identifier of the user when a service token is used.
|
|
486
496
|
* @public
|
|
487
497
|
*/
|
|
488
|
-
userId?: string;
|
|
498
|
+
userId?: string | undefined;
|
|
489
499
|
/**
|
|
490
500
|
* True to not send a system message that channel was assigned to specific service or user. Default - false.
|
|
491
501
|
* @public
|
|
492
502
|
*/
|
|
493
|
-
silent?: boolean;
|
|
503
|
+
silent?: boolean | undefined;
|
|
494
504
|
/**
|
|
495
505
|
* Service information to assign to. If service is not empty than `addAgentFromService` option could be used.
|
|
496
506
|
* @public
|
|
497
507
|
*/
|
|
498
|
-
service?: AssignChannelServiceRequest;
|
|
508
|
+
service?: AssignChannelServiceRequest | undefined;
|
|
499
509
|
/**
|
|
500
510
|
* A user that should be assigned to the channel. If service was specified than this field can be optional.
|
|
501
511
|
* @public
|
|
502
512
|
*/
|
|
503
|
-
assignee?: AssignChannelAssigneeRequest;
|
|
513
|
+
assignee?: AssignChannelAssigneeRequest | undefined;
|
|
504
514
|
/**
|
|
505
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.
|
|
506
516
|
* @public
|
|
507
517
|
*/
|
|
508
|
-
variant?: AssignChannelVariant;
|
|
518
|
+
variant?: AssignChannelVariant | undefined;
|
|
509
519
|
}
|
|
510
520
|
/**
|
|
511
521
|
* @public
|
|
@@ -518,6 +528,8 @@ export interface ServicePbx {
|
|
|
518
528
|
* @public
|
|
519
529
|
*/
|
|
520
530
|
export interface ServiceSettings {
|
|
531
|
+
phoneNumber?: string | undefined;
|
|
532
|
+
messagingNumber?: string | undefined;
|
|
521
533
|
}
|
|
522
534
|
/**
|
|
523
535
|
* @public
|
|
@@ -538,12 +550,12 @@ export interface AssignChannelOutput {
|
|
|
538
550
|
* A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
|
|
539
551
|
* @public
|
|
540
552
|
*/
|
|
541
|
-
assignee?: User;
|
|
553
|
+
assignee?: User | undefined;
|
|
542
554
|
/**
|
|
543
555
|
* A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
|
|
544
556
|
* @public
|
|
545
557
|
*/
|
|
546
|
-
service?: Service;
|
|
558
|
+
service?: Service | undefined;
|
|
547
559
|
}
|
|
548
560
|
/**
|
|
549
561
|
* @public
|
|
@@ -576,19 +588,19 @@ export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttend
|
|
|
576
588
|
*/
|
|
577
589
|
export interface ChannelContextEventAttendee {
|
|
578
590
|
email: string;
|
|
579
|
-
name?: string;
|
|
591
|
+
name?: string | undefined;
|
|
580
592
|
status: ChannelContextEventAttendeeStatus;
|
|
581
593
|
}
|
|
582
594
|
/**
|
|
583
595
|
* @public
|
|
584
596
|
*/
|
|
585
597
|
export interface ChannelContextEvent {
|
|
586
|
-
id?: string;
|
|
587
|
-
owner?: string;
|
|
588
|
-
start?: string;
|
|
589
|
-
end?: string;
|
|
590
|
-
summary?: string;
|
|
591
|
-
attendees?: (ChannelContextEventAttendee)[];
|
|
598
|
+
id?: string | undefined;
|
|
599
|
+
owner?: string | undefined;
|
|
600
|
+
start?: string | undefined;
|
|
601
|
+
end?: string | undefined;
|
|
602
|
+
summary?: string | undefined;
|
|
603
|
+
attendees?: (ChannelContextEventAttendee)[] | undefined;
|
|
592
604
|
}
|
|
593
605
|
/**
|
|
594
606
|
* @public
|
|
@@ -598,7 +610,7 @@ export interface ChannelContextPushToTalk {
|
|
|
598
610
|
* A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
|
|
599
611
|
* @public
|
|
600
612
|
*/
|
|
601
|
-
broadcastId?: string;
|
|
613
|
+
broadcastId?: string | undefined;
|
|
602
614
|
}
|
|
603
615
|
/**
|
|
604
616
|
* @public
|
|
@@ -615,10 +627,10 @@ export type ChannelContextSource = typeof ChannelContextSource[keyof typeof Chan
|
|
|
615
627
|
* @public
|
|
616
628
|
*/
|
|
617
629
|
export interface ChannelContext {
|
|
618
|
-
source?: ChannelContextSource;
|
|
619
|
-
target?: string;
|
|
620
|
-
events?: (ChannelContextEvent)[];
|
|
621
|
-
ptt?: ChannelContextPushToTalk;
|
|
630
|
+
source?: ChannelContextSource | undefined;
|
|
631
|
+
target?: string | undefined;
|
|
632
|
+
events?: (ChannelContextEvent)[] | undefined;
|
|
633
|
+
ptt?: ChannelContextPushToTalk | undefined;
|
|
622
634
|
}
|
|
623
635
|
/**
|
|
624
636
|
* @public
|
|
@@ -635,44 +647,44 @@ export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof Ch
|
|
|
635
647
|
* @public
|
|
636
648
|
*/
|
|
637
649
|
export interface Channel {
|
|
638
|
-
subject?: string;
|
|
639
|
-
description?: string;
|
|
650
|
+
subject?: string | undefined;
|
|
651
|
+
description?: string | undefined;
|
|
640
652
|
/**
|
|
641
653
|
* Picture URL
|
|
642
654
|
* @public
|
|
643
655
|
*/
|
|
644
|
-
picture?: string;
|
|
656
|
+
picture?: string | undefined;
|
|
645
657
|
/**
|
|
646
658
|
* Picture dominant color represented by a hex value.
|
|
647
659
|
* @public
|
|
648
660
|
*/
|
|
649
|
-
pictureColor?: string;
|
|
650
|
-
access?: ChannelAccess;
|
|
651
|
-
company?: string;
|
|
652
|
-
context?: ChannelContext;
|
|
653
|
-
kite?: boolean;
|
|
654
|
-
kiteTarget?: string;
|
|
655
|
-
kiteVariant?: string;
|
|
656
|
-
kiteAssign?: string;
|
|
657
|
-
kiteServiceName?: string;
|
|
658
|
-
kiteDefaultSubject?: string;
|
|
659
|
-
service?: string;
|
|
660
|
-
serviceTitle?: string;
|
|
661
|
-
serviceRecipient?: string;
|
|
662
|
-
assignee?: User;
|
|
663
|
-
telephony?: boolean;
|
|
664
|
-
sms?: boolean;
|
|
665
|
-
mms?: boolean;
|
|
666
|
-
whatsapp?: boolean;
|
|
667
|
-
whatsappStatus?: ChannelWhatsAppStatus;
|
|
668
|
-
broadcast?: boolean;
|
|
669
|
-
external?: boolean;
|
|
661
|
+
pictureColor?: string | undefined;
|
|
662
|
+
access?: ChannelAccess | undefined;
|
|
663
|
+
company?: string | undefined;
|
|
664
|
+
context?: ChannelContext | undefined;
|
|
665
|
+
kite?: boolean | undefined;
|
|
666
|
+
kiteTarget?: string | undefined;
|
|
667
|
+
kiteVariant?: string | undefined;
|
|
668
|
+
kiteAssign?: string | undefined;
|
|
669
|
+
kiteServiceName?: string | undefined;
|
|
670
|
+
kiteDefaultSubject?: string | undefined;
|
|
671
|
+
service?: string | undefined;
|
|
672
|
+
serviceTitle?: string | undefined;
|
|
673
|
+
serviceRecipient?: string | undefined;
|
|
674
|
+
assignee?: User | undefined;
|
|
675
|
+
telephony?: boolean | undefined;
|
|
676
|
+
sms?: boolean | undefined;
|
|
677
|
+
mms?: boolean | undefined;
|
|
678
|
+
whatsapp?: boolean | undefined;
|
|
679
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
680
|
+
broadcast?: boolean | undefined;
|
|
681
|
+
external?: boolean | undefined;
|
|
670
682
|
channelId: string;
|
|
671
683
|
channelType: ChannelType;
|
|
672
684
|
memberCount: number;
|
|
673
685
|
createdAt: string;
|
|
674
686
|
createdBy: string;
|
|
675
|
-
updatedAt?: string;
|
|
687
|
+
updatedAt?: string | undefined;
|
|
676
688
|
}
|
|
677
689
|
/**
|
|
678
690
|
* @public
|
|
@@ -685,11 +697,19 @@ export declare class ChannelAlreadyExistException extends __BaseException {
|
|
|
685
697
|
*/
|
|
686
698
|
constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
|
|
687
699
|
}
|
|
700
|
+
/**
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
export interface ChannelMemberReadStatus {
|
|
704
|
+
user?: User | undefined;
|
|
705
|
+
lastRead?: string | undefined;
|
|
706
|
+
lastReadMessageId?: string | undefined;
|
|
707
|
+
}
|
|
688
708
|
/**
|
|
689
709
|
* @public
|
|
690
710
|
*/
|
|
691
711
|
export interface ChannelsQuery {
|
|
692
|
-
ids?: (string)[];
|
|
712
|
+
ids?: (string)[] | undefined;
|
|
693
713
|
}
|
|
694
714
|
/**
|
|
695
715
|
* @public
|
|
@@ -699,57 +719,57 @@ export interface CreateGroupChannelInput {
|
|
|
699
719
|
* The subject of the channel.
|
|
700
720
|
* @public
|
|
701
721
|
*/
|
|
702
|
-
subject?: string;
|
|
722
|
+
subject?: string | undefined;
|
|
703
723
|
/**
|
|
704
724
|
* The description of the channel.
|
|
705
725
|
* @public
|
|
706
726
|
*/
|
|
707
|
-
description?: string;
|
|
727
|
+
description?: string | undefined;
|
|
708
728
|
/**
|
|
709
729
|
* The URL of the channel's picture.
|
|
710
730
|
* @public
|
|
711
731
|
*/
|
|
712
|
-
picture?: string;
|
|
732
|
+
picture?: string | undefined;
|
|
713
733
|
/**
|
|
714
734
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
715
735
|
* @public
|
|
716
736
|
*/
|
|
717
|
-
pictureColor?: string;
|
|
737
|
+
pictureColor?: string | undefined;
|
|
718
738
|
/**
|
|
719
739
|
* The access level of the channel.
|
|
720
740
|
* @public
|
|
721
741
|
*/
|
|
722
|
-
access?: ChannelAccess;
|
|
742
|
+
access?: ChannelAccess | undefined;
|
|
723
743
|
/**
|
|
724
744
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
725
745
|
* @public
|
|
726
746
|
*/
|
|
727
|
-
broadcast?: boolean;
|
|
747
|
+
broadcast?: boolean | undefined;
|
|
728
748
|
/**
|
|
729
749
|
* An additional information that associated with this channel.
|
|
730
750
|
* @public
|
|
731
751
|
*/
|
|
732
|
-
context?: ChannelContext;
|
|
752
|
+
context?: ChannelContext | undefined;
|
|
733
753
|
/**
|
|
734
754
|
* The unique identifier of the user when a service token is used.
|
|
735
755
|
* @public
|
|
736
756
|
*/
|
|
737
|
-
userId?: string;
|
|
757
|
+
userId?: string | undefined;
|
|
738
758
|
/**
|
|
739
759
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
740
760
|
* @public
|
|
741
761
|
*/
|
|
742
|
-
channelId?: string;
|
|
762
|
+
channelId?: string | undefined;
|
|
743
763
|
/**
|
|
744
764
|
* A list of user IDs to be added as members of the group channel.
|
|
745
765
|
* @public
|
|
746
766
|
*/
|
|
747
|
-
members?: (string)[];
|
|
767
|
+
members?: (string)[] | undefined;
|
|
748
768
|
/**
|
|
749
769
|
* A list of users to invite to the group channel, identified by their email addresses or phone numbers.
|
|
750
770
|
* @public
|
|
751
771
|
*/
|
|
752
|
-
membersToInvite?: (UserToInvite)[];
|
|
772
|
+
membersToInvite?: (UserToInvite)[] | undefined;
|
|
753
773
|
}
|
|
754
774
|
/**
|
|
755
775
|
* @public
|
|
@@ -765,12 +785,12 @@ export interface CreateInboxTagInput {
|
|
|
765
785
|
* The unique identifier of the user when a service token is used.
|
|
766
786
|
* @public
|
|
767
787
|
*/
|
|
768
|
-
userId?: string;
|
|
788
|
+
userId?: string | undefined;
|
|
769
789
|
/**
|
|
770
790
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
771
791
|
* @public
|
|
772
792
|
*/
|
|
773
|
-
tagId?: string;
|
|
793
|
+
tagId?: string | undefined;
|
|
774
794
|
/**
|
|
775
795
|
* The name of the tag.
|
|
776
796
|
* @public
|
|
@@ -811,12 +831,12 @@ export interface MessageAttachment {
|
|
|
811
831
|
* @public
|
|
812
832
|
*/
|
|
813
833
|
fsId: string;
|
|
814
|
-
mime?: string;
|
|
834
|
+
mime?: string | undefined;
|
|
815
835
|
name: string;
|
|
816
836
|
size: number;
|
|
817
|
-
width?: number;
|
|
818
|
-
height?: number;
|
|
819
|
-
thumbnail?: string;
|
|
837
|
+
width?: number | undefined;
|
|
838
|
+
height?: number | undefined;
|
|
839
|
+
thumbnail?: string | undefined;
|
|
820
840
|
}
|
|
821
841
|
/**
|
|
822
842
|
* @public
|
|
@@ -847,10 +867,10 @@ export declare namespace Element {
|
|
|
847
867
|
* @public
|
|
848
868
|
*/
|
|
849
869
|
export interface MessageForward {
|
|
850
|
-
forwardCompany?: string;
|
|
870
|
+
forwardCompany?: string | undefined;
|
|
851
871
|
forwardDate: string;
|
|
852
|
-
forwardEmail?: string;
|
|
853
|
-
forwardName?: string;
|
|
872
|
+
forwardEmail?: string | undefined;
|
|
873
|
+
forwardName?: string | undefined;
|
|
854
874
|
messageId: string;
|
|
855
875
|
channelId: string;
|
|
856
876
|
}
|
|
@@ -871,23 +891,23 @@ export interface MessageQuote {
|
|
|
871
891
|
messageId: string;
|
|
872
892
|
channelId: string;
|
|
873
893
|
user: User;
|
|
874
|
-
text?: string;
|
|
875
|
-
attachments?: (MessageAttachment)[];
|
|
876
|
-
forward?: MessageForward;
|
|
877
|
-
mentions?: (User)[];
|
|
878
|
-
giphy?: MessageGiphy;
|
|
894
|
+
text?: string | undefined;
|
|
895
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
896
|
+
forward?: MessageForward | undefined;
|
|
897
|
+
mentions?: (User)[] | undefined;
|
|
898
|
+
giphy?: MessageGiphy | undefined;
|
|
879
899
|
createdAt: string;
|
|
880
|
-
updatedAt?: string;
|
|
900
|
+
updatedAt?: string | undefined;
|
|
881
901
|
}
|
|
882
902
|
/**
|
|
883
903
|
* @public
|
|
884
904
|
*/
|
|
885
905
|
export interface InitialMessage {
|
|
886
|
-
text?: string;
|
|
887
|
-
elements?: (Element)[];
|
|
888
|
-
attachments?: (MessageAttachment)[];
|
|
889
|
-
quote?: MessageQuote;
|
|
890
|
-
forward?: MessageForward;
|
|
906
|
+
text?: string | undefined;
|
|
907
|
+
elements?: (Element)[] | undefined;
|
|
908
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
909
|
+
quote?: MessageQuote | undefined;
|
|
910
|
+
forward?: MessageForward | undefined;
|
|
891
911
|
/**
|
|
892
912
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
893
913
|
* @public
|
|
@@ -897,17 +917,17 @@ export interface InitialMessage {
|
|
|
897
917
|
* A list of user IDs mentioned in the message.
|
|
898
918
|
* @public
|
|
899
919
|
*/
|
|
900
|
-
mentions?: (string)[];
|
|
920
|
+
mentions?: (string)[] | undefined;
|
|
901
921
|
}
|
|
902
922
|
/**
|
|
903
923
|
* @public
|
|
904
924
|
*/
|
|
905
925
|
export interface WelcomeMessage {
|
|
906
|
-
text?: string;
|
|
907
|
-
elements?: (Element)[];
|
|
908
|
-
attachments?: (MessageAttachment)[];
|
|
909
|
-
quote?: MessageQuote;
|
|
910
|
-
forward?: MessageForward;
|
|
926
|
+
text?: string | undefined;
|
|
927
|
+
elements?: (Element)[] | undefined;
|
|
928
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
929
|
+
quote?: MessageQuote | undefined;
|
|
930
|
+
forward?: MessageForward | undefined;
|
|
911
931
|
/**
|
|
912
932
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
913
933
|
* @public
|
|
@@ -917,7 +937,7 @@ export interface WelcomeMessage {
|
|
|
917
937
|
* A list of user IDs mentioned in the message.
|
|
918
938
|
* @public
|
|
919
939
|
*/
|
|
920
|
-
mentions?: (string)[];
|
|
940
|
+
mentions?: (string)[] | undefined;
|
|
921
941
|
user: User;
|
|
922
942
|
}
|
|
923
943
|
/**
|
|
@@ -928,12 +948,12 @@ export interface CreateKiteChannelInput {
|
|
|
928
948
|
* The unique identifier of the user when a service token is used.
|
|
929
949
|
* @public
|
|
930
950
|
*/
|
|
931
|
-
userId?: string;
|
|
951
|
+
userId?: string | undefined;
|
|
932
952
|
/**
|
|
933
953
|
* The unique identifier for the new group channel. If not provided, the system will generate one.
|
|
934
954
|
* @public
|
|
935
955
|
*/
|
|
936
|
-
channelId?: string;
|
|
956
|
+
channelId?: string | undefined;
|
|
937
957
|
/**
|
|
938
958
|
* The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).
|
|
939
959
|
* @public
|
|
@@ -943,17 +963,17 @@ export interface CreateKiteChannelInput {
|
|
|
943
963
|
* The unique identifier of the route for time-based configuration.
|
|
944
964
|
* @public
|
|
945
965
|
*/
|
|
946
|
-
targetRouteId?: string;
|
|
966
|
+
targetRouteId?: string | undefined;
|
|
947
967
|
/**
|
|
948
968
|
* 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.
|
|
949
969
|
* @public
|
|
950
970
|
*/
|
|
951
|
-
welcomeMessages?: (WelcomeMessage)[];
|
|
971
|
+
welcomeMessages?: (WelcomeMessage)[] | undefined;
|
|
952
972
|
/**
|
|
953
973
|
* 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.
|
|
954
974
|
* @public
|
|
955
975
|
*/
|
|
956
|
-
initialMessage?: InitialMessage;
|
|
976
|
+
initialMessage?: InitialMessage | undefined;
|
|
957
977
|
}
|
|
958
978
|
/**
|
|
959
979
|
* @public
|
|
@@ -978,7 +998,7 @@ export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeo
|
|
|
978
998
|
export declare class TargetNotEligibleException extends __BaseException {
|
|
979
999
|
readonly name: "TargetNotEligibleException";
|
|
980
1000
|
readonly $fault: "client";
|
|
981
|
-
reason?: TargetNotEligibleReason;
|
|
1001
|
+
reason?: TargetNotEligibleReason | undefined;
|
|
982
1002
|
/**
|
|
983
1003
|
* @internal
|
|
984
1004
|
*/
|
|
@@ -1023,7 +1043,7 @@ export interface DeleteChannelMemberInput {
|
|
|
1023
1043
|
* The unique identifier of the user when a service token is used.
|
|
1024
1044
|
* @public
|
|
1025
1045
|
*/
|
|
1026
|
-
userId?: string;
|
|
1046
|
+
userId?: string | undefined;
|
|
1027
1047
|
/**
|
|
1028
1048
|
* The unique identifier of the member to be deleted.
|
|
1029
1049
|
* @public
|
|
@@ -1033,7 +1053,7 @@ export interface DeleteChannelMemberInput {
|
|
|
1033
1053
|
* Set to true to suppress system messages that the member was removed from the conversation. Default is false.
|
|
1034
1054
|
* @public
|
|
1035
1055
|
*/
|
|
1036
|
-
silent?: boolean;
|
|
1056
|
+
silent?: boolean | undefined;
|
|
1037
1057
|
}
|
|
1038
1058
|
/**
|
|
1039
1059
|
* @public
|
|
@@ -1064,7 +1084,7 @@ export interface DeleteInboxTagInput {
|
|
|
1064
1084
|
* The unique identifier of the user when a service token is used.
|
|
1065
1085
|
* @public
|
|
1066
1086
|
*/
|
|
1067
|
-
userId?: string;
|
|
1087
|
+
userId?: string | undefined;
|
|
1068
1088
|
}
|
|
1069
1089
|
/**
|
|
1070
1090
|
* @public
|
|
@@ -1089,7 +1109,7 @@ export interface DeleteMessageInput {
|
|
|
1089
1109
|
* The unique identifier of the user when a service token is used.
|
|
1090
1110
|
* @public
|
|
1091
1111
|
*/
|
|
1092
|
-
userId?: string;
|
|
1112
|
+
userId?: string | undefined;
|
|
1093
1113
|
}
|
|
1094
1114
|
/**
|
|
1095
1115
|
* @public
|
|
@@ -1149,7 +1169,7 @@ export interface DeleteMessageReactionInput {
|
|
|
1149
1169
|
* The unique identifier of the user when a service token is used.
|
|
1150
1170
|
* @public
|
|
1151
1171
|
*/
|
|
1152
|
-
userId?: string;
|
|
1172
|
+
userId?: string | undefined;
|
|
1153
1173
|
}
|
|
1154
1174
|
/**
|
|
1155
1175
|
* @public
|
|
@@ -1165,10 +1185,10 @@ export interface DescribeEventInput {
|
|
|
1165
1185
|
* @public
|
|
1166
1186
|
*/
|
|
1167
1187
|
export interface Reaction {
|
|
1168
|
-
type?: string;
|
|
1169
|
-
userId?: string;
|
|
1170
|
-
messageId?: string;
|
|
1171
|
-
user?: User;
|
|
1188
|
+
type?: string | undefined;
|
|
1189
|
+
userId?: string | undefined;
|
|
1190
|
+
messageId?: string | undefined;
|
|
1191
|
+
user?: User | undefined;
|
|
1172
1192
|
}
|
|
1173
1193
|
/**
|
|
1174
1194
|
* @public
|
|
@@ -1214,28 +1234,28 @@ export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof Me
|
|
|
1214
1234
|
* @public
|
|
1215
1235
|
*/
|
|
1216
1236
|
export interface Message {
|
|
1217
|
-
text?: string;
|
|
1218
|
-
elements?: (Element)[];
|
|
1219
|
-
attachments?: (MessageAttachment)[];
|
|
1220
|
-
quote?: MessageQuote;
|
|
1221
|
-
forward?: MessageForward;
|
|
1237
|
+
text?: string | undefined;
|
|
1238
|
+
elements?: (Element)[] | undefined;
|
|
1239
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
1240
|
+
quote?: MessageQuote | undefined;
|
|
1241
|
+
forward?: MessageForward | undefined;
|
|
1222
1242
|
type: MessageType;
|
|
1223
|
-
giphy?: MessageGiphy;
|
|
1224
|
-
silent?: boolean;
|
|
1225
|
-
event?: string;
|
|
1226
|
-
sms?: boolean;
|
|
1227
|
-
smsStatus?: MessageSmsStatus;
|
|
1228
|
-
whatsapp?: boolean;
|
|
1229
|
-
whatsappStatus?: MessageWhatsAppStatus;
|
|
1243
|
+
giphy?: MessageGiphy | undefined;
|
|
1244
|
+
silent?: boolean | undefined;
|
|
1245
|
+
event?: string | undefined;
|
|
1246
|
+
sms?: boolean | undefined;
|
|
1247
|
+
smsStatus?: MessageSmsStatus | undefined;
|
|
1248
|
+
whatsapp?: boolean | undefined;
|
|
1249
|
+
whatsappStatus?: MessageWhatsAppStatus | undefined;
|
|
1230
1250
|
messageId: string;
|
|
1231
1251
|
channelId: string;
|
|
1232
1252
|
user: User;
|
|
1233
|
-
edit?: boolean;
|
|
1234
|
-
mentions?: (User)[];
|
|
1235
|
-
latestReactions?: (Reaction)[];
|
|
1236
|
-
reactionCounts?: Record<string, number
|
|
1253
|
+
edit?: boolean | undefined;
|
|
1254
|
+
mentions?: (User)[] | undefined;
|
|
1255
|
+
latestReactions?: (Reaction)[] | undefined;
|
|
1256
|
+
reactionCounts?: Record<string, number> | undefined;
|
|
1237
1257
|
createdAt: string;
|
|
1238
|
-
updatedAt?: string;
|
|
1258
|
+
updatedAt?: string | undefined;
|
|
1239
1259
|
}
|
|
1240
1260
|
/**
|
|
1241
1261
|
* @public
|
|
@@ -1275,8 +1295,8 @@ export interface WebhookChatActionTriggeredEvent {
|
|
|
1275
1295
|
company: string;
|
|
1276
1296
|
type: WebhookEventType;
|
|
1277
1297
|
time: number;
|
|
1278
|
-
integrationId?: string;
|
|
1279
|
-
botId?: string;
|
|
1298
|
+
integrationId?: string | undefined;
|
|
1299
|
+
botId?: string | undefined;
|
|
1280
1300
|
data: WebhookChatActionTriggeredEventData;
|
|
1281
1301
|
}
|
|
1282
1302
|
/**
|
|
@@ -1295,8 +1315,8 @@ export interface WebhookChatChannelCreatedEvent {
|
|
|
1295
1315
|
company: string;
|
|
1296
1316
|
type: WebhookEventType;
|
|
1297
1317
|
time: number;
|
|
1298
|
-
integrationId?: string;
|
|
1299
|
-
botId?: string;
|
|
1318
|
+
integrationId?: string | undefined;
|
|
1319
|
+
botId?: string | undefined;
|
|
1300
1320
|
data: WebhookChatChannelCreatedOrUpdatedEventData;
|
|
1301
1321
|
}
|
|
1302
1322
|
/**
|
|
@@ -1307,8 +1327,8 @@ export interface WebhookChatChannelUpdatedEvent {
|
|
|
1307
1327
|
company: string;
|
|
1308
1328
|
type: WebhookEventType;
|
|
1309
1329
|
time: number;
|
|
1310
|
-
integrationId?: string;
|
|
1311
|
-
botId?: string;
|
|
1330
|
+
integrationId?: string | undefined;
|
|
1331
|
+
botId?: string | undefined;
|
|
1312
1332
|
data: WebhookChatChannelCreatedOrUpdatedEventData;
|
|
1313
1333
|
}
|
|
1314
1334
|
/**
|
|
@@ -1327,8 +1347,8 @@ export interface WebhookChatMemberAddedEvent {
|
|
|
1327
1347
|
company: string;
|
|
1328
1348
|
type: WebhookEventType;
|
|
1329
1349
|
time: number;
|
|
1330
|
-
integrationId?: string;
|
|
1331
|
-
botId?: string;
|
|
1350
|
+
integrationId?: string | undefined;
|
|
1351
|
+
botId?: string | undefined;
|
|
1332
1352
|
data: WebhookChatMemberAddedOrRemovedEventData;
|
|
1333
1353
|
}
|
|
1334
1354
|
/**
|
|
@@ -1339,8 +1359,8 @@ export interface WebhookChatMemberRemovedEvent {
|
|
|
1339
1359
|
company: string;
|
|
1340
1360
|
type: WebhookEventType;
|
|
1341
1361
|
time: number;
|
|
1342
|
-
integrationId?: string;
|
|
1343
|
-
botId?: string;
|
|
1362
|
+
integrationId?: string | undefined;
|
|
1363
|
+
botId?: string | undefined;
|
|
1344
1364
|
data: WebhookChatMemberAddedOrRemovedEventData;
|
|
1345
1365
|
}
|
|
1346
1366
|
/**
|
|
@@ -1358,8 +1378,8 @@ export interface WebhookChatMessageDeletedEvent {
|
|
|
1358
1378
|
company: string;
|
|
1359
1379
|
type: WebhookEventType;
|
|
1360
1380
|
time: number;
|
|
1361
|
-
integrationId?: string;
|
|
1362
|
-
botId?: string;
|
|
1381
|
+
integrationId?: string | undefined;
|
|
1382
|
+
botId?: string | undefined;
|
|
1363
1383
|
data: WebhookChatMessageUpdatedOrDeletedEventData;
|
|
1364
1384
|
}
|
|
1365
1385
|
/**
|
|
@@ -1379,8 +1399,8 @@ export interface WebhookChatMessageNewEvent {
|
|
|
1379
1399
|
company: string;
|
|
1380
1400
|
type: WebhookEventType;
|
|
1381
1401
|
time: number;
|
|
1382
|
-
integrationId?: string;
|
|
1383
|
-
botId?: string;
|
|
1402
|
+
integrationId?: string | undefined;
|
|
1403
|
+
botId?: string | undefined;
|
|
1384
1404
|
data: WebhookChatMessageNewEventData;
|
|
1385
1405
|
}
|
|
1386
1406
|
/**
|
|
@@ -1391,8 +1411,8 @@ export interface WebhookChatMessageUpdatedEvent {
|
|
|
1391
1411
|
company: string;
|
|
1392
1412
|
type: WebhookEventType;
|
|
1393
1413
|
time: number;
|
|
1394
|
-
integrationId?: string;
|
|
1395
|
-
botId?: string;
|
|
1414
|
+
integrationId?: string | undefined;
|
|
1415
|
+
botId?: string | undefined;
|
|
1396
1416
|
data: WebhookChatMessageUpdatedOrDeletedEventData;
|
|
1397
1417
|
}
|
|
1398
1418
|
/**
|
|
@@ -1411,8 +1431,8 @@ export interface WebhookChatReactionDeletedEvent {
|
|
|
1411
1431
|
company: string;
|
|
1412
1432
|
type: WebhookEventType;
|
|
1413
1433
|
time: number;
|
|
1414
|
-
integrationId?: string;
|
|
1415
|
-
botId?: string;
|
|
1434
|
+
integrationId?: string | undefined;
|
|
1435
|
+
botId?: string | undefined;
|
|
1416
1436
|
data: WebhookChatReactionNewOrDeletedEventData;
|
|
1417
1437
|
}
|
|
1418
1438
|
/**
|
|
@@ -1423,24 +1443,24 @@ export interface WebhookChatReactionNewEvent {
|
|
|
1423
1443
|
company: string;
|
|
1424
1444
|
type: WebhookEventType;
|
|
1425
1445
|
time: number;
|
|
1426
|
-
integrationId?: string;
|
|
1427
|
-
botId?: string;
|
|
1446
|
+
integrationId?: string | undefined;
|
|
1447
|
+
botId?: string | undefined;
|
|
1428
1448
|
data: WebhookChatReactionNewOrDeletedEventData;
|
|
1429
1449
|
}
|
|
1430
1450
|
/**
|
|
1431
1451
|
* @public
|
|
1432
1452
|
*/
|
|
1433
1453
|
export interface DescribeEventOutput {
|
|
1434
|
-
WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent;
|
|
1435
|
-
WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent;
|
|
1436
|
-
WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent;
|
|
1437
|
-
WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent;
|
|
1438
|
-
WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent;
|
|
1439
|
-
WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent;
|
|
1440
|
-
WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent;
|
|
1441
|
-
WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent;
|
|
1442
|
-
WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent;
|
|
1443
|
-
WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent;
|
|
1454
|
+
WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent | undefined;
|
|
1455
|
+
WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent | undefined;
|
|
1456
|
+
WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent | undefined;
|
|
1457
|
+
WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent | undefined;
|
|
1458
|
+
WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent | undefined;
|
|
1459
|
+
WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent | undefined;
|
|
1460
|
+
WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent | undefined;
|
|
1461
|
+
WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent | undefined;
|
|
1462
|
+
WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent | undefined;
|
|
1463
|
+
WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent | undefined;
|
|
1444
1464
|
}
|
|
1445
1465
|
/**
|
|
1446
1466
|
* @public
|
|
@@ -1455,14 +1475,14 @@ export interface GetActionTriggerResultInput {
|
|
|
1455
1475
|
* The unique identifier of the user when a service token is used.
|
|
1456
1476
|
* @public
|
|
1457
1477
|
*/
|
|
1458
|
-
userId?: string;
|
|
1478
|
+
userId?: string | undefined;
|
|
1459
1479
|
}
|
|
1460
1480
|
/**
|
|
1461
1481
|
* @public
|
|
1462
1482
|
*/
|
|
1463
1483
|
export interface GetActionTriggerResultOutput {
|
|
1464
1484
|
status: ActionTriggerStatus;
|
|
1465
|
-
result?: ActionTriggerResult;
|
|
1485
|
+
result?: ActionTriggerResult | undefined;
|
|
1466
1486
|
}
|
|
1467
1487
|
/**
|
|
1468
1488
|
* @public
|
|
@@ -1529,17 +1549,17 @@ export interface GetDirectChannelIdInput {
|
|
|
1529
1549
|
* The unique identifier of the user when a service token is used.
|
|
1530
1550
|
* @public
|
|
1531
1551
|
*/
|
|
1532
|
-
userId?: string;
|
|
1552
|
+
userId?: string | undefined;
|
|
1533
1553
|
/**
|
|
1534
1554
|
* A User ID of the member to connect with the direct channel.
|
|
1535
1555
|
* @public
|
|
1536
1556
|
*/
|
|
1537
|
-
memberId?: string;
|
|
1557
|
+
memberId?: string | undefined;
|
|
1538
1558
|
/**
|
|
1539
1559
|
* A user to invite to the direct channel, identified by email addresse or phone number.
|
|
1540
1560
|
* @public
|
|
1541
1561
|
*/
|
|
1542
|
-
memberToInvite?: UserToInvite;
|
|
1562
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1543
1563
|
}
|
|
1544
1564
|
/**
|
|
1545
1565
|
* @public
|
|
@@ -1570,12 +1590,12 @@ export interface GetFilePresignedDownloadUrlInput {
|
|
|
1570
1590
|
* The category of the file, either channel files or conference recordings.
|
|
1571
1591
|
* @public
|
|
1572
1592
|
*/
|
|
1573
|
-
category?: ConversationFileCategory;
|
|
1593
|
+
category?: ConversationFileCategory | undefined;
|
|
1574
1594
|
/**
|
|
1575
1595
|
* URL behavior, 0 - open(play) for audio/video, others are downloaded; 1 — always download.
|
|
1576
1596
|
* @public
|
|
1577
1597
|
*/
|
|
1578
|
-
download?: number;
|
|
1598
|
+
download?: number | undefined;
|
|
1579
1599
|
}
|
|
1580
1600
|
/**
|
|
1581
1601
|
* @public
|
|
@@ -1595,7 +1615,7 @@ export interface GetInboxStateInput {
|
|
|
1595
1615
|
* The unique identifier of the user when a service token is used.
|
|
1596
1616
|
* @public
|
|
1597
1617
|
*/
|
|
1598
|
-
userId?: string;
|
|
1618
|
+
userId?: string | undefined;
|
|
1599
1619
|
}
|
|
1600
1620
|
/**
|
|
1601
1621
|
* @public
|
|
@@ -1621,7 +1641,7 @@ export interface InboxUnreadChannel {
|
|
|
1621
1641
|
* @public
|
|
1622
1642
|
*/
|
|
1623
1643
|
unreadAt: string;
|
|
1624
|
-
messageId?: string;
|
|
1644
|
+
messageId?: string | undefined;
|
|
1625
1645
|
}
|
|
1626
1646
|
/**
|
|
1627
1647
|
* @public
|
|
@@ -1667,17 +1687,17 @@ export interface GetOrCreateDirectChannelInput {
|
|
|
1667
1687
|
* The unique identifier of the user when a service token is used.
|
|
1668
1688
|
* @public
|
|
1669
1689
|
*/
|
|
1670
|
-
userId?: string;
|
|
1690
|
+
userId?: string | undefined;
|
|
1671
1691
|
/**
|
|
1672
1692
|
* A User ID of the member to connect with the direct channel.
|
|
1673
1693
|
* @public
|
|
1674
1694
|
*/
|
|
1675
|
-
memberId?: string;
|
|
1695
|
+
memberId?: string | undefined;
|
|
1676
1696
|
/**
|
|
1677
1697
|
* A user to invite to the direct channel, identified by email addresse or phone number.
|
|
1678
1698
|
* @public
|
|
1679
1699
|
*/
|
|
1680
|
-
memberToInvite?: UserToInvite;
|
|
1700
|
+
memberToInvite?: UserToInvite | undefined;
|
|
1681
1701
|
}
|
|
1682
1702
|
/**
|
|
1683
1703
|
* @public
|
|
@@ -1723,7 +1743,7 @@ export interface GetUploadedFileInfoInput {
|
|
|
1723
1743
|
* The category of the file, either channel files or conference recordings. Default: channels.
|
|
1724
1744
|
* @public
|
|
1725
1745
|
*/
|
|
1726
|
-
category?: ConversationFileCategory;
|
|
1746
|
+
category?: ConversationFileCategory | undefined;
|
|
1727
1747
|
}
|
|
1728
1748
|
/**
|
|
1729
1749
|
* @public
|
|
@@ -1744,7 +1764,7 @@ export interface HideChannelInput {
|
|
|
1744
1764
|
* The unique identifier of the user when a service token is used.
|
|
1745
1765
|
* @public
|
|
1746
1766
|
*/
|
|
1747
|
-
userId?: string;
|
|
1767
|
+
userId?: string | undefined;
|
|
1748
1768
|
}
|
|
1749
1769
|
/**
|
|
1750
1770
|
* @public
|
|
@@ -1784,12 +1804,12 @@ export interface JoinChannelInput {
|
|
|
1784
1804
|
* The unique identifier of the user when a service token is used.
|
|
1785
1805
|
* @public
|
|
1786
1806
|
*/
|
|
1787
|
-
userId?: string;
|
|
1807
|
+
userId?: string | undefined;
|
|
1788
1808
|
/**
|
|
1789
1809
|
* Set to true to suppress system messages that the user joined the channel. Default is false.
|
|
1790
1810
|
* @public
|
|
1791
1811
|
*/
|
|
1792
|
-
silent?: boolean;
|
|
1812
|
+
silent?: boolean | undefined;
|
|
1793
1813
|
}
|
|
1794
1814
|
/**
|
|
1795
1815
|
* @public
|
|
@@ -1810,12 +1830,12 @@ export interface LeaveChannelInput {
|
|
|
1810
1830
|
* The unique identifier of the user when a service token is used.
|
|
1811
1831
|
* @public
|
|
1812
1832
|
*/
|
|
1813
|
-
userId?: string;
|
|
1833
|
+
userId?: string | undefined;
|
|
1814
1834
|
/**
|
|
1815
1835
|
* Set to true to suppress system messages that the user left the channel. Default is false.
|
|
1816
1836
|
* @public
|
|
1817
1837
|
*/
|
|
1818
|
-
silent?: boolean;
|
|
1838
|
+
silent?: boolean | undefined;
|
|
1819
1839
|
}
|
|
1820
1840
|
/**
|
|
1821
1841
|
* @public
|
|
@@ -1835,12 +1855,12 @@ export interface ListChannelMembersInput {
|
|
|
1835
1855
|
* The maximum number of members to return. The value must be between 1 and 100.
|
|
1836
1856
|
* @public
|
|
1837
1857
|
*/
|
|
1838
|
-
limit?: number;
|
|
1858
|
+
limit?: number | undefined;
|
|
1839
1859
|
/**
|
|
1840
1860
|
* The offset from which to start listing members. The value must be between 0 and 1000.
|
|
1841
1861
|
* @public
|
|
1842
1862
|
*/
|
|
1843
|
-
offset?: number;
|
|
1863
|
+
offset?: number | undefined;
|
|
1844
1864
|
}
|
|
1845
1865
|
/**
|
|
1846
1866
|
* @public
|
|
@@ -1857,6 +1877,26 @@ export interface ListChannelMembersOutput {
|
|
|
1857
1877
|
*/
|
|
1858
1878
|
users: (User)[];
|
|
1859
1879
|
}
|
|
1880
|
+
/**
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1883
|
+
export interface ListChannelMembersReadStatusInput {
|
|
1884
|
+
/**
|
|
1885
|
+
* The unique identifier of the channel whose members are to be listed.
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
channelId: string;
|
|
1889
|
+
}
|
|
1890
|
+
/**
|
|
1891
|
+
* @public
|
|
1892
|
+
*/
|
|
1893
|
+
export interface ListChannelMembersReadStatusOutput {
|
|
1894
|
+
/**
|
|
1895
|
+
* Read status of members.
|
|
1896
|
+
* @public
|
|
1897
|
+
*/
|
|
1898
|
+
members: (ChannelMemberReadStatus)[];
|
|
1899
|
+
}
|
|
1860
1900
|
/**
|
|
1861
1901
|
* @public
|
|
1862
1902
|
*/
|
|
@@ -1865,22 +1905,22 @@ export interface ListChannelsInput {
|
|
|
1865
1905
|
* The unique identifier of the tenant when a service token is used.
|
|
1866
1906
|
* @public
|
|
1867
1907
|
*/
|
|
1868
|
-
companyId?: string;
|
|
1908
|
+
companyId?: string | undefined;
|
|
1869
1909
|
/**
|
|
1870
1910
|
* The unique identifier of the user when a service or PBX token is used.
|
|
1871
1911
|
* @public
|
|
1872
1912
|
*/
|
|
1873
|
-
userId?: string;
|
|
1913
|
+
userId?: string | undefined;
|
|
1874
1914
|
/**
|
|
1875
1915
|
* The maximum number of channels to return. The value must be between 1 and 30.
|
|
1876
1916
|
* @public
|
|
1877
1917
|
*/
|
|
1878
|
-
limit?: number;
|
|
1918
|
+
limit?: number | undefined;
|
|
1879
1919
|
/**
|
|
1880
1920
|
* The offset from which to start listing channels. The value must be between 0 and 1000.
|
|
1881
1921
|
* @public
|
|
1882
1922
|
*/
|
|
1883
|
-
offset?: number;
|
|
1923
|
+
offset?: number | undefined;
|
|
1884
1924
|
}
|
|
1885
1925
|
/**
|
|
1886
1926
|
* @public
|
|
@@ -1900,7 +1940,7 @@ export interface ListInboxTaggedChannelsInput {
|
|
|
1900
1940
|
* The unique identifier of the user when a service token is used.
|
|
1901
1941
|
* @public
|
|
1902
1942
|
*/
|
|
1903
|
-
userId?: string;
|
|
1943
|
+
userId?: string | undefined;
|
|
1904
1944
|
/**
|
|
1905
1945
|
* The unique identifier of the channel whose members are to be listed.
|
|
1906
1946
|
* @public
|
|
@@ -1932,7 +1972,7 @@ export interface ListInboxTagsInput {
|
|
|
1932
1972
|
* The unique identifier of the user when a service token is used.
|
|
1933
1973
|
* @public
|
|
1934
1974
|
*/
|
|
1935
|
-
userId?: string;
|
|
1975
|
+
userId?: string | undefined;
|
|
1936
1976
|
}
|
|
1937
1977
|
/**
|
|
1938
1978
|
* @public
|
|
@@ -1958,12 +1998,12 @@ export interface ListMessageReactionsInput {
|
|
|
1958
1998
|
* The maximum number of reactions to return. The value must be between 1 and 300.
|
|
1959
1999
|
* @public
|
|
1960
2000
|
*/
|
|
1961
|
-
limit?: number;
|
|
2001
|
+
limit?: number | undefined;
|
|
1962
2002
|
/**
|
|
1963
2003
|
* The offset from which to start listing reactions. The value must be between 0 and 1000.
|
|
1964
2004
|
* @public
|
|
1965
2005
|
*/
|
|
1966
|
-
offset?: number;
|
|
2006
|
+
offset?: number | undefined;
|
|
1967
2007
|
}
|
|
1968
2008
|
/**
|
|
1969
2009
|
* @public
|
|
@@ -1988,12 +2028,12 @@ export interface ListMessagesInput {
|
|
|
1988
2028
|
* The maximum number of messages to return. The value must be between 1 and 100.
|
|
1989
2029
|
* @public
|
|
1990
2030
|
*/
|
|
1991
|
-
limit?: number;
|
|
2031
|
+
limit?: number | undefined;
|
|
1992
2032
|
/**
|
|
1993
2033
|
* The offset from which to start listing messages. The value must be between 0 and 1000.
|
|
1994
2034
|
* @public
|
|
1995
2035
|
*/
|
|
1996
|
-
offset?: number;
|
|
2036
|
+
offset?: number | undefined;
|
|
1997
2037
|
}
|
|
1998
2038
|
/**
|
|
1999
2039
|
* @public
|
|
@@ -2018,12 +2058,12 @@ export interface ListPinnedMessagesInput {
|
|
|
2018
2058
|
* The maximum number of pinned messages to return. The value must be between 1 and 100.
|
|
2019
2059
|
* @public
|
|
2020
2060
|
*/
|
|
2021
|
-
limit?: number;
|
|
2061
|
+
limit?: number | undefined;
|
|
2022
2062
|
/**
|
|
2023
2063
|
* The offset from which to start listing pinned messages. The value must be between 0 and 1000.
|
|
2024
2064
|
* @public
|
|
2025
2065
|
*/
|
|
2026
|
-
offset?: number;
|
|
2066
|
+
offset?: number | undefined;
|
|
2027
2067
|
}
|
|
2028
2068
|
/**
|
|
2029
2069
|
* @public
|
|
@@ -2048,7 +2088,7 @@ export interface MarkReadInput {
|
|
|
2048
2088
|
* The unique identifier of the user when a service token is used.
|
|
2049
2089
|
* @public
|
|
2050
2090
|
*/
|
|
2051
|
-
userId?: string;
|
|
2091
|
+
userId?: string | undefined;
|
|
2052
2092
|
}
|
|
2053
2093
|
/**
|
|
2054
2094
|
* @public
|
|
@@ -2079,17 +2119,17 @@ export interface MarkUnreadInput {
|
|
|
2079
2119
|
* The unique identifier of the user when a service token is used.
|
|
2080
2120
|
* @public
|
|
2081
2121
|
*/
|
|
2082
|
-
userId?: string;
|
|
2122
|
+
userId?: string | undefined;
|
|
2083
2123
|
/**
|
|
2084
2124
|
* A Message ID in the channel from which to calculate the amount of unread messages.
|
|
2085
2125
|
* @public
|
|
2086
2126
|
*/
|
|
2087
|
-
messageId?: string;
|
|
2127
|
+
messageId?: string | undefined;
|
|
2088
2128
|
/**
|
|
2089
2129
|
* 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.
|
|
2090
2130
|
* @public
|
|
2091
2131
|
*/
|
|
2092
|
-
force?: boolean;
|
|
2132
|
+
force?: boolean | undefined;
|
|
2093
2133
|
}
|
|
2094
2134
|
/**
|
|
2095
2135
|
* @public
|
|
@@ -2104,37 +2144,37 @@ export interface PartialUpdateChannelSetOptions {
|
|
|
2104
2144
|
* The subject of the channel.
|
|
2105
2145
|
* @public
|
|
2106
2146
|
*/
|
|
2107
|
-
subject?: string;
|
|
2147
|
+
subject?: string | undefined;
|
|
2108
2148
|
/**
|
|
2109
2149
|
* The description of the channel.
|
|
2110
2150
|
* @public
|
|
2111
2151
|
*/
|
|
2112
|
-
description?: string;
|
|
2152
|
+
description?: string | undefined;
|
|
2113
2153
|
/**
|
|
2114
2154
|
* The URL of the channel's picture.
|
|
2115
2155
|
* @public
|
|
2116
2156
|
*/
|
|
2117
|
-
picture?: string;
|
|
2157
|
+
picture?: string | undefined;
|
|
2118
2158
|
/**
|
|
2119
2159
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
2120
2160
|
* @public
|
|
2121
2161
|
*/
|
|
2122
|
-
pictureColor?: string;
|
|
2162
|
+
pictureColor?: string | undefined;
|
|
2123
2163
|
/**
|
|
2124
2164
|
* The access level of the channel.
|
|
2125
2165
|
* @public
|
|
2126
2166
|
*/
|
|
2127
|
-
access?: ChannelAccess;
|
|
2167
|
+
access?: ChannelAccess | undefined;
|
|
2128
2168
|
/**
|
|
2129
2169
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
2130
2170
|
* @public
|
|
2131
2171
|
*/
|
|
2132
|
-
broadcast?: boolean;
|
|
2172
|
+
broadcast?: boolean | undefined;
|
|
2133
2173
|
/**
|
|
2134
2174
|
* An additional information that associated with this channel.
|
|
2135
2175
|
* @public
|
|
2136
2176
|
*/
|
|
2137
|
-
context?: ChannelContext;
|
|
2177
|
+
context?: ChannelContext | undefined;
|
|
2138
2178
|
}
|
|
2139
2179
|
/**
|
|
2140
2180
|
* @public
|
|
@@ -2168,22 +2208,22 @@ export interface PartialUpdateChannelInput {
|
|
|
2168
2208
|
* The unique identifier of the user when a service token is used.
|
|
2169
2209
|
* @public
|
|
2170
2210
|
*/
|
|
2171
|
-
userId?: string;
|
|
2211
|
+
userId?: string | undefined;
|
|
2172
2212
|
/**
|
|
2173
2213
|
* Set to true to suppress system messages about the updates. Default is false.
|
|
2174
2214
|
* @public
|
|
2175
2215
|
*/
|
|
2176
|
-
silent?: boolean;
|
|
2216
|
+
silent?: boolean | undefined;
|
|
2177
2217
|
/**
|
|
2178
2218
|
* Options to set specific fields in the channel.
|
|
2179
2219
|
* @public
|
|
2180
2220
|
*/
|
|
2181
|
-
set?: PartialUpdateChannelSetOptions;
|
|
2221
|
+
set?: PartialUpdateChannelSetOptions | undefined;
|
|
2182
2222
|
/**
|
|
2183
2223
|
* Options to unset specific fields in the channel.
|
|
2184
2224
|
* @public
|
|
2185
2225
|
*/
|
|
2186
|
-
unset?: (GroupChannelUnsetOptions)[];
|
|
2226
|
+
unset?: (GroupChannelUnsetOptions)[] | undefined;
|
|
2187
2227
|
}
|
|
2188
2228
|
/**
|
|
2189
2229
|
* @public
|
|
@@ -2195,16 +2235,16 @@ export interface PartialUpdateChannelOutput {
|
|
|
2195
2235
|
* @public
|
|
2196
2236
|
*/
|
|
2197
2237
|
export interface PartialUpdateMessageSetInput {
|
|
2198
|
-
text?: string;
|
|
2199
|
-
elements?: (Element)[];
|
|
2200
|
-
attachments?: (MessageAttachment)[];
|
|
2201
|
-
quote?: MessageQuote;
|
|
2202
|
-
forward?: MessageForward;
|
|
2238
|
+
text?: string | undefined;
|
|
2239
|
+
elements?: (Element)[] | undefined;
|
|
2240
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2241
|
+
quote?: MessageQuote | undefined;
|
|
2242
|
+
forward?: MessageForward | undefined;
|
|
2203
2243
|
/**
|
|
2204
2244
|
* A list of user IDs mentioned in the message.
|
|
2205
2245
|
* @public
|
|
2206
2246
|
*/
|
|
2207
|
-
mentions?: (string)[];
|
|
2247
|
+
mentions?: (string)[] | undefined;
|
|
2208
2248
|
}
|
|
2209
2249
|
/**
|
|
2210
2250
|
* @public
|
|
@@ -2240,22 +2280,22 @@ export interface PartialUpdateMessageInput {
|
|
|
2240
2280
|
* The unique identifier of the user when a service token is used.
|
|
2241
2281
|
* @public
|
|
2242
2282
|
*/
|
|
2243
|
-
userId?: string;
|
|
2283
|
+
userId?: string | undefined;
|
|
2244
2284
|
/**
|
|
2245
2285
|
* Fields to set during the partial update.
|
|
2246
2286
|
* @public
|
|
2247
2287
|
*/
|
|
2248
|
-
set?: PartialUpdateMessageSetInput;
|
|
2288
|
+
set?: PartialUpdateMessageSetInput | undefined;
|
|
2249
2289
|
/**
|
|
2250
2290
|
* Fields to unset during the partial update.
|
|
2251
2291
|
* @public
|
|
2252
2292
|
*/
|
|
2253
|
-
unset?: (MessageUnsetFields)[];
|
|
2293
|
+
unset?: (MessageUnsetFields)[] | undefined;
|
|
2254
2294
|
/**
|
|
2255
2295
|
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2256
2296
|
* @public
|
|
2257
2297
|
*/
|
|
2258
|
-
silent?: boolean;
|
|
2298
|
+
silent?: boolean | undefined;
|
|
2259
2299
|
}
|
|
2260
2300
|
/**
|
|
2261
2301
|
* @public
|
|
@@ -2276,12 +2316,12 @@ export interface PinChannelInput {
|
|
|
2276
2316
|
* The unique identifier of the user when a service token is used.
|
|
2277
2317
|
* @public
|
|
2278
2318
|
*/
|
|
2279
|
-
userId?: string;
|
|
2319
|
+
userId?: string | undefined;
|
|
2280
2320
|
/**
|
|
2281
2321
|
* 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.
|
|
2282
2322
|
* @public
|
|
2283
2323
|
*/
|
|
2284
|
-
force?: boolean;
|
|
2324
|
+
force?: boolean | undefined;
|
|
2285
2325
|
}
|
|
2286
2326
|
/**
|
|
2287
2327
|
* @public
|
|
@@ -2313,22 +2353,22 @@ export interface PinMessageInput {
|
|
|
2313
2353
|
* The unique identifier of the user when a service token is used.
|
|
2314
2354
|
* @public
|
|
2315
2355
|
*/
|
|
2316
|
-
userId?: string;
|
|
2356
|
+
userId?: string | undefined;
|
|
2317
2357
|
/**
|
|
2318
2358
|
* 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.
|
|
2319
2359
|
* @public
|
|
2320
2360
|
*/
|
|
2321
|
-
expiresAfter?: number;
|
|
2361
|
+
expiresAfter?: number | undefined;
|
|
2322
2362
|
/**
|
|
2323
2363
|
* 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.
|
|
2324
2364
|
* @public
|
|
2325
2365
|
*/
|
|
2326
|
-
expiresAt?: string;
|
|
2366
|
+
expiresAt?: string | undefined;
|
|
2327
2367
|
/**
|
|
2328
2368
|
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2329
2369
|
* @public
|
|
2330
2370
|
*/
|
|
2331
|
-
silent?: boolean;
|
|
2371
|
+
silent?: boolean | undefined;
|
|
2332
2372
|
}
|
|
2333
2373
|
/**
|
|
2334
2374
|
* @public
|
|
@@ -2343,23 +2383,23 @@ export interface QueryChannelsInput {
|
|
|
2343
2383
|
* The unique identifier of the tenant when a service token is used.
|
|
2344
2384
|
* @public
|
|
2345
2385
|
*/
|
|
2346
|
-
companyId?: string;
|
|
2386
|
+
companyId?: string | undefined;
|
|
2347
2387
|
/**
|
|
2348
2388
|
* The unique identifier of the user when a service or PBX token is used.
|
|
2349
2389
|
* @public
|
|
2350
2390
|
*/
|
|
2351
|
-
userId?: string;
|
|
2352
|
-
query?: ChannelsQuery;
|
|
2391
|
+
userId?: string | undefined;
|
|
2392
|
+
query?: ChannelsQuery | undefined;
|
|
2353
2393
|
/**
|
|
2354
2394
|
* The maximum number of channels to return. The value must be between 1 and 30.
|
|
2355
2395
|
* @public
|
|
2356
2396
|
*/
|
|
2357
|
-
limit?: number;
|
|
2397
|
+
limit?: number | undefined;
|
|
2358
2398
|
/**
|
|
2359
2399
|
* The offset from which to start listing channels. The value must be between 0 and 1000.
|
|
2360
2400
|
* @public
|
|
2361
2401
|
*/
|
|
2362
|
-
offset?: number;
|
|
2402
|
+
offset?: number | undefined;
|
|
2363
2403
|
}
|
|
2364
2404
|
/**
|
|
2365
2405
|
* @public
|
|
@@ -2427,12 +2467,12 @@ export interface SendGiphyInput {
|
|
|
2427
2467
|
* The unique identifier of the user when a service token is used.
|
|
2428
2468
|
* @public
|
|
2429
2469
|
*/
|
|
2430
|
-
userId?: string;
|
|
2470
|
+
userId?: string | undefined;
|
|
2431
2471
|
/**
|
|
2432
2472
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
2433
2473
|
* @public
|
|
2434
2474
|
*/
|
|
2435
|
-
messageId?: string;
|
|
2475
|
+
messageId?: string | undefined;
|
|
2436
2476
|
/**
|
|
2437
2477
|
* Details of the Giphy message to be sent.
|
|
2438
2478
|
* @public
|
|
@@ -2449,21 +2489,21 @@ export interface SendGiphyOutput {
|
|
|
2449
2489
|
* @public
|
|
2450
2490
|
*/
|
|
2451
2491
|
export interface SendMessageInput {
|
|
2452
|
-
text?: string;
|
|
2453
|
-
elements?: (Element)[];
|
|
2454
|
-
attachments?: (MessageAttachment)[];
|
|
2455
|
-
quote?: MessageQuote;
|
|
2456
|
-
forward?: MessageForward;
|
|
2492
|
+
text?: string | undefined;
|
|
2493
|
+
elements?: (Element)[] | undefined;
|
|
2494
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2495
|
+
quote?: MessageQuote | undefined;
|
|
2496
|
+
forward?: MessageForward | undefined;
|
|
2457
2497
|
/**
|
|
2458
2498
|
* The unique identifier of the message. If not provided, an ID will be auto-generated.
|
|
2459
2499
|
* @public
|
|
2460
2500
|
*/
|
|
2461
|
-
messageId?: string;
|
|
2501
|
+
messageId?: string | undefined;
|
|
2462
2502
|
/**
|
|
2463
2503
|
* A list of user IDs mentioned in the message.
|
|
2464
2504
|
* @public
|
|
2465
2505
|
*/
|
|
2466
|
-
mentions?: (string)[];
|
|
2506
|
+
mentions?: (string)[] | undefined;
|
|
2467
2507
|
/**
|
|
2468
2508
|
* The unique identifier of the channel to which the message is sent.
|
|
2469
2509
|
* @public
|
|
@@ -2473,7 +2513,7 @@ export interface SendMessageInput {
|
|
|
2473
2513
|
* The unique identifier of the user when a service token is used.
|
|
2474
2514
|
* @public
|
|
2475
2515
|
*/
|
|
2476
|
-
userId?: string;
|
|
2516
|
+
userId?: string | undefined;
|
|
2477
2517
|
}
|
|
2478
2518
|
/**
|
|
2479
2519
|
* @public
|
|
@@ -2504,7 +2544,7 @@ export interface SendMessageReactionInput {
|
|
|
2504
2544
|
* The unique identifier of the user when a service token is used.
|
|
2505
2545
|
* @public
|
|
2506
2546
|
*/
|
|
2507
|
-
userId?: string;
|
|
2547
|
+
userId?: string | undefined;
|
|
2508
2548
|
}
|
|
2509
2549
|
/**
|
|
2510
2550
|
* @public
|
|
@@ -2524,7 +2564,7 @@ export interface SendTypingStartInput {
|
|
|
2524
2564
|
* The unique identifier of the user when a service token is used.
|
|
2525
2565
|
* @public
|
|
2526
2566
|
*/
|
|
2527
|
-
userId?: string;
|
|
2567
|
+
userId?: string | undefined;
|
|
2528
2568
|
}
|
|
2529
2569
|
/**
|
|
2530
2570
|
* @public
|
|
@@ -2544,7 +2584,7 @@ export interface SendTypingStopInput {
|
|
|
2544
2584
|
* The unique identifier of the user when a service token is used.
|
|
2545
2585
|
* @public
|
|
2546
2586
|
*/
|
|
2547
|
-
userId?: string;
|
|
2587
|
+
userId?: string | undefined;
|
|
2548
2588
|
}
|
|
2549
2589
|
/**
|
|
2550
2590
|
* @public
|
|
@@ -2564,7 +2604,7 @@ export interface ShowChannelInput {
|
|
|
2564
2604
|
* The unique identifier of the user when a service token is used.
|
|
2565
2605
|
* @public
|
|
2566
2606
|
*/
|
|
2567
|
-
userId?: string;
|
|
2607
|
+
userId?: string | undefined;
|
|
2568
2608
|
}
|
|
2569
2609
|
/**
|
|
2570
2610
|
* @public
|
|
@@ -2584,7 +2624,7 @@ export interface TagChannelInput {
|
|
|
2584
2624
|
* The unique identifier of the user when a service token is used.
|
|
2585
2625
|
* @public
|
|
2586
2626
|
*/
|
|
2587
|
-
userId?: string;
|
|
2627
|
+
userId?: string | undefined;
|
|
2588
2628
|
/**
|
|
2589
2629
|
* The unique identifier of the tag to add to the channel.
|
|
2590
2630
|
* @public
|
|
@@ -2594,7 +2634,7 @@ export interface TagChannelInput {
|
|
|
2594
2634
|
* 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.
|
|
2595
2635
|
* @public
|
|
2596
2636
|
*/
|
|
2597
|
-
force?: boolean;
|
|
2637
|
+
force?: boolean | undefined;
|
|
2598
2638
|
}
|
|
2599
2639
|
/**
|
|
2600
2640
|
* @public
|
|
@@ -2646,7 +2686,7 @@ export interface TriggerMessageActionInput {
|
|
|
2646
2686
|
* The unique identifier of the user when a service token is used.
|
|
2647
2687
|
* @public
|
|
2648
2688
|
*/
|
|
2649
|
-
userId?: string;
|
|
2689
|
+
userId?: string | undefined;
|
|
2650
2690
|
}
|
|
2651
2691
|
/**
|
|
2652
2692
|
* @public
|
|
@@ -2667,7 +2707,7 @@ export interface UnpinChannelInput {
|
|
|
2667
2707
|
* The unique identifier of the user when a service token is used.
|
|
2668
2708
|
* @public
|
|
2669
2709
|
*/
|
|
2670
|
-
userId?: string;
|
|
2710
|
+
userId?: string | undefined;
|
|
2671
2711
|
}
|
|
2672
2712
|
/**
|
|
2673
2713
|
* @public
|
|
@@ -2688,12 +2728,12 @@ export interface UnpinMessageInput {
|
|
|
2688
2728
|
* The unique identifier of the user when a service token is used.
|
|
2689
2729
|
* @public
|
|
2690
2730
|
*/
|
|
2691
|
-
userId?: string;
|
|
2731
|
+
userId?: string | undefined;
|
|
2692
2732
|
/**
|
|
2693
2733
|
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2694
2734
|
* @public
|
|
2695
2735
|
*/
|
|
2696
|
-
silent?: boolean;
|
|
2736
|
+
silent?: boolean | undefined;
|
|
2697
2737
|
}
|
|
2698
2738
|
/**
|
|
2699
2739
|
* @public
|
|
@@ -2713,7 +2753,7 @@ export interface UntagChannelInput {
|
|
|
2713
2753
|
* The unique identifier of the user when a service token is used.
|
|
2714
2754
|
* @public
|
|
2715
2755
|
*/
|
|
2716
|
-
userId?: string;
|
|
2756
|
+
userId?: string | undefined;
|
|
2717
2757
|
/**
|
|
2718
2758
|
* The unique identifier of the tag to remove from the channel.
|
|
2719
2759
|
* @public
|
|
@@ -2733,37 +2773,37 @@ export interface UpdateChannelInput {
|
|
|
2733
2773
|
* The subject of the channel.
|
|
2734
2774
|
* @public
|
|
2735
2775
|
*/
|
|
2736
|
-
subject?: string;
|
|
2776
|
+
subject?: string | undefined;
|
|
2737
2777
|
/**
|
|
2738
2778
|
* The description of the channel.
|
|
2739
2779
|
* @public
|
|
2740
2780
|
*/
|
|
2741
|
-
description?: string;
|
|
2781
|
+
description?: string | undefined;
|
|
2742
2782
|
/**
|
|
2743
2783
|
* The URL of the channel's picture.
|
|
2744
2784
|
* @public
|
|
2745
2785
|
*/
|
|
2746
|
-
picture?: string;
|
|
2786
|
+
picture?: string | undefined;
|
|
2747
2787
|
/**
|
|
2748
2788
|
* The dominant color of the channel's picture, represented by a hex value.
|
|
2749
2789
|
* @public
|
|
2750
2790
|
*/
|
|
2751
|
-
pictureColor?: string;
|
|
2791
|
+
pictureColor?: string | undefined;
|
|
2752
2792
|
/**
|
|
2753
2793
|
* The access level of the channel.
|
|
2754
2794
|
* @public
|
|
2755
2795
|
*/
|
|
2756
|
-
access?: ChannelAccess;
|
|
2796
|
+
access?: ChannelAccess | undefined;
|
|
2757
2797
|
/**
|
|
2758
2798
|
* Indicates if the channel is broadcast-only. Default is false.
|
|
2759
2799
|
* @public
|
|
2760
2800
|
*/
|
|
2761
|
-
broadcast?: boolean;
|
|
2801
|
+
broadcast?: boolean | undefined;
|
|
2762
2802
|
/**
|
|
2763
2803
|
* An additional information that associated with this channel.
|
|
2764
2804
|
* @public
|
|
2765
2805
|
*/
|
|
2766
|
-
context?: ChannelContext;
|
|
2806
|
+
context?: ChannelContext | undefined;
|
|
2767
2807
|
/**
|
|
2768
2808
|
* The unique identifier of the channel to be updated.
|
|
2769
2809
|
* @public
|
|
@@ -2773,12 +2813,12 @@ export interface UpdateChannelInput {
|
|
|
2773
2813
|
* The unique identifier of the user when a service token is used.
|
|
2774
2814
|
* @public
|
|
2775
2815
|
*/
|
|
2776
|
-
userId?: string;
|
|
2816
|
+
userId?: string | undefined;
|
|
2777
2817
|
/**
|
|
2778
2818
|
* Set to true to suppress system messages about the updates. Default is false.
|
|
2779
2819
|
* @public
|
|
2780
2820
|
*/
|
|
2781
|
-
silent?: boolean;
|
|
2821
|
+
silent?: boolean | undefined;
|
|
2782
2822
|
}
|
|
2783
2823
|
/**
|
|
2784
2824
|
* @public
|
|
@@ -2799,7 +2839,7 @@ export interface UpdateInboxTagInput {
|
|
|
2799
2839
|
* The unique identifier of the user when a service token is used.
|
|
2800
2840
|
* @public
|
|
2801
2841
|
*/
|
|
2802
|
-
userId?: string;
|
|
2842
|
+
userId?: string | undefined;
|
|
2803
2843
|
/**
|
|
2804
2844
|
* The name of the tag.
|
|
2805
2845
|
* @public
|
|
@@ -2816,11 +2856,11 @@ export interface UpdateInboxTagOutput {
|
|
|
2816
2856
|
* @public
|
|
2817
2857
|
*/
|
|
2818
2858
|
export interface UpdateMessageInput {
|
|
2819
|
-
text?: string;
|
|
2820
|
-
elements?: (Element)[];
|
|
2821
|
-
attachments?: (MessageAttachment)[];
|
|
2822
|
-
quote?: MessageQuote;
|
|
2823
|
-
forward?: MessageForward;
|
|
2859
|
+
text?: string | undefined;
|
|
2860
|
+
elements?: (Element)[] | undefined;
|
|
2861
|
+
attachments?: (MessageAttachment)[] | undefined;
|
|
2862
|
+
quote?: MessageQuote | undefined;
|
|
2863
|
+
forward?: MessageForward | undefined;
|
|
2824
2864
|
/**
|
|
2825
2865
|
* The unique identifier of the message to update.
|
|
2826
2866
|
* @public
|
|
@@ -2830,7 +2870,7 @@ export interface UpdateMessageInput {
|
|
|
2830
2870
|
* A list of user IDs mentioned in the message.
|
|
2831
2871
|
* @public
|
|
2832
2872
|
*/
|
|
2833
|
-
mentions?: (string)[];
|
|
2873
|
+
mentions?: (string)[] | undefined;
|
|
2834
2874
|
/**
|
|
2835
2875
|
* The unique identifier of the channel containing the message.
|
|
2836
2876
|
* @public
|
|
@@ -2840,12 +2880,12 @@ export interface UpdateMessageInput {
|
|
|
2840
2880
|
* The unique identifier of the user when a service token is used.
|
|
2841
2881
|
* @public
|
|
2842
2882
|
*/
|
|
2843
|
-
userId?: string;
|
|
2883
|
+
userId?: string | undefined;
|
|
2844
2884
|
/**
|
|
2845
2885
|
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2846
2886
|
* @public
|
|
2847
2887
|
*/
|
|
2848
|
-
silent?: boolean;
|
|
2888
|
+
silent?: boolean | undefined;
|
|
2849
2889
|
}
|
|
2850
2890
|
/**
|
|
2851
2891
|
* @public
|
|
@@ -2861,12 +2901,12 @@ export interface UploadFileOptions {
|
|
|
2861
2901
|
* File category. Channel files or conference recordings. Default: channels.
|
|
2862
2902
|
* @public
|
|
2863
2903
|
*/
|
|
2864
|
-
category?: ConversationFileCategory;
|
|
2904
|
+
category?: ConversationFileCategory | undefined;
|
|
2865
2905
|
/**
|
|
2866
2906
|
* The region in which you need to upload the file. It is only for s2s, in other cases it will be ignored.
|
|
2867
2907
|
* @public
|
|
2868
2908
|
*/
|
|
2869
|
-
region?: string;
|
|
2909
|
+
region?: string | undefined;
|
|
2870
2910
|
}
|
|
2871
2911
|
/**
|
|
2872
2912
|
* @public
|
|
@@ -2886,12 +2926,12 @@ export interface UploadFileInput {
|
|
|
2886
2926
|
* The unique identifier of the user when a service token is used.
|
|
2887
2927
|
* @public
|
|
2888
2928
|
*/
|
|
2889
|
-
userId?: string;
|
|
2929
|
+
userId?: string | undefined;
|
|
2890
2930
|
/**
|
|
2891
2931
|
* Additional options for the file upload.
|
|
2892
2932
|
* @public
|
|
2893
2933
|
*/
|
|
2894
|
-
options?: UploadFileOptions;
|
|
2934
|
+
options?: UploadFileOptions | undefined;
|
|
2895
2935
|
}
|
|
2896
2936
|
/**
|
|
2897
2937
|
* @public
|