@wildix/stream-client 4.1.6 → 4.1.7
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/models/enums.js +14 -8
- package/dist-cjs/schemas/schemas_0.js +156 -160
- package/dist-es/models/enums.js +13 -7
- package/dist-es/schemas/schemas_0.js +156 -160
- package/dist-types/commands/AddChannelMemberCommand.d.ts +0 -5
- package/dist-types/commands/AddChannelMembersCommand.d.ts +0 -5
- package/dist-types/commands/AssignChannelCommand.d.ts +0 -5
- package/dist-types/commands/CreateGroupChannelCommand.d.ts +7 -13
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +8 -9
- package/dist-types/commands/CreateSectionCommand.d.ts +0 -5
- package/dist-types/commands/DeleteChannelMemberCommand.d.ts +2 -8
- package/dist-types/commands/DeleteMessageCommand.d.ts +2 -8
- package/dist-types/commands/DeleteMessageReactionCommand.d.ts +2 -7
- package/dist-types/commands/DeleteSectionCommand.d.ts +2 -8
- package/dist-types/commands/GetChannelCommand.d.ts +4 -9
- package/dist-types/commands/GetChannelMemberCommand.d.ts +0 -5
- package/dist-types/commands/GetDirectChannelIdCommand.d.ts +0 -5
- package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +0 -5
- package/dist-types/commands/GetInboxCommand.d.ts +4 -9
- package/dist-types/commands/GetMessageCommand.d.ts +2 -7
- package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +4 -9
- package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +4 -9
- package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +4 -9
- package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +4 -9
- package/dist-types/commands/GetSmsChannelIdCommand.d.ts +0 -5
- package/dist-types/commands/GetTelephonyChannelIdCommand.d.ts +0 -5
- package/dist-types/commands/GetTokenCommand.d.ts +0 -5
- package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +0 -5
- package/dist-types/commands/GetWhatsAppChannelIdCommand.d.ts +0 -5
- package/dist-types/commands/HideChannelCommand.d.ts +2 -8
- package/dist-types/commands/JoinChannelCommand.d.ts +4 -9
- package/dist-types/commands/LeaveChannelCommand.d.ts +2 -8
- package/dist-types/commands/ListChannelMembersCommand.d.ts +0 -5
- package/dist-types/commands/ListChannelMembersReadStatusCommand.d.ts +0 -5
- package/dist-types/commands/ListChannelsCommand.d.ts +4 -9
- package/dist-types/commands/ListMentionsCommand.d.ts +2 -7
- package/dist-types/commands/ListMessagesCommand.d.ts +2 -7
- package/dist-types/commands/MarkReadCommand.d.ts +0 -5
- package/dist-types/commands/MarkUnreadCommand.d.ts +0 -5
- package/dist-types/commands/MoveChannelToSectionCommand.d.ts +0 -5
- package/dist-types/commands/MuteChannelCommand.d.ts +0 -5
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +8 -14
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +4 -7
- package/dist-types/commands/PinChannelCommand.d.ts +2 -8
- package/dist-types/commands/PinMessageCommand.d.ts +2 -7
- package/dist-types/commands/QueryChannelsCommand.d.ts +4 -9
- package/dist-types/commands/RemoveChannelFromSectionCommand.d.ts +0 -5
- package/dist-types/commands/RenameSectionCommand.d.ts +0 -5
- package/dist-types/commands/SearchChannelsCommand.d.ts +4 -9
- package/dist-types/commands/SearchMessagesCommand.d.ts +2 -7
- package/dist-types/commands/SendGiphyCommand.d.ts +2 -7
- package/dist-types/commands/SendMessageCommand.d.ts +4 -7
- package/dist-types/commands/SendMessageReactionCommand.d.ts +2 -7
- package/dist-types/commands/SendSystemMessageCommand.d.ts +2 -7
- package/dist-types/commands/SendTypingStartCommand.d.ts +2 -8
- package/dist-types/commands/SendTypingStopCommand.d.ts +2 -8
- package/dist-types/commands/ShowChannelCommand.d.ts +2 -8
- package/dist-types/commands/UnmuteChannelCommand.d.ts +0 -5
- package/dist-types/commands/UnpinChannelCommand.d.ts +2 -8
- package/dist-types/commands/UnpinMessageCommand.d.ts +2 -7
- package/dist-types/commands/UpdateChannelCommand.d.ts +7 -13
- package/dist-types/commands/UpdateMessageCommand.d.ts +4 -7
- package/dist-types/commands/UploadFileCommand.d.ts +0 -5
- package/dist-types/models/enums.d.ts +30 -16
- package/dist-types/models/models_0.d.ts +100 -1536
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole,
|
|
1
|
+
import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, SearchSort, SectionType } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -189,31 +189,6 @@ export interface ChannelMember {
|
|
|
189
189
|
* @public
|
|
190
190
|
*/
|
|
191
191
|
export interface AddChannelMemberOutput {
|
|
192
|
-
/**
|
|
193
|
-
* The request ID of the request.
|
|
194
|
-
* @public
|
|
195
|
-
*/
|
|
196
|
-
requestId?: string | undefined;
|
|
197
|
-
/**
|
|
198
|
-
* The duration of the request in milliseconds.
|
|
199
|
-
* @public
|
|
200
|
-
*/
|
|
201
|
-
requestDuration?: number | undefined;
|
|
202
|
-
/**
|
|
203
|
-
* Displays the applicable rate limits for the current request.
|
|
204
|
-
* @public
|
|
205
|
-
*/
|
|
206
|
-
rateLimit?: string | undefined;
|
|
207
|
-
/**
|
|
208
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
209
|
-
* @public
|
|
210
|
-
*/
|
|
211
|
-
rateLimitRemaining?: number | undefined;
|
|
212
|
-
/**
|
|
213
|
-
* Shows the time in seconds until the rate limit resets.
|
|
214
|
-
* @public
|
|
215
|
-
*/
|
|
216
|
-
rateLimitReset?: number | undefined;
|
|
217
192
|
/**
|
|
218
193
|
* Channel membership row.
|
|
219
194
|
* @public
|
|
@@ -253,31 +228,6 @@ export interface AddChannelMembersInput {
|
|
|
253
228
|
* @public
|
|
254
229
|
*/
|
|
255
230
|
export interface AddChannelMembersOutput {
|
|
256
|
-
/**
|
|
257
|
-
* The request ID of the request.
|
|
258
|
-
* @public
|
|
259
|
-
*/
|
|
260
|
-
requestId?: string | undefined;
|
|
261
|
-
/**
|
|
262
|
-
* The duration of the request in milliseconds.
|
|
263
|
-
* @public
|
|
264
|
-
*/
|
|
265
|
-
requestDuration?: number | undefined;
|
|
266
|
-
/**
|
|
267
|
-
* Displays the applicable rate limits for the current request.
|
|
268
|
-
* @public
|
|
269
|
-
*/
|
|
270
|
-
rateLimit?: string | undefined;
|
|
271
|
-
/**
|
|
272
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
273
|
-
* @public
|
|
274
|
-
*/
|
|
275
|
-
rateLimitRemaining?: number | undefined;
|
|
276
|
-
/**
|
|
277
|
-
* Shows the time in seconds until the rate limit resets.
|
|
278
|
-
* @public
|
|
279
|
-
*/
|
|
280
|
-
rateLimitReset?: number | undefined;
|
|
281
231
|
members: ChannelMember[];
|
|
282
232
|
}
|
|
283
233
|
/**
|
|
@@ -376,31 +326,6 @@ export interface AssignChannelInput {
|
|
|
376
326
|
* @public
|
|
377
327
|
*/
|
|
378
328
|
export interface AssignChannelOutput {
|
|
379
|
-
/**
|
|
380
|
-
* The request ID of the request.
|
|
381
|
-
* @public
|
|
382
|
-
*/
|
|
383
|
-
requestId?: string | undefined;
|
|
384
|
-
/**
|
|
385
|
-
* The duration of the request in milliseconds.
|
|
386
|
-
* @public
|
|
387
|
-
*/
|
|
388
|
-
requestDuration?: number | undefined;
|
|
389
|
-
/**
|
|
390
|
-
* Displays the applicable rate limits for the current request.
|
|
391
|
-
* @public
|
|
392
|
-
*/
|
|
393
|
-
rateLimit?: string | undefined;
|
|
394
|
-
/**
|
|
395
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
396
|
-
* @public
|
|
397
|
-
*/
|
|
398
|
-
rateLimitRemaining?: number | undefined;
|
|
399
|
-
/**
|
|
400
|
-
* Shows the time in seconds until the rate limit resets.
|
|
401
|
-
* @public
|
|
402
|
-
*/
|
|
403
|
-
rateLimitReset?: number | undefined;
|
|
404
329
|
assigneeId?: string | undefined;
|
|
405
330
|
serviceUri?: string | undefined;
|
|
406
331
|
}
|
|
@@ -537,6 +462,11 @@ export interface Channel {
|
|
|
537
462
|
service?: string | undefined;
|
|
538
463
|
serviceRecipient?: string | undefined;
|
|
539
464
|
telephony?: boolean | undefined;
|
|
465
|
+
/**
|
|
466
|
+
* The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
540
470
|
external?: boolean | undefined;
|
|
541
471
|
/**
|
|
542
472
|
* Message ids currently pinned at channel scope, newest pin first. Empty when nothing is pinned.
|
|
@@ -626,25 +556,20 @@ export interface Channel {
|
|
|
626
556
|
*/
|
|
627
557
|
wizyGuestViewOnly?: boolean | undefined;
|
|
628
558
|
/**
|
|
629
|
-
*
|
|
559
|
+
* The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
630
560
|
* @public
|
|
631
561
|
*/
|
|
632
|
-
|
|
562
|
+
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
633
563
|
/**
|
|
634
|
-
* The Messenger
|
|
564
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram. Written by kite from the inbound event, because the channel id hashes the sender's linked service and not the sender, and a reply has to name the sender it is sent from.
|
|
635
565
|
* @public
|
|
636
566
|
*/
|
|
637
|
-
|
|
567
|
+
messagingSenderId?: string | undefined;
|
|
638
568
|
/**
|
|
639
|
-
*
|
|
569
|
+
* Epoch seconds until which a reply still reaches the person. On Messenger and Instagram this is Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message; classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messagingReplyUntil > 0 && now > messagingReplyUntil` and shows nothing at 0. Absent on a channel with no reply window.
|
|
640
570
|
* @public
|
|
641
571
|
*/
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
* Epoch seconds until which a reply still reaches the person: Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message. classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messengerReplyUntil > 0 && now > messengerReplyUntil` and shows nothing at 0.
|
|
645
|
-
* @public
|
|
646
|
-
*/
|
|
647
|
-
messengerReplyUntil?: number | undefined;
|
|
572
|
+
messagingReplyUntil?: number | undefined;
|
|
648
573
|
}
|
|
649
574
|
/**
|
|
650
575
|
* Read pointer for one channel member.
|
|
@@ -762,25 +687,20 @@ export interface CreateGroupChannelInput {
|
|
|
762
687
|
*/
|
|
763
688
|
wizyGuestViewOnly?: boolean | undefined;
|
|
764
689
|
/**
|
|
765
|
-
*
|
|
766
|
-
* @public
|
|
767
|
-
*/
|
|
768
|
-
messenger?: boolean | undefined;
|
|
769
|
-
/**
|
|
770
|
-
* The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
690
|
+
* The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
771
691
|
* @public
|
|
772
692
|
*/
|
|
773
|
-
|
|
693
|
+
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
774
694
|
/**
|
|
775
|
-
* The Facebook Page ID the
|
|
695
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram. Written by kite from the inbound event, because the channel id hashes the sender's linked service and not the sender, and a reply has to name the sender it is sent from.
|
|
776
696
|
* @public
|
|
777
697
|
*/
|
|
778
|
-
|
|
698
|
+
messagingSenderId?: string | undefined;
|
|
779
699
|
/**
|
|
780
|
-
* Epoch seconds until which a reply still reaches the person
|
|
700
|
+
* Epoch seconds until which a reply still reaches the person. On Messenger and Instagram this is Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message; classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messagingReplyUntil > 0 && now > messagingReplyUntil` and shows nothing at 0. Absent on a channel with no reply window.
|
|
781
701
|
* @public
|
|
782
702
|
*/
|
|
783
|
-
|
|
703
|
+
messagingReplyUntil?: number | undefined;
|
|
784
704
|
/**
|
|
785
705
|
* Optional client-supplied channel id.
|
|
786
706
|
* @public
|
|
@@ -806,31 +726,6 @@ export interface CreateGroupChannelInput {
|
|
|
806
726
|
* @public
|
|
807
727
|
*/
|
|
808
728
|
export interface CreateGroupChannelOutput {
|
|
809
|
-
/**
|
|
810
|
-
* The request ID of the request.
|
|
811
|
-
* @public
|
|
812
|
-
*/
|
|
813
|
-
requestId?: string | undefined;
|
|
814
|
-
/**
|
|
815
|
-
* The duration of the request in milliseconds.
|
|
816
|
-
* @public
|
|
817
|
-
*/
|
|
818
|
-
requestDuration?: number | undefined;
|
|
819
|
-
/**
|
|
820
|
-
* Displays the applicable rate limits for the current request.
|
|
821
|
-
* @public
|
|
822
|
-
*/
|
|
823
|
-
rateLimit?: string | undefined;
|
|
824
|
-
/**
|
|
825
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
826
|
-
* @public
|
|
827
|
-
*/
|
|
828
|
-
rateLimitRemaining?: number | undefined;
|
|
829
|
-
/**
|
|
830
|
-
* Shows the time in seconds until the rate limit resets.
|
|
831
|
-
* @public
|
|
832
|
-
*/
|
|
833
|
-
rateLimitReset?: number | undefined;
|
|
834
729
|
channel: Channel;
|
|
835
730
|
}
|
|
836
731
|
/**
|
|
@@ -992,6 +887,16 @@ export interface InitialMessage {
|
|
|
992
887
|
*/
|
|
993
888
|
sms?: boolean | undefined;
|
|
994
889
|
smsStatus?: MessageSmsStatus | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
895
|
+
/**
|
|
896
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
995
900
|
/**
|
|
996
901
|
* Optional client-supplied message id. Auto-generated when omitted.
|
|
997
902
|
* @public
|
|
@@ -1055,6 +960,16 @@ export interface WelcomeMessage {
|
|
|
1055
960
|
*/
|
|
1056
961
|
sms?: boolean | undefined;
|
|
1057
962
|
smsStatus?: MessageSmsStatus | undefined;
|
|
963
|
+
/**
|
|
964
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
1058
973
|
/**
|
|
1059
974
|
* Optional client-supplied message id. Auto-generated when omitted.
|
|
1060
975
|
* @public
|
|
@@ -1103,31 +1018,6 @@ export interface CreateKiteChannelInput {
|
|
|
1103
1018
|
* @public
|
|
1104
1019
|
*/
|
|
1105
1020
|
export interface CreateKiteChannelOutput {
|
|
1106
|
-
/**
|
|
1107
|
-
* The request ID of the request.
|
|
1108
|
-
* @public
|
|
1109
|
-
*/
|
|
1110
|
-
requestId?: string | undefined;
|
|
1111
|
-
/**
|
|
1112
|
-
* The duration of the request in milliseconds.
|
|
1113
|
-
* @public
|
|
1114
|
-
*/
|
|
1115
|
-
requestDuration?: number | undefined;
|
|
1116
|
-
/**
|
|
1117
|
-
* Displays the applicable rate limits for the current request.
|
|
1118
|
-
* @public
|
|
1119
|
-
*/
|
|
1120
|
-
rateLimit?: string | undefined;
|
|
1121
|
-
/**
|
|
1122
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1123
|
-
* @public
|
|
1124
|
-
*/
|
|
1125
|
-
rateLimitRemaining?: number | undefined;
|
|
1126
|
-
/**
|
|
1127
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1128
|
-
* @public
|
|
1129
|
-
*/
|
|
1130
|
-
rateLimitReset?: number | undefined;
|
|
1131
1021
|
channel: Channel;
|
|
1132
1022
|
}
|
|
1133
1023
|
/**
|
|
@@ -1201,31 +1091,6 @@ export interface Section {
|
|
|
1201
1091
|
* @public
|
|
1202
1092
|
*/
|
|
1203
1093
|
export interface CreateSectionOutput {
|
|
1204
|
-
/**
|
|
1205
|
-
* The request ID of the request.
|
|
1206
|
-
* @public
|
|
1207
|
-
*/
|
|
1208
|
-
requestId?: string | undefined;
|
|
1209
|
-
/**
|
|
1210
|
-
* The duration of the request in milliseconds.
|
|
1211
|
-
* @public
|
|
1212
|
-
*/
|
|
1213
|
-
requestDuration?: number | undefined;
|
|
1214
|
-
/**
|
|
1215
|
-
* Displays the applicable rate limits for the current request.
|
|
1216
|
-
* @public
|
|
1217
|
-
*/
|
|
1218
|
-
rateLimit?: string | undefined;
|
|
1219
|
-
/**
|
|
1220
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1221
|
-
* @public
|
|
1222
|
-
*/
|
|
1223
|
-
rateLimitRemaining?: number | undefined;
|
|
1224
|
-
/**
|
|
1225
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1226
|
-
* @public
|
|
1227
|
-
*/
|
|
1228
|
-
rateLimitReset?: number | undefined;
|
|
1229
1094
|
/**
|
|
1230
1095
|
* Inbox section with metadata, channel count, and unread counters.
|
|
1231
1096
|
* @public
|
|
@@ -1278,31 +1143,6 @@ export interface DeleteChannelMemberInput {
|
|
|
1278
1143
|
* @public
|
|
1279
1144
|
*/
|
|
1280
1145
|
export interface DeleteChannelMemberOutput {
|
|
1281
|
-
/**
|
|
1282
|
-
* The request ID of the request.
|
|
1283
|
-
* @public
|
|
1284
|
-
*/
|
|
1285
|
-
requestId?: string | undefined;
|
|
1286
|
-
/**
|
|
1287
|
-
* The duration of the request in milliseconds.
|
|
1288
|
-
* @public
|
|
1289
|
-
*/
|
|
1290
|
-
requestDuration?: number | undefined;
|
|
1291
|
-
/**
|
|
1292
|
-
* Displays the applicable rate limits for the current request.
|
|
1293
|
-
* @public
|
|
1294
|
-
*/
|
|
1295
|
-
rateLimit?: string | undefined;
|
|
1296
|
-
/**
|
|
1297
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1298
|
-
* @public
|
|
1299
|
-
*/
|
|
1300
|
-
rateLimitRemaining?: number | undefined;
|
|
1301
|
-
/**
|
|
1302
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1303
|
-
* @public
|
|
1304
|
-
*/
|
|
1305
|
-
rateLimitReset?: number | undefined;
|
|
1306
1146
|
}
|
|
1307
1147
|
/**
|
|
1308
1148
|
* @public
|
|
@@ -1329,31 +1169,6 @@ export interface DeleteMessageInput {
|
|
|
1329
1169
|
* @public
|
|
1330
1170
|
*/
|
|
1331
1171
|
export interface DeleteMessageOutput {
|
|
1332
|
-
/**
|
|
1333
|
-
* The request ID of the request.
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
requestId?: string | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* The duration of the request in milliseconds.
|
|
1339
|
-
* @public
|
|
1340
|
-
*/
|
|
1341
|
-
requestDuration?: number | undefined;
|
|
1342
|
-
/**
|
|
1343
|
-
* Displays the applicable rate limits for the current request.
|
|
1344
|
-
* @public
|
|
1345
|
-
*/
|
|
1346
|
-
rateLimit?: string | undefined;
|
|
1347
|
-
/**
|
|
1348
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1349
|
-
* @public
|
|
1350
|
-
*/
|
|
1351
|
-
rateLimitRemaining?: number | undefined;
|
|
1352
|
-
/**
|
|
1353
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1354
|
-
* @public
|
|
1355
|
-
*/
|
|
1356
|
-
rateLimitReset?: number | undefined;
|
|
1357
1172
|
}
|
|
1358
1173
|
/**
|
|
1359
1174
|
* @public
|
|
@@ -1632,12 +1447,16 @@ export interface Message {
|
|
|
1632
1447
|
* @public
|
|
1633
1448
|
*/
|
|
1634
1449
|
pollId?: string | undefined;
|
|
1635
|
-
messenger?: boolean | undefined;
|
|
1636
1450
|
/**
|
|
1637
|
-
*
|
|
1451
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
1452
|
+
* @public
|
|
1453
|
+
*/
|
|
1454
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
1455
|
+
/**
|
|
1456
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
1638
1457
|
* @public
|
|
1639
1458
|
*/
|
|
1640
|
-
|
|
1459
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
1641
1460
|
}
|
|
1642
1461
|
/**
|
|
1643
1462
|
* @public
|
|
@@ -1648,31 +1467,6 @@ export interface DeleteMessageReactionOutput {
|
|
|
1648
1467
|
* @public
|
|
1649
1468
|
*/
|
|
1650
1469
|
message: Message;
|
|
1651
|
-
/**
|
|
1652
|
-
* The request ID of the request.
|
|
1653
|
-
* @public
|
|
1654
|
-
*/
|
|
1655
|
-
requestId?: string | undefined;
|
|
1656
|
-
/**
|
|
1657
|
-
* The duration of the request in milliseconds.
|
|
1658
|
-
* @public
|
|
1659
|
-
*/
|
|
1660
|
-
requestDuration?: number | undefined;
|
|
1661
|
-
/**
|
|
1662
|
-
* Displays the applicable rate limits for the current request.
|
|
1663
|
-
* @public
|
|
1664
|
-
*/
|
|
1665
|
-
rateLimit?: string | undefined;
|
|
1666
|
-
/**
|
|
1667
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1668
|
-
* @public
|
|
1669
|
-
*/
|
|
1670
|
-
rateLimitRemaining?: number | undefined;
|
|
1671
|
-
/**
|
|
1672
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1673
|
-
* @public
|
|
1674
|
-
*/
|
|
1675
|
-
rateLimitReset?: number | undefined;
|
|
1676
1470
|
}
|
|
1677
1471
|
/**
|
|
1678
1472
|
* @public
|
|
@@ -1698,31 +1492,6 @@ export interface DeleteSectionInput {
|
|
|
1698
1492
|
* @public
|
|
1699
1493
|
*/
|
|
1700
1494
|
export interface DeleteSectionOutput {
|
|
1701
|
-
/**
|
|
1702
|
-
* The request ID of the request.
|
|
1703
|
-
* @public
|
|
1704
|
-
*/
|
|
1705
|
-
requestId?: string | undefined;
|
|
1706
|
-
/**
|
|
1707
|
-
* The duration of the request in milliseconds.
|
|
1708
|
-
* @public
|
|
1709
|
-
*/
|
|
1710
|
-
requestDuration?: number | undefined;
|
|
1711
|
-
/**
|
|
1712
|
-
* Displays the applicable rate limits for the current request.
|
|
1713
|
-
* @public
|
|
1714
|
-
*/
|
|
1715
|
-
rateLimit?: string | undefined;
|
|
1716
|
-
/**
|
|
1717
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1718
|
-
* @public
|
|
1719
|
-
*/
|
|
1720
|
-
rateLimitRemaining?: number | undefined;
|
|
1721
|
-
/**
|
|
1722
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1723
|
-
* @public
|
|
1724
|
-
*/
|
|
1725
|
-
rateLimitReset?: number | undefined;
|
|
1726
1495
|
}
|
|
1727
1496
|
/**
|
|
1728
1497
|
* @public
|
|
@@ -1748,31 +1517,6 @@ export interface GetChannelInput {
|
|
|
1748
1517
|
* @public
|
|
1749
1518
|
*/
|
|
1750
1519
|
export interface GetChannelOutput {
|
|
1751
|
-
/**
|
|
1752
|
-
* The request ID of the request.
|
|
1753
|
-
* @public
|
|
1754
|
-
*/
|
|
1755
|
-
requestId?: string | undefined;
|
|
1756
|
-
/**
|
|
1757
|
-
* The duration of the request in milliseconds.
|
|
1758
|
-
* @public
|
|
1759
|
-
*/
|
|
1760
|
-
requestDuration?: number | undefined;
|
|
1761
|
-
/**
|
|
1762
|
-
* Displays the applicable rate limits for the current request.
|
|
1763
|
-
* @public
|
|
1764
|
-
*/
|
|
1765
|
-
rateLimit?: string | undefined;
|
|
1766
|
-
/**
|
|
1767
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1768
|
-
* @public
|
|
1769
|
-
*/
|
|
1770
|
-
rateLimitRemaining?: number | undefined;
|
|
1771
|
-
/**
|
|
1772
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1773
|
-
* @public
|
|
1774
|
-
*/
|
|
1775
|
-
rateLimitReset?: number | undefined;
|
|
1776
1520
|
channel: Channel;
|
|
1777
1521
|
}
|
|
1778
1522
|
/**
|
|
@@ -1800,31 +1544,6 @@ export interface GetChannelMemberInput {
|
|
|
1800
1544
|
* @public
|
|
1801
1545
|
*/
|
|
1802
1546
|
export interface GetChannelMemberOutput {
|
|
1803
|
-
/**
|
|
1804
|
-
* The request ID of the request.
|
|
1805
|
-
* @public
|
|
1806
|
-
*/
|
|
1807
|
-
requestId?: string | undefined;
|
|
1808
|
-
/**
|
|
1809
|
-
* The duration of the request in milliseconds.
|
|
1810
|
-
* @public
|
|
1811
|
-
*/
|
|
1812
|
-
requestDuration?: number | undefined;
|
|
1813
|
-
/**
|
|
1814
|
-
* Displays the applicable rate limits for the current request.
|
|
1815
|
-
* @public
|
|
1816
|
-
*/
|
|
1817
|
-
rateLimit?: string | undefined;
|
|
1818
|
-
/**
|
|
1819
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1820
|
-
* @public
|
|
1821
|
-
*/
|
|
1822
|
-
rateLimitRemaining?: number | undefined;
|
|
1823
|
-
/**
|
|
1824
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1825
|
-
* @public
|
|
1826
|
-
*/
|
|
1827
|
-
rateLimitReset?: number | undefined;
|
|
1828
1547
|
/**
|
|
1829
1548
|
* Channel membership row.
|
|
1830
1549
|
* @public
|
|
@@ -1856,31 +1575,6 @@ export interface GetDirectChannelIdInput {
|
|
|
1856
1575
|
* @public
|
|
1857
1576
|
*/
|
|
1858
1577
|
export interface GetDirectChannelIdOutput {
|
|
1859
|
-
/**
|
|
1860
|
-
* The request ID of the request.
|
|
1861
|
-
* @public
|
|
1862
|
-
*/
|
|
1863
|
-
requestId?: string | undefined;
|
|
1864
|
-
/**
|
|
1865
|
-
* The duration of the request in milliseconds.
|
|
1866
|
-
* @public
|
|
1867
|
-
*/
|
|
1868
|
-
requestDuration?: number | undefined;
|
|
1869
|
-
/**
|
|
1870
|
-
* Displays the applicable rate limits for the current request.
|
|
1871
|
-
* @public
|
|
1872
|
-
*/
|
|
1873
|
-
rateLimit?: string | undefined;
|
|
1874
|
-
/**
|
|
1875
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1876
|
-
* @public
|
|
1877
|
-
*/
|
|
1878
|
-
rateLimitRemaining?: number | undefined;
|
|
1879
|
-
/**
|
|
1880
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1881
|
-
* @public
|
|
1882
|
-
*/
|
|
1883
|
-
rateLimitReset?: number | undefined;
|
|
1884
1578
|
/**
|
|
1885
1579
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
1886
1580
|
* @public
|
|
@@ -1927,31 +1621,6 @@ export interface GetFilePresignedDownloadUrlInput {
|
|
|
1927
1621
|
* @public
|
|
1928
1622
|
*/
|
|
1929
1623
|
export interface GetFilePresignedDownloadUrlOutput {
|
|
1930
|
-
/**
|
|
1931
|
-
* The request ID of the request.
|
|
1932
|
-
* @public
|
|
1933
|
-
*/
|
|
1934
|
-
requestId?: string | undefined;
|
|
1935
|
-
/**
|
|
1936
|
-
* The duration of the request in milliseconds.
|
|
1937
|
-
* @public
|
|
1938
|
-
*/
|
|
1939
|
-
requestDuration?: number | undefined;
|
|
1940
|
-
/**
|
|
1941
|
-
* Displays the applicable rate limits for the current request.
|
|
1942
|
-
* @public
|
|
1943
|
-
*/
|
|
1944
|
-
rateLimit?: string | undefined;
|
|
1945
|
-
/**
|
|
1946
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
1947
|
-
* @public
|
|
1948
|
-
*/
|
|
1949
|
-
rateLimitRemaining?: number | undefined;
|
|
1950
|
-
/**
|
|
1951
|
-
* Shows the time in seconds until the rate limit resets.
|
|
1952
|
-
* @public
|
|
1953
|
-
*/
|
|
1954
|
-
rateLimitReset?: number | undefined;
|
|
1955
1624
|
/**
|
|
1956
1625
|
* Presigned URL for downloading the file.
|
|
1957
1626
|
* @public
|
|
@@ -2098,6 +1767,11 @@ export interface InboxChannel {
|
|
|
2098
1767
|
service?: string | undefined;
|
|
2099
1768
|
serviceRecipient?: string | undefined;
|
|
2100
1769
|
telephony?: boolean | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
2101
1775
|
external?: boolean | undefined;
|
|
2102
1776
|
/**
|
|
2103
1777
|
* Message ids currently pinned at channel scope, newest pin first. Empty when nothing is pinned.
|
|
@@ -2187,25 +1861,20 @@ export interface InboxChannel {
|
|
|
2187
1861
|
*/
|
|
2188
1862
|
wizyGuestViewOnly?: boolean | undefined;
|
|
2189
1863
|
/**
|
|
2190
|
-
*
|
|
2191
|
-
* @public
|
|
2192
|
-
*/
|
|
2193
|
-
messenger?: boolean | undefined;
|
|
2194
|
-
/**
|
|
2195
|
-
* The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
1864
|
+
* The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
2196
1865
|
* @public
|
|
2197
1866
|
*/
|
|
2198
|
-
|
|
1867
|
+
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
2199
1868
|
/**
|
|
2200
|
-
* The Facebook Page ID the
|
|
1869
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram. Written by kite from the inbound event, because the channel id hashes the sender's linked service and not the sender, and a reply has to name the sender it is sent from.
|
|
2201
1870
|
* @public
|
|
2202
1871
|
*/
|
|
2203
|
-
|
|
1872
|
+
messagingSenderId?: string | undefined;
|
|
2204
1873
|
/**
|
|
2205
|
-
* Epoch seconds until which a reply still reaches the person
|
|
1874
|
+
* Epoch seconds until which a reply still reaches the person. On Messenger and Instagram this is Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message; classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messagingReplyUntil > 0 && now > messagingReplyUntil` and shows nothing at 0. Absent on a channel with no reply window.
|
|
2206
1875
|
* @public
|
|
2207
1876
|
*/
|
|
2208
|
-
|
|
1877
|
+
messagingReplyUntil?: number | undefined;
|
|
2209
1878
|
/**
|
|
2210
1879
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
2211
1880
|
* @public
|
|
@@ -2216,31 +1885,6 @@ export interface InboxChannel {
|
|
|
2216
1885
|
* @public
|
|
2217
1886
|
*/
|
|
2218
1887
|
export interface GetInboxOutput {
|
|
2219
|
-
/**
|
|
2220
|
-
* The request ID of the request.
|
|
2221
|
-
* @public
|
|
2222
|
-
*/
|
|
2223
|
-
requestId?: string | undefined;
|
|
2224
|
-
/**
|
|
2225
|
-
* The duration of the request in milliseconds.
|
|
2226
|
-
* @public
|
|
2227
|
-
*/
|
|
2228
|
-
requestDuration?: number | undefined;
|
|
2229
|
-
/**
|
|
2230
|
-
* Displays the applicable rate limits for the current request.
|
|
2231
|
-
* @public
|
|
2232
|
-
*/
|
|
2233
|
-
rateLimit?: string | undefined;
|
|
2234
|
-
/**
|
|
2235
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2236
|
-
* @public
|
|
2237
|
-
*/
|
|
2238
|
-
rateLimitRemaining?: number | undefined;
|
|
2239
|
-
/**
|
|
2240
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2241
|
-
* @public
|
|
2242
|
-
*/
|
|
2243
|
-
rateLimitReset?: number | undefined;
|
|
2244
1888
|
/**
|
|
2245
1889
|
* Recent channels with per-user state and last-message preview.
|
|
2246
1890
|
* @public
|
|
@@ -2278,32 +1922,7 @@ export interface GetMessageInput {
|
|
|
2278
1922
|
*/
|
|
2279
1923
|
export interface GetMessageOutput {
|
|
2280
1924
|
/**
|
|
2281
|
-
*
|
|
2282
|
-
* @public
|
|
2283
|
-
*/
|
|
2284
|
-
requestId?: string | undefined;
|
|
2285
|
-
/**
|
|
2286
|
-
* The duration of the request in milliseconds.
|
|
2287
|
-
* @public
|
|
2288
|
-
*/
|
|
2289
|
-
requestDuration?: number | undefined;
|
|
2290
|
-
/**
|
|
2291
|
-
* Displays the applicable rate limits for the current request.
|
|
2292
|
-
* @public
|
|
2293
|
-
*/
|
|
2294
|
-
rateLimit?: string | undefined;
|
|
2295
|
-
/**
|
|
2296
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2297
|
-
* @public
|
|
2298
|
-
*/
|
|
2299
|
-
rateLimitRemaining?: number | undefined;
|
|
2300
|
-
/**
|
|
2301
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2302
|
-
* @public
|
|
2303
|
-
*/
|
|
2304
|
-
rateLimitReset?: number | undefined;
|
|
2305
|
-
/**
|
|
2306
|
-
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1925
|
+
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
2307
1926
|
* @public
|
|
2308
1927
|
*/
|
|
2309
1928
|
message: Message;
|
|
@@ -2333,31 +1952,6 @@ export interface GetOrCreateDirectChannelInput {
|
|
|
2333
1952
|
* @public
|
|
2334
1953
|
*/
|
|
2335
1954
|
export interface GetOrCreateDirectChannelOutput {
|
|
2336
|
-
/**
|
|
2337
|
-
* The request ID of the request.
|
|
2338
|
-
* @public
|
|
2339
|
-
*/
|
|
2340
|
-
requestId?: string | undefined;
|
|
2341
|
-
/**
|
|
2342
|
-
* The duration of the request in milliseconds.
|
|
2343
|
-
* @public
|
|
2344
|
-
*/
|
|
2345
|
-
requestDuration?: number | undefined;
|
|
2346
|
-
/**
|
|
2347
|
-
* Displays the applicable rate limits for the current request.
|
|
2348
|
-
* @public
|
|
2349
|
-
*/
|
|
2350
|
-
rateLimit?: string | undefined;
|
|
2351
|
-
/**
|
|
2352
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2353
|
-
* @public
|
|
2354
|
-
*/
|
|
2355
|
-
rateLimitRemaining?: number | undefined;
|
|
2356
|
-
/**
|
|
2357
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2358
|
-
* @public
|
|
2359
|
-
*/
|
|
2360
|
-
rateLimitReset?: number | undefined;
|
|
2361
1955
|
channel: Channel;
|
|
2362
1956
|
}
|
|
2363
1957
|
/**
|
|
@@ -2395,31 +1989,6 @@ export interface GetOrCreateSmsChannelInput {
|
|
|
2395
1989
|
* @public
|
|
2396
1990
|
*/
|
|
2397
1991
|
export interface GetOrCreateSmsChannelOutput {
|
|
2398
|
-
/**
|
|
2399
|
-
* The request ID of the request.
|
|
2400
|
-
* @public
|
|
2401
|
-
*/
|
|
2402
|
-
requestId?: string | undefined;
|
|
2403
|
-
/**
|
|
2404
|
-
* The duration of the request in milliseconds.
|
|
2405
|
-
* @public
|
|
2406
|
-
*/
|
|
2407
|
-
requestDuration?: number | undefined;
|
|
2408
|
-
/**
|
|
2409
|
-
* Displays the applicable rate limits for the current request.
|
|
2410
|
-
* @public
|
|
2411
|
-
*/
|
|
2412
|
-
rateLimit?: string | undefined;
|
|
2413
|
-
/**
|
|
2414
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2415
|
-
* @public
|
|
2416
|
-
*/
|
|
2417
|
-
rateLimitRemaining?: number | undefined;
|
|
2418
|
-
/**
|
|
2419
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2420
|
-
* @public
|
|
2421
|
-
*/
|
|
2422
|
-
rateLimitReset?: number | undefined;
|
|
2423
1992
|
channel: Channel;
|
|
2424
1993
|
}
|
|
2425
1994
|
/**
|
|
@@ -2456,31 +2025,6 @@ export interface GetOrCreateTelephonyChannelInput {
|
|
|
2456
2025
|
* @public
|
|
2457
2026
|
*/
|
|
2458
2027
|
export interface GetOrCreateTelephonyChannelOutput {
|
|
2459
|
-
/**
|
|
2460
|
-
* The request ID of the request.
|
|
2461
|
-
* @public
|
|
2462
|
-
*/
|
|
2463
|
-
requestId?: string | undefined;
|
|
2464
|
-
/**
|
|
2465
|
-
* The duration of the request in milliseconds.
|
|
2466
|
-
* @public
|
|
2467
|
-
*/
|
|
2468
|
-
requestDuration?: number | undefined;
|
|
2469
|
-
/**
|
|
2470
|
-
* Displays the applicable rate limits for the current request.
|
|
2471
|
-
* @public
|
|
2472
|
-
*/
|
|
2473
|
-
rateLimit?: string | undefined;
|
|
2474
|
-
/**
|
|
2475
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2476
|
-
* @public
|
|
2477
|
-
*/
|
|
2478
|
-
rateLimitRemaining?: number | undefined;
|
|
2479
|
-
/**
|
|
2480
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2481
|
-
* @public
|
|
2482
|
-
*/
|
|
2483
|
-
rateLimitReset?: number | undefined;
|
|
2484
2028
|
channel: Channel;
|
|
2485
2029
|
}
|
|
2486
2030
|
/**
|
|
@@ -2518,31 +2062,6 @@ export interface GetOrCreateWhatsAppChannelInput {
|
|
|
2518
2062
|
* @public
|
|
2519
2063
|
*/
|
|
2520
2064
|
export interface GetOrCreateWhatsAppChannelOutput {
|
|
2521
|
-
/**
|
|
2522
|
-
* The request ID of the request.
|
|
2523
|
-
* @public
|
|
2524
|
-
*/
|
|
2525
|
-
requestId?: string | undefined;
|
|
2526
|
-
/**
|
|
2527
|
-
* The duration of the request in milliseconds.
|
|
2528
|
-
* @public
|
|
2529
|
-
*/
|
|
2530
|
-
requestDuration?: number | undefined;
|
|
2531
|
-
/**
|
|
2532
|
-
* Displays the applicable rate limits for the current request.
|
|
2533
|
-
* @public
|
|
2534
|
-
*/
|
|
2535
|
-
rateLimit?: string | undefined;
|
|
2536
|
-
/**
|
|
2537
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2538
|
-
* @public
|
|
2539
|
-
*/
|
|
2540
|
-
rateLimitRemaining?: number | undefined;
|
|
2541
|
-
/**
|
|
2542
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2543
|
-
* @public
|
|
2544
|
-
*/
|
|
2545
|
-
rateLimitReset?: number | undefined;
|
|
2546
2065
|
channel: Channel;
|
|
2547
2066
|
}
|
|
2548
2067
|
/**
|
|
@@ -2579,31 +2098,6 @@ export interface GetSmsChannelIdInput {
|
|
|
2579
2098
|
* @public
|
|
2580
2099
|
*/
|
|
2581
2100
|
export interface GetSmsChannelIdOutput {
|
|
2582
|
-
/**
|
|
2583
|
-
* The request ID of the request.
|
|
2584
|
-
* @public
|
|
2585
|
-
*/
|
|
2586
|
-
requestId?: string | undefined;
|
|
2587
|
-
/**
|
|
2588
|
-
* The duration of the request in milliseconds.
|
|
2589
|
-
* @public
|
|
2590
|
-
*/
|
|
2591
|
-
requestDuration?: number | undefined;
|
|
2592
|
-
/**
|
|
2593
|
-
* Displays the applicable rate limits for the current request.
|
|
2594
|
-
* @public
|
|
2595
|
-
*/
|
|
2596
|
-
rateLimit?: string | undefined;
|
|
2597
|
-
/**
|
|
2598
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2599
|
-
* @public
|
|
2600
|
-
*/
|
|
2601
|
-
rateLimitRemaining?: number | undefined;
|
|
2602
|
-
/**
|
|
2603
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2604
|
-
* @public
|
|
2605
|
-
*/
|
|
2606
|
-
rateLimitReset?: number | undefined;
|
|
2607
2101
|
/**
|
|
2608
2102
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
2609
2103
|
* @public
|
|
@@ -2644,31 +2138,6 @@ export interface GetTelephonyChannelIdInput {
|
|
|
2644
2138
|
* @public
|
|
2645
2139
|
*/
|
|
2646
2140
|
export interface GetTelephonyChannelIdOutput {
|
|
2647
|
-
/**
|
|
2648
|
-
* The request ID of the request.
|
|
2649
|
-
* @public
|
|
2650
|
-
*/
|
|
2651
|
-
requestId?: string | undefined;
|
|
2652
|
-
/**
|
|
2653
|
-
* The duration of the request in milliseconds.
|
|
2654
|
-
* @public
|
|
2655
|
-
*/
|
|
2656
|
-
requestDuration?: number | undefined;
|
|
2657
|
-
/**
|
|
2658
|
-
* Displays the applicable rate limits for the current request.
|
|
2659
|
-
* @public
|
|
2660
|
-
*/
|
|
2661
|
-
rateLimit?: string | undefined;
|
|
2662
|
-
/**
|
|
2663
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2664
|
-
* @public
|
|
2665
|
-
*/
|
|
2666
|
-
rateLimitRemaining?: number | undefined;
|
|
2667
|
-
/**
|
|
2668
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2669
|
-
* @public
|
|
2670
|
-
*/
|
|
2671
|
-
rateLimitReset?: number | undefined;
|
|
2672
2141
|
/**
|
|
2673
2142
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
2674
2143
|
* @public
|
|
@@ -2699,31 +2168,6 @@ export interface GetTokenInput {
|
|
|
2699
2168
|
* @public
|
|
2700
2169
|
*/
|
|
2701
2170
|
export interface GetTokenOutput {
|
|
2702
|
-
/**
|
|
2703
|
-
* The request ID of the request.
|
|
2704
|
-
* @public
|
|
2705
|
-
*/
|
|
2706
|
-
requestId?: string | undefined;
|
|
2707
|
-
/**
|
|
2708
|
-
* The duration of the request in milliseconds.
|
|
2709
|
-
* @public
|
|
2710
|
-
*/
|
|
2711
|
-
requestDuration?: number | undefined;
|
|
2712
|
-
/**
|
|
2713
|
-
* Displays the applicable rate limits for the current request.
|
|
2714
|
-
* @public
|
|
2715
|
-
*/
|
|
2716
|
-
rateLimit?: string | undefined;
|
|
2717
|
-
/**
|
|
2718
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2719
|
-
* @public
|
|
2720
|
-
*/
|
|
2721
|
-
rateLimitRemaining?: number | undefined;
|
|
2722
|
-
/**
|
|
2723
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2724
|
-
* @public
|
|
2725
|
-
*/
|
|
2726
|
-
rateLimitReset?: number | undefined;
|
|
2727
2171
|
/**
|
|
2728
2172
|
* Authorization token.
|
|
2729
2173
|
* @public
|
|
@@ -2810,31 +2254,6 @@ export interface UploadedFileInfo {
|
|
|
2810
2254
|
* @public
|
|
2811
2255
|
*/
|
|
2812
2256
|
export interface GetUploadedFileInfoOutput {
|
|
2813
|
-
/**
|
|
2814
|
-
* The request ID of the request.
|
|
2815
|
-
* @public
|
|
2816
|
-
*/
|
|
2817
|
-
requestId?: string | undefined;
|
|
2818
|
-
/**
|
|
2819
|
-
* The duration of the request in milliseconds.
|
|
2820
|
-
* @public
|
|
2821
|
-
*/
|
|
2822
|
-
requestDuration?: number | undefined;
|
|
2823
|
-
/**
|
|
2824
|
-
* Displays the applicable rate limits for the current request.
|
|
2825
|
-
* @public
|
|
2826
|
-
*/
|
|
2827
|
-
rateLimit?: string | undefined;
|
|
2828
|
-
/**
|
|
2829
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2830
|
-
* @public
|
|
2831
|
-
*/
|
|
2832
|
-
rateLimitRemaining?: number | undefined;
|
|
2833
|
-
/**
|
|
2834
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2835
|
-
* @public
|
|
2836
|
-
*/
|
|
2837
|
-
rateLimitReset?: number | undefined;
|
|
2838
2257
|
/**
|
|
2839
2258
|
* Metadata for a file uploaded to the channel file store but not yet attached to a message.
|
|
2840
2259
|
* @public
|
|
@@ -2875,31 +2294,6 @@ export interface GetWhatsAppChannelIdInput {
|
|
|
2875
2294
|
* @public
|
|
2876
2295
|
*/
|
|
2877
2296
|
export interface GetWhatsAppChannelIdOutput {
|
|
2878
|
-
/**
|
|
2879
|
-
* The request ID of the request.
|
|
2880
|
-
* @public
|
|
2881
|
-
*/
|
|
2882
|
-
requestId?: string | undefined;
|
|
2883
|
-
/**
|
|
2884
|
-
* The duration of the request in milliseconds.
|
|
2885
|
-
* @public
|
|
2886
|
-
*/
|
|
2887
|
-
requestDuration?: number | undefined;
|
|
2888
|
-
/**
|
|
2889
|
-
* Displays the applicable rate limits for the current request.
|
|
2890
|
-
* @public
|
|
2891
|
-
*/
|
|
2892
|
-
rateLimit?: string | undefined;
|
|
2893
|
-
/**
|
|
2894
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2895
|
-
* @public
|
|
2896
|
-
*/
|
|
2897
|
-
rateLimitRemaining?: number | undefined;
|
|
2898
|
-
/**
|
|
2899
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2900
|
-
* @public
|
|
2901
|
-
*/
|
|
2902
|
-
rateLimitReset?: number | undefined;
|
|
2903
2297
|
/**
|
|
2904
2298
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
2905
2299
|
* @public
|
|
@@ -2950,31 +2344,6 @@ export interface HideChannelInput {
|
|
|
2950
2344
|
* @public
|
|
2951
2345
|
*/
|
|
2952
2346
|
export interface HideChannelOutput {
|
|
2953
|
-
/**
|
|
2954
|
-
* The request ID of the request.
|
|
2955
|
-
* @public
|
|
2956
|
-
*/
|
|
2957
|
-
requestId?: string | undefined;
|
|
2958
|
-
/**
|
|
2959
|
-
* The duration of the request in milliseconds.
|
|
2960
|
-
* @public
|
|
2961
|
-
*/
|
|
2962
|
-
requestDuration?: number | undefined;
|
|
2963
|
-
/**
|
|
2964
|
-
* Displays the applicable rate limits for the current request.
|
|
2965
|
-
* @public
|
|
2966
|
-
*/
|
|
2967
|
-
rateLimit?: string | undefined;
|
|
2968
|
-
/**
|
|
2969
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
2970
|
-
* @public
|
|
2971
|
-
*/
|
|
2972
|
-
rateLimitRemaining?: number | undefined;
|
|
2973
|
-
/**
|
|
2974
|
-
* Shows the time in seconds until the rate limit resets.
|
|
2975
|
-
* @public
|
|
2976
|
-
*/
|
|
2977
|
-
rateLimitReset?: number | undefined;
|
|
2978
2347
|
}
|
|
2979
2348
|
/**
|
|
2980
2349
|
* @public
|
|
@@ -3001,31 +2370,6 @@ export interface JoinChannelInput {
|
|
|
3001
2370
|
* @public
|
|
3002
2371
|
*/
|
|
3003
2372
|
export interface JoinChannelOutput {
|
|
3004
|
-
/**
|
|
3005
|
-
* The request ID of the request.
|
|
3006
|
-
* @public
|
|
3007
|
-
*/
|
|
3008
|
-
requestId?: string | undefined;
|
|
3009
|
-
/**
|
|
3010
|
-
* The duration of the request in milliseconds.
|
|
3011
|
-
* @public
|
|
3012
|
-
*/
|
|
3013
|
-
requestDuration?: number | undefined;
|
|
3014
|
-
/**
|
|
3015
|
-
* Displays the applicable rate limits for the current request.
|
|
3016
|
-
* @public
|
|
3017
|
-
*/
|
|
3018
|
-
rateLimit?: string | undefined;
|
|
3019
|
-
/**
|
|
3020
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3021
|
-
* @public
|
|
3022
|
-
*/
|
|
3023
|
-
rateLimitRemaining?: number | undefined;
|
|
3024
|
-
/**
|
|
3025
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3026
|
-
* @public
|
|
3027
|
-
*/
|
|
3028
|
-
rateLimitReset?: number | undefined;
|
|
3029
2373
|
channel: Channel;
|
|
3030
2374
|
}
|
|
3031
2375
|
/**
|
|
@@ -3053,31 +2397,6 @@ export interface LeaveChannelInput {
|
|
|
3053
2397
|
* @public
|
|
3054
2398
|
*/
|
|
3055
2399
|
export interface LeaveChannelOutput {
|
|
3056
|
-
/**
|
|
3057
|
-
* The request ID of the request.
|
|
3058
|
-
* @public
|
|
3059
|
-
*/
|
|
3060
|
-
requestId?: string | undefined;
|
|
3061
|
-
/**
|
|
3062
|
-
* The duration of the request in milliseconds.
|
|
3063
|
-
* @public
|
|
3064
|
-
*/
|
|
3065
|
-
requestDuration?: number | undefined;
|
|
3066
|
-
/**
|
|
3067
|
-
* Displays the applicable rate limits for the current request.
|
|
3068
|
-
* @public
|
|
3069
|
-
*/
|
|
3070
|
-
rateLimit?: string | undefined;
|
|
3071
|
-
/**
|
|
3072
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3073
|
-
* @public
|
|
3074
|
-
*/
|
|
3075
|
-
rateLimitRemaining?: number | undefined;
|
|
3076
|
-
/**
|
|
3077
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3078
|
-
* @public
|
|
3079
|
-
*/
|
|
3080
|
-
rateLimitReset?: number | undefined;
|
|
3081
2400
|
}
|
|
3082
2401
|
/**
|
|
3083
2402
|
* @public
|
|
@@ -3105,31 +2424,6 @@ export interface ListChannelMembersInput {
|
|
|
3105
2424
|
* @public
|
|
3106
2425
|
*/
|
|
3107
2426
|
export interface ListChannelMembersOutput {
|
|
3108
|
-
/**
|
|
3109
|
-
* The request ID of the request.
|
|
3110
|
-
* @public
|
|
3111
|
-
*/
|
|
3112
|
-
requestId?: string | undefined;
|
|
3113
|
-
/**
|
|
3114
|
-
* The duration of the request in milliseconds.
|
|
3115
|
-
* @public
|
|
3116
|
-
*/
|
|
3117
|
-
requestDuration?: number | undefined;
|
|
3118
|
-
/**
|
|
3119
|
-
* Displays the applicable rate limits for the current request.
|
|
3120
|
-
* @public
|
|
3121
|
-
*/
|
|
3122
|
-
rateLimit?: string | undefined;
|
|
3123
|
-
/**
|
|
3124
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3125
|
-
* @public
|
|
3126
|
-
*/
|
|
3127
|
-
rateLimitRemaining?: number | undefined;
|
|
3128
|
-
/**
|
|
3129
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3130
|
-
* @public
|
|
3131
|
-
*/
|
|
3132
|
-
rateLimitReset?: number | undefined;
|
|
3133
2427
|
members: ChannelMember[];
|
|
3134
2428
|
}
|
|
3135
2429
|
/**
|
|
@@ -3156,31 +2450,6 @@ export interface ListChannelMembersReadStatusInput {
|
|
|
3156
2450
|
* @public
|
|
3157
2451
|
*/
|
|
3158
2452
|
export interface ListChannelMembersReadStatusOutput {
|
|
3159
|
-
/**
|
|
3160
|
-
* The request ID of the request.
|
|
3161
|
-
* @public
|
|
3162
|
-
*/
|
|
3163
|
-
requestId?: string | undefined;
|
|
3164
|
-
/**
|
|
3165
|
-
* The duration of the request in milliseconds.
|
|
3166
|
-
* @public
|
|
3167
|
-
*/
|
|
3168
|
-
requestDuration?: number | undefined;
|
|
3169
|
-
/**
|
|
3170
|
-
* Displays the applicable rate limits for the current request.
|
|
3171
|
-
* @public
|
|
3172
|
-
*/
|
|
3173
|
-
rateLimit?: string | undefined;
|
|
3174
|
-
/**
|
|
3175
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3176
|
-
* @public
|
|
3177
|
-
*/
|
|
3178
|
-
rateLimitRemaining?: number | undefined;
|
|
3179
|
-
/**
|
|
3180
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3181
|
-
* @public
|
|
3182
|
-
*/
|
|
3183
|
-
rateLimitReset?: number | undefined;
|
|
3184
2453
|
members: ChannelMemberReadStatus[];
|
|
3185
2454
|
}
|
|
3186
2455
|
/**
|
|
@@ -3217,31 +2486,6 @@ export interface ListChannelsInput {
|
|
|
3217
2486
|
* @public
|
|
3218
2487
|
*/
|
|
3219
2488
|
export interface ListChannelsOutput {
|
|
3220
|
-
/**
|
|
3221
|
-
* The request ID of the request.
|
|
3222
|
-
* @public
|
|
3223
|
-
*/
|
|
3224
|
-
requestId?: string | undefined;
|
|
3225
|
-
/**
|
|
3226
|
-
* The duration of the request in milliseconds.
|
|
3227
|
-
* @public
|
|
3228
|
-
*/
|
|
3229
|
-
requestDuration?: number | undefined;
|
|
3230
|
-
/**
|
|
3231
|
-
* Displays the applicable rate limits for the current request.
|
|
3232
|
-
* @public
|
|
3233
|
-
*/
|
|
3234
|
-
rateLimit?: string | undefined;
|
|
3235
|
-
/**
|
|
3236
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3237
|
-
* @public
|
|
3238
|
-
*/
|
|
3239
|
-
rateLimitRemaining?: number | undefined;
|
|
3240
|
-
/**
|
|
3241
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3242
|
-
* @public
|
|
3243
|
-
*/
|
|
3244
|
-
rateLimitReset?: number | undefined;
|
|
3245
2489
|
/**
|
|
3246
2490
|
* Ordered page of channels for the requested section.
|
|
3247
2491
|
* @public
|
|
@@ -3375,31 +2619,6 @@ export interface MentionEntry {
|
|
|
3375
2619
|
* @public
|
|
3376
2620
|
*/
|
|
3377
2621
|
export interface ListMentionsOutput {
|
|
3378
|
-
/**
|
|
3379
|
-
* The request ID of the request.
|
|
3380
|
-
* @public
|
|
3381
|
-
*/
|
|
3382
|
-
requestId?: string | undefined;
|
|
3383
|
-
/**
|
|
3384
|
-
* The duration of the request in milliseconds.
|
|
3385
|
-
* @public
|
|
3386
|
-
*/
|
|
3387
|
-
requestDuration?: number | undefined;
|
|
3388
|
-
/**
|
|
3389
|
-
* Displays the applicable rate limits for the current request.
|
|
3390
|
-
* @public
|
|
3391
|
-
*/
|
|
3392
|
-
rateLimit?: string | undefined;
|
|
3393
|
-
/**
|
|
3394
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3395
|
-
* @public
|
|
3396
|
-
*/
|
|
3397
|
-
rateLimitRemaining?: number | undefined;
|
|
3398
|
-
/**
|
|
3399
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3400
|
-
* @public
|
|
3401
|
-
*/
|
|
3402
|
-
rateLimitReset?: number | undefined;
|
|
3403
2622
|
/**
|
|
3404
2623
|
* Mentions ordered by most recent `mentionAddedAt` first.
|
|
3405
2624
|
* @public
|
|
@@ -3450,31 +2669,6 @@ export interface ListMessagesInput {
|
|
|
3450
2669
|
* @public
|
|
3451
2670
|
*/
|
|
3452
2671
|
export interface ListMessagesOutput {
|
|
3453
|
-
/**
|
|
3454
|
-
* The request ID of the request.
|
|
3455
|
-
* @public
|
|
3456
|
-
*/
|
|
3457
|
-
requestId?: string | undefined;
|
|
3458
|
-
/**
|
|
3459
|
-
* The duration of the request in milliseconds.
|
|
3460
|
-
* @public
|
|
3461
|
-
*/
|
|
3462
|
-
requestDuration?: number | undefined;
|
|
3463
|
-
/**
|
|
3464
|
-
* Displays the applicable rate limits for the current request.
|
|
3465
|
-
* @public
|
|
3466
|
-
*/
|
|
3467
|
-
rateLimit?: string | undefined;
|
|
3468
|
-
/**
|
|
3469
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3470
|
-
* @public
|
|
3471
|
-
*/
|
|
3472
|
-
rateLimitRemaining?: number | undefined;
|
|
3473
|
-
/**
|
|
3474
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3475
|
-
* @public
|
|
3476
|
-
*/
|
|
3477
|
-
rateLimitReset?: number | undefined;
|
|
3478
2672
|
/**
|
|
3479
2673
|
* Messages ordered newest-first by `timelineSeq`.
|
|
3480
2674
|
* @public
|
|
@@ -3520,31 +2714,6 @@ export interface MarkReadInput {
|
|
|
3520
2714
|
* @public
|
|
3521
2715
|
*/
|
|
3522
2716
|
export interface MarkReadOutput {
|
|
3523
|
-
/**
|
|
3524
|
-
* The request ID of the request.
|
|
3525
|
-
* @public
|
|
3526
|
-
*/
|
|
3527
|
-
requestId?: string | undefined;
|
|
3528
|
-
/**
|
|
3529
|
-
* The duration of the request in milliseconds.
|
|
3530
|
-
* @public
|
|
3531
|
-
*/
|
|
3532
|
-
requestDuration?: number | undefined;
|
|
3533
|
-
/**
|
|
3534
|
-
* Displays the applicable rate limits for the current request.
|
|
3535
|
-
* @public
|
|
3536
|
-
*/
|
|
3537
|
-
rateLimit?: string | undefined;
|
|
3538
|
-
/**
|
|
3539
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3540
|
-
* @public
|
|
3541
|
-
*/
|
|
3542
|
-
rateLimitRemaining?: number | undefined;
|
|
3543
|
-
/**
|
|
3544
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3545
|
-
* @public
|
|
3546
|
-
*/
|
|
3547
|
-
rateLimitReset?: number | undefined;
|
|
3548
2717
|
/**
|
|
3549
2718
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
3550
2719
|
* @public
|
|
@@ -3590,31 +2759,6 @@ export interface MarkUnreadInput {
|
|
|
3590
2759
|
* @public
|
|
3591
2760
|
*/
|
|
3592
2761
|
export interface MarkUnreadOutput {
|
|
3593
|
-
/**
|
|
3594
|
-
* The request ID of the request.
|
|
3595
|
-
* @public
|
|
3596
|
-
*/
|
|
3597
|
-
requestId?: string | undefined;
|
|
3598
|
-
/**
|
|
3599
|
-
* The duration of the request in milliseconds.
|
|
3600
|
-
* @public
|
|
3601
|
-
*/
|
|
3602
|
-
requestDuration?: number | undefined;
|
|
3603
|
-
/**
|
|
3604
|
-
* Displays the applicable rate limits for the current request.
|
|
3605
|
-
* @public
|
|
3606
|
-
*/
|
|
3607
|
-
rateLimit?: string | undefined;
|
|
3608
|
-
/**
|
|
3609
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3610
|
-
* @public
|
|
3611
|
-
*/
|
|
3612
|
-
rateLimitRemaining?: number | undefined;
|
|
3613
|
-
/**
|
|
3614
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3615
|
-
* @public
|
|
3616
|
-
*/
|
|
3617
|
-
rateLimitReset?: number | undefined;
|
|
3618
2762
|
/**
|
|
3619
2763
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
3620
2764
|
* @public
|
|
@@ -3650,31 +2794,6 @@ export interface MoveChannelToSectionInput {
|
|
|
3650
2794
|
* @public
|
|
3651
2795
|
*/
|
|
3652
2796
|
export interface MoveChannelToSectionOutput {
|
|
3653
|
-
/**
|
|
3654
|
-
* The request ID of the request.
|
|
3655
|
-
* @public
|
|
3656
|
-
*/
|
|
3657
|
-
requestId?: string | undefined;
|
|
3658
|
-
/**
|
|
3659
|
-
* The duration of the request in milliseconds.
|
|
3660
|
-
* @public
|
|
3661
|
-
*/
|
|
3662
|
-
requestDuration?: number | undefined;
|
|
3663
|
-
/**
|
|
3664
|
-
* Displays the applicable rate limits for the current request.
|
|
3665
|
-
* @public
|
|
3666
|
-
*/
|
|
3667
|
-
rateLimit?: string | undefined;
|
|
3668
|
-
/**
|
|
3669
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3670
|
-
* @public
|
|
3671
|
-
*/
|
|
3672
|
-
rateLimitRemaining?: number | undefined;
|
|
3673
|
-
/**
|
|
3674
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3675
|
-
* @public
|
|
3676
|
-
*/
|
|
3677
|
-
rateLimitReset?: number | undefined;
|
|
3678
2797
|
/**
|
|
3679
2798
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
3680
2799
|
* @public
|
|
@@ -3717,31 +2836,6 @@ export interface MuteChannelInput {
|
|
|
3717
2836
|
* @public
|
|
3718
2837
|
*/
|
|
3719
2838
|
export interface MuteChannelOutput {
|
|
3720
|
-
/**
|
|
3721
|
-
* The request ID of the request.
|
|
3722
|
-
* @public
|
|
3723
|
-
*/
|
|
3724
|
-
requestId?: string | undefined;
|
|
3725
|
-
/**
|
|
3726
|
-
* The duration of the request in milliseconds.
|
|
3727
|
-
* @public
|
|
3728
|
-
*/
|
|
3729
|
-
requestDuration?: number | undefined;
|
|
3730
|
-
/**
|
|
3731
|
-
* Displays the applicable rate limits for the current request.
|
|
3732
|
-
* @public
|
|
3733
|
-
*/
|
|
3734
|
-
rateLimit?: string | undefined;
|
|
3735
|
-
/**
|
|
3736
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3737
|
-
* @public
|
|
3738
|
-
*/
|
|
3739
|
-
rateLimitRemaining?: number | undefined;
|
|
3740
|
-
/**
|
|
3741
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3742
|
-
* @public
|
|
3743
|
-
*/
|
|
3744
|
-
rateLimitReset?: number | undefined;
|
|
3745
2839
|
/**
|
|
3746
2840
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
3747
2841
|
* @public
|
|
@@ -3830,25 +2924,20 @@ export interface PartialUpdateChannelSetOptions {
|
|
|
3830
2924
|
*/
|
|
3831
2925
|
wizyGuestViewOnly?: boolean | undefined;
|
|
3832
2926
|
/**
|
|
3833
|
-
*
|
|
2927
|
+
* The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
3834
2928
|
* @public
|
|
3835
2929
|
*/
|
|
3836
|
-
|
|
2930
|
+
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
3837
2931
|
/**
|
|
3838
|
-
* The Messenger
|
|
2932
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram. Written by kite from the inbound event, because the channel id hashes the sender's linked service and not the sender, and a reply has to name the sender it is sent from.
|
|
3839
2933
|
* @public
|
|
3840
2934
|
*/
|
|
3841
|
-
|
|
2935
|
+
messagingSenderId?: string | undefined;
|
|
3842
2936
|
/**
|
|
3843
|
-
*
|
|
2937
|
+
* Epoch seconds until which a reply still reaches the person. On Messenger and Instagram this is Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message; classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messagingReplyUntil > 0 && now > messagingReplyUntil` and shows nothing at 0. Absent on a channel with no reply window.
|
|
3844
2938
|
* @public
|
|
3845
2939
|
*/
|
|
3846
|
-
|
|
3847
|
-
/**
|
|
3848
|
-
* Epoch seconds until which a reply still reaches the person: Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message. classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messengerReplyUntil > 0 && now > messengerReplyUntil` and shows nothing at 0.
|
|
3849
|
-
* @public
|
|
3850
|
-
*/
|
|
3851
|
-
messengerReplyUntil?: number | undefined;
|
|
2940
|
+
messagingReplyUntil?: number | undefined;
|
|
3852
2941
|
}
|
|
3853
2942
|
/**
|
|
3854
2943
|
* @public
|
|
@@ -3877,31 +2966,6 @@ export interface PartialUpdateChannelInput {
|
|
|
3877
2966
|
* @public
|
|
3878
2967
|
*/
|
|
3879
2968
|
export interface PartialUpdateChannelOutput {
|
|
3880
|
-
/**
|
|
3881
|
-
* The request ID of the request.
|
|
3882
|
-
* @public
|
|
3883
|
-
*/
|
|
3884
|
-
requestId?: string | undefined;
|
|
3885
|
-
/**
|
|
3886
|
-
* The duration of the request in milliseconds.
|
|
3887
|
-
* @public
|
|
3888
|
-
*/
|
|
3889
|
-
requestDuration?: number | undefined;
|
|
3890
|
-
/**
|
|
3891
|
-
* Displays the applicable rate limits for the current request.
|
|
3892
|
-
* @public
|
|
3893
|
-
*/
|
|
3894
|
-
rateLimit?: string | undefined;
|
|
3895
|
-
/**
|
|
3896
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
3897
|
-
* @public
|
|
3898
|
-
*/
|
|
3899
|
-
rateLimitRemaining?: number | undefined;
|
|
3900
|
-
/**
|
|
3901
|
-
* Shows the time in seconds until the rate limit resets.
|
|
3902
|
-
* @public
|
|
3903
|
-
*/
|
|
3904
|
-
rateLimitReset?: number | undefined;
|
|
3905
2969
|
channel: Channel;
|
|
3906
2970
|
}
|
|
3907
2971
|
/**
|
|
@@ -3955,6 +3019,16 @@ export interface PartialUpdateMessageSetInput {
|
|
|
3955
3019
|
*/
|
|
3956
3020
|
sms?: boolean | undefined;
|
|
3957
3021
|
smsStatus?: MessageSmsStatus | undefined;
|
|
3022
|
+
/**
|
|
3023
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
3024
|
+
* @public
|
|
3025
|
+
*/
|
|
3026
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
3027
|
+
/**
|
|
3028
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
3029
|
+
* @public
|
|
3030
|
+
*/
|
|
3031
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
3958
3032
|
}
|
|
3959
3033
|
/**
|
|
3960
3034
|
* @public
|
|
@@ -4001,31 +3075,6 @@ export interface PartialUpdateMessageOutput {
|
|
|
4001
3075
|
* @public
|
|
4002
3076
|
*/
|
|
4003
3077
|
message: Message;
|
|
4004
|
-
/**
|
|
4005
|
-
* The request ID of the request.
|
|
4006
|
-
* @public
|
|
4007
|
-
*/
|
|
4008
|
-
requestId?: string | undefined;
|
|
4009
|
-
/**
|
|
4010
|
-
* The duration of the request in milliseconds.
|
|
4011
|
-
* @public
|
|
4012
|
-
*/
|
|
4013
|
-
requestDuration?: number | undefined;
|
|
4014
|
-
/**
|
|
4015
|
-
* Displays the applicable rate limits for the current request.
|
|
4016
|
-
* @public
|
|
4017
|
-
*/
|
|
4018
|
-
rateLimit?: string | undefined;
|
|
4019
|
-
/**
|
|
4020
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4021
|
-
* @public
|
|
4022
|
-
*/
|
|
4023
|
-
rateLimitRemaining?: number | undefined;
|
|
4024
|
-
/**
|
|
4025
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4026
|
-
* @public
|
|
4027
|
-
*/
|
|
4028
|
-
rateLimitReset?: number | undefined;
|
|
4029
3078
|
}
|
|
4030
3079
|
/**
|
|
4031
3080
|
* @public
|
|
@@ -4051,31 +3100,6 @@ export interface PinChannelInput {
|
|
|
4051
3100
|
* @public
|
|
4052
3101
|
*/
|
|
4053
3102
|
export interface PinChannelOutput {
|
|
4054
|
-
/**
|
|
4055
|
-
* The request ID of the request.
|
|
4056
|
-
* @public
|
|
4057
|
-
*/
|
|
4058
|
-
requestId?: string | undefined;
|
|
4059
|
-
/**
|
|
4060
|
-
* The duration of the request in milliseconds.
|
|
4061
|
-
* @public
|
|
4062
|
-
*/
|
|
4063
|
-
requestDuration?: number | undefined;
|
|
4064
|
-
/**
|
|
4065
|
-
* Displays the applicable rate limits for the current request.
|
|
4066
|
-
* @public
|
|
4067
|
-
*/
|
|
4068
|
-
rateLimit?: string | undefined;
|
|
4069
|
-
/**
|
|
4070
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4071
|
-
* @public
|
|
4072
|
-
*/
|
|
4073
|
-
rateLimitRemaining?: number | undefined;
|
|
4074
|
-
/**
|
|
4075
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4076
|
-
* @public
|
|
4077
|
-
*/
|
|
4078
|
-
rateLimitReset?: number | undefined;
|
|
4079
3103
|
}
|
|
4080
3104
|
/**
|
|
4081
3105
|
* @public
|
|
@@ -4107,31 +3131,6 @@ export interface PinMessageOutput {
|
|
|
4107
3131
|
* @public
|
|
4108
3132
|
*/
|
|
4109
3133
|
message: Message;
|
|
4110
|
-
/**
|
|
4111
|
-
* The request ID of the request.
|
|
4112
|
-
* @public
|
|
4113
|
-
*/
|
|
4114
|
-
requestId?: string | undefined;
|
|
4115
|
-
/**
|
|
4116
|
-
* The duration of the request in milliseconds.
|
|
4117
|
-
* @public
|
|
4118
|
-
*/
|
|
4119
|
-
requestDuration?: number | undefined;
|
|
4120
|
-
/**
|
|
4121
|
-
* Displays the applicable rate limits for the current request.
|
|
4122
|
-
* @public
|
|
4123
|
-
*/
|
|
4124
|
-
rateLimit?: string | undefined;
|
|
4125
|
-
/**
|
|
4126
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4127
|
-
* @public
|
|
4128
|
-
*/
|
|
4129
|
-
rateLimitRemaining?: number | undefined;
|
|
4130
|
-
/**
|
|
4131
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4132
|
-
* @public
|
|
4133
|
-
*/
|
|
4134
|
-
rateLimitReset?: number | undefined;
|
|
4135
3134
|
}
|
|
4136
3135
|
/**
|
|
4137
3136
|
* @public
|
|
@@ -4157,31 +3156,6 @@ export interface QueryChannelsInput {
|
|
|
4157
3156
|
* @public
|
|
4158
3157
|
*/
|
|
4159
3158
|
export interface QueryChannelsOutput {
|
|
4160
|
-
/**
|
|
4161
|
-
* The request ID of the request.
|
|
4162
|
-
* @public
|
|
4163
|
-
*/
|
|
4164
|
-
requestId?: string | undefined;
|
|
4165
|
-
/**
|
|
4166
|
-
* The duration of the request in milliseconds.
|
|
4167
|
-
* @public
|
|
4168
|
-
*/
|
|
4169
|
-
requestDuration?: number | undefined;
|
|
4170
|
-
/**
|
|
4171
|
-
* Displays the applicable rate limits for the current request.
|
|
4172
|
-
* @public
|
|
4173
|
-
*/
|
|
4174
|
-
rateLimit?: string | undefined;
|
|
4175
|
-
/**
|
|
4176
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4177
|
-
* @public
|
|
4178
|
-
*/
|
|
4179
|
-
rateLimitRemaining?: number | undefined;
|
|
4180
|
-
/**
|
|
4181
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4182
|
-
* @public
|
|
4183
|
-
*/
|
|
4184
|
-
rateLimitReset?: number | undefined;
|
|
4185
3159
|
channels: InboxChannel[];
|
|
4186
3160
|
}
|
|
4187
3161
|
/**
|
|
@@ -4212,32 +3186,7 @@ export interface RemoveChannelFromSectionInput {
|
|
|
4212
3186
|
/**
|
|
4213
3187
|
* @public
|
|
4214
3188
|
*/
|
|
4215
|
-
export interface RemoveChannelFromSectionOutput {
|
|
4216
|
-
/**
|
|
4217
|
-
* The request ID of the request.
|
|
4218
|
-
* @public
|
|
4219
|
-
*/
|
|
4220
|
-
requestId?: string | undefined;
|
|
4221
|
-
/**
|
|
4222
|
-
* The duration of the request in milliseconds.
|
|
4223
|
-
* @public
|
|
4224
|
-
*/
|
|
4225
|
-
requestDuration?: number | undefined;
|
|
4226
|
-
/**
|
|
4227
|
-
* Displays the applicable rate limits for the current request.
|
|
4228
|
-
* @public
|
|
4229
|
-
*/
|
|
4230
|
-
rateLimit?: string | undefined;
|
|
4231
|
-
/**
|
|
4232
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4233
|
-
* @public
|
|
4234
|
-
*/
|
|
4235
|
-
rateLimitRemaining?: number | undefined;
|
|
4236
|
-
/**
|
|
4237
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4238
|
-
* @public
|
|
4239
|
-
*/
|
|
4240
|
-
rateLimitReset?: number | undefined;
|
|
3189
|
+
export interface RemoveChannelFromSectionOutput {
|
|
4241
3190
|
/**
|
|
4242
3191
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
4243
3192
|
* @public
|
|
@@ -4269,31 +3218,6 @@ export interface RenameSectionInput {
|
|
|
4269
3218
|
* @public
|
|
4270
3219
|
*/
|
|
4271
3220
|
export interface RenameSectionOutput {
|
|
4272
|
-
/**
|
|
4273
|
-
* The request ID of the request.
|
|
4274
|
-
* @public
|
|
4275
|
-
*/
|
|
4276
|
-
requestId?: string | undefined;
|
|
4277
|
-
/**
|
|
4278
|
-
* The duration of the request in milliseconds.
|
|
4279
|
-
* @public
|
|
4280
|
-
*/
|
|
4281
|
-
requestDuration?: number | undefined;
|
|
4282
|
-
/**
|
|
4283
|
-
* Displays the applicable rate limits for the current request.
|
|
4284
|
-
* @public
|
|
4285
|
-
*/
|
|
4286
|
-
rateLimit?: string | undefined;
|
|
4287
|
-
/**
|
|
4288
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4289
|
-
* @public
|
|
4290
|
-
*/
|
|
4291
|
-
rateLimitRemaining?: number | undefined;
|
|
4292
|
-
/**
|
|
4293
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4294
|
-
* @public
|
|
4295
|
-
*/
|
|
4296
|
-
rateLimitReset?: number | undefined;
|
|
4297
3221
|
/**
|
|
4298
3222
|
* Inbox section with metadata, channel count, and unread counters.
|
|
4299
3223
|
* @public
|
|
@@ -4360,31 +3284,6 @@ export interface SearchChannelsInput {
|
|
|
4360
3284
|
* @public
|
|
4361
3285
|
*/
|
|
4362
3286
|
export interface SearchChannelsOutput {
|
|
4363
|
-
/**
|
|
4364
|
-
* The request ID of the request.
|
|
4365
|
-
* @public
|
|
4366
|
-
*/
|
|
4367
|
-
requestId?: string | undefined;
|
|
4368
|
-
/**
|
|
4369
|
-
* The duration of the request in milliseconds.
|
|
4370
|
-
* @public
|
|
4371
|
-
*/
|
|
4372
|
-
requestDuration?: number | undefined;
|
|
4373
|
-
/**
|
|
4374
|
-
* Displays the applicable rate limits for the current request.
|
|
4375
|
-
* @public
|
|
4376
|
-
*/
|
|
4377
|
-
rateLimit?: string | undefined;
|
|
4378
|
-
/**
|
|
4379
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4380
|
-
* @public
|
|
4381
|
-
*/
|
|
4382
|
-
rateLimitRemaining?: number | undefined;
|
|
4383
|
-
/**
|
|
4384
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4385
|
-
* @public
|
|
4386
|
-
*/
|
|
4387
|
-
rateLimitReset?: number | undefined;
|
|
4388
3287
|
/**
|
|
4389
3288
|
* Matching channels ordered by relevance.
|
|
4390
3289
|
* @public
|
|
@@ -4485,31 +3384,6 @@ export interface SearchMessagesInput {
|
|
|
4485
3384
|
* @public
|
|
4486
3385
|
*/
|
|
4487
3386
|
export interface SearchMessagesOutput {
|
|
4488
|
-
/**
|
|
4489
|
-
* The request ID of the request.
|
|
4490
|
-
* @public
|
|
4491
|
-
*/
|
|
4492
|
-
requestId?: string | undefined;
|
|
4493
|
-
/**
|
|
4494
|
-
* The duration of the request in milliseconds.
|
|
4495
|
-
* @public
|
|
4496
|
-
*/
|
|
4497
|
-
requestDuration?: number | undefined;
|
|
4498
|
-
/**
|
|
4499
|
-
* Displays the applicable rate limits for the current request.
|
|
4500
|
-
* @public
|
|
4501
|
-
*/
|
|
4502
|
-
rateLimit?: string | undefined;
|
|
4503
|
-
/**
|
|
4504
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4505
|
-
* @public
|
|
4506
|
-
*/
|
|
4507
|
-
rateLimitRemaining?: number | undefined;
|
|
4508
|
-
/**
|
|
4509
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4510
|
-
* @public
|
|
4511
|
-
*/
|
|
4512
|
-
rateLimitReset?: number | undefined;
|
|
4513
3387
|
/**
|
|
4514
3388
|
* Matching messages, access-filtered and ordered by the requested sort.
|
|
4515
3389
|
* @public
|
|
@@ -4576,31 +3450,6 @@ export interface SendGiphyOutput {
|
|
|
4576
3450
|
* @public
|
|
4577
3451
|
*/
|
|
4578
3452
|
message: Message;
|
|
4579
|
-
/**
|
|
4580
|
-
* The request ID of the request.
|
|
4581
|
-
* @public
|
|
4582
|
-
*/
|
|
4583
|
-
requestId?: string | undefined;
|
|
4584
|
-
/**
|
|
4585
|
-
* The duration of the request in milliseconds.
|
|
4586
|
-
* @public
|
|
4587
|
-
*/
|
|
4588
|
-
requestDuration?: number | undefined;
|
|
4589
|
-
/**
|
|
4590
|
-
* Displays the applicable rate limits for the current request.
|
|
4591
|
-
* @public
|
|
4592
|
-
*/
|
|
4593
|
-
rateLimit?: string | undefined;
|
|
4594
|
-
/**
|
|
4595
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4596
|
-
* @public
|
|
4597
|
-
*/
|
|
4598
|
-
rateLimitRemaining?: number | undefined;
|
|
4599
|
-
/**
|
|
4600
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4601
|
-
* @public
|
|
4602
|
-
*/
|
|
4603
|
-
rateLimitReset?: number | undefined;
|
|
4604
3453
|
}
|
|
4605
3454
|
/**
|
|
4606
3455
|
* @public
|
|
@@ -4663,6 +3512,16 @@ export interface SendMessageInput {
|
|
|
4663
3512
|
*/
|
|
4664
3513
|
sms?: boolean | undefined;
|
|
4665
3514
|
smsStatus?: MessageSmsStatus | undefined;
|
|
3515
|
+
/**
|
|
3516
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
3517
|
+
* @public
|
|
3518
|
+
*/
|
|
3519
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
3520
|
+
/**
|
|
3521
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
3522
|
+
* @public
|
|
3523
|
+
*/
|
|
3524
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
4666
3525
|
/**
|
|
4667
3526
|
* Optional client-supplied message id. Auto-generated when omitted.
|
|
4668
3527
|
* @public
|
|
@@ -4693,31 +3552,6 @@ export interface SendMessageOutput {
|
|
|
4693
3552
|
* @public
|
|
4694
3553
|
*/
|
|
4695
3554
|
message: Message;
|
|
4696
|
-
/**
|
|
4697
|
-
* The request ID of the request.
|
|
4698
|
-
* @public
|
|
4699
|
-
*/
|
|
4700
|
-
requestId?: string | undefined;
|
|
4701
|
-
/**
|
|
4702
|
-
* The duration of the request in milliseconds.
|
|
4703
|
-
* @public
|
|
4704
|
-
*/
|
|
4705
|
-
requestDuration?: number | undefined;
|
|
4706
|
-
/**
|
|
4707
|
-
* Displays the applicable rate limits for the current request.
|
|
4708
|
-
* @public
|
|
4709
|
-
*/
|
|
4710
|
-
rateLimit?: string | undefined;
|
|
4711
|
-
/**
|
|
4712
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4713
|
-
* @public
|
|
4714
|
-
*/
|
|
4715
|
-
rateLimitRemaining?: number | undefined;
|
|
4716
|
-
/**
|
|
4717
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4718
|
-
* @public
|
|
4719
|
-
*/
|
|
4720
|
-
rateLimitReset?: number | undefined;
|
|
4721
3555
|
}
|
|
4722
3556
|
/**
|
|
4723
3557
|
* @public
|
|
@@ -4754,31 +3588,6 @@ export interface SendMessageReactionOutput {
|
|
|
4754
3588
|
* @public
|
|
4755
3589
|
*/
|
|
4756
3590
|
message: Message;
|
|
4757
|
-
/**
|
|
4758
|
-
* The request ID of the request.
|
|
4759
|
-
* @public
|
|
4760
|
-
*/
|
|
4761
|
-
requestId?: string | undefined;
|
|
4762
|
-
/**
|
|
4763
|
-
* The duration of the request in milliseconds.
|
|
4764
|
-
* @public
|
|
4765
|
-
*/
|
|
4766
|
-
requestDuration?: number | undefined;
|
|
4767
|
-
/**
|
|
4768
|
-
* Displays the applicable rate limits for the current request.
|
|
4769
|
-
* @public
|
|
4770
|
-
*/
|
|
4771
|
-
rateLimit?: string | undefined;
|
|
4772
|
-
/**
|
|
4773
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4774
|
-
* @public
|
|
4775
|
-
*/
|
|
4776
|
-
rateLimitRemaining?: number | undefined;
|
|
4777
|
-
/**
|
|
4778
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4779
|
-
* @public
|
|
4780
|
-
*/
|
|
4781
|
-
rateLimitReset?: number | undefined;
|
|
4782
3591
|
}
|
|
4783
3592
|
/**
|
|
4784
3593
|
* Empty payload for the WhatsApp 24-hour window closed system message.
|
|
@@ -4875,31 +3684,6 @@ export interface SendSystemMessageOutput {
|
|
|
4875
3684
|
* @public
|
|
4876
3685
|
*/
|
|
4877
3686
|
message: Message;
|
|
4878
|
-
/**
|
|
4879
|
-
* The request ID of the request.
|
|
4880
|
-
* @public
|
|
4881
|
-
*/
|
|
4882
|
-
requestId?: string | undefined;
|
|
4883
|
-
/**
|
|
4884
|
-
* The duration of the request in milliseconds.
|
|
4885
|
-
* @public
|
|
4886
|
-
*/
|
|
4887
|
-
requestDuration?: number | undefined;
|
|
4888
|
-
/**
|
|
4889
|
-
* Displays the applicable rate limits for the current request.
|
|
4890
|
-
* @public
|
|
4891
|
-
*/
|
|
4892
|
-
rateLimit?: string | undefined;
|
|
4893
|
-
/**
|
|
4894
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4895
|
-
* @public
|
|
4896
|
-
*/
|
|
4897
|
-
rateLimitRemaining?: number | undefined;
|
|
4898
|
-
/**
|
|
4899
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4900
|
-
* @public
|
|
4901
|
-
*/
|
|
4902
|
-
rateLimitReset?: number | undefined;
|
|
4903
3687
|
}
|
|
4904
3688
|
/**
|
|
4905
3689
|
* @public
|
|
@@ -4925,31 +3709,6 @@ export interface SendTypingStartInput {
|
|
|
4925
3709
|
* @public
|
|
4926
3710
|
*/
|
|
4927
3711
|
export interface SendTypingStartOutput {
|
|
4928
|
-
/**
|
|
4929
|
-
* The request ID of the request.
|
|
4930
|
-
* @public
|
|
4931
|
-
*/
|
|
4932
|
-
requestId?: string | undefined;
|
|
4933
|
-
/**
|
|
4934
|
-
* The duration of the request in milliseconds.
|
|
4935
|
-
* @public
|
|
4936
|
-
*/
|
|
4937
|
-
requestDuration?: number | undefined;
|
|
4938
|
-
/**
|
|
4939
|
-
* Displays the applicable rate limits for the current request.
|
|
4940
|
-
* @public
|
|
4941
|
-
*/
|
|
4942
|
-
rateLimit?: string | undefined;
|
|
4943
|
-
/**
|
|
4944
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4945
|
-
* @public
|
|
4946
|
-
*/
|
|
4947
|
-
rateLimitRemaining?: number | undefined;
|
|
4948
|
-
/**
|
|
4949
|
-
* Shows the time in seconds until the rate limit resets.
|
|
4950
|
-
* @public
|
|
4951
|
-
*/
|
|
4952
|
-
rateLimitReset?: number | undefined;
|
|
4953
3712
|
}
|
|
4954
3713
|
/**
|
|
4955
3714
|
* @public
|
|
@@ -4975,31 +3734,6 @@ export interface SendTypingStopInput {
|
|
|
4975
3734
|
* @public
|
|
4976
3735
|
*/
|
|
4977
3736
|
export interface SendTypingStopOutput {
|
|
4978
|
-
/**
|
|
4979
|
-
* The request ID of the request.
|
|
4980
|
-
* @public
|
|
4981
|
-
*/
|
|
4982
|
-
requestId?: string | undefined;
|
|
4983
|
-
/**
|
|
4984
|
-
* The duration of the request in milliseconds.
|
|
4985
|
-
* @public
|
|
4986
|
-
*/
|
|
4987
|
-
requestDuration?: number | undefined;
|
|
4988
|
-
/**
|
|
4989
|
-
* Displays the applicable rate limits for the current request.
|
|
4990
|
-
* @public
|
|
4991
|
-
*/
|
|
4992
|
-
rateLimit?: string | undefined;
|
|
4993
|
-
/**
|
|
4994
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
4995
|
-
* @public
|
|
4996
|
-
*/
|
|
4997
|
-
rateLimitRemaining?: number | undefined;
|
|
4998
|
-
/**
|
|
4999
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5000
|
-
* @public
|
|
5001
|
-
*/
|
|
5002
|
-
rateLimitReset?: number | undefined;
|
|
5003
3737
|
}
|
|
5004
3738
|
/**
|
|
5005
3739
|
* @public
|
|
@@ -5025,31 +3759,6 @@ export interface ShowChannelInput {
|
|
|
5025
3759
|
* @public
|
|
5026
3760
|
*/
|
|
5027
3761
|
export interface ShowChannelOutput {
|
|
5028
|
-
/**
|
|
5029
|
-
* The request ID of the request.
|
|
5030
|
-
* @public
|
|
5031
|
-
*/
|
|
5032
|
-
requestId?: string | undefined;
|
|
5033
|
-
/**
|
|
5034
|
-
* The duration of the request in milliseconds.
|
|
5035
|
-
* @public
|
|
5036
|
-
*/
|
|
5037
|
-
requestDuration?: number | undefined;
|
|
5038
|
-
/**
|
|
5039
|
-
* Displays the applicable rate limits for the current request.
|
|
5040
|
-
* @public
|
|
5041
|
-
*/
|
|
5042
|
-
rateLimit?: string | undefined;
|
|
5043
|
-
/**
|
|
5044
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5045
|
-
* @public
|
|
5046
|
-
*/
|
|
5047
|
-
rateLimitRemaining?: number | undefined;
|
|
5048
|
-
/**
|
|
5049
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5050
|
-
* @public
|
|
5051
|
-
*/
|
|
5052
|
-
rateLimitReset?: number | undefined;
|
|
5053
3762
|
}
|
|
5054
3763
|
/**
|
|
5055
3764
|
* @public
|
|
@@ -5075,31 +3784,6 @@ export interface UnmuteChannelInput {
|
|
|
5075
3784
|
* @public
|
|
5076
3785
|
*/
|
|
5077
3786
|
export interface UnmuteChannelOutput {
|
|
5078
|
-
/**
|
|
5079
|
-
* The request ID of the request.
|
|
5080
|
-
* @public
|
|
5081
|
-
*/
|
|
5082
|
-
requestId?: string | undefined;
|
|
5083
|
-
/**
|
|
5084
|
-
* The duration of the request in milliseconds.
|
|
5085
|
-
* @public
|
|
5086
|
-
*/
|
|
5087
|
-
requestDuration?: number | undefined;
|
|
5088
|
-
/**
|
|
5089
|
-
* Displays the applicable rate limits for the current request.
|
|
5090
|
-
* @public
|
|
5091
|
-
*/
|
|
5092
|
-
rateLimit?: string | undefined;
|
|
5093
|
-
/**
|
|
5094
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5095
|
-
* @public
|
|
5096
|
-
*/
|
|
5097
|
-
rateLimitRemaining?: number | undefined;
|
|
5098
|
-
/**
|
|
5099
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5100
|
-
* @public
|
|
5101
|
-
*/
|
|
5102
|
-
rateLimitReset?: number | undefined;
|
|
5103
3787
|
/**
|
|
5104
3788
|
* Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
|
|
5105
3789
|
* @public
|
|
@@ -5130,31 +3814,6 @@ export interface UnpinChannelInput {
|
|
|
5130
3814
|
* @public
|
|
5131
3815
|
*/
|
|
5132
3816
|
export interface UnpinChannelOutput {
|
|
5133
|
-
/**
|
|
5134
|
-
* The request ID of the request.
|
|
5135
|
-
* @public
|
|
5136
|
-
*/
|
|
5137
|
-
requestId?: string | undefined;
|
|
5138
|
-
/**
|
|
5139
|
-
* The duration of the request in milliseconds.
|
|
5140
|
-
* @public
|
|
5141
|
-
*/
|
|
5142
|
-
requestDuration?: number | undefined;
|
|
5143
|
-
/**
|
|
5144
|
-
* Displays the applicable rate limits for the current request.
|
|
5145
|
-
* @public
|
|
5146
|
-
*/
|
|
5147
|
-
rateLimit?: string | undefined;
|
|
5148
|
-
/**
|
|
5149
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5150
|
-
* @public
|
|
5151
|
-
*/
|
|
5152
|
-
rateLimitRemaining?: number | undefined;
|
|
5153
|
-
/**
|
|
5154
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5155
|
-
* @public
|
|
5156
|
-
*/
|
|
5157
|
-
rateLimitReset?: number | undefined;
|
|
5158
3817
|
}
|
|
5159
3818
|
/**
|
|
5160
3819
|
* @public
|
|
@@ -5186,31 +3845,6 @@ export interface UnpinMessageOutput {
|
|
|
5186
3845
|
* @public
|
|
5187
3846
|
*/
|
|
5188
3847
|
message: Message;
|
|
5189
|
-
/**
|
|
5190
|
-
* The request ID of the request.
|
|
5191
|
-
* @public
|
|
5192
|
-
*/
|
|
5193
|
-
requestId?: string | undefined;
|
|
5194
|
-
/**
|
|
5195
|
-
* The duration of the request in milliseconds.
|
|
5196
|
-
* @public
|
|
5197
|
-
*/
|
|
5198
|
-
requestDuration?: number | undefined;
|
|
5199
|
-
/**
|
|
5200
|
-
* Displays the applicable rate limits for the current request.
|
|
5201
|
-
* @public
|
|
5202
|
-
*/
|
|
5203
|
-
rateLimit?: string | undefined;
|
|
5204
|
-
/**
|
|
5205
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5206
|
-
* @public
|
|
5207
|
-
*/
|
|
5208
|
-
rateLimitRemaining?: number | undefined;
|
|
5209
|
-
/**
|
|
5210
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5211
|
-
* @public
|
|
5212
|
-
*/
|
|
5213
|
-
rateLimitReset?: number | undefined;
|
|
5214
3848
|
}
|
|
5215
3849
|
/**
|
|
5216
3850
|
* @public
|
|
@@ -5304,25 +3938,20 @@ export interface UpdateChannelInput {
|
|
|
5304
3938
|
*/
|
|
5305
3939
|
wizyGuestViewOnly?: boolean | undefined;
|
|
5306
3940
|
/**
|
|
5307
|
-
*
|
|
5308
|
-
* @public
|
|
5309
|
-
*/
|
|
5310
|
-
messenger?: boolean | undefined;
|
|
5311
|
-
/**
|
|
5312
|
-
* The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
3941
|
+
* The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
|
|
5313
3942
|
* @public
|
|
5314
3943
|
*/
|
|
5315
|
-
|
|
3944
|
+
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
5316
3945
|
/**
|
|
5317
|
-
* The Facebook Page ID the
|
|
3946
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram. Written by kite from the inbound event, because the channel id hashes the sender's linked service and not the sender, and a reply has to name the sender it is sent from.
|
|
5318
3947
|
* @public
|
|
5319
3948
|
*/
|
|
5320
|
-
|
|
3949
|
+
messagingSenderId?: string | undefined;
|
|
5321
3950
|
/**
|
|
5322
|
-
* Epoch seconds until which a reply still reaches the person
|
|
3951
|
+
* Epoch seconds until which a reply still reaches the person. On Messenger and Instagram this is Meta's 7 day HUMAN_AGENT deadline, restarted by each inbound message; classound applies the tag itself, so this is the one deadline a client has to show. 0 means the deadline is not known, which is what the inbound event carries when the session row was gone before it could be read back; it does not mean the window has closed, so a client reads the window as closed on `messagingReplyUntil > 0 && now > messagingReplyUntil` and shows nothing at 0. Absent on a channel with no reply window.
|
|
5323
3952
|
* @public
|
|
5324
3953
|
*/
|
|
5325
|
-
|
|
3954
|
+
messagingReplyUntil?: number | undefined;
|
|
5326
3955
|
/**
|
|
5327
3956
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
5328
3957
|
* @public
|
|
@@ -5334,31 +3963,6 @@ export interface UpdateChannelInput {
|
|
|
5334
3963
|
* @public
|
|
5335
3964
|
*/
|
|
5336
3965
|
export interface UpdateChannelOutput {
|
|
5337
|
-
/**
|
|
5338
|
-
* The request ID of the request.
|
|
5339
|
-
* @public
|
|
5340
|
-
*/
|
|
5341
|
-
requestId?: string | undefined;
|
|
5342
|
-
/**
|
|
5343
|
-
* The duration of the request in milliseconds.
|
|
5344
|
-
* @public
|
|
5345
|
-
*/
|
|
5346
|
-
requestDuration?: number | undefined;
|
|
5347
|
-
/**
|
|
5348
|
-
* Displays the applicable rate limits for the current request.
|
|
5349
|
-
* @public
|
|
5350
|
-
*/
|
|
5351
|
-
rateLimit?: string | undefined;
|
|
5352
|
-
/**
|
|
5353
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5354
|
-
* @public
|
|
5355
|
-
*/
|
|
5356
|
-
rateLimitRemaining?: number | undefined;
|
|
5357
|
-
/**
|
|
5358
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5359
|
-
* @public
|
|
5360
|
-
*/
|
|
5361
|
-
rateLimitReset?: number | undefined;
|
|
5362
3966
|
channel: Channel;
|
|
5363
3967
|
}
|
|
5364
3968
|
/**
|
|
@@ -5422,6 +4026,16 @@ export interface UpdateMessageInput {
|
|
|
5422
4026
|
*/
|
|
5423
4027
|
sms?: boolean | undefined;
|
|
5424
4028
|
smsStatus?: MessageSmsStatus | undefined;
|
|
4029
|
+
/**
|
|
4030
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. RCS is listed but not accepted yet: whether an RCS conversation is a telephony channel is still open, so conversations refuses it until its ticket decides.
|
|
4031
|
+
* @public
|
|
4032
|
+
*/
|
|
4033
|
+
messagingChannel?: MessagingChannel | undefined;
|
|
4034
|
+
/**
|
|
4035
|
+
* The delivery state of a message an agent sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS today). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
4036
|
+
* @public
|
|
4037
|
+
*/
|
|
4038
|
+
messagingStatus?: MessageMessagingStatus | undefined;
|
|
5425
4039
|
/**
|
|
5426
4040
|
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
5427
4041
|
* @public
|
|
@@ -5443,31 +4057,6 @@ export interface UpdateMessageOutput {
|
|
|
5443
4057
|
* @public
|
|
5444
4058
|
*/
|
|
5445
4059
|
message: Message;
|
|
5446
|
-
/**
|
|
5447
|
-
* The request ID of the request.
|
|
5448
|
-
* @public
|
|
5449
|
-
*/
|
|
5450
|
-
requestId?: string | undefined;
|
|
5451
|
-
/**
|
|
5452
|
-
* The duration of the request in milliseconds.
|
|
5453
|
-
* @public
|
|
5454
|
-
*/
|
|
5455
|
-
requestDuration?: number | undefined;
|
|
5456
|
-
/**
|
|
5457
|
-
* Displays the applicable rate limits for the current request.
|
|
5458
|
-
* @public
|
|
5459
|
-
*/
|
|
5460
|
-
rateLimit?: string | undefined;
|
|
5461
|
-
/**
|
|
5462
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5463
|
-
* @public
|
|
5464
|
-
*/
|
|
5465
|
-
rateLimitRemaining?: number | undefined;
|
|
5466
|
-
/**
|
|
5467
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5468
|
-
* @public
|
|
5469
|
-
*/
|
|
5470
|
-
rateLimitReset?: number | undefined;
|
|
5471
4060
|
}
|
|
5472
4061
|
/**
|
|
5473
4062
|
* Optional parameters for the upload presign flow.
|
|
@@ -5519,31 +4108,6 @@ export interface UploadFileInput {
|
|
|
5519
4108
|
* @public
|
|
5520
4109
|
*/
|
|
5521
4110
|
export interface UploadFileOutput {
|
|
5522
|
-
/**
|
|
5523
|
-
* The request ID of the request.
|
|
5524
|
-
* @public
|
|
5525
|
-
*/
|
|
5526
|
-
requestId?: string | undefined;
|
|
5527
|
-
/**
|
|
5528
|
-
* The duration of the request in milliseconds.
|
|
5529
|
-
* @public
|
|
5530
|
-
*/
|
|
5531
|
-
requestDuration?: number | undefined;
|
|
5532
|
-
/**
|
|
5533
|
-
* Displays the applicable rate limits for the current request.
|
|
5534
|
-
* @public
|
|
5535
|
-
*/
|
|
5536
|
-
rateLimit?: string | undefined;
|
|
5537
|
-
/**
|
|
5538
|
-
* Indicates how many requests a user can still make within the current time window.
|
|
5539
|
-
* @public
|
|
5540
|
-
*/
|
|
5541
|
-
rateLimitRemaining?: number | undefined;
|
|
5542
|
-
/**
|
|
5543
|
-
* Shows the time in seconds until the rate limit resets.
|
|
5544
|
-
* @public
|
|
5545
|
-
*/
|
|
5546
|
-
rateLimitReset?: number | undefined;
|
|
5547
4111
|
/**
|
|
5548
4112
|
* File service identifier. Pass this value as `attachments[].fsId` on send and edit.
|
|
5549
4113
|
* @public
|