@wildix/stream-client 4.1.5 → 4.1.7

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessengerStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessengerStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, SearchSort, SectionType } from "./enums";
+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";
 /**
  * @public
  */
@@ -462,6 +462,11 @@ export interface Channel {
     service?: string | undefined;
     serviceRecipient?: string | undefined;
     telephony?: boolean | undefined;
+    /**
+     * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
     external?: boolean | undefined;
     /**
      * Message ids currently pinned at channel scope, newest pin first. Empty when nothing is pinned.
@@ -551,25 +556,20 @@ export interface Channel {
      */
     wizyGuestViewOnly?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingStatus?: ChannelMessagingStatus | undefined;
     /**
-     * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
+     * 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.
      * @public
      */
-    messengerStatus?: ChannelMessengerStatus | undefined;
+    messagingSenderId?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerPageId?: string | undefined;
-    /**
-     * 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.
-     * @public
-     */
-    messengerReplyUntil?: number | undefined;
+    messagingReplyUntil?: number | undefined;
 }
 /**
  * Read pointer for one channel member.
@@ -687,25 +687,20 @@ export interface CreateGroupChannelInput {
      */
     wizyGuestViewOnly?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
-     * @public
-     */
-    messenger?: boolean | undefined;
-    /**
-     * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
+     * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
      * @public
      */
-    messengerStatus?: ChannelMessengerStatus | undefined;
+    messagingStatus?: ChannelMessagingStatus | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerPageId?: string | undefined;
+    messagingSenderId?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerReplyUntil?: number | undefined;
+    messagingReplyUntil?: number | undefined;
     /**
      * Optional client-supplied channel id.
      * @public
@@ -892,6 +887,16 @@ export interface InitialMessage {
      */
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
     /**
      * Optional client-supplied message id. Auto-generated when omitted.
      * @public
@@ -955,6 +960,16 @@ export interface WelcomeMessage {
      */
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
     /**
      * Optional client-supplied message id. Auto-generated when omitted.
      * @public
@@ -1432,12 +1447,16 @@ export interface Message {
      * @public
      */
     pollId?: string | undefined;
-    messenger?: boolean | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerStatus?: MessageMessengerStatus | undefined;
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
 }
 /**
  * @public
@@ -1748,6 +1767,11 @@ export interface InboxChannel {
     service?: string | undefined;
     serviceRecipient?: string | undefined;
     telephony?: boolean | undefined;
+    /**
+     * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
     external?: boolean | undefined;
     /**
      * Message ids currently pinned at channel scope, newest pin first. Empty when nothing is pinned.
@@ -1837,25 +1861,20 @@ export interface InboxChannel {
      */
     wizyGuestViewOnly?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingStatus?: ChannelMessagingStatus | undefined;
     /**
-     * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
+     * 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.
      * @public
      */
-    messengerStatus?: ChannelMessengerStatus | undefined;
+    messagingSenderId?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerPageId?: string | undefined;
-    /**
-     * 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.
-     * @public
-     */
-    messengerReplyUntil?: number | undefined;
+    messagingReplyUntil?: number | undefined;
     /**
      * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
      * @public
@@ -2905,25 +2924,20 @@ export interface PartialUpdateChannelSetOptions {
      */
     wizyGuestViewOnly?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingStatus?: ChannelMessagingStatus | undefined;
     /**
-     * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
+     * 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.
      * @public
      */
-    messengerStatus?: ChannelMessengerStatus | undefined;
+    messagingSenderId?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerPageId?: string | undefined;
-    /**
-     * 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.
-     * @public
-     */
-    messengerReplyUntil?: number | undefined;
+    messagingReplyUntil?: number | undefined;
 }
 /**
  * @public
@@ -3005,6 +3019,16 @@ export interface PartialUpdateMessageSetInput {
      */
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
 }
 /**
  * @public
@@ -3488,6 +3512,16 @@ export interface SendMessageInput {
      */
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
     /**
      * Optional client-supplied message id. Auto-generated when omitted.
      * @public
@@ -3904,25 +3938,20 @@ export interface UpdateChannelInput {
      */
     wizyGuestViewOnly?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
-     * @public
-     */
-    messenger?: boolean | undefined;
-    /**
-     * The Messenger reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
+     * The reply state of the channel: WINDOW_CLOSED after classound refused a reply, absent while a reply can be sent.
      * @public
      */
-    messengerStatus?: ChannelMessengerStatus | undefined;
+    messagingStatus?: ChannelMessagingStatus | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerPageId?: string | undefined;
+    messagingSenderId?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
-    messengerReplyUntil?: number | undefined;
+    messagingReplyUntil?: number | undefined;
     /**
      * 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.
      * @public
@@ -3997,6 +4026,16 @@ export interface UpdateMessageInput {
      */
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingChannel?: MessagingChannel | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messagingStatus?: MessageMessagingStatus | undefined;
     /**
      * 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.
      * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/stream-client",
     "description": "@wildix/stream-client client",
-    "version": "4.1.5",
+    "version": "4.1.7",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -56,4 +56,4 @@
     "browser": {
         "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
     }
-}
+}