@wildix/xbees-conversations-client 1.0.30 → 1.0.31

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

@@ -0,0 +1,98 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { InviteInput, InviteOutput } 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 InviteCommand}.
+ */
+export interface InviteCommandInput extends InviteInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link InviteCommand}.
+ */
+export interface InviteCommandOutput extends InviteOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, InviteCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, InviteCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // InviteInput
+ *   invitees: [ // UsersToInviteList // required
+ *     { // UserToInvite
+ *       email: "STRING_VALUE",
+ *       phone: "STRING_VALUE",
+ *       name: "STRING_VALUE",
+ *       colleague: true || false,
+ *     },
+ *   ],
+ * };
+ * const command = new InviteCommand(input);
+ * const response = await client.send(command);
+ * // { // InviteOutput
+ * //   users: [ // UsersList // required
+ * //     { // 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",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param InviteCommandInput - {@link InviteCommandInput}
+ * @returns {@link InviteCommandOutput}
+ * @see {@link InviteCommandInput} for command's `input` shape.
+ * @see {@link InviteCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @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 InviteCommand extends $Command<InviteCommandInput, InviteCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: InviteCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: InviteCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InviteCommandInput, InviteCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -32,6 +32,7 @@ export interface JoinChannelCommandOutput extends JoinChannelOutput, __MetadataB
  * const input = { // JoinChannelInput
  *   channelId: "STRING_VALUE", // required
  *   userId: "STRING_VALUE",
+ *   silent: true || false,
  * };
  * const command = new JoinChannelCommand(input);
  * const response = await client.send(command);

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

@@ -0,0 +1,77 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { LeaveChannelInput, LeaveChannelOutput } 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 LeaveChannelCommand}.
+ */
+export interface LeaveChannelCommandInput extends LeaveChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link LeaveChannelCommand}.
+ */
+export interface LeaveChannelCommandOutput extends LeaveChannelOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, LeaveChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, LeaveChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // LeaveChannelInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   silent: true || false,
+ * };
+ * const command = new LeaveChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param LeaveChannelCommandInput - {@link LeaveChannelCommandInput}
+ * @returns {@link LeaveChannelCommandOutput}
+ * @see {@link LeaveChannelCommandInput} for command's `input` shape.
+ * @see {@link LeaveChannelCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (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 LeaveChannelCommand extends $Command<LeaveChannelCommandInput, LeaveChannelCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: LeaveChannelCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: LeaveChannelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<LeaveChannelCommandInput, LeaveChannelCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,102 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { ListChannelMembersInput, ListChannelMembersOutput } 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 ListChannelMembersCommand}.
+ */
+export interface ListChannelMembersCommandInput extends ListChannelMembersInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListChannelMembersCommand}.
+ */
+export interface ListChannelMembersCommandOutput extends ListChannelMembersOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, ListChannelMembersCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, ListChannelMembersCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // ListChannelMembersInput
+ *   channelId: "STRING_VALUE", // required
+ *   limit: Number("int"),
+ *   offset: Number("int"),
+ * };
+ * const command = new ListChannelMembersCommand(input);
+ * const response = await client.send(command);
+ * // { // ListChannelMembersOutput
+ * //   members: [ // ChannelMembersList // required
+ * //     { // ChannelMember
+ * //       id: "STRING_VALUE", // required
+ * //       createdAt: "STRING_VALUE", // required
+ * //       role: "member" || "supervisor", // required
+ * //     },
+ * //   ],
+ * //   users: [ // UsersList // required
+ * //     { // 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",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListChannelMembersCommandInput - {@link ListChannelMembersCommandInput}
+ * @returns {@link ListChannelMembersCommandOutput}
+ * @see {@link ListChannelMembersCommandInput} for command's `input` shape.
+ * @see {@link ListChannelMembersCommandOutput} 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 ListChannelMembersCommand extends $Command<ListChannelMembersCommandInput, ListChannelMembersCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: ListChannelMembersCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: ListChannelMembersCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMembersCommandInput, ListChannelMembersCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -114,6 +114,8 @@ export interface ListChannelsCommandOutput extends ListChannelsOutput, __Metadat
  *
  * @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>
  *

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

@@ -37,10 +37,7 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * // { // ListMessagesOutput
  * //   messages: [ // MessagesList
  * //     { // Message
- * //       type: "regular", // required
  * //       text: "STRING_VALUE",
- * //       silent: true || false,
- * //       event: "STRING_VALUE",
  * //       attachments: [ // MessageAttachmentList
  * //         { // MessageAttachment
  * //           id: "STRING_VALUE", // required
@@ -53,18 +50,8 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * //           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
@@ -77,13 +64,6 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * //             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",
@@ -91,6 +71,16 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * //           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
@@ -111,7 +101,7 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * //           updatedAt: "STRING_VALUE",
  * //         },
  * //         edit: true || false,
- * //         mentions: [ // UserList
+ * //         mentions: [ // UsersList
  * //           {
  * //             id: "STRING_VALUE", // required
  * //             name: "STRING_VALUE",
@@ -148,6 +138,16 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  * //         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
@@ -186,6 +186,8 @@ export interface ListMessagesCommandOutput extends ListMessagesOutput, __Metadat
  *
  * @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>
  *

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

@@ -0,0 +1,76 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { MarkReadInput, MarkReadOutput } 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 MarkReadCommand}.
+ */
+export interface MarkReadCommandInput extends MarkReadInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link MarkReadCommand}.
+ */
+export interface MarkReadCommandOutput extends MarkReadOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, MarkReadCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, MarkReadCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // MarkReadInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ * };
+ * const command = new MarkReadCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param MarkReadCommandInput - {@link MarkReadCommandInput}
+ * @returns {@link MarkReadCommandOutput}
+ * @see {@link MarkReadCommandInput} for command's `input` shape.
+ * @see {@link MarkReadCommandOutput} 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 MarkReadCommand extends $Command<MarkReadCommandInput, MarkReadCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: MarkReadCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: MarkReadCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<MarkReadCommandInput, MarkReadCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -32,65 +32,16 @@ export interface PartialUpdateChannelCommandOutput extends PartialUpdateChannelO
  * const input = { // PartialUpdateChannelInput
  *   channelId: "STRING_VALUE", // required
  *   userId: "STRING_VALUE",
- *   set: { // ChannelUpdateFields
+ *   set: { // PartialUpdateChannelSetOptions
  *     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,
  *   },
- *   unset: [ // ChannelUnsetFieldsList
- *     "subject" || "description" || "picture" || "pictureColor" || "access" || "company" || "context" || "kite" || "kiteTarget" || "kiteVariant" || "kiteAssign" || "kiteServiceName" || "kiteDefaultSubject" || "service" || "serviceTitle" || "serviceRecipient" || "assignee" || "telephony" || "sms" || "mms" || "broadcast" || "external",
+ *   unset: [ // PartialUpdateChannelUnsetOptions
+ *     "subject" || "description" || "picture" || "pictureColor" || "access" || "broadcast",
  *   ],
  * };
  * const command = new PartialUpdateChannelCommand(input);
@@ -173,6 +124,8 @@ export interface PartialUpdateChannelCommandOutput extends PartialUpdateChannelO
  *
  * @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>
  *