@wildix/xbees-conversations-client 1.0.30 → 1.0.32

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

@@ -0,0 +1,213 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { SendSystemMessageInput, SendSystemMessageOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendSystemMessageCommand}.
+ */
+export interface SendSystemMessageCommandInput extends SendSystemMessageInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendSystemMessageCommand}.
+ */
+export interface SendSystemMessageCommandOutput extends SendSystemMessageOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, SendSystemMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, SendSystemMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // SendSystemMessageInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   messageId: "STRING_VALUE",
+ * };
+ * const command = new SendSystemMessageCommand(input);
+ * const response = await client.send(command);
+ * // { // SendSystemMessageOutput
+ * //   message: { // Message
+ * //     text: "STRING_VALUE",
+ * //     attachments: [ // MessageAttachmentList
+ * //       { // MessageAttachment
+ * //         id: "STRING_VALUE", // required
+ * //         fsId: "STRING_VALUE", // required
+ * //         mime: "STRING_VALUE",
+ * //         name: "STRING_VALUE",
+ * //         size: Number("int"), // required
+ * //         width: Number("int"),
+ * //         height: Number("int"),
+ * //         thumbnail: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     quote: {
+ * //       text: "STRING_VALUE",
+ * //       attachments: [
+ * //         {
+ * //           id: "STRING_VALUE", // required
+ * //           fsId: "STRING_VALUE", // required
+ * //           mime: "STRING_VALUE",
+ * //           name: "STRING_VALUE",
+ * //           size: Number("int"), // required
+ * //           width: Number("int"),
+ * //           height: Number("int"),
+ * //           thumbnail: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       quote: "<Message>",
+ * //       forward: { // MessageForward
+ * //         forwardCompany: "STRING_VALUE",
+ * //         forwardDate: "STRING_VALUE", // required
+ * //         forwardEmail: "STRING_VALUE",
+ * //         forwardName: "STRING_VALUE",
+ * //       },
+ * //       type: "regular", // required
+ * //       giphy: { // MessageGiphy
+ * //         id: "STRING_VALUE",
+ * //         size: "STRING_VALUE",
+ * //         url: "STRING_VALUE",
+ * //         height: "STRING_VALUE",
+ * //         width: "STRING_VALUE",
+ * //       },
+ * //       silent: true || false,
+ * //       event: "STRING_VALUE",
+ * //       sms: true || false,
+ * //       smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //       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",
+ * //         company: "STRING_VALUE",
+ * //         pbxDomain: "STRING_VALUE",
+ * //         pbxPort: "STRING_VALUE",
+ * //         pbxExtension: "STRING_VALUE",
+ * //         pbxSerial: "STRING_VALUE",
+ * //         pbxUserId: "STRING_VALUE",
+ * //         createdAt: "STRING_VALUE",
+ * //         updatedAt: "STRING_VALUE",
+ * //       },
+ * //       edit: true || false,
+ * //       mentions: [ // UsersList
+ * //         {
+ * //           id: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           phone: "STRING_VALUE",
+ * //           picture: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //           pbxDomain: "STRING_VALUE",
+ * //           pbxPort: "STRING_VALUE",
+ * //           pbxExtension: "STRING_VALUE",
+ * //           pbxSerial: "STRING_VALUE",
+ * //           pbxUserId: "STRING_VALUE",
+ * //           createdAt: "STRING_VALUE",
+ * //           updatedAt: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       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",
+ * //     },
+ * //     forward: {
+ * //       forwardCompany: "STRING_VALUE",
+ * //       forwardDate: "STRING_VALUE", // required
+ * //       forwardEmail: "STRING_VALUE",
+ * //       forwardName: "STRING_VALUE",
+ * //     },
+ * //     type: "regular", // required
+ * //     giphy: {
+ * //       id: "STRING_VALUE",
+ * //       size: "STRING_VALUE",
+ * //       url: "STRING_VALUE",
+ * //       height: "STRING_VALUE",
+ * //       width: "STRING_VALUE",
+ * //     },
+ * //     silent: true || false,
+ * //     event: "STRING_VALUE",
+ * //     sms: true || false,
+ * //     smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //     messageId: "STRING_VALUE", // required
+ * //     channelId: "STRING_VALUE", // required
+ * //     user: "<User>", // required
+ * //     edit: true || false,
+ * //     mentions: [
+ * //       "<User>",
+ * //     ],
+ * //     latestReactions: [
+ * //       {
+ * //         type: "STRING_VALUE",
+ * //         userId: "STRING_VALUE",
+ * //         messageId: "STRING_VALUE",
+ * //         user: "<User>",
+ * //       },
+ * //     ],
+ * //     reactionCounts: {
+ * //       "<keys>": Number("int"),
+ * //     },
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param SendSystemMessageCommandInput - {@link SendSystemMessageCommandInput}
+ * @returns {@link SendSystemMessageCommandOutput}
+ * @see {@link SendSystemMessageCommandInput} for command's `input` shape.
+ * @see {@link SendSystemMessageCommandOutput} 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 ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ */
+export declare class SendSystemMessageCommand extends $Command<SendSystemMessageCommandInput, SendSystemMessageCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: SendSystemMessageCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: SendSystemMessageCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendSystemMessageCommandInput, SendSystemMessageCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,76 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { SendTypingStartInput, SendTypingStartOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendTypingStartCommand}.
+ */
+export interface SendTypingStartCommandInput extends SendTypingStartInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendTypingStartCommand}.
+ */
+export interface SendTypingStartCommandOutput extends SendTypingStartOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, SendTypingStartCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, SendTypingStartCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // SendTypingStartInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ * };
+ * const command = new SendTypingStartCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SendTypingStartCommandInput - {@link SendTypingStartCommandInput}
+ * @returns {@link SendTypingStartCommandOutput}
+ * @see {@link SendTypingStartCommandInput} for command's `input` shape.
+ * @see {@link SendTypingStartCommandOutput} 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 ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ */
+export declare class SendTypingStartCommand extends $Command<SendTypingStartCommandInput, SendTypingStartCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: SendTypingStartCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: SendTypingStartCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTypingStartCommandInput, SendTypingStartCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,76 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { SendTypingStopInput, SendTypingStopOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendTypingStopCommand}.
+ */
+export interface SendTypingStopCommandInput extends SendTypingStopInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendTypingStopCommand}.
+ */
+export interface SendTypingStopCommandOutput extends SendTypingStopOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, SendTypingStopCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, SendTypingStopCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // SendTypingStopInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ * };
+ * const command = new SendTypingStopCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SendTypingStopCommandInput - {@link SendTypingStopCommandInput}
+ * @returns {@link SendTypingStopCommandOutput}
+ * @see {@link SendTypingStopCommandInput} for command's `input` shape.
+ * @see {@link SendTypingStopCommandOutput} 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 ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ */
+export declare class SendTypingStopCommand extends $Command<SendTypingStopCommandInput, SendTypingStopCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: SendTypingStopCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: SendTypingStopCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTypingStopCommandInput, SendTypingStopCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -30,65 +30,14 @@ export interface UpdateChannelCommandOutput extends UpdateChannelOutput, __Metad
  * // const { ConversationsClient, UpdateChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
  * const client = new ConversationsClient(config);
  * const input = { // UpdateChannelInput
+ *   subject: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   picture: "STRING_VALUE",
+ *   pictureColor: "STRING_VALUE",
+ *   access: "private" || "public",
+ *   broadcast: true || false,
  *   channelId: "STRING_VALUE", // required
  *   userId: "STRING_VALUE",
- *   channel: { // ChannelUpdateFields
- *     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
- *             },
- *           ],
- *         },
- *       ],
- *     },
- *     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",
- *       company: "STRING_VALUE",
- *       pbxDomain: "STRING_VALUE",
- *       pbxPort: "STRING_VALUE",
- *       pbxExtension: "STRING_VALUE",
- *       pbxSerial: "STRING_VALUE",
- *       pbxUserId: "STRING_VALUE",
- *       createdAt: "STRING_VALUE",
- *       updatedAt: "STRING_VALUE",
- *     },
- *     telephony: true || false,
- *     sms: true || false,
- *     mms: true || false,
- *     broadcast: true || false,
- *     external: true || false,
- *   },
  * };
  * const command = new UpdateChannelCommand(input);
  * const response = await client.send(command);
@@ -170,6 +119,8 @@ export interface UpdateChannelCommandOutput extends UpdateChannelOutput, __Metad
  *
  * @throws {@link ValidationException} (client fault)
  *
+ * @throws {@link ForbiddenException} (client fault)
+ *
  * @throws {@link ConversationsServiceException}
  * <p>Base exception class for all service exceptions from Conversations service.</p>
  *