@wildix/xbees-conversations-client 1.0.59 → 1.0.60

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

@@ -36,6 +36,88 @@ declare const SendMessageCommand_base: {
  * const client = new ConversationsClient(config);
  * const input = { // SendMessageInput
  *   text: "STRING_VALUE",
+ *   elements: [ // ElementsList
+ *     { // Element Union: only one key present
+ *       text: { // TextElement
+ *         value: "STRING_VALUE", // required
+ *         style: { // TextStyle
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       link: { // LinkElement
+ *         url: "STRING_VALUE", // required
+ *         text: "STRING_VALUE",
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       email: { // EmailElement
+ *         value: "STRING_VALUE", // required
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       phone: { // PhoneElement
+ *         value: "STRING_VALUE", // required
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       mention: { // MentionElement
+ *         text: "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",
+ *         },
+ *       },
+ *       actions: [ // ActionsElementsList
+ *         { // ActionElement Union: only one key present
+ *           button: { // ButtonElement
+ *             text: "STRING_VALUE", // required
+ *             variant: "contained" || "outlined",
+ *             disabled: true || false,
+ *             handler: { // ButtonHandler Union: only one key present
+ *               link: { // ButtonLinkHandler
+ *                 url: "STRING_VALUE", // required
+ *               },
+ *               reply: { // ButtonReplyHandler
+ *                 text: "STRING_VALUE",
+ *               },
+ *               action: { // ButtonActionHandler
+ *                 id: "STRING_VALUE", // required
+ *               },
+ *             },
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
  *   attachments: [ // MessageAttachmentList
  *     { // MessageAttachment
  *       id: "STRING_VALUE", // required
@@ -51,7 +133,7 @@ declare const SendMessageCommand_base: {
  *   quote: { // MessageQuote
  *     messageId: "STRING_VALUE", // required
  *     channelId: "STRING_VALUE", // required
- *     user: { // User
+ *     user: {
  *       id: "STRING_VALUE", // required
  *       name: "STRING_VALUE",
  *       email: "STRING_VALUE",
@@ -89,24 +171,7 @@ declare const SendMessageCommand_base: {
  *       forwardName: "STRING_VALUE",
  *     },
  *     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",
- *       },
+ *       "<User>",
  *     ],
  *     giphy: { // MessageGiphy
  *       id: "STRING_VALUE", // required
@@ -136,6 +201,88 @@ declare const SendMessageCommand_base: {
  * // { // SendMessageOutput
  * //   message: { // Message
  * //     text: "STRING_VALUE",
+ * //     elements: [ // ElementsList
+ * //       { // Element Union: only one key present
+ * //         text: { // TextElement
+ * //           value: "STRING_VALUE", // required
+ * //           style: { // TextStyle
+ * //             italic: true || false,
+ * //             bold: true || false,
+ * //             strike: true || false,
+ * //             code: true || false,
+ * //           },
+ * //         },
+ * //         link: { // LinkElement
+ * //           url: "STRING_VALUE", // required
+ * //           text: "STRING_VALUE",
+ * //           style: {
+ * //             italic: true || false,
+ * //             bold: true || false,
+ * //             strike: true || false,
+ * //             code: true || false,
+ * //           },
+ * //         },
+ * //         email: { // EmailElement
+ * //           value: "STRING_VALUE", // required
+ * //           style: {
+ * //             italic: true || false,
+ * //             bold: true || false,
+ * //             strike: true || false,
+ * //             code: true || false,
+ * //           },
+ * //         },
+ * //         phone: { // PhoneElement
+ * //           value: "STRING_VALUE", // required
+ * //           style: {
+ * //             italic: true || false,
+ * //             bold: true || false,
+ * //             strike: true || false,
+ * //             code: true || false,
+ * //           },
+ * //         },
+ * //         mention: { // MentionElement
+ * //           text: "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",
+ * //           },
+ * //         },
+ * //         actions: [ // ActionsElementsList
+ * //           { // ActionElement Union: only one key present
+ * //             button: { // ButtonElement
+ * //               text: "STRING_VALUE", // required
+ * //               variant: "contained" || "outlined",
+ * //               disabled: true || false,
+ * //               handler: { // ButtonHandler Union: only one key present
+ * //                 link: { // ButtonLinkHandler
+ * //                   url: "STRING_VALUE", // required
+ * //                 },
+ * //                 reply: { // ButtonReplyHandler
+ * //                   text: "STRING_VALUE",
+ * //                 },
+ * //                 action: { // ButtonActionHandler
+ * //                   id: "STRING_VALUE", // required
+ * //                 },
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
  * //     attachments: [ // MessageAttachmentList
  * //       { // MessageAttachment
  * //         id: "STRING_VALUE", // required
@@ -151,7 +298,7 @@ declare const SendMessageCommand_base: {
  * //     quote: { // MessageQuote
  * //       messageId: "STRING_VALUE", // required
  * //       channelId: "STRING_VALUE", // required
- * //       user: { // User
+ * //       user: {
  * //         id: "STRING_VALUE", // required
  * //         name: "STRING_VALUE",
  * //         email: "STRING_VALUE",
@@ -189,24 +336,7 @@ declare const SendMessageCommand_base: {
  * //         forwardName: "STRING_VALUE",
  * //       },
  * //       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",
- * //         },
+ * //         "<User>",
  * //       ],
  * //       giphy: { // MessageGiphy
  * //         id: "STRING_VALUE", // required

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

@@ -0,0 +1,227 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { TriggerMessageActionInput, TriggerMessageActionOutput } 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 TriggerMessageActionCommand}.
+ */
+export interface TriggerMessageActionCommandInput extends TriggerMessageActionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TriggerMessageActionCommand}.
+ */
+export interface TriggerMessageActionCommandOutput extends TriggerMessageActionOutput, __MetadataBearer {
+}
+declare const TriggerMessageActionCommand_base: {
+    new (input: TriggerMessageActionCommandInput): import("@smithy/smithy-client").CommandImpl<TriggerMessageActionCommandInput, TriggerMessageActionCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TriggerMessageActionCommandInput): import("@smithy/smithy-client").CommandImpl<TriggerMessageActionCommandInput, TriggerMessageActionCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Sends a trigger for specific action for specified message. This operation requires the message 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, TriggerMessageActionCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, TriggerMessageActionCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // TriggerMessageActionInput
+ *   text: "STRING_VALUE",
+ *   elements: [ // ElementsList
+ *     { // Element Union: only one key present
+ *       text: { // TextElement
+ *         value: "STRING_VALUE", // required
+ *         style: { // TextStyle
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       link: { // LinkElement
+ *         url: "STRING_VALUE", // required
+ *         text: "STRING_VALUE",
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       email: { // EmailElement
+ *         value: "STRING_VALUE", // required
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       phone: { // PhoneElement
+ *         value: "STRING_VALUE", // required
+ *         style: {
+ *           italic: true || false,
+ *           bold: true || false,
+ *           strike: true || false,
+ *           code: true || false,
+ *         },
+ *       },
+ *       mention: { // MentionElement
+ *         text: "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",
+ *         },
+ *       },
+ *       actions: [ // ActionsElementsList
+ *         { // ActionElement Union: only one key present
+ *           button: { // ButtonElement
+ *             text: "STRING_VALUE", // required
+ *             variant: "contained" || "outlined",
+ *             disabled: true || false,
+ *             handler: { // ButtonHandler Union: only one key present
+ *               link: { // ButtonLinkHandler
+ *                 url: "STRING_VALUE", // required
+ *               },
+ *               reply: { // ButtonReplyHandler
+ *                 text: "STRING_VALUE",
+ *               },
+ *               action: { // ButtonActionHandler
+ *                 id: "STRING_VALUE", // required
+ *               },
+ *             },
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   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: {
+ *       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",
+ *     },
+ *     mentions: [ // UsersList
+ *       "<User>",
+ *     ],
+ *     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",
+ *   },
+ *   channelId: "STRING_VALUE", // required
+ *   messageId: "STRING_VALUE", // required
+ *   actionId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ * };
+ * const command = new TriggerMessageActionCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TriggerMessageActionCommandInput - {@link TriggerMessageActionCommandInput}
+ * @returns {@link TriggerMessageActionCommandOutput}
+ * @see {@link TriggerMessageActionCommandInput} for command's `input` shape.
+ * @see {@link TriggerMessageActionCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link MessageNotFoundException} (client fault)
+ *
+ * @throws {@link MessageActionNotFoundException} (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 TriggerMessageActionCommand extends TriggerMessageActionCommand_base {
+}