@wildix/xbees-conversations-client 1.0.64 → 1.1.0

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

@@ -1,261 +0,0 @@
-import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
-import { ListPinnedMessagesInput, ListPinnedMessagesOutput } 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 ListPinnedMessagesCommand}.
- */
-export interface ListPinnedMessagesCommandInput extends ListPinnedMessagesInput {
-}
-/**
- * @public
- *
- * The output of {@link ListPinnedMessagesCommand}.
- */
-export interface ListPinnedMessagesCommandOutput extends ListPinnedMessagesOutput, __MetadataBearer {
-}
-declare const ListPinnedMessagesCommand_base: {
-    new (input: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ConversationsClient, ListPinnedMessagesCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
- * // const { ConversationsClient, ListPinnedMessagesCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
- * const client = new ConversationsClient(config);
- * const input = { // ListPinnedMessagesInput
- *   channelId: "STRING_VALUE", // required
- *   limit: Number("int"),
- *   offset: Number("int"),
- * };
- * const command = new ListPinnedMessagesCommand(input);
- * const response = await client.send(command);
- * // { // ListPinnedMessagesOutput
- * //   messages: [ // MessagesList // required
- * //     { // 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
- * //           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",
- * //       },
- * //       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 ListPinnedMessagesCommandInput - {@link ListPinnedMessagesCommandInput}
- * @returns {@link ListPinnedMessagesCommandOutput}
- * @see {@link ListPinnedMessagesCommandInput} for command's `input` shape.
- * @see {@link ListPinnedMessagesCommandOutput} 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 ListPinnedMessagesCommand extends ListPinnedMessagesCommand_base {
-}

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

@@ -1,73 +0,0 @@
-import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
-import { PinMessageInput, PinMessageOutput } 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 PinMessageCommand}.
- */
-export interface PinMessageCommandInput extends PinMessageInput {
-}
-/**
- * @public
- *
- * The output of {@link PinMessageCommand}.
- */
-export interface PinMessageCommandOutput extends PinMessageOutput, __MetadataBearer {
-}
-declare const PinMessageCommand_base: {
-    new (input: PinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<PinMessageCommandInput, PinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: PinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<PinMessageCommandInput, PinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Pins specified message in the message. This operation is idempotent, meaning that if the message is already pinned, no error will be thrown.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ConversationsClient, PinMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
- * // const { ConversationsClient, PinMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
- * const client = new ConversationsClient(config);
- * const input = { // PinMessageInput
- *   channelId: "STRING_VALUE", // required
- *   messageId: "STRING_VALUE", // required
- *   userId: "STRING_VALUE",
- *   expiresAfter: Number("int"),
- *   expiresTill: "STRING_VALUE",
- *   silent: true || false,
- * };
- * const command = new PinMessageCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param PinMessageCommandInput - {@link PinMessageCommandInput}
- * @returns {@link PinMessageCommandOutput}
- * @see {@link PinMessageCommandInput} for command's `input` shape.
- * @see {@link PinMessageCommandOutput} 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 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 PinMessageCommand extends PinMessageCommand_base {
-}

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

@@ -1,68 +0,0 @@
-import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
-import { SendActionTriggerResultInput, SendActionTriggerResultOutput } 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 SendActionTriggerResultCommand}.
- */
-export interface SendActionTriggerResultCommandInput extends SendActionTriggerResultInput {
-}
-/**
- * @public
- *
- * The output of {@link SendActionTriggerResultCommand}.
- */
-export interface SendActionTriggerResultCommandOutput extends SendActionTriggerResultOutput, __MetadataBearer {
-}
-declare const SendActionTriggerResultCommand_base: {
-    new (input: SendActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<SendActionTriggerResultCommandInput, SendActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: SendActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<SendActionTriggerResultCommandInput, SendActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Send result of the triggered action.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ConversationsClient, SendActionTriggerResultCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
- * // const { ConversationsClient, SendActionTriggerResultCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
- * const client = new ConversationsClient(config);
- * const input = { // SendActionTriggerResultInput
- *   triggerId: "STRING_VALUE", // required
- *   status: "completed" || "pending", // required
- *   result: {},
- * };
- * const command = new SendActionTriggerResultCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param SendActionTriggerResultCommandInput - {@link SendActionTriggerResultCommandInput}
- * @returns {@link SendActionTriggerResultCommandOutput}
- * @see {@link SendActionTriggerResultCommandInput} for command's `input` shape.
- * @see {@link SendActionTriggerResultCommandOutput} for command's `response` shape.
- * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
- *
- * @throws {@link TriggerNotFoundException} (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 SendActionTriggerResultCommand extends SendActionTriggerResultCommand_base {
-}

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

@@ -1,75 +0,0 @@
-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
- *   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);
- * // { // TriggerMessageActionOutput
- * //   triggerId: "STRING_VALUE", // required
- * // };
- *
- * ```
- *
- * @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 {
-}

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

@@ -1,71 +0,0 @@
-import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
-import { UnpinMessageInput, UnpinMessageOutput } 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 UnpinMessageCommand}.
- */
-export interface UnpinMessageCommandInput extends UnpinMessageInput {
-}
-/**
- * @public
- *
- * The output of {@link UnpinMessageCommand}.
- */
-export interface UnpinMessageCommandOutput extends UnpinMessageOutput, __MetadataBearer {
-}
-declare const UnpinMessageCommand_base: {
-    new (input: UnpinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinMessageCommandInput, UnpinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: UnpinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinMessageCommandInput, UnpinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Unpins the message that was previously pinned. This operation is idempotent, meaning that if the message is not pinned, no error will be thrown.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ConversationsClient, UnpinMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
- * // const { ConversationsClient, UnpinMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
- * const client = new ConversationsClient(config);
- * const input = { // UnpinMessageInput
- *   channelId: "STRING_VALUE", // required
- *   messageId: "STRING_VALUE", // required
- *   userId: "STRING_VALUE",
- *   silent: true || false,
- * };
- * const command = new UnpinMessageCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param UnpinMessageCommandInput - {@link UnpinMessageCommandInput}
- * @returns {@link UnpinMessageCommandOutput}
- * @see {@link UnpinMessageCommandInput} for command's `input` shape.
- * @see {@link UnpinMessageCommandOutput} 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 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 UnpinMessageCommand extends UnpinMessageCommand_base {
-}