@wildix/xbees-conversations-client 4.0.4 → 4.1.1

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

@@ -1,4 +1,4 @@
-import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, ReactionType, WebhookEventType } from "./enums";
+import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessengerStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessengerStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, ReactionType, WebhookEventType } from "./enums";
 /**
  * @public
  */
@@ -107,11 +107,23 @@ export interface Channel {
     mms?: boolean | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: ChannelWhatsAppStatus | undefined;
+    messenger?: boolean | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    messengerStatus?: ChannelMessengerStatus | undefined;
+    messengerPageId?: string | undefined;
+    messengerReplyUntil?: number | undefined;
     broadcast?: boolean | undefined;
     external?: boolean | undefined;
     autoRecord?: boolean | undefined;
     transcriptionLanguage?: string | undefined;
     wizyGuestViewOnly?: boolean | 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
+     */
     channelId: string;
     channelType: ChannelType;
     memberCount: number;
@@ -292,6 +304,10 @@ export interface MessageForward {
     forwardEmail?: string | undefined;
     forwardName?: string | undefined;
     messageId: string;
+    /**
+     * 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
+     */
     channelId: string;
 }
 /**
@@ -318,6 +334,10 @@ export interface Reaction {
  */
 export interface MessageQuote {
     messageId: string;
+    /**
+     * 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
+     */
     channelId: string;
     user: User;
     text?: string | undefined;
@@ -339,6 +359,12 @@ export interface Message {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -347,6 +373,10 @@ export interface Message {
     silent?: boolean | undefined;
     event?: string | undefined;
     messageId: string;
+    /**
+     * 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
+     */
     channelId: string;
     user: User;
     edit?: boolean | undefined;
@@ -372,7 +402,7 @@ export interface UserToInvite {
      */
     email?: string | undefined;
     /**
-     * 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.
+     * 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.
      * @public
      */
     phone?: string | undefined;
@@ -608,6 +638,10 @@ export declare namespace AssignChannelServiceRequest {
  * @public
  */
 export interface AssignChannelInput {
+    /**
+     * 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
+     */
     channelId: string;
     /**
      * The unique identifier of the user when a service token is used.
@@ -748,6 +782,26 @@ export interface CreateGroupChannelInput {
      * @public
      */
     whatsapp?: 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.
+     * @public
+     */
+    messengerStatus?: ChannelMessengerStatus | 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.
+     * @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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -838,6 +892,12 @@ export interface InitialMessage {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -863,6 +923,12 @@ export interface WelcomeMessage {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -1321,6 +1387,10 @@ export interface GetDirectChannelIdInput {
  * @public
  */
 export interface GetDirectChannelIdOutput {
+    /**
+     * 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
+     */
     channelId: string;
 }
 /**
@@ -1377,6 +1447,10 @@ export interface GetInboxStateInput {
  * @public
  */
 export interface InboxPinnedChannel {
+    /**
+     * 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
+     */
     channelId: string;
     pinnedAt: string;
 }
@@ -1384,6 +1458,10 @@ export interface InboxPinnedChannel {
  * @public
  */
 export interface InboxTaggedChannel {
+    /**
+     * 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
+     */
     channelId: string;
     tagId: string;
 }
@@ -1391,6 +1469,10 @@ export interface InboxTaggedChannel {
  * @public
  */
 export interface InboxUnreadChannel {
+    /**
+     * 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
+     */
     channelId: string;
     /**
      * A date when unread indicator was set by the user.
@@ -1435,6 +1517,41 @@ export interface GetMessageInput {
 export interface GetMessageOutput {
     message: Message;
 }
+/**
+ * @public
+ */
+export interface GetMessengerChannelIdInput {
+    /**
+     * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * The unique identifier of the telephony channel.
+     * @public
+     */
+    serviceUri: string;
+    /**
+     * The unique identifier of the recipient. Required if recipientNumber is not provided.
+     * @public
+     */
+    recipientId?: string | undefined;
+    /**
+     * The unique identifier of the recipient. Required if recipientId is not provided.
+     * @public
+     */
+    recipientNumber?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetMessengerChannelIdOutput {
+    /**
+     * 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
+     */
+    channelId: string;
+}
 /**
  * @public
  */
@@ -1461,6 +1578,42 @@ export interface GetOrCreateDirectChannelInput {
 export interface GetOrCreateDirectChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ */
+export interface GetOrCreateMessengerChannelInput {
+    /**
+     * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * The unique identifier of the telephony channel.
+     * @public
+     */
+    serviceUri: string;
+    /**
+     * The unique identifier of the recipient. Required if recipientNumber is not provided.
+     * @public
+     */
+    recipientId?: string | undefined;
+    /**
+     * The unique identifier of the recipient. Required if recipientId is not provided.
+     * @public
+     */
+    recipientNumber?: string | undefined;
+    /**
+     * 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.
+     * @public
+     */
+    outgoing?: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface GetOrCreateMessengerChannelOutput {
+    channel: Channel;
+}
 /**
  * @public
  */
@@ -1593,6 +1746,10 @@ export interface GetSmsChannelIdInput {
  * @public
  */
 export interface GetSmsChannelIdOutput {
+    /**
+     * 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
+     */
     channelId: string;
 }
 /**
@@ -1624,6 +1781,10 @@ export interface GetTelephonyChannelIdInput {
  * @public
  */
 export interface GetTelephonyChannelIdOutput {
+    /**
+     * 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
+     */
     channelId: string;
 }
 /**
@@ -1706,6 +1867,10 @@ export interface GetWhatsAppChannelIdInput {
  * @public
  */
 export interface GetWhatsAppChannelIdOutput {
+    /**
+     * 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
+     */
     channelId: string;
 }
 /**
@@ -2140,6 +2305,26 @@ export interface PartialUpdateChannelSetOptions {
      * @public
      */
     whatsapp?: 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.
+     * @public
+     */
+    messengerStatus?: ChannelMessengerStatus | 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.
+     * @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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -2202,6 +2387,12 @@ export interface PartialUpdateMessageSetInput {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -2281,6 +2472,10 @@ export interface PinChannelOutput {
  * @public
  */
 export interface PinMessageInput {
+    /**
+     * 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
+     */
     channelId: string;
     /**
      * The unique identifier of the message which should be pinned.
@@ -2423,6 +2618,12 @@ export interface SendMessageInput {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -2705,6 +2906,10 @@ export interface UnpinChannelOutput {
  * @public
  */
 export interface UnpinMessageInput {
+    /**
+     * 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
+     */
     channelId: string;
     /**
      * The unique identifier of the message which should be unpinned.
@@ -2811,6 +3016,26 @@ export interface UpdateChannelInput {
      * @public
      */
     whatsapp?: 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.
+     * @public
+     */
+    messengerStatus?: ChannelMessengerStatus | 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.
+     * @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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -2884,6 +3109,12 @@ export interface UpdateMessageInput {
     forward?: MessageForward | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: MessageWhatsAppStatus | 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.
+     * @public
+     */
+    messengerStatus?: MessageMessengerStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;

package/dist-types/schemas/schemas_0.d.ts

@@ -80,8 +80,12 @@ export declare var GetInboxStateInput$: StaticStructureSchema;
 export declare var GetInboxStateOutput$: StaticStructureSchema;
 export declare var GetMessageInput$: StaticStructureSchema;
 export declare var GetMessageOutput$: StaticStructureSchema;
+export declare var GetMessengerChannelIdInput$: StaticStructureSchema;
+export declare var GetMessengerChannelIdOutput$: StaticStructureSchema;
 export declare var GetOrCreateDirectChannelInput$: StaticStructureSchema;
 export declare var GetOrCreateDirectChannelOutput$: StaticStructureSchema;
+export declare var GetOrCreateMessengerChannelInput$: StaticStructureSchema;
+export declare var GetOrCreateMessengerChannelOutput$: StaticStructureSchema;
 export declare var GetOrCreateSmsChannelInput$: StaticStructureSchema;
 export declare var GetOrCreateSmsChannelOutput$: StaticStructureSchema;
 export declare var GetOrCreateTelephonyChannelInput$: StaticStructureSchema;
@@ -238,7 +242,9 @@ export declare var GetDirectChannelId$: StaticOperationSchema;
 export declare var GetFilePresignedDownloadUrl$: StaticOperationSchema;
 export declare var GetInboxState$: StaticOperationSchema;
 export declare var GetMessage$: StaticOperationSchema;
+export declare var GetMessengerChannelId$: StaticOperationSchema;
 export declare var GetOrCreateDirectChannel$: StaticOperationSchema;
+export declare var GetOrCreateMessengerChannel$: StaticOperationSchema;
 export declare var GetOrCreateSmsChannel$: StaticOperationSchema;
 export declare var GetOrCreateTelephonyChannel$: StaticOperationSchema;
 export declare var GetOrCreateWhatsAppChannel$: StaticOperationSchema;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/xbees-conversations-client",
     "description": "@wildix/xbees-conversations-client client",
-    "version": "4.0.4",
+    "version": "4.1.1",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",