@wildix/xbees-conversations-client 4.1.1 → 4.2.0-messaging.1

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

@@ -1,4 +1,4 @@
-import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessengerStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessengerStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, ReactionType, WebhookEventType } from "./enums";
+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";
 /**
  * @public
  */
@@ -107,14 +107,18 @@ export interface Channel {
     mms?: boolean | undefined;
     whatsapp?: boolean | undefined;
     whatsappStatus?: ChannelWhatsAppStatus | undefined;
-    messenger?: boolean | 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;
     /**
      * 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;
+    messagingStatus?: ChannelMessagingStatus | undefined;
+    messagingSenderId?: string | undefined;
+    messagingReplyUntil?: number | undefined;
     broadcast?: boolean | undefined;
     external?: boolean | undefined;
     autoRecord?: boolean | undefined;
@@ -359,12 +363,16 @@ 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.
+     * 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;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -402,7 +410,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. 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.
+     * 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.
      * @public
      */
     phone?: string | undefined;
@@ -783,25 +791,25 @@ export interface CreateGroupChannelInput {
      */
     whatsapp?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingChannel?: MessagingChannel | 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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -892,12 +900,16 @@ 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.
+     * 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
      */
-    messengerStatus?: MessageMessengerStatus | undefined;
+    messagingStatus?: MessageMessagingStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -923,12 +935,16 @@ 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.
+     * 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;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -1520,7 +1536,7 @@ export interface GetMessageOutput {
 /**
  * @public
  */
-export interface GetMessengerChannelIdInput {
+export interface GetMessagingChannelIdInput {
     /**
      * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
      * @public
@@ -1541,11 +1557,16 @@ export interface GetMessengerChannelIdInput {
      * @public
      */
     recipientNumber?: string | undefined;
+    /**
+     * The customer messaging channel the conversation runs over.
+     * @public
+     */
+    channel: MessagingChannel;
 }
 /**
  * @public
  */
-export interface GetMessengerChannelIdOutput {
+export interface GetMessagingChannelIdOutput {
     /**
      * 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
@@ -1581,7 +1602,7 @@ export interface GetOrCreateDirectChannelOutput {
 /**
  * @public
  */
-export interface GetOrCreateMessengerChannelInput {
+export interface GetOrCreateMessagingChannelInput {
     /**
      * The unique identifier of the user when a service token is used. Required if used PBX or S2S token.
      * @public
@@ -1602,6 +1623,11 @@ export interface GetOrCreateMessengerChannelInput {
      * @public
      */
     recipientNumber?: string | undefined;
+    /**
+     * The customer messaging channel the conversation runs over.
+     * @public
+     */
+    channel: MessagingChannel;
     /**
      * 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
@@ -1611,7 +1637,7 @@ export interface GetOrCreateMessengerChannelInput {
 /**
  * @public
  */
-export interface GetOrCreateMessengerChannelOutput {
+export interface GetOrCreateMessagingChannelOutput {
     channel: Channel;
 }
 /**
@@ -2306,25 +2332,25 @@ export interface PartialUpdateChannelSetOptions {
      */
     whatsapp?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingChannel?: MessagingChannel | 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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -2387,12 +2413,16 @@ 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.
+     * 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
      */
-    messengerStatus?: MessageMessengerStatus | undefined;
+    messagingStatus?: MessageMessagingStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -2618,12 +2648,16 @@ 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.
+     * 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;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;
@@ -3017,25 +3051,25 @@ export interface UpdateChannelInput {
      */
     whatsapp?: boolean | undefined;
     /**
-     * Indicates if the channel supports Facebook Messenger. Default is false.
+     * The customer messaging channel this conversation runs over. Set when the channel is created and never changed. Absent on every other channel.
      * @public
      */
-    messenger?: boolean | undefined;
+    messagingChannel?: MessagingChannel | 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;
     /**
      * The unique identifier of the assignee.
      * @public
@@ -3109,12 +3143,16 @@ 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.
+     * 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
      */
-    messengerStatus?: MessageMessengerStatus | undefined;
+    messagingStatus?: MessageMessagingStatus | undefined;
     sms?: boolean | undefined;
     smsStatus?: MessageSmsStatus | undefined;
     markdown?: boolean | undefined;

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

@@ -80,12 +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 GetMessagingChannelIdInput$: StaticStructureSchema;
+export declare var GetMessagingChannelIdOutput$: StaticStructureSchema;
 export declare var GetOrCreateDirectChannelInput$: StaticStructureSchema;
 export declare var GetOrCreateDirectChannelOutput$: StaticStructureSchema;
-export declare var GetOrCreateMessengerChannelInput$: StaticStructureSchema;
-export declare var GetOrCreateMessengerChannelOutput$: StaticStructureSchema;
+export declare var GetOrCreateMessagingChannelInput$: StaticStructureSchema;
+export declare var GetOrCreateMessagingChannelOutput$: StaticStructureSchema;
 export declare var GetOrCreateSmsChannelInput$: StaticStructureSchema;
 export declare var GetOrCreateSmsChannelOutput$: StaticStructureSchema;
 export declare var GetOrCreateTelephonyChannelInput$: StaticStructureSchema;
@@ -242,9 +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 GetMessagingChannelId$: StaticOperationSchema;
 export declare var GetOrCreateDirectChannel$: StaticOperationSchema;
-export declare var GetOrCreateMessengerChannel$: StaticOperationSchema;
+export declare var GetOrCreateMessagingChannel$: 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.1.1",
+    "version": "4.2.0-messaging.1",
     "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"
     }
-}
+}

package/dist-types/commands/GetMessengerChannelIdCommand.d.ts

@@ -1,83 +0,0 @@
-import { Command as $Command } from "@smithy/core/client";
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
-import type { GetMessengerChannelIdInput, GetMessengerChannelIdOutput } from "../models/models_0";
-/**
- * @public
- */
-export type { __MetadataBearer };
-export { $Command };
-/**
- * @public
- *
- * The input for {@link GetMessengerChannelIdCommand}.
- */
-export interface GetMessengerChannelIdCommandInput extends GetMessengerChannelIdInput {
-}
-/**
- * @public
- *
- * The output of {@link GetMessengerChannelIdCommand}.
- */
-export interface GetMessengerChannelIdCommandOutput extends GetMessengerChannelIdOutput, __MetadataBearer {
-}
-declare const GetMessengerChannelIdCommand_base: {
-    new (input: GetMessengerChannelIdCommandInput): import("@smithy/core/client").CommandImpl<GetMessengerChannelIdCommandInput, GetMessengerChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (input: GetMessengerChannelIdCommandInput): import("@smithy/core/client").CommandImpl<GetMessengerChannelIdCommandInput, GetMessengerChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
-};
-/**
- * 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.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ConversationsClient, GetMessengerChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
- * // const { ConversationsClient, GetMessengerChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
- * // import type { ConversationsClientConfig } from "@wildix/xbees-conversations-client";
- * const config = {}; // type is ConversationsClientConfig
- * const client = new ConversationsClient(config);
- * const input = { // GetMessengerChannelIdInput
- *   userId: "STRING_VALUE",
- *   serviceUri: "STRING_VALUE", // required
- *   recipientId: "STRING_VALUE",
- *   recipientNumber: "STRING_VALUE",
- * };
- * const command = new GetMessengerChannelIdCommand(input);
- * const response = await client.send(command);
- * // { // GetMessengerChannelIdOutput
- * //   channelId: "STRING_VALUE", // required
- * // };
- *
- * ```
- *
- * @param GetMessengerChannelIdCommandInput - {@link GetMessengerChannelIdCommandInput}
- * @returns {@link GetMessengerChannelIdCommandOutput}
- * @see {@link GetMessengerChannelIdCommandInput} for command's `input` shape.
- * @see {@link GetMessengerChannelIdCommandOutput} for command's `response` shape.
- * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
- *
- * @throws {@link ForbiddenException} (client fault)
- *
- * @throws {@link ValidationException} (client fault)
- *
- * @throws {@link RateLimitExceededException} (client fault)
- *
- * @throws {@link ConversationsSyntheticServiceException}
- * <p>Base exception class for all service exceptions from Conversations service.</p>
- *
- *
- * @public
- */
-export declare class GetMessengerChannelIdCommand extends GetMessengerChannelIdCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: GetMessengerChannelIdInput;
-            output: GetMessengerChannelIdOutput;
-        };
-        sdk: {
-            input: GetMessengerChannelIdCommandInput;
-            output: GetMessengerChannelIdCommandOutput;
-        };
-    };
-}