@wildix/xbees-conversations-client 4.1.1 → 4.2.0

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.
Files changed (43) hide show
  1. package/dist-cjs/Conversations.js +4 -4
  2. package/dist-cjs/commands/{GetMessengerChannelIdCommand.js → GetMessagingChannelIdCommand.js} +6 -6
  3. package/dist-cjs/commands/{GetOrCreateMessengerChannelCommand.js → GetOrCreateMessagingChannelCommand.js} +6 -6
  4. package/dist-cjs/commands/index.js +2 -2
  5. package/dist-cjs/models/enums.js +9 -4
  6. package/dist-cjs/schemas/schemas_0.js +49 -49
  7. package/dist-es/Conversations.js +4 -4
  8. package/dist-es/commands/{GetMessengerChannelIdCommand.js → GetMessagingChannelIdCommand.js} +5 -5
  9. package/dist-es/commands/{GetOrCreateMessengerChannelCommand.js → GetOrCreateMessagingChannelCommand.js} +5 -5
  10. package/dist-es/commands/index.js +2 -2
  11. package/dist-es/models/enums.js +8 -3
  12. package/dist-es/schemas/schemas_0.js +47 -47
  13. package/dist-types/Conversations.d.ts +10 -10
  14. package/dist-types/ConversationsClient.d.ts +4 -4
  15. package/dist-types/commands/CreateGroupChannelCommand.d.ts +7 -8
  16. package/dist-types/commands/CreateKiteChannelCommand.d.ts +8 -8
  17. package/dist-types/commands/DescribeEventCommand.d.ts +30 -30
  18. package/dist-types/commands/GetChannelCommand.d.ts +4 -4
  19. package/dist-types/commands/GetMessageCommand.d.ts +2 -2
  20. package/dist-types/commands/GetMessagingChannelIdCommand.d.ts +84 -0
  21. package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +4 -4
  22. package/dist-types/commands/{GetOrCreateMessengerChannelCommand.d.ts → GetOrCreateMessagingChannelCommand.d.ts} +28 -27
  23. package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +4 -4
  24. package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +4 -4
  25. package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +4 -4
  26. package/dist-types/commands/JoinChannelCommand.d.ts +4 -4
  27. package/dist-types/commands/ListChannelsCommand.d.ts +4 -4
  28. package/dist-types/commands/ListMessagesCommand.d.ts +2 -2
  29. package/dist-types/commands/ListPinnedMessagesCommand.d.ts +2 -2
  30. package/dist-types/commands/PartialUpdateChannelCommand.d.ts +8 -9
  31. package/dist-types/commands/PartialUpdateMessageCommand.d.ts +4 -4
  32. package/dist-types/commands/QueryChannelsCommand.d.ts +4 -4
  33. package/dist-types/commands/SendGiphyCommand.d.ts +2 -2
  34. package/dist-types/commands/SendMessageCommand.d.ts +4 -4
  35. package/dist-types/commands/SendSystemMessageCommand.d.ts +2 -2
  36. package/dist-types/commands/UpdateChannelCommand.d.ts +7 -8
  37. package/dist-types/commands/UpdateMessageCommand.d.ts +4 -4
  38. package/dist-types/commands/index.d.ts +2 -2
  39. package/dist-types/models/enums.d.ts +18 -5
  40. package/dist-types/models/models_0.d.ts +84 -61
  41. package/dist-types/schemas/schemas_0.d.ts +6 -6
  42. package/package.json +4 -3
  43. package/dist-types/commands/GetMessengerChannelIdCommand.d.ts +0 -83
@@ -1,4 +1,4 @@
1
- import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessengerStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessengerStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, ReactionType, WebhookEventType } from "./enums";
1
+ import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, ReactionType, WebhookEventType } from "./enums";
2
2
  /**
3
3
  * @public
4
4
  */
