@wildix/xbees-conversations-client 4.0.4 → 4.1.1

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

@@ -0,0 +1,162 @@
+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 { GetOrCreateMessengerChannelInput, GetOrCreateMessengerChannelOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetOrCreateMessengerChannelCommand}.
+ */
+export interface GetOrCreateMessengerChannelCommandInput extends GetOrCreateMessengerChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetOrCreateMessengerChannelCommand}.
+ */
+export interface GetOrCreateMessengerChannelCommandOutput extends GetOrCreateMessengerChannelOutput, __MetadataBearer {
+}
+declare const GetOrCreateMessengerChannelCommand_base: {
+    new (input: GetOrCreateMessengerChannelCommandInput): import("@smithy/core/client").CommandImpl<GetOrCreateMessengerChannelCommandInput, GetOrCreateMessengerChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetOrCreateMessengerChannelCommandInput): import("@smithy/core/client").CommandImpl<GetOrCreateMessengerChannelCommandInput, GetOrCreateMessengerChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Gets or creates a 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, GetOrCreateMessengerChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, GetOrCreateMessengerChannelCommand } = 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 = { // GetOrCreateMessengerChannelInput
+ *   userId: "STRING_VALUE",
+ *   serviceUri: "STRING_VALUE", // required
+ *   recipientId: "STRING_VALUE",
+ *   recipientNumber: "STRING_VALUE",
+ *   outgoing: true || false,
+ * };
+ * const command = new GetOrCreateMessengerChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // GetOrCreateMessengerChannelOutput
+ * //   channel: { // Channel
+ * //     subject: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     pictureColor: "STRING_VALUE",
+ * //     access: "private" || "public",
+ * //     company: "STRING_VALUE",
+ * //     context: { // ChannelContext
+ * //       source: "kite",
+ * //       target: "STRING_VALUE",
+ * //       events: [ // ChannelContextEventList
+ * //         { // ChannelContextEvent
+ * //           id: "STRING_VALUE",
+ * //           owner: "STRING_VALUE",
+ * //           start: "STRING_VALUE",
+ * //           end: "STRING_VALUE",
+ * //           summary: "STRING_VALUE",
+ * //           attendees: [ // ChannelContextEventAttendeeList
+ * //             { // ChannelContextEventAttendee
+ * //               email: "STRING_VALUE", // required
+ * //               name: "STRING_VALUE",
+ * //               status: "accepted" || "tentative" || "declined" || "none", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //       ptt: { // ChannelContextPushToTalk
+ * //         broadcastId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     kite: true || false,
+ * //     kiteTarget: "STRING_VALUE",
+ * //     kiteVariant: "STRING_VALUE",
+ * //     kiteAssign: "STRING_VALUE",
+ * //     kiteServiceName: "STRING_VALUE",
+ * //     kiteDefaultSubject: "STRING_VALUE",
+ * //     service: "STRING_VALUE",
+ * //     serviceTitle: "STRING_VALUE",
+ * //     serviceRecipient: "STRING_VALUE",
+ * //     assignee: { // User
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //       picture: "STRING_VALUE",
+ * //       locale: "STRING_VALUE",
+ * //       timeZone: "STRING_VALUE",
+ * //       company: "STRING_VALUE",
+ * //       bot: true || false,
+ * //       pbxDomain: "STRING_VALUE",
+ * //       pbxPort: "STRING_VALUE",
+ * //       pbxExtension: "STRING_VALUE",
+ * //       pbxSerial: "STRING_VALUE",
+ * //       pbxUserId: "STRING_VALUE",
+ * //       pbxGroupId: "STRING_VALUE",
+ * //       createdAt: "STRING_VALUE",
+ * //       updatedAt: "STRING_VALUE",
+ * //     },
+ * //     telephony: true || false,
+ * //     sms: true || false,
+ * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
+ * //     broadcast: true || false,
+ * //     external: true || false,
+ * //     autoRecord: true || false,
+ * //     transcriptionLanguage: "STRING_VALUE",
+ * //     wizyGuestViewOnly: true || false,
+ * //     channelId: "STRING_VALUE", // required
+ * //     channelType: "direct" || "group", // required
+ * //     memberCount: Number("int"), // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetOrCreateMessengerChannelCommandInput - {@link GetOrCreateMessengerChannelCommandInput}
+ * @returns {@link GetOrCreateMessengerChannelCommandOutput}
+ * @see {@link GetOrCreateMessengerChannelCommandInput} for command's `input` shape.
+ * @see {@link GetOrCreateMessengerChannelCommandOutput} 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 GetOrCreateMessengerChannelCommand extends GetOrCreateMessengerChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetOrCreateMessengerChannelInput;
+            output: GetOrCreateMessengerChannelOutput;
+        };
+        sdk: {
+            input: GetOrCreateMessengerChannelCommandInput;
+            output: GetOrCreateMessengerChannelCommandOutput;
+        };
+    };
+}

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

