@wildix/xbees-conversations-client 1.1.14 → 1.1.16

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

@@ -0,0 +1,363 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { SendTemplateMessageInput, SendTemplateMessageOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendTemplateMessageCommand}.
+ */
+export interface SendTemplateMessageCommandInput extends SendTemplateMessageInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendTemplateMessageCommand}.
+ */
+export interface SendTemplateMessageCommandOutput extends SendTemplateMessageOutput, __MetadataBearer {
+}
+declare const SendTemplateMessageCommand_base: {
+    new (input: SendTemplateMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendTemplateMessageCommandInput, SendTemplateMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SendTemplateMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendTemplateMessageCommandInput, SendTemplateMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Sends a template message to a specified channel. This operation requires the channel to be accessible to the user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, SendTemplateMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, SendTemplateMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // SendTemplateMessageInput
+ *   text: "STRING_VALUE",
+ *   elements: [ // ElementsList
+ *     { // Element Union: only one key present
+ *       actions: [ // ActionsElementsList
+ *         { // ActionElement Union: only one key present
+ *           button: { // ButtonElement
+ *             text: "STRING_VALUE", // required
+ *             handler: { // ButtonHandler Union: only one key present
+ *               link: { // ButtonLinkHandler
+ *                 url: "STRING_VALUE", // required
+ *               },
+ *               reply: { // ButtonReplyHandler
+ *                 text: "STRING_VALUE",
+ *               },
+ *               action: { // ButtonActionHandler
+ *                 id: "STRING_VALUE", // required
+ *               },
+ *             },
+ *             variant: "contained" || "outlined",
+ *             disabled: true || false,
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   attachments: [ // MessageAttachmentList
+ *     { // MessageAttachment
+ *       id: "STRING_VALUE", // required
+ *       fsId: "STRING_VALUE", // required
+ *       mime: "STRING_VALUE",
+ *       name: "STRING_VALUE", // required
+ *       size: Number("int"), // required
+ *       width: Number("int"),
+ *       height: Number("int"),
+ *       thumbnail: "STRING_VALUE",
+ *     },
+ *   ],
+ *   quote: { // MessageQuote
+ *     messageId: "STRING_VALUE", // required
+ *     channelId: "STRING_VALUE", // required
+ *     user: { // 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",
+ *       createdAt: "STRING_VALUE",
+ *       updatedAt: "STRING_VALUE",
+ *     },
+ *     text: "STRING_VALUE",
+ *     attachments: [
+ *       {
+ *         id: "STRING_VALUE", // required
+ *         fsId: "STRING_VALUE", // required
+ *         mime: "STRING_VALUE",
+ *         name: "STRING_VALUE", // required
+ *         size: Number("int"), // required
+ *         width: Number("int"),
+ *         height: Number("int"),
+ *         thumbnail: "STRING_VALUE",
+ *       },
+ *     ],
+ *     forward: { // MessageForward
+ *       forwardCompany: "STRING_VALUE",
+ *       forwardDate: "STRING_VALUE", // required
+ *       forwardEmail: "STRING_VALUE",
+ *       forwardName: "STRING_VALUE",
+ *       messageId: "STRING_VALUE", // required
+ *       channelId: "STRING_VALUE", // required
+ *     },
+ *     mentions: [ // UsersList
+ *       {
+ *         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",
+ *         createdAt: "STRING_VALUE",
+ *         updatedAt: "STRING_VALUE",
+ *       },
+ *     ],
+ *     giphy: { // MessageGiphy
+ *       id: "STRING_VALUE", // required
+ *       size: "STRING_VALUE", // required
+ *       url: "STRING_VALUE", // required
+ *       height: "STRING_VALUE", // required
+ *       width: "STRING_VALUE", // required
+ *     },
+ *     createdAt: "STRING_VALUE", // required
+ *     updatedAt: "STRING_VALUE",
+ *   },
+ *   forward: {
+ *     forwardCompany: "STRING_VALUE",
+ *     forwardDate: "STRING_VALUE", // required
+ *     forwardEmail: "STRING_VALUE",
+ *     forwardName: "STRING_VALUE",
+ *     messageId: "STRING_VALUE", // required
+ *     channelId: "STRING_VALUE", // required
+ *   },
+ *   messageId: "STRING_VALUE",
+ *   mentions: [ // UsersIdList
+ *     "STRING_VALUE",
+ *   ],
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   template: { // TemplateWithParameters
+ *     name: "STRING_VALUE", // required
+ *     parameters: [ // ListTemplateParameter // required
+ *       { // TemplateParameter
+ *         name: "STRING_VALUE", // required
+ *         value: "STRING_VALUE", // required
+ *       },
+ *     ],
+ *   },
+ * };
+ * const command = new SendTemplateMessageCommand(input);
+ * const response = await client.send(command);
+ * // { // SendTemplateMessageOutput
+ * //   message: { // Message
+ * //     text: "STRING_VALUE",
+ * //     elements: [ // ElementsList
+ * //       { // Element Union: only one key present
+ * //         actions: [ // ActionsElementsList
+ * //           { // ActionElement Union: only one key present
+ * //             button: { // ButtonElement
+ * //               text: "STRING_VALUE", // required
+ * //               handler: { // ButtonHandler Union: only one key present
+ * //                 link: { // ButtonLinkHandler
+ * //                   url: "STRING_VALUE", // required
+ * //                 },
+ * //                 reply: { // ButtonReplyHandler
+ * //                   text: "STRING_VALUE",
+ * //                 },
+ * //                 action: { // ButtonActionHandler
+ * //                   id: "STRING_VALUE", // required
+ * //                 },
+ * //               },
+ * //               variant: "contained" || "outlined",
+ * //               disabled: true || false,
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     attachments: [ // MessageAttachmentList
+ * //       { // MessageAttachment
+ * //         id: "STRING_VALUE", // required
+ * //         fsId: "STRING_VALUE", // required
+ * //         mime: "STRING_VALUE",
+ * //         name: "STRING_VALUE", // required
+ * //         size: Number("int"), // required
+ * //         width: Number("int"),
+ * //         height: Number("int"),
+ * //         thumbnail: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     quote: { // MessageQuote
+ * //       messageId: "STRING_VALUE", // required
+ * //       channelId: "STRING_VALUE", // required
+ * //       user: { // 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",
+ * //         createdAt: "STRING_VALUE",
+ * //         updatedAt: "STRING_VALUE",
+ * //       },
+ * //       text: "STRING_VALUE",
+ * //       attachments: [
+ * //         {
+ * //           id: "STRING_VALUE", // required
+ * //           fsId: "STRING_VALUE", // required
+ * //           mime: "STRING_VALUE",
+ * //           name: "STRING_VALUE", // required
+ * //           size: Number("int"), // required
+ * //           width: Number("int"),
+ * //           height: Number("int"),
+ * //           thumbnail: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       forward: { // MessageForward
+ * //         forwardCompany: "STRING_VALUE",
+ * //         forwardDate: "STRING_VALUE", // required
+ * //         forwardEmail: "STRING_VALUE",
+ * //         forwardName: "STRING_VALUE",
+ * //         messageId: "STRING_VALUE", // required
+ * //         channelId: "STRING_VALUE", // required
+ * //       },
+ * //       mentions: [ // UsersList
+ * //         {
+ * //           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",
+ * //           createdAt: "STRING_VALUE",
+ * //           updatedAt: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       giphy: { // MessageGiphy
+ * //         id: "STRING_VALUE", // required
+ * //         size: "STRING_VALUE", // required
+ * //         url: "STRING_VALUE", // required
+ * //         height: "STRING_VALUE", // required
+ * //         width: "STRING_VALUE", // required
+ * //       },
+ * //       createdAt: "STRING_VALUE", // required
+ * //       updatedAt: "STRING_VALUE",
+ * //     },
+ * //     forward: {
+ * //       forwardCompany: "STRING_VALUE",
+ * //       forwardDate: "STRING_VALUE", // required
+ * //       forwardEmail: "STRING_VALUE",
+ * //       forwardName: "STRING_VALUE",
+ * //       messageId: "STRING_VALUE", // required
+ * //       channelId: "STRING_VALUE", // required
+ * //     },
+ * //     type: "regular" || "system", // required
+ * //     giphy: {
+ * //       id: "STRING_VALUE", // required
+ * //       size: "STRING_VALUE", // required
+ * //       url: "STRING_VALUE", // required
+ * //       height: "STRING_VALUE", // required
+ * //       width: "STRING_VALUE", // required
+ * //     },
+ * //     silent: true || false,
+ * //     event: "STRING_VALUE",
+ * //     sms: true || false,
+ * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     whatsapp: true || false,
+ * //     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //     messageId: "STRING_VALUE", // required
+ * //     channelId: "STRING_VALUE", // required
+ * //     user: "<User>", // required
+ * //     edit: true || false,
+ * //     mentions: [
+ * //       "<User>",
+ * //     ],
+ * //     latestReactions: [ // ReactionList
+ * //       { // Reaction
+ * //         type: "STRING_VALUE",
+ * //         userId: "STRING_VALUE",
+ * //         messageId: "STRING_VALUE",
+ * //         user: "<User>",
+ * //       },
+ * //     ],
+ * //     reactionCounts: { // ReactionCounts
+ * //       "<keys>": Number("int"),
+ * //     },
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param SendTemplateMessageCommandInput - {@link SendTemplateMessageCommandInput}
+ * @returns {@link SendTemplateMessageCommandOutput}
+ * @see {@link SendTemplateMessageCommandInput} for command's `input` shape.
+ * @see {@link SendTemplateMessageCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link RateLimitExceededException} (client fault)
+ *
+ * @throws {@link ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ *
+ * @public
+ */
+export declare class SendTemplateMessageCommand extends SendTemplateMessageCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SendTemplateMessageInput;
+            output: SendTemplateMessageOutput;
+        };
+        sdk: {
+            input: SendTemplateMessageCommandInput;
+            output: SendTemplateMessageCommandOutput;
+        };
+    };
+}

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

@@ -18,13 +18,20 @@ export * from "./GetFilePresignedDownloadUrlCommand";
 export * from "./GetInboxStateCommand";
 export * from "./GetMessageCommand";
 export * from "./GetOrCreateDirectChannelCommand";
+export * from "./GetOrCreateSmsChannelCommand";
+export * from "./GetOrCreateTelephonyChannelCommand";
+export * from "./GetOrCreateWhatsAppChannelCommand";
+export * from "./GetSmsChannelIdCommand";
+export * from "./GetTelephonyChannelIdCommand";
 export * from "./GetTokenCommand";
 export * from "./GetUploadedFileInfoCommand";
+export * from "./GetWhatsAppChannelIdCommand";
 export * from "./HideChannelCommand";
 export * from "./InviteCommand";
 export * from "./JoinChannelCommand";
 export * from "./LeaveChannelCommand";
 export * from "./ListChannelMembersCommand";
+export * from "./ListChannelMembersReadStatusCommand";
 export * from "./ListChannelsCommand";
 export * from "./ListInboxTaggedChannelsCommand";
 export * from "./ListInboxTagsCommand";
@@ -43,6 +50,7 @@ export * from "./SendActionTriggerResultCommand";
 export * from "./SendGiphyCommand";
 export * from "./SendMessageCommand";
 export * from "./SendMessageReactionCommand";
+export * from "./SendTemplateMessageCommand";
 export * from "./SendTypingStartCommand";
 export * from "./SendTypingStopCommand";
 export * from "./ShowChannelCommand";

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

@@ -53,6 +53,20 @@ export declare class RateLimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<RateLimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface TemplateParameter {
+    name: string;
+    value: string;
+}
+/**
+ * @public
+ */
+export interface TemplateWithParameters {
+    name: string;
+    parameters: (TemplateParameter)[];
+}
 /**
  * @public
  * @enum
@@ -528,6 +542,8 @@ export interface ServicePbx {
  * @public
  */
 export interface ServiceSettings {
+    phoneNumber?: string | undefined;
+    messagingNumber?: string | undefined;
 }
 /**
  * @public
@@ -695,6 +711,14 @@ export declare class ChannelAlreadyExistException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface ChannelMemberReadStatus {
+    user?: User | undefined;
+    lastRead?: string | undefined;
+    lastReadMessageId?: string | undefined;
+}
 /**
  * @public
  */
@@ -1695,6 +1719,161 @@ export interface GetOrCreateDirectChannelInput {
 export interface GetOrCreateDirectChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ */
+export interface GetOrCreateSmsChannelInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetOrCreateSmsChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface GetOrCreateTelephonyChannelInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetOrCreateTelephonyChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface GetOrCreateWhatsAppChannelInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetOrCreateWhatsAppChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface GetSmsChannelIdInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetSmsChannelIdOutput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface GetTelephonyChannelIdInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetTelephonyChannelIdOutput {
+    channelId: string;
+}
 /**
  * @public
  */
@@ -1741,6 +1920,37 @@ export interface GetUploadedFileInfoInput {
 export interface GetUploadedFileInfoOutput {
     file: MessageAttachment;
 }
+/**
+ * @public
+ */
+export interface GetWhatsAppChannelIdInput {
+    /**
+     * 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 | undefined;
+    /**
+     * 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 GetWhatsAppChannelIdOutput {
+    channelId: string;
+}
 /**
  * @public
  */
@@ -1867,6 +2077,26 @@ export interface ListChannelMembersOutput {
      */
     users: (User)[];
 }
+/**
+ * @public
+ */
+export interface ListChannelMembersReadStatusInput {
+    /**
+     * The unique identifier of the channel whose members are to be listed.
+     * @public
+     */
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface ListChannelMembersReadStatusOutput {
+    /**
+     * Read status of members.
+     * @public
+     */
+    members: (ChannelMemberReadStatus)[];
+}
 /**
  * @public
  */
@@ -2521,6 +2751,43 @@ export interface SendMessageReactionInput {
  */
 export interface SendMessageReactionOutput {
 }
+/**
+ * @public
+ */
+export interface SendTemplateMessageInput {
+    text?: string | undefined;
+    elements?: (Element)[] | undefined;
+    attachments?: (MessageAttachment)[] | undefined;
+    quote?: MessageQuote | undefined;
+    forward?: MessageForward | undefined;
+    /**
+     * The unique identifier of the message. If not provided, an ID will be auto-generated.
+     * @public
+     */
+    messageId?: string | undefined;
+    /**
+     * A list of user IDs mentioned in the message.
+     * @public
+     */
+    mentions?: (string)[] | undefined;
+    /**
+     * The unique identifier of the channel to which the template message is sent.
+     * @public
+     */
+    channelId: string;
+    /**
+     * The unique identifier of the user when a service token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    template: TemplateWithParameters;
+}
+/**
+ * @public
+ */
+export interface SendTemplateMessageOutput {
+    message: Message;
+}
 /**
  * @public
  */