@wildix/xbees-conversations-client 1.0.28 → 1.0.30

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

@@ -0,0 +1,362 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { UpdateMessageInput, UpdateMessageOutput } 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 UpdateMessageCommand}.
+ */
+export interface UpdateMessageCommandInput extends UpdateMessageInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateMessageCommand}.
+ */
+export interface UpdateMessageCommandOutput extends UpdateMessageOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, UpdateMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, UpdateMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // UpdateMessageInput
+ *   channelId: "STRING_VALUE", // required
+ *   messageId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   message: { // MessageUpdateFields
+ *     type: "regular", // required
+ *     text: "STRING_VALUE",
+ *     silent: true || false,
+ *     event: "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",
+ *       },
+ *     ],
+ *     giphy: { // MessageGiphy
+ *       id: "STRING_VALUE",
+ *       size: "STRING_VALUE",
+ *       url: "STRING_VALUE",
+ *       height: "STRING_VALUE",
+ *       width: "STRING_VALUE",
+ *     },
+ *     quote: { // Message
+ *       type: "regular", // required
+ *       text: "STRING_VALUE",
+ *       silent: true || false,
+ *       event: "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",
+ *         },
+ *       ],
+ *       giphy: {
+ *         id: "STRING_VALUE",
+ *         size: "STRING_VALUE",
+ *         url: "STRING_VALUE",
+ *         height: "STRING_VALUE",
+ *         width: "STRING_VALUE",
+ *       },
+ *       quote: {
+ *         type: "regular", // required
+ *         text: "STRING_VALUE",
+ *         silent: true || false,
+ *         event: "STRING_VALUE",
+ *         attachments: "<MessageAttachmentList>",
+ *         giphy: "<MessageGiphy>",
+ *         quote: "<Message>",
+ *         forward: { // MessageForward
+ *           forwardCompany: "STRING_VALUE",
+ *           forwardDate: "STRING_VALUE", // required
+ *           forwardEmail: "STRING_VALUE",
+ *           forwardName: "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: [ // UserList
+ *           {
+ *             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",
+ *       },
+ *       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",
+ *     },
+ *     forward: "<MessageForward>",
+ *     sms: true || false,
+ *     smsStatus: "sent" || "delivered" || "trying" || "error",
+ *     mentions: [ // MessageCreateMentionsList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new UpdateMessageCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateMessageOutput
+ * //   message: { // Message
+ * //     type: "regular", // required
+ * //     text: "STRING_VALUE",
+ * //     silent: true || false,
+ * //     event: "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",
+ * //       },
+ * //     ],
+ * //     giphy: { // MessageGiphy
+ * //       id: "STRING_VALUE",
+ * //       size: "STRING_VALUE",
+ * //       url: "STRING_VALUE",
+ * //       height: "STRING_VALUE",
+ * //       width: "STRING_VALUE",
+ * //     },
+ * //     quote: {
+ * //       type: "regular", // required
+ * //       text: "STRING_VALUE",
+ * //       silent: true || false,
+ * //       event: "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",
+ * //         },
+ * //       ],
+ * //       giphy: {
+ * //         id: "STRING_VALUE",
+ * //         size: "STRING_VALUE",
+ * //         url: "STRING_VALUE",
+ * //         height: "STRING_VALUE",
+ * //         width: "STRING_VALUE",
+ * //       },
+ * //       quote: "<Message>",
+ * //       forward: { // MessageForward
+ * //         forwardCompany: "STRING_VALUE",
+ * //         forwardDate: "STRING_VALUE", // required
+ * //         forwardEmail: "STRING_VALUE",
+ * //         forwardName: "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: [ // UserList
+ * //         {
+ * //           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",
+ * //     },
+ * //     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 UpdateMessageCommandInput - {@link UpdateMessageCommandInput}
+ * @returns {@link UpdateMessageCommandOutput}
+ * @see {@link UpdateMessageCommandInput} for command's `input` shape.
+ * @see {@link UpdateMessageCommandOutput} 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 ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ */
+export declare class UpdateMessageCommand extends $Command<UpdateMessageCommandInput, UpdateMessageCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: UpdateMessageCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: UpdateMessageCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateMessageCommandInput, UpdateMessageCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,10 +1,15 @@
 export * from "./CreateChannelCommand";
 export * from "./CreateMessageCommand";
 export * from "./DeleteChannelCommand";
+export * from "./DeleteMessageCommand";
 export * from "./GetChannelCommand";
 export * from "./GetChannelMemberCommand";
 export * from "./GetMessageCommand";
 export * from "./JoinChannelCommand";
+export * from "./ListChannelsCommand";
+export * from "./ListMessagesCommand";
 export * from "./PartialUpdateChannelCommand";
+export * from "./PartialUpdateMessageCommand";
 export * from "./ScheduleExternalFlagAdjustmentJobCommand";
 export * from "./UpdateChannelCommand";
+export * from "./UpdateMessageCommand";

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

@@ -3,24 +3,24 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
 /**
  * @public
  */
-export declare class ValidationException extends __BaseException {
-    readonly name: "ValidationException";
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
  * @public
  */
-export declare class ForbiddenException extends __BaseException {
-    readonly name: "ForbiddenException";
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
  * @public
@@ -298,6 +298,7 @@ export interface ChannelUpdateFields {
  */
 export interface CreateChannelInput {
     channel: ChannelCreateFields;
+    userId?: string;
 }
 /**
  * @public
@@ -386,6 +387,29 @@ export interface DeleteChannelInput {
  */
 export interface DeleteChannelOutput {
 }
+/**
+ * @public
+ */
+export interface DeleteMessageInput {
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteMessageOutput {
+}
+/**
+ * @public
+ */
+export declare class MessageNotFoundException extends __BaseException {
+    readonly name: "MessageNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
+}
 /**
  * @public
  */
@@ -427,12 +451,14 @@ export declare class MemberNotFoundException extends __BaseException {
  */
 export interface GetMessageInput {
     channelId: string;
+    messageId: string;
 }
 /**
  * @public
  */
 export interface JoinChannelInput {
     channelId: string;
+    userId?: string;
 }
 /**
  * @public
@@ -440,11 +466,32 @@ export interface JoinChannelInput {
 export interface JoinChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ */
+export interface ListChannelsInput {
+    userId?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * @public
+ */
+export interface ListChannelsOutput {
+    channels: (Channel)[];
+}
+/**
+ * @public
+ */
+export interface ListMessagesInput {
+    channelId: string;
+}
 /**
  * @public
  */
 export interface PartialUpdateChannelInput {
     channelId: string;
+    userId?: string;
     set?: ChannelUpdateFields;
     unset?: (ChannelUnsetFields | string)[];
 }
@@ -454,6 +501,22 @@ export interface PartialUpdateChannelInput {
 export interface PartialUpdateChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageUnsetFields: {
+    readonly ATTACHMENTS: "attachments";
+    readonly EVENT: "event";
+    readonly FORWARD: "forward";
+    readonly QUOTE: "quote";
+    readonly SMS: "sms";
+    readonly SMS_STATUS: "smsStatus";
+};
+/**
+ * @public
+ */
+export type MessageUnsetFields = typeof MessageUnsetFields[keyof typeof MessageUnsetFields];
 /**
  * @public
  */
@@ -485,6 +548,7 @@ export interface ScheduleExternalFlagAdjustmentJobOutput {
  */
 export interface UpdateChannelInput {
     channelId: string;
+    userId?: string;
     channel: ChannelUpdateFields;
 }
 /**
@@ -547,15 +611,68 @@ export interface MessageCreateFields {
     messageId?: string;
     mentions?: (string)[];
 }
+/**
+ * @public
+ */
+export interface MessageUpdateFields {
+    type: MessageType | string;
+    text?: string;
+    silent?: boolean;
+    event?: string;
+    attachments?: (MessageAttachment)[];
+    giphy?: MessageGiphy;
+    quote?: Message;
+    forward?: MessageForward;
+    sms?: boolean;
+    smsStatus?: MessageSmsStatus | string;
+    mentions?: (string)[];
+}
+/**
+ * @public
+ */
+export interface PartialUpdateMessageOutput {
+    message?: Message;
+}
+/**
+ * @public
+ */
+export interface UpdateMessageOutput {
+    message?: Message;
+}
 /**
  * @public
  */
 export interface CreateMessageInput {
     channelId: string;
-    userId: string;
+    userId?: string;
     /**
      * @public
      * An interface of available options for new message command
      */
     message: MessageCreateFields;
 }
+/**
+ * @public
+ */
+export interface ListMessagesOutput {
+    messages?: (Message)[];
+}
+/**
+ * @public
+ */
+export interface PartialUpdateMessageInput {
+    channelId: string;
+    messageId: string;
+    userId?: string;
+    set?: MessageUpdateFields;
+    unset?: (MessageUnsetFields | string)[];
+}
+/**
+ * @public
+ */
+export interface UpdateMessageInput {
+    channelId: string;
+    messageId: string;
+    userId?: string;
+    message: MessageUpdateFields;
+}