@wildix/stream-client 0.0.1 → 0.0.5

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

@@ -88,6 +88,13 @@ declare const ListMentionsCommand_base: {
  * //         reactionCounts: { // ReactionCounts // required
  * //           "<keys>": Number("int"),
  * //         },
+ * //         latestReactions: [ // ReactionList
+ * //           { // Reaction
+ * //             type: "STRING_VALUE", // required
+ * //             userId: "STRING_VALUE", // required
+ * //             messageId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //         pinned: true || false, // required
  * //         pinnedAt: "STRING_VALUE",
  * //         pinnedBy: "STRING_VALUE",
@@ -99,10 +106,59 @@ declare const ListMentionsCommand_base: {
  * //         createdAt: "STRING_VALUE", // required
  * //         editedAt: "STRING_VALUE",
  * //         deletedAt: "STRING_VALUE",
+ * //         elements: [ // ElementsList
+ * //           { // Element Union: only one key present
+ * //             template: { // MessageTemplateConfig
+ * //               whatsapp: { // TemplateWithParameters
+ * //                 name: "STRING_VALUE", // required
+ * //                 parameters: [ // ListTemplateParameter
+ * //                   { // TemplateParameter
+ * //                     name: "STRING_VALUE", // required
+ * //                     value: "STRING_VALUE", // required
+ * //                   },
+ * //                 ],
+ * //               },
+ * //             },
+ * //             actions: [ // ActionsElementsList
+ * //               { // ActionElement Union: only one key present
+ * //                 button: { // ButtonElement
+ * //                   text: "STRING_VALUE", // required
+ * //                   handler: { // ButtonHandler Union: only one key present
+ * //                     link: { // ButtonLinkHandler
+ * //                       url: "STRING_VALUE", // required
+ * //                     },
+ * //                     reply: { // ButtonReplyHandler
+ * //                       text: "STRING_VALUE",
+ * //                     },
+ * //                     action: { // ButtonActionHandler
+ * //                       id: "STRING_VALUE", // required
+ * //                     },
+ * //                   },
+ * //                   variant: "contained" || "outlined",
+ * //                   disabled: true || false,
+ * //                 },
+ * //               },
+ * //             ],
+ * //           },
+ * //         ],
+ * //         whatsapp: true || false,
+ * //         whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //         sms: true || false,
+ * //         smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //         markdown: true || false,
+ * //         giphy: { // MessageGiphy
+ * //           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",
  * //       },
  * //       channel: { // MentionChannelPreview
  * //         channelId: "STRING_VALUE", // required
- * //         channelType: "direct" || "group" || "external", // required
+ * //         channelType: "direct" || "group", // required
  * //         subject: "STRING_VALUE",
  * //         picture: "STRING_VALUE",
  * //         memberCount: Number("int"), // required
@@ -122,7 +178,7 @@ declare const ListMentionsCommand_base: {
  * @see {@link ListMentionsCommandOutput} for command's `response` shape.
  * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
  *
- * @throws {@link InternalServerError} (server fault)
+ * @throws {@link StreamServiceException} (server fault)
  *
  * @throws {@link UnauthorizedException} (client fault)
  *

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

@@ -81,6 +81,13 @@ declare const ListMessagesCommand_base: {
  * //       reactionCounts: { // ReactionCounts // required
  * //         "<keys>": Number("int"),
  * //       },
+ * //       latestReactions: [ // ReactionList
+ * //         { // Reaction
+ * //           type: "STRING_VALUE", // required
+ * //           userId: "STRING_VALUE", // required
+ * //           messageId: "STRING_VALUE", // required
+ * //         },
+ * //       ],
  * //       pinned: true || false, // required
  * //       pinnedAt: "STRING_VALUE",
  * //       pinnedBy: "STRING_VALUE",
@@ -92,6 +99,55 @@ declare const ListMessagesCommand_base: {
  * //       createdAt: "STRING_VALUE", // required
  * //       editedAt: "STRING_VALUE",
  * //       deletedAt: "STRING_VALUE",
+ * //       elements: [ // ElementsList
+ * //         { // Element Union: only one key present
+ * //           template: { // MessageTemplateConfig
+ * //             whatsapp: { // TemplateWithParameters
+ * //               name: "STRING_VALUE", // required
+ * //               parameters: [ // ListTemplateParameter
+ * //                 { // TemplateParameter
+ * //                   name: "STRING_VALUE", // required
+ * //                   value: "STRING_VALUE", // required
+ * //                 },
+ * //               ],
+ * //             },
+ * //           },
+ * //           actions: [ // ActionsElementsList
+ * //             { // ActionElement Union: only one key present
+ * //               button: { // ButtonElement
+ * //                 text: "STRING_VALUE", // required
+ * //                 handler: { // ButtonHandler Union: only one key present
+ * //                   link: { // ButtonLinkHandler
+ * //                     url: "STRING_VALUE", // required
+ * //                   },
+ * //                   reply: { // ButtonReplyHandler
+ * //                     text: "STRING_VALUE",
+ * //                   },
+ * //                   action: { // ButtonActionHandler
+ * //                     id: "STRING_VALUE", // required
+ * //                   },
+ * //                 },
+ * //                 variant: "contained" || "outlined",
+ * //                 disabled: true || false,
+ * //               },
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //       whatsapp: true || false,
+ * //       whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ * //       sms: true || false,
+ * //       smsStatus: "sent" || "delivered" || "trying" || "error",
+ * //       markdown: true || false,
+ * //       giphy: { // MessageGiphy
+ * //         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",
  * //     },
  * //   ],
  * // };
@@ -106,7 +162,7 @@ declare const ListMessagesCommand_base: {
  *
  * @throws {@link ChannelNotFoundException} (client fault)
  *
- * @throws {@link InternalServerError} (server fault)
+ * @throws {@link StreamServiceException} (server fault)
  *
  * @throws {@link UnauthorizedException} (client fault)
  *

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

@@ -0,0 +1,99 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { MarkReadInput, MarkReadOutput } 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 MarkReadCommand}.
+ */
+export interface MarkReadCommandInput extends MarkReadInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link MarkReadCommand}.
+ */
+export interface MarkReadCommandOutput extends MarkReadOutput, __MetadataBearer {
+}
+declare const MarkReadCommand_base: {
+    new (input: MarkReadCommandInput): import("@smithy/smithy-client").CommandImpl<MarkReadCommandInput, MarkReadCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: MarkReadCommandInput): import("@smithy/smithy-client").CommandImpl<MarkReadCommandInput, MarkReadCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Marks the channel read up to the latest visible message for the current user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, MarkReadCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, MarkReadCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // MarkReadInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   lastReadVisibleSeq: Number("long"),
+ * };
+ * const command = new MarkReadCommand(input);
+ * const response = await client.send(command);
+ * // { // MarkReadOutput
+ * //   inbox: { // InboxState
+ * //     sectionIds: [ // SectionIdList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     unreadCount: Number("int"), // required
+ * //     mentionUnreadCount: Number("int"), // required
+ * //     lastReadVisibleSeq: Number("long"),
+ * //     lastReadAt: "STRING_VALUE",
+ * //     hidden: true || false, // required
+ * //     muted: true || false, // required
+ * //     mutedUntil: "STRING_VALUE",
+ * //     unreadMarkAt: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @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 StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link StreamServiceException} (server fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link RateLimitExceededException} (client fault)
+ *
+ * @throws {@link StreamServiceServiceException}
+ * <p>Base exception class for all service exceptions from StreamService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class MarkReadCommand extends MarkReadCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: MarkReadInput;
+            output: MarkReadOutput;
+        };
+        sdk: {
+            input: MarkReadCommandInput;
+            output: MarkReadCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,103 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+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, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: MarkUnreadCommandInput): import("@smithy/smithy-client").CommandImpl<MarkUnreadCommandInput, MarkUnreadCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Marks the channel unread for the current user from the resolved read pointer.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, MarkUnreadCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, MarkUnreadCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // MarkUnreadInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   messageId: "STRING_VALUE",
+ *   unreadMarkAt: Number("long"),
+ *   force: true || false,
+ * };
+ * const command = new MarkUnreadCommand(input);
+ * const response = await client.send(command);
+ * // { // MarkUnreadOutput
+ * //   inbox: { // InboxState
+ * //     sectionIds: [ // SectionIdList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     unreadCount: Number("int"), // required
+ * //     mentionUnreadCount: Number("int"), // required
+ * //     lastReadVisibleSeq: Number("long"),
+ * //     lastReadAt: "STRING_VALUE",
+ * //     hidden: true || false, // required
+ * //     muted: true || false, // required
+ * //     mutedUntil: "STRING_VALUE",
+ * //     unreadMarkAt: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @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 StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link MarkUnreadChannelsLimitReachedException} (client fault)
+ *
+ * @throws {@link StreamServiceException} (server fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link RateLimitExceededException} (client fault)
+ *
+ * @throws {@link StreamServiceServiceException}
+ * <p>Base exception class for all service exceptions from StreamService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class MarkUnreadCommand extends MarkUnreadCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: MarkUnreadInput;
+            output: MarkUnreadOutput;
+        };
+        sdk: {
+            input: MarkUnreadCommandInput;
+            output: MarkUnreadCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,101 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { MoveChannelToSectionInput, MoveChannelToSectionOutput } 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 MoveChannelToSectionCommand}.
+ */
+export interface MoveChannelToSectionCommandInput extends MoveChannelToSectionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link MoveChannelToSectionCommand}.
+ */
+export interface MoveChannelToSectionCommandOutput extends MoveChannelToSectionOutput, __MetadataBearer {
+}
+declare const MoveChannelToSectionCommand_base: {
+    new (input: MoveChannelToSectionCommandInput): import("@smithy/smithy-client").CommandImpl<MoveChannelToSectionCommandInput, MoveChannelToSectionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: MoveChannelToSectionCommandInput): import("@smithy/smithy-client").CommandImpl<MoveChannelToSectionCommandInput, MoveChannelToSectionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Adds a channel to a custom section for the current user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, MoveChannelToSectionCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, MoveChannelToSectionCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // MoveChannelToSectionInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   sectionId: "STRING_VALUE", // required
+ * };
+ * const command = new MoveChannelToSectionCommand(input);
+ * const response = await client.send(command);
+ * // { // MoveChannelToSectionOutput
+ * //   inbox: { // InboxState
+ * //     sectionIds: [ // SectionIdList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     unreadCount: Number("int"), // required
+ * //     mentionUnreadCount: Number("int"), // required
+ * //     lastReadVisibleSeq: Number("long"),
+ * //     lastReadAt: "STRING_VALUE",
+ * //     hidden: true || false, // required
+ * //     muted: true || false, // required
+ * //     mutedUntil: "STRING_VALUE",
+ * //     unreadMarkAt: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param MoveChannelToSectionCommandInput - {@link MoveChannelToSectionCommandInput}
+ * @returns {@link MoveChannelToSectionCommandOutput}
+ * @see {@link MoveChannelToSectionCommandInput} for command's `input` shape.
+ * @see {@link MoveChannelToSectionCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link SectionNotFoundException} (client fault)
+ *
+ * @throws {@link StreamServiceException} (server fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link RateLimitExceededException} (client fault)
+ *
+ * @throws {@link StreamServiceServiceException}
+ * <p>Base exception class for all service exceptions from StreamService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class MoveChannelToSectionCommand extends MoveChannelToSectionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: MoveChannelToSectionInput;
+            output: MoveChannelToSectionOutput;
+        };
+        sdk: {
+            input: MoveChannelToSectionCommandInput;
+            output: MoveChannelToSectionCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,99 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { MuteChannelInput, MuteChannelOutput } 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 MuteChannelCommand}.
+ */
+export interface MuteChannelCommandInput extends MuteChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link MuteChannelCommand}.
+ */
+export interface MuteChannelCommandOutput extends MuteChannelOutput, __MetadataBearer {
+}
+declare const MuteChannelCommand_base: {
+    new (input: MuteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<MuteChannelCommandInput, MuteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: MuteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<MuteChannelCommandInput, MuteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Mutes a channel for the current user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, MuteChannelCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, MuteChannelCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // MuteChannelInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   mutedUntil: "STRING_VALUE",
+ * };
+ * const command = new MuteChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // MuteChannelOutput
+ * //   inbox: { // InboxState
+ * //     sectionIds: [ // SectionIdList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     unreadCount: Number("int"), // required
+ * //     mentionUnreadCount: Number("int"), // required
+ * //     lastReadVisibleSeq: Number("long"),
+ * //     lastReadAt: "STRING_VALUE",
+ * //     hidden: true || false, // required
+ * //     muted: true || false, // required
+ * //     mutedUntil: "STRING_VALUE",
+ * //     unreadMarkAt: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param MuteChannelCommandInput - {@link MuteChannelCommandInput}
+ * @returns {@link MuteChannelCommandOutput}
+ * @see {@link MuteChannelCommandInput} for command's `input` shape.
+ * @see {@link MuteChannelCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link StreamServiceException} (server fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link RateLimitExceededException} (client fault)
+ *
+ * @throws {@link StreamServiceServiceException}
+ * <p>Base exception class for all service exceptions from StreamService service.</p>
+ *
+ *
+ * @public
+ */
+export declare class MuteChannelCommand extends MuteChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: MuteChannelInput;
+            output: MuteChannelOutput;
+        };
+        sdk: {
+            input: MuteChannelCommandInput;
+            output: MuteChannelCommandOutput;
+        };
+    };
+}