@@ -109,6 +109,10 @@ declare const GetOrCreateSmsChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -108,6 +108,10 @@ declare const GetOrCreateTelephonyChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -109,6 +109,10 @@ declare const GetOrCreateWhatsAppChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -107,6 +107,10 @@ declare const JoinChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -109,6 +109,10 @@ declare const ListChannelsCommand_base: {
  * //       mms: true || false,
  * //       whatsapp: true || false,
  * //       whatsappStatus: "24h_channel_closed",
+ * //       messenger: true || false,
+ * //       messengerStatus: "window_closed",
+ * //       messengerPageId: "STRING_VALUE",
+ * //       messengerReplyUntil: Number("long"),
  * //       broadcast: true || false,
  * //       external: true || false,
  * //       autoRecord: true || false,

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

@@ -178,6 +178,8 @@ declare const ListMessagesCommand_base: {
  * //       },
  * //       whatsapp: true || false,
  * //       whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //       messenger: true || false,
+ * //       messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //       sms: true || false,
  * //       smsStatus: "sent" || "delivered" || "trying" || "error",
  * //       markdown: true || false,

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

@@ -178,6 +178,8 @@ declare const ListPinnedMessagesCommand_base: {
  * //       },
  * //       whatsapp: true || false,
  * //       whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //       messenger: true || false,
+ * //       messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //       sms: true || false,
  * //       smsStatus: "sent" || "delivered" || "trying" || "error",
  * //       markdown: true || false,

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

@@ -74,6 +74,10 @@ declare const PartialUpdateChannelCommand_base: {
  *     sms: true || false,
  *     mms: true || false,
  *     whatsapp: true || false,
+ *     messenger: true || false,
+ *     messengerStatus: "window_closed",
+ *     messengerPageId: "STRING_VALUE",
+ *     messengerReplyUntil: Number("long"),
  *     kiteAssign: "STRING_VALUE",
  *     serviceTitle: "STRING_VALUE",
  *     assignee: { // User
@@ -100,7 +104,7 @@ declare const PartialUpdateChannelCommand_base: {
  *     wizyGuestViewOnly: true || false,
  *   },
  *   unset: [ // PartialUpdateChannelUnsetOptions
- *     "subject" || "description" || "picture" || "pictureColor" || "access" || "broadcast" || "context" || "contextPtt" || "contextEvents" || "whatsappStatus" || "kiteAssign" || "service" || "serviceTitle" || "assignee" || "sms" || "mms" || "whatsapp",
+ *     "subject" || "description" || "picture" || "pictureColor" || "access" || "broadcast" || "context" || "contextPtt" || "contextEvents" || "whatsappStatus" || "messengerStatus" || "kiteAssign" || "service" || "serviceTitle" || "assignee" || "sms" || "mms" || "whatsapp",
  *   ],
  * };
  * const command = new PartialUpdateChannelCommand(input);
@@ -169,6 +173,10 @@ declare const PartialUpdateChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -173,6 +173,8 @@ declare const PartialUpdateMessageCommand_base: {
  *     },
  *     whatsapp: true || false,
  *     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ *     messenger: true || false,
+ *     messengerStatus: "trying" || "sent" || "error" || "delivered",
  *     sms: true || false,
  *     smsStatus: "sent" || "delivered" || "trying" || "error",
  *     markdown: true || false,
@@ -321,6 +323,8 @@ declare const PartialUpdateMessageCommand_base: {
  * //     },
  * //     whatsapp: true || false,
  * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messenger: true || false,
+ * //     messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
  * //     markdown: true || false,

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

@@ -114,6 +114,10 @@ declare const QueryChannelsCommand_base: {
  * //       mms: true || false,
  * //       whatsapp: true || false,
  * //       whatsappStatus: "24h_channel_closed",
+ * //       messenger: true || false,
+ * //       messengerStatus: "window_closed",
+ * //       messengerPageId: "STRING_VALUE",
+ * //       messengerReplyUntil: Number("long"),
  * //       broadcast: true || false,
  * //       external: true || false,
  * //       autoRecord: true || false,

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

@@ -184,6 +184,8 @@ declare const SendGiphyCommand_base: {
  * //     },
  * //     whatsapp: true || false,
  * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messenger: true || false,
+ * //     messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
  * //     markdown: true || false,

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

@@ -169,6 +169,8 @@ declare const SendMessageCommand_base: {
  *   },
  *   whatsapp: true || false,
  *   whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ *   messenger: true || false,
+ *   messengerStatus: "trying" || "sent" || "error" || "delivered",
  *   sms: true || false,
  *   smsStatus: "sent" || "delivered" || "trying" || "error",
  *   markdown: true || false,
@@ -315,6 +317,8 @@ declare const SendMessageCommand_base: {
  * //     },
  * //     whatsapp: true || false,
  * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messenger: true || false,
+ * //     messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
  * //     markdown: true || false,

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

@@ -184,6 +184,8 @@ declare const SendSystemMessageCommand_base: {
  * //     },
  * //     whatsapp: true || false,
  * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messenger: true || false,
+ * //     messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
  * //     markdown: true || false,

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

@@ -70,6 +70,10 @@ declare const UpdateChannelCommand_base: {
  *   sms: true || false,
  *   mms: true || false,
  *   whatsapp: true || false,
+ *   messenger: true || false,
+ *   messengerStatus: "window_closed",
+ *   messengerPageId: "STRING_VALUE",
+ *   messengerReplyUntil: Number("long"),
  *   kiteAssign: "STRING_VALUE",
  *   serviceTitle: "STRING_VALUE",
  *   assignee: { // User
@@ -164,6 +168,10 @@ declare const UpdateChannelCommand_base: {
  * //     mms: true || false,
  * //     whatsapp: true || false,
  * //     whatsappStatus: "24h_channel_closed",
+ * //     messenger: true || false,
+ * //     messengerStatus: "window_closed",
+ * //     messengerPageId: "STRING_VALUE",
+ * //     messengerReplyUntil: Number("long"),
  * //     broadcast: true || false,
  * //     external: true || false,
  * //     autoRecord: true || false,

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

@@ -169,6 +169,8 @@ declare const UpdateMessageCommand_base: {
  *   },
  *   whatsapp: true || false,
  *   whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ *   messenger: true || false,
+ *   messengerStatus: "trying" || "sent" || "error" || "delivered",
  *   sms: true || false,
  *   smsStatus: "sent" || "delivered" || "trying" || "error",
  *   markdown: true || false,
@@ -316,6 +318,8 @@ declare const UpdateMessageCommand_base: {
  * //     },
  * //     whatsapp: true || false,
  * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messenger: true || false,
+ * //     messengerStatus: "trying" || "sent" || "error" || "delivered",
  * //     sms: true || false,
  * //     smsStatus: "sent" || "delivered" || "trying" || "error",
  * //     markdown: true || false,

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

@@ -17,7 +17,9 @@ export * from "./GetDirectChannelIdCommand";
 export * from "./GetFilePresignedDownloadUrlCommand";
 export * from "./GetInboxStateCommand";
 export * from "./GetMessageCommand";
+export * from "./GetMessengerChannelIdCommand";
 export * from "./GetOrCreateDirectChannelCommand";
+export * from "./GetOrCreateMessengerChannelCommand";
 export * from "./GetOrCreateSmsChannelCommand";
 export * from "./GetOrCreateTelephonyChannelCommand";
 export * from "./GetOrCreateWhatsAppChannelCommand";

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

@@ -58,6 +58,17 @@ export declare const ChannelContextSource: {
  * @public
  */
 export type ChannelContextSource = (typeof ChannelContextSource)[keyof typeof ChannelContextSource];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelMessengerStatus: {
+    readonly WINDOW_CLOSED: "window_closed";
+};
+/**
+ * @public
+ */
+export type ChannelMessengerStatus = (typeof ChannelMessengerStatus)[keyof typeof ChannelMessengerStatus];
 /**
  * @public
  * @enum
@@ -81,6 +92,20 @@ export declare const ButtonVariant: {
  * @public
  */
 export type ButtonVariant = (typeof ButtonVariant)[keyof typeof ButtonVariant];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageMessengerStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageMessengerStatus = (typeof MessageMessengerStatus)[keyof typeof MessageMessengerStatus];
 /**
  * @public
  * @enum
@@ -249,6 +274,7 @@ export declare const GroupChannelUnsetOptions: {
     readonly CONTEXT_PTT: "contextPtt";
     readonly DESCRIPTION: "description";
     readonly KITE_ASSIGN: "kiteAssign";
+    readonly MESSENGER_STATUS: "messengerStatus";
     readonly MMS: "mms";
     readonly PICTURE: "picture";
     readonly PICTURE_COLOR: "pictureColor";