@wildix/xbees-conversations-client 1.0.55 → 1.0.57

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

@@ -0,0 +1,76 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { MarkUnreadInput, MarkUnreadOutput } 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 MarkUnreadCommand}.
+ */
+export interface MarkUnreadCommandInput extends MarkUnreadInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link MarkUnreadCommand}.
+ */
+export interface MarkUnreadCommandOutput extends MarkUnreadOutput, __MetadataBearer {
+}
+declare const MarkUnreadCommand_base: {
+    new (input: MarkUnreadCommandInput): import("@smithy/smithy-client").CommandImpl<MarkUnreadCommandInput, MarkUnreadCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: MarkUnreadCommandInput): import("@smithy/smithy-client").CommandImpl<MarkUnreadCommandInput, MarkUnreadCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ *
+ *   Marks the channel with unread indicator.
+ *   A user can have up to 100 channels marked as unread. If a user tries to tag more than 100 channels, the system will remove the oldest channel unread marked if the force flag is specified; otherwise, a MarkUnreadChannelsLimitReachedException will be thrown.
+ *   The system will automatically remove the unread mark from the channel if the user reads the messages using the MarkRead operation.
+ *   This operation is idempotent, meaning that if the channel is already marked as unread, no error will be thrown.
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, MarkUnreadCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, MarkUnreadCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // MarkUnreadInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   messageId: "STRING_VALUE",
+ *   force: true || false,
+ * };
+ * const command = new MarkUnreadCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param MarkUnreadCommandInput - {@link MarkUnreadCommandInput}
+ * @returns {@link MarkUnreadCommandOutput}
+ * @see {@link MarkUnreadCommandInput} for command's `input` shape.
+ * @see {@link MarkUnreadCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link MarkUnreadChannelsLimitReachedException} (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 MarkUnreadCommand extends MarkUnreadCommand_base {
+}

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

@@ -0,0 +1,75 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { PinChannelInput, PinChannelOutput } 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 PinChannelCommand}.
+ */
+export interface PinChannelCommandInput extends PinChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PinChannelCommand}.
+ */
+export interface PinChannelCommandOutput extends PinChannelOutput, __MetadataBearer {
+}
+declare const PinChannelCommand_base: {
+    new (input: PinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<PinChannelCommandInput, PinChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<PinChannelCommandInput, PinChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ *
+ *   Marks the channel with a pin flag.
+ *   A user can have up to 10 pinned channels. If a user tries to pin more than 10 channels, the system will remove the oldest channel if the force flag is specified; otherwise, a PinnedChannelsLimitReachedException will be thrown.
+ *   The system will automatically remove the channel from pinned list if the user leaves the channel or if the channel is removed.
+ *   This operation is idempotent, meaning that if the channel 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, PinChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, PinChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // PinChannelInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   force: true || false,
+ * };
+ * const command = new PinChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PinChannelCommandInput - {@link PinChannelCommandInput}
+ * @returns {@link PinChannelCommandOutput}
+ * @see {@link PinChannelCommandInput} for command's `input` shape.
+ * @see {@link PinChannelCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link PinnedChannelsLimitReachedException} (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 PinChannelCommand extends PinChannelCommand_base {
+}

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

@@ -0,0 +1,76 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { TagChannelInput, TagChannelOutput } 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 TagChannelCommand}.
+ */
+export interface TagChannelCommandInput extends TagChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagChannelCommand}.
+ */
+export interface TagChannelCommandOutput extends TagChannelOutput, __MetadataBearer {
+}
+declare const TagChannelCommand_base: {
+    new (input: TagChannelCommandInput): import("@smithy/smithy-client").CommandImpl<TagChannelCommandInput, TagChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TagChannelCommandInput): import("@smithy/smithy-client").CommandImpl<TagChannelCommandInput, TagChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ *
+ *   Marks the channel with specified tag.
+ *   A user can have up to 100 channels tagged for a single tag. If a user tries to tag more than 100 channels, the system will remove the oldest channel tagged if the force flag is specified; otherwise, a TaggedChannelsLimitReachedException will be thrown.
+ *   The system will automatically remove the channel from the specified tag if the user leaves the channel or if the channel is removed.
+ *   This operation is idempotent, meaning that if the channel is already tagged, no error will be thrown.
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, TagChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, TagChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // TagChannelInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   tagId: "STRING_VALUE", // required
+ *   force: true || false,
+ * };
+ * const command = new TagChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagChannelCommandInput - {@link TagChannelCommandInput}
+ * @returns {@link TagChannelCommandOutput}
+ * @see {@link TagChannelCommandInput} for command's `input` shape.
+ * @see {@link TagChannelCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link TaggedChannelsLimitReachedException} (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 TagChannelCommand extends TagChannelCommand_base {
+}

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

@@ -0,0 +1,67 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { UnpinChannelInput, UnpinChannelOutput } 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 UnpinChannelCommand}.
+ */
+export interface UnpinChannelCommandInput extends UnpinChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UnpinChannelCommand}.
+ */
+export interface UnpinChannelCommandOutput extends UnpinChannelOutput, __MetadataBearer {
+}
+declare const UnpinChannelCommand_base: {
+    new (input: UnpinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinChannelCommandInput, UnpinChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UnpinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinChannelCommandInput, UnpinChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Removes pin flag from the the channel.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, UnpinChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, UnpinChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // UnpinChannelInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ * };
+ * const command = new UnpinChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UnpinChannelCommandInput - {@link UnpinChannelCommandInput}
+ * @returns {@link UnpinChannelCommandOutput}
+ * @see {@link UnpinChannelCommandInput} for command's `input` shape.
+ * @see {@link UnpinChannelCommandOutput} 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 UnpinChannelCommand extends UnpinChannelCommand_base {
+}

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

@@ -0,0 +1,68 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { UntagChannelInput, UntagChannelOutput } 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 UntagChannelCommand}.
+ */
+export interface UntagChannelCommandInput extends UntagChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagChannelCommand}.
+ */
+export interface UntagChannelCommandOutput extends UntagChannelOutput, __MetadataBearer {
+}
+declare const UntagChannelCommand_base: {
+    new (input: UntagChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UntagChannelCommandInput, UntagChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UntagChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UntagChannelCommandInput, UntagChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Removes specified tag from the the channel.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, UntagChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, UntagChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // UntagChannelInput
+ *   channelId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   tagId: "STRING_VALUE", // required
+ * };
+ * const command = new UntagChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagChannelCommandInput - {@link UntagChannelCommandInput}
+ * @returns {@link UntagChannelCommandOutput}
+ * @see {@link UntagChannelCommandInput} for command's `input` shape.
+ * @see {@link UntagChannelCommandOutput} 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 UntagChannelCommand extends UntagChannelCommand_base {
+}

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

@@ -0,0 +1,73 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { UpdateInboxTagInput, UpdateInboxTagOutput } 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 UpdateInboxTagCommand}.
+ */
+export interface UpdateInboxTagCommandInput extends UpdateInboxTagInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateInboxTagCommand}.
+ */
+export interface UpdateInboxTagCommandOutput extends UpdateInboxTagOutput, __MetadataBearer {
+}
+declare const UpdateInboxTagCommand_base: {
+    new (input: UpdateInboxTagCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateInboxTagCommandInput, UpdateInboxTagCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateInboxTagCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateInboxTagCommandInput, UpdateInboxTagCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Updates an existing tag. This operation is idempotent.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, UpdateInboxTagCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, UpdateInboxTagCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // UpdateInboxTagInput
+ *   tagId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE",
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateInboxTagCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateInboxTagOutput
+ * //   tag: { // InboxTag
+ * //     id: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateInboxTagCommandInput - {@link UpdateInboxTagCommandInput}
+ * @returns {@link UpdateInboxTagCommandOutput}
+ * @see {@link UpdateInboxTagCommandInput} for command's `input` shape.
+ * @see {@link UpdateInboxTagCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link TagNotFoundException} (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 UpdateInboxTagCommand extends UpdateInboxTagCommand_base {
+}

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

@@ -1,8 +1,10 @@
 export * from "./AddChannelMemberCommand";
 export * from "./AddChannelMembersCommand";
 export * from "./CreateGroupChannelCommand";
+export * from "./CreateInboxTagCommand";
 export * from "./DeleteChannelCommand";
 export * from "./DeleteChannelMemberCommand";
+export * from "./DeleteInboxTagCommand";
 export * from "./DeleteMessageCommand";
 export * from "./DeleteMessageReactionCommand";
 export * from "./DescribeEventCommand";
@@ -10,6 +12,7 @@ export * from "./GetChannelCommand";
 export * from "./GetChannelMemberCommand";
 export * from "./GetDirectChannelIdCommand";
 export * from "./GetFilePresignedDownloadUrlCommand";
+export * from "./GetInboxStateCommand";
 export * from "./GetMessageCommand";
 export * from "./GetOrCreateDirectChannelCommand";
 export * from "./GetUploadedFileInfoCommand";
@@ -19,11 +22,15 @@ export * from "./JoinChannelCommand";
 export * from "./LeaveChannelCommand";
 export * from "./ListChannelMembersCommand";
 export * from "./ListChannelsCommand";
+export * from "./ListInboxTaggedChannelsCommand";
+export * from "./ListInboxTagsCommand";
 export * from "./ListMessageReactionsCommand";
 export * from "./ListMessagesCommand";
 export * from "./MarkReadCommand";
+export * from "./MarkUnreadCommand";
 export * from "./PartialUpdateChannelCommand";
 export * from "./PartialUpdateMessageCommand";
+export * from "./PinChannelCommand";
 export * from "./ScheduleExternalFlagAdjustmentJobCommand";
 export * from "./SendGiphyCommand";
 export * from "./SendMessageCommand";
@@ -31,6 +38,10 @@ export * from "./SendMessageReactionCommand";
 export * from "./SendTypingStartCommand";
 export * from "./SendTypingStopCommand";
 export * from "./ShowChannelCommand";
+export * from "./TagChannelCommand";
+export * from "./UnpinChannelCommand";
+export * from "./UntagChannelCommand";
 export * from "./UpdateChannelCommand";
+export * from "./UpdateInboxTagCommand";
 export * from "./UpdateMessageCommand";
 export * from "./UploadFileCommand";