@@ -107,14 +107,18 @@ export interface Channel {
107
107
  mms?: boolean | undefined;
108
108
  whatsapp?: boolean | undefined;
109
109
  whatsappStatus?: ChannelWhatsAppStatus | undefined;
110
- messenger?: boolean | undefined;
110
+ /**
111
+ * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
112
+ * @public
113
+ */
114
+ messagingChannel?: MessagingChannel | undefined;
111
115
  /**
112
116
  * Set when classound refused a reply because the person's messaging window is closed (a 409 on the send). Unset by the next inbound message, which is the only thing that reopens the window.
113
117
  * @public
114
118
  */
115
- messengerStatus?: ChannelMessengerStatus | undefined;
116
- messengerPageId?: string | undefined;
117
- messengerReplyUntil?: number | undefined;
119
+ messagingStatus?: ChannelMessagingStatus | undefined;
120
+ messagingSenderId?: string | undefined;
121
+ messagingReplyUntil?: number | undefined;
118
122
  broadcast?: boolean | undefined;
119
123
  external?: boolean | undefined;
120
124
  autoRecord?: boolean | undefined;
@@ -359,12 +363,16 @@ export interface Message {
359
363
  forward?: MessageForward | undefined;
360
364
  whatsapp?: boolean | undefined;
361
365
  whatsappStatus?: MessageWhatsAppStatus | undefined;
362
- messenger?: boolean | undefined;
363
366
  /**
364
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
367
+ * 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.
365
368
  * @public
366
369
  */
367
- messengerStatus?: MessageMessengerStatus | undefined;
370
+ messagingChannel?: MessagingChannel | undefined;
371
+ /**
372
+ * 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.
373
+ * @public
374
+ */
375
+ messagingStatus?: MessageMessagingStatus | undefined;
368
376
  sms?: boolean | undefined;
369
377
  smsStatus?: MessageSmsStatus | undefined;
370
378
  markdown?: boolean | undefined;
@@ -402,7 +410,7 @@ export interface UserToInvite {
402
410
  */
403
411
  email?: string | undefined;
404
412
  /**
405
- * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided. On Facebook Messenger it is not a phone number at all: the caller passes the Page Scoped ID, so the identity key stays the one the supplier reports. UserPhone allows up to 17 digits and a Page Scoped ID is 17, so there is no headroom left.
413
+ * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided. On a customer messaging channel (see MessagingChannel) it is not a phone number at all: the caller passes the channel's own customer id, the Page Scoped ID on Messenger, so the identity key stays the one the supplier reports. UserPhone allows up to 17 digits and a Page Scoped ID is 17, so there is no headroom left, and the Instagram scoped id has to be checked against the same limit.
406
414
  * @public
407
415
  */
408
416
  phone?: string | undefined;
@@ -783,25 +791,20 @@ export interface CreateGroupChannelInput {
783
791
  */
784
792
  whatsapp?: boolean | undefined;
785
793
  /**
786
- * Indicates if the channel supports Facebook Messenger. Default is false.
787
- * @public
788
- */
789
- messenger?: boolean | undefined;
790
- /**
791
- * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
794
+ * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
792
795
  * @public
793
796
  */
794
- messengerStatus?: ChannelMessengerStatus | undefined;
797
+ messagingStatus?: ChannelMessagingStatus | undefined;
795
798
  /**
796
- * The Facebook Page ID the conversation runs through. Written by kite from the inbound event, because the channel id hashes the page's linked service and not the page, and a reply has to name the page it is sent from.
799
+ * 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.
797
800
  * @public
798
801
  */
799
- messengerPageId?: string | undefined;
802
+ messagingSenderId?: string | undefined;
800
803
  /**
801
- * 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.
804
+ * 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.
802
805
  * @public
803
806
  */
804
- messengerReplyUntil?: number | undefined;
807
+ messagingReplyUntil?: number | undefined;
805
808
  /**
806
809
  * The unique identifier of the assignee.
807
810
  * @public
@@ -892,12 +895,16 @@ export interface InitialMessage {
892
895
  forward?: MessageForward | undefined;
893
896
  whatsapp?: boolean | undefined;
894
897
  whatsappStatus?: MessageWhatsAppStatus | undefined;
895
- messenger?: boolean | undefined;
896
898
  /**
897
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
899
+ * 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.
898
900
  * @public
899
901
  */
900
- messengerStatus?: MessageMessengerStatus | undefined;
902
+ messagingChannel?: MessagingChannel | undefined;
903
+ /**
904
+ * 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.
905
+ * @public
906
+ */
907
+ messagingStatus?: MessageMessagingStatus | undefined;
901
908
  sms?: boolean | undefined;
902
909
  smsStatus?: MessageSmsStatus | undefined;
903
910
  markdown?: boolean | undefined;
@@ -923,12 +930,16 @@ export interface WelcomeMessage {
923
930
  forward?: MessageForward | undefined;
924
931
  whatsapp?: boolean | undefined;
925
932
  whatsappStatus?: MessageWhatsAppStatus | undefined;
926
- messenger?: boolean | undefined;
927
933
  /**
928
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
934
+ * 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.
929
935
  * @public
930
936
  */
931
- messengerStatus?: MessageMessengerStatus | undefined;
937
+ messagingChannel?: MessagingChannel | undefined;
938
+ /**
939
+ * 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.
940
+ * @public
941
+ */
942
+ messagingStatus?: MessageMessagingStatus | undefined;
932
943
  sms?: boolean | undefined;
933
944
  smsStatus?: MessageSmsStatus | undefined;
934
945
  markdown?: boolean | undefined;
@@ -1520,7 +1531,7 @@ export interface GetMessageOutput {
1520
1531
  /**
1521
1532
  * @public
1522
1533
  */
1523
- export interface GetMessengerChannelIdInput {
1534
+ export interface GetMessagingChannelIdInput {
1524
1535
  /**
1525
1536
  * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
1526
1537
  * @public
@@ -1541,11 +1552,16 @@ export interface GetMessengerChannelIdInput {
1541
1552
  * @public
1542
1553
  */
1543
1554
  recipientNumber?: string | undefined;
1555
+ /**
1556
+ * The customer messaging channel the conversation runs over.
1557
+ * @public
1558
+ */
1559
+ channel: MessagingChannel;
1544
1560
  }
1545
1561
  /**
1546
1562
  * @public
1547
1563
  */
1548
- export interface GetMessengerChannelIdOutput {
1564
+ export interface GetMessagingChannelIdOutput {
1549
1565
  /**
1550
1566
  * 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.
1551
1567
  * @public
@@ -1581,7 +1597,7 @@ export interface GetOrCreateDirectChannelOutput {
1581
1597
  /**
1582
1598
  * @public
1583
1599
  */
1584
- export interface GetOrCreateMessengerChannelInput {
1600
+ export interface GetOrCreateMessagingChannelInput {
1585
1601
  /**
1586
1602
  * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
1587
1603
  * @public
@@ -1602,6 +1618,11 @@ export interface GetOrCreateMessengerChannelInput {
1602
1618
  * @public
1603
1619
  */
1604
1620
  recipientNumber?: string | undefined;
1621
+ /**
1622
+ * The customer messaging channel the conversation runs over.
1623
+ * @public
1624
+ */
1625
+ channel: MessagingChannel;
1605
1626
  /**
1606
1627
  * Indicates if the channel is outgoing. It's prevents applying routing settings for the channel. This parameter will be reset to false after 48 hours. Default is false.
1607
1628
  * @public
@@ -1611,7 +1632,7 @@ export interface GetOrCreateMessengerChannelInput {
1611
1632
  /**
1612
1633
  * @public
1613
1634
  */
1614
- export interface GetOrCreateMessengerChannelOutput {
1635
+ export interface GetOrCreateMessagingChannelOutput {
1615
1636
  channel: Channel;
1616
1637
  }
1617
1638
  /**
@@ -2306,25 +2327,20 @@ export interface PartialUpdateChannelSetOptions {
2306
2327
  */
2307
2328
  whatsapp?: boolean | undefined;
2308
2329
  /**
2309
- * Indicates if the channel supports Facebook Messenger. Default is false.
2330
+ * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
2310
2331
  * @public
2311
2332
  */
2312
- messenger?: boolean | undefined;
2333
+ messagingStatus?: ChannelMessagingStatus | undefined;
2313
2334
  /**
2314
- * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
2335
+ * 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.
2315
2336
  * @public
2316
2337
  */
2317
- messengerStatus?: ChannelMessengerStatus | undefined;
2338
+ messagingSenderId?: string | undefined;
2318
2339
  /**
2319
- * The Facebook Page ID the conversation runs through. Written by kite from the inbound event, because the channel id hashes the page's linked service and not the page, and a reply has to name the page it is sent from.
2340
+ * 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.
2320
2341
  * @public
2321
2342
  */
2322
- messengerPageId?: string | undefined;
2323
- /**
2324
- * 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.
2325
- * @public
2326
- */
2327
- messengerReplyUntil?: number | undefined;
2343
+ messagingReplyUntil?: number | undefined;
2328
2344
  /**
2329
2345
  * The unique identifier of the assignee.
2330
2346
  * @public
@@ -2387,12 +2403,16 @@ export interface PartialUpdateMessageSetInput {
2387
2403
  forward?: MessageForward | undefined;
2388
2404
  whatsapp?: boolean | undefined;
2389
2405
  whatsappStatus?: MessageWhatsAppStatus | undefined;
2390
- messenger?: boolean | undefined;
2391
2406
  /**
2392
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
2407
+ * 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.
2408
+ * @public
2409
+ */
2410
+ messagingChannel?: MessagingChannel | undefined;
2411
+ /**
2412
+ * 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.
2393
2413
  * @public
2394
2414
  */
2395
- messengerStatus?: MessageMessengerStatus | undefined;
2415
+ messagingStatus?: MessageMessagingStatus | undefined;
2396
2416
  sms?: boolean | undefined;
2397
2417
  smsStatus?: MessageSmsStatus | undefined;
2398
2418
  markdown?: boolean | undefined;
@@ -2618,12 +2638,16 @@ export interface SendMessageInput {
2618
2638
  forward?: MessageForward | undefined;
2619
2639
  whatsapp?: boolean | undefined;
2620
2640
  whatsappStatus?: MessageWhatsAppStatus | undefined;
2621
- messenger?: boolean | undefined;
2622
2641
  /**
2623
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
2642
+ * 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.
2624
2643
  * @public
2625
2644
  */
2626
- messengerStatus?: MessageMessengerStatus | undefined;
2645
+ messagingChannel?: MessagingChannel | undefined;
2646
+ /**
2647
+ * 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.
2648
+ * @public
2649
+ */
2650
+ messagingStatus?: MessageMessagingStatus | undefined;
2627
2651
  sms?: boolean | undefined;
2628
2652
  smsStatus?: MessageSmsStatus | undefined;
2629
2653
  markdown?: boolean | undefined;
@@ -3017,25 +3041,20 @@ export interface UpdateChannelInput {
3017
3041
  */
3018
3042
  whatsapp?: boolean | undefined;
3019
3043
  /**
3020
- * Indicates if the channel supports Facebook Messenger. Default is false.
3044
+ * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
3021
3045
  * @public
3022
3046
  */
3023
- messenger?: boolean | undefined;
3047
+ messagingStatus?: ChannelMessagingStatus | undefined;
3024
3048
  /**
3025
- * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
3049
+ * 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.
3026
3050
  * @public
3027
3051
  */
3028
- messengerStatus?: ChannelMessengerStatus | undefined;
3052
+ messagingSenderId?: string | undefined;
3029
3053
  /**
3030
- * The Facebook Page ID the conversation runs through. Written by kite from the inbound event, because the channel id hashes the page's linked service and not the page, and a reply has to name the page it is sent from.
3054
+ * 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.
3031
3055
  * @public
3032
3056
  */
3033
- messengerPageId?: string | undefined;
3034
- /**
3035
- * 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.
3036
- * @public
3037
- */
3038
- messengerReplyUntil?: number | undefined;
3057
+ messagingReplyUntil?: number | undefined;
3039
3058
  /**
3040
3059
  * The unique identifier of the assignee.
3041
3060
  * @public
@@ -3109,12 +3128,16 @@ export interface UpdateMessageInput {
3109
3128
  forward?: MessageForward | undefined;
3110
3129
  whatsapp?: boolean | undefined;
3111
3130
  whatsappStatus?: MessageWhatsAppStatus | undefined;
3112
- messenger?: boolean | undefined;
3113
3131
  /**
3114
- * The delivery state of a Facebook Messenger message an agent sent, 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 MESSENGER.STATUS stream event. A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
3132
+ * 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.
3133
+ * @public
3134
+ */
3135
+ messagingChannel?: MessagingChannel | undefined;
3136
+ /**
3137
+ * 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.
3115
3138
  * @public
3116
3139
  */
3117
- messengerStatus?: MessageMessengerStatus | undefined;
3140
+ messagingStatus?: MessageMessagingStatus | undefined;
3118
3141
  sms?: boolean | undefined;
3119
3142
  smsStatus?: MessageSmsStatus | undefined;
3120
3143
  markdown?: boolean | undefined;
@@ -80,12 +80,12 @@ export declare var GetInboxStateInput$: StaticStructureSchema;
80
80
  export declare var GetInboxStateOutput$: StaticStructureSchema;
81
81
  export declare var GetMessageInput$: StaticStructureSchema;
82
82
  export declare var GetMessageOutput$: StaticStructureSchema;
83
- export declare var GetMessengerChannelIdInput$: StaticStructureSchema;
84
- export declare var GetMessengerChannelIdOutput$: StaticStructureSchema;
83
+ export declare var GetMessagingChannelIdInput$: StaticStructureSchema;
84
+ export declare var GetMessagingChannelIdOutput$: StaticStructureSchema;
85
85
  export declare var GetOrCreateDirectChannelInput$: StaticStructureSchema;
86
86
  export declare var GetOrCreateDirectChannelOutput$: StaticStructureSchema;
87
- export declare var GetOrCreateMessengerChannelInput$: StaticStructureSchema;
88
- export declare var GetOrCreateMessengerChannelOutput$: StaticStructureSchema;
87
+ export declare var GetOrCreateMessagingChannelInput$: StaticStructureSchema;
88
+ export declare var GetOrCreateMessagingChannelOutput$: StaticStructureSchema;
89
89
  export declare var GetOrCreateSmsChannelInput$: StaticStructureSchema;
90
90
  export declare var GetOrCreateSmsChannelOutput$: StaticStructureSchema;
91
91
  export declare var GetOrCreateTelephonyChannelInput$: StaticStructureSchema;
@@ -242,9 +242,9 @@ export declare var GetDirectChannelId$: StaticOperationSchema;
242
242
  export declare var GetFilePresignedDownloadUrl$: StaticOperationSchema;
243
243
  export declare var GetInboxState$: StaticOperationSchema;
244
244
  export declare var GetMessage$: StaticOperationSchema;
245
- export declare var GetMessengerChannelId$: StaticOperationSchema;
245
+ export declare var GetMessagingChannelId$: StaticOperationSchema;
246
246
  export declare var GetOrCreateDirectChannel$: StaticOperationSchema;
247
- export declare var GetOrCreateMessengerChannel$: StaticOperationSchema;
247
+ export declare var GetOrCreateMessagingChannel$: StaticOperationSchema;
248
248
  export declare var GetOrCreateSmsChannel$: StaticOperationSchema;
249
249
  export declare var GetOrCreateTelephonyChannel$: StaticOperationSchema;
250
250
  export declare var GetOrCreateWhatsAppChannel$: StaticOperationSchema;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/xbees-conversations-client",
3
3
  "description": "@wildix/xbees-conversations-client client",
4
- "version": "4.1.1",
4
+ "version": "4.2.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -25,7 +25,8 @@
25
25
  "@smithy/fetch-http-handler": "^5.4.5",
26
26
  "@smithy/node-http-handler": "^4.7.5",
27
27
  "@smithy/types": "^4.14.2",
28
- "@wildix/smithy-react-native": "^1.0.0"
28
+ "@wildix/smithy-react-native": "^1.0.0",
29
+ "@smithy/middleware-endpoint": "^4.7.2"
29
30
  },
30
31
  "devDependencies": {
31
32
  "@tsconfig/node20": "20.1.8",
@@ -56,4 +57,4 @@
56
57
  "browser": {
57
58
  "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
58
59
  }
59
- }
60
+ }
@@ -1,83 +0,0 @@
1
- import { Command as $Command } from "@smithy/core/client";
2
- import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import type { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
4
- import type { GetMessengerChannelIdInput, GetMessengerChannelIdOutput } from "../models/models_0";
5
- /**
6
- * @public
7
- */
8
- export type { __MetadataBearer };
9
- export { $Command };
10
- /**
11
- * @public
12
- *
13
- * The input for {@link GetMessengerChannelIdCommand}.
14
- */
15
- export interface GetMessengerChannelIdCommandInput extends GetMessengerChannelIdInput {
16
- }
17
- /**
18
- * @public
19
- *
20
- * The output of {@link GetMessengerChannelIdCommand}.
21
- */
22
- export interface GetMessengerChannelIdCommandOutput extends GetMessengerChannelIdOutput, __MetadataBearer {
23
- }
24
- declare const GetMessengerChannelIdCommand_base: {
25
- new (input: GetMessengerChannelIdCommandInput): import("@smithy/core/client").CommandImpl<GetMessengerChannelIdCommandInput, GetMessengerChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
- new (input: GetMessengerChannelIdCommandInput): import("@smithy/core/client").CommandImpl<GetMessengerChannelIdCommandInput, GetMessengerChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
- getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
- };
29
- /**
30
- * Gets the channel ID of an existing or non-existing Facebook Messenger channel. The person is named by recipientId, the x-bees user invited for them; recipientNumber names the same person directly. On this channel either value resolves to a Page Scoped ID, an opaque Meta identifier and not a phone number.
31
- * @example
32
- * Use a bare-bones client and the command you need to make an API call.
33
- * ```javascript
34
- * import { ConversationsClient, GetMessengerChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
35
- * // const { ConversationsClient, GetMessengerChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
36
- * // import type { ConversationsClientConfig } from "@wildix/xbees-conversations-client";
37
- * const config = {}; // type is ConversationsClientConfig
38
- * const client = new ConversationsClient(config);
39
- * const input = { // GetMessengerChannelIdInput
40
- * userId: "STRING_VALUE",
41
- * serviceUri: "STRING_VALUE", // required
42
- * recipientId: "STRING_VALUE",
43
- * recipientNumber: "STRING_VALUE",
44
- * };
45
- * const command = new GetMessengerChannelIdCommand(input);
46
- * const response = await client.send(command);
47
- * // { // GetMessengerChannelIdOutput
48
- * // channelId: "STRING_VALUE", // required
49
- * // };
50
- *
51
- * ```
52
- *
53
- * @param GetMessengerChannelIdCommandInput - {@link GetMessengerChannelIdCommandInput}
54
- * @returns {@link GetMessengerChannelIdCommandOutput}
55
- * @see {@link GetMessengerChannelIdCommandInput} for command's `input` shape.
56
- * @see {@link GetMessengerChannelIdCommandOutput} for command's `response` shape.
57
- * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
58
- *
59
- * @throws {@link ForbiddenException} (client fault)
60
- *
61
- * @throws {@link ValidationException} (client fault)
62
- *
63
- * @throws {@link RateLimitExceededException} (client fault)
64
- *
65
- * @throws {@link ConversationsSyntheticServiceException}
66
- * <p>Base exception class for all service exceptions from Conversations service.</p>
67
- *
68
- *
69
- * @public
70
- */
71
- export declare class GetMessengerChannelIdCommand extends GetMessengerChannelIdCommand_base {
72
- /** @internal type navigation helper, not in runtime. */
73
- protected static __types: {
74
- api: {
75
- input: GetMessengerChannelIdInput;
76
- output: GetMessengerChannelIdOutput;
77
- };
78
- sdk: {
79
- input: GetMessengerChannelIdCommandInput;
80
- output: GetMessengerChannelIdCommandOutput;
81
- };
82
- };
83
- }