@wildix/stream-client 0.0.4 → 0.0.5

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

@@ -0,0 +1,291 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { CreateKiteChannelInput, CreateKiteChannelOutput } 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 CreateKiteChannelCommand}.
+ */
+export interface CreateKiteChannelCommandInput extends CreateKiteChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateKiteChannelCommand}.
+ */
+export interface CreateKiteChannelCommandOutput extends CreateKiteChannelOutput, __MetadataBearer {
+}
+declare const CreateKiteChannelCommand_base: {
+    new (input: CreateKiteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKiteChannelCommandInput, CreateKiteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: CreateKiteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKiteChannelCommandInput, CreateKiteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Creates a new Kite channel for a widget target or agent email.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, CreateKiteChannelCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, CreateKiteChannelCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // CreateKiteChannelInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE",
+ *   targetId: "STRING_VALUE", // required
+ *   targetRouteId: "STRING_VALUE",
+ *   welcomeMessages: [ // WelcomeMessageList
+ *     { // WelcomeMessage
+ *       text: "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,
+ *               },
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *       attachments: [ // MessageAttachmentRequestList
+ *         { // MessageAttachmentRequest
+ *           fsId: "STRING_VALUE", // required
+ *           mime: "STRING_VALUE",
+ *           name: "STRING_VALUE", // required
+ *           size: Number("long"), // required
+ *           width: Number("int"),
+ *           height: Number("int"),
+ *           thumbnail: "STRING_VALUE",
+ *         },
+ *       ],
+ *       quote: { // MessageQuoteRef
+ *         channelId: "STRING_VALUE", // required
+ *         messageId: "STRING_VALUE", // required
+ *       },
+ *       forward: { // MessageForwardRef
+ *         channelId: "STRING_VALUE", // required
+ *         messageId: "STRING_VALUE", // required
+ *       },
+ *       markdown: true || false,
+ *       silent: true || false,
+ *       whatsapp: true || false,
+ *       whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ *       sms: true || false,
+ *       smsStatus: "sent" || "delivered" || "trying" || "error",
+ *       messageId: "STRING_VALUE", // required
+ *       mentions: [ // UserIdList
+ *         "STRING_VALUE",
+ *       ],
+ *       userId: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   initialMessage: { // InitialMessage
+ *     text: "STRING_VALUE",
+ *     elements: [
+ *       {//  Union: only one key present
+ *         template: {
+ *           whatsapp: {
+ *             name: "STRING_VALUE", // required
+ *             parameters: [
+ *               {
+ *                 name: "STRING_VALUE", // required
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *             ],
+ *           },
+ *         },
+ *         actions: [
+ *           {//  Union: only one key present
+ *             button: {
+ *               text: "STRING_VALUE", // required
+ *               handler: {//  Union: only one key present
+ *                 link: {
+ *                   url: "STRING_VALUE", // required
+ *                 },
+ *                 reply: {
+ *                   text: "STRING_VALUE",
+ *                 },
+ *                 action: {
+ *                   id: "STRING_VALUE", // required
+ *                 },
+ *               },
+ *               variant: "contained" || "outlined",
+ *               disabled: true || false,
+ *             },
+ *           },
+ *         ],
+ *       },
+ *     ],
+ *     attachments: [
+ *       {
+ *         fsId: "STRING_VALUE", // required
+ *         mime: "STRING_VALUE",
+ *         name: "STRING_VALUE", // required
+ *         size: Number("long"), // required
+ *         width: Number("int"),
+ *         height: Number("int"),
+ *         thumbnail: "STRING_VALUE",
+ *       },
+ *     ],
+ *     quote: {
+ *       channelId: "STRING_VALUE", // required
+ *       messageId: "STRING_VALUE", // required
+ *     },
+ *     forward: {
+ *       channelId: "STRING_VALUE", // required
+ *       messageId: "STRING_VALUE", // required
+ *     },
+ *     markdown: true || false,
+ *     silent: true || false,
+ *     whatsapp: true || false,
+ *     whatsappStatus: "trying" || "sent" || "delivered" || "error",
+ *     sms: true || false,
+ *     smsStatus: "sent" || "delivered" || "trying" || "error",
+ *     messageId: "STRING_VALUE", // required
+ *     mentions: [
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new CreateKiteChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateKiteChannelOutput
+ * //   channel: { // Channel
+ * //     channelId: "STRING_VALUE", // required
+ * //     channelType: "direct" || "group", // required
+ * //     membersCount: Number("int"), // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE",
+ * //     channelVersion: Number("long"), // required
+ * //     lastActivityAt: "STRING_VALUE", // required
+ * //     lastMessage: { // LastMessagePreview
+ * //       messageId: "STRING_VALUE", // required
+ * //       userId: "STRING_VALUE", // required
+ * //       text: "STRING_VALUE",
+ * //       createdAt: "STRING_VALUE", // required
+ * //     },
+ * //     company: "STRING_VALUE",
+ * //     kite: true || false,
+ * //     kiteTarget: "STRING_VALUE",
+ * //     kiteVariant: "STRING_VALUE",
+ * //     kiteServiceName: "STRING_VALUE",
+ * //     kiteDefaultSubject: "STRING_VALUE",
+ * //     service: "STRING_VALUE",
+ * //     serviceRecipient: "STRING_VALUE",
+ * //     telephony: true || false,
+ * //     external: true || false,
+ * //     subject: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     pictureColor: "STRING_VALUE",
+ * //     access: "private" || "public",
+ * //     broadcast: true || false,
+ * //     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
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //       ptt: { // ChannelContextPushToTalk
+ * //         broadcastId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     whatsappStatus: "24h_channel_closed",
+ * //     sms: true || false,
+ * //     mms: true || false,
+ * //     whatsapp: true || false,
+ * //     kiteAssign: "STRING_VALUE",
+ * //     serviceTitle: "STRING_VALUE",
+ * //     assigneeId: "STRING_VALUE",
+ * //     autoRecord: true || false,
+ * //     transcriptionLanguage: "STRING_VALUE",
+ * //     wizyGuestViewOnly: true || false,
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateKiteChannelCommandInput - {@link CreateKiteChannelCommandInput}
+ * @returns {@link CreateKiteChannelCommandOutput}
+ * @see {@link CreateKiteChannelCommandInput} for command's `input` shape.
+ * @see {@link CreateKiteChannelCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link TargetNotFoundException} (client fault)
+ *
+ * @throws {@link TargetNotEligibleException} (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 CreateKiteChannelCommand extends CreateKiteChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateKiteChannelInput;
+            output: CreateKiteChannelOutput;
+        };
+        sdk: {
+            input: CreateKiteChannelCommandInput;
+            output: CreateKiteChannelCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,96 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { CreateSectionInput, CreateSectionOutput } 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 CreateSectionCommand}.
+ */
+export interface CreateSectionCommandInput extends CreateSectionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateSectionCommand}.
+ */
+export interface CreateSectionCommandOutput extends CreateSectionOutput, __MetadataBearer {
+}
+declare const CreateSectionCommand_base: {
+    new (input: CreateSectionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSectionCommandInput, CreateSectionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: CreateSectionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSectionCommandInput, CreateSectionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Creates a custom inbox section.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, CreateSectionCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, CreateSectionCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // CreateSectionInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   sectionId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new CreateSectionCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateSectionOutput
+ * //   section: { // Section
+ * //     sectionId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     type: "system" || "custom", // required
+ * //     channelCount: Number("int"), // required
+ * //     unread: { // SectionUnreadCounters
+ * //       unmutedUnreadChannelCount: Number("int"), // required
+ * //       unmutedUnreadMessageCount: Number("int"), // required
+ * //       mutedUnreadMessageCount: Number("int"), // required
+ * //       unreadMentionCount: Number("int"), // required
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateSectionCommandInput - {@link CreateSectionCommandInput}
+ * @returns {@link CreateSectionCommandOutput}
+ * @see {@link CreateSectionCommandInput} for command's `input` shape.
+ * @see {@link CreateSectionCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @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 CreateSectionCommand extends CreateSectionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateSectionInput;
+            output: CreateSectionOutput;
+        };
+        sdk: {
+            input: CreateSectionCommandInput;
+            output: CreateSectionCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,82 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { DeleteChannelInput, DeleteChannelOutput } 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 DeleteChannelCommand}.
+ */
+export interface DeleteChannelCommandInput extends DeleteChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteChannelCommand}.
+ */
+export interface DeleteChannelCommandOutput extends DeleteChannelOutput, __MetadataBearer {
+}
+declare const DeleteChannelCommand_base: {
+    new (input: DeleteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Deletes a channel. Idempotent when the channel is already gone.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, DeleteChannelCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, DeleteChannelCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // DeleteChannelInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteChannelCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
+ * @returns {@link DeleteChannelCommandOutput}
+ * @see {@link DeleteChannelCommandInput} for command's `input` shape.
+ * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @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 DeleteChannelCommand extends DeleteChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteChannelInput;
+            output: {};
+        };
+        sdk: {
+            input: DeleteChannelCommandInput;
+            output: DeleteChannelCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,88 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { DeleteChannelMemberInput, DeleteChannelMemberOutput } 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 DeleteChannelMemberCommand}.
+ */
+export interface DeleteChannelMemberCommandInput extends DeleteChannelMemberInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteChannelMemberCommand}.
+ */
+export interface DeleteChannelMemberCommandOutput extends DeleteChannelMemberOutput, __MetadataBearer {
+}
+declare const DeleteChannelMemberCommand_base: {
+    new (input: DeleteChannelMemberCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteChannelMemberCommandInput, DeleteChannelMemberCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteChannelMemberCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteChannelMemberCommandInput, DeleteChannelMemberCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Removes one member from a channel.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, DeleteChannelMemberCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, DeleteChannelMemberCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // DeleteChannelMemberInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   memberId: "STRING_VALUE", // required
+ *   silent: true || false,
+ * };
+ * const command = new DeleteChannelMemberCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteChannelMemberCommandInput - {@link DeleteChannelMemberCommandInput}
+ * @returns {@link DeleteChannelMemberCommandOutput}
+ * @see {@link DeleteChannelMemberCommandInput} for command's `input` shape.
+ * @see {@link DeleteChannelMemberCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link MemberNotFoundException} (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 DeleteChannelMemberCommand extends DeleteChannelMemberCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteChannelMemberInput;
+            output: {};
+        };
+        sdk: {
+            input: DeleteChannelMemberCommandInput;
+            output: DeleteChannelMemberCommandOutput;
+        };
+    };
+}

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

@@ -56,7 +56,7 @@ declare const DeleteMessageCommand_base: {
  *
  * @throws {@link MessageNotFoundException} (client fault)
  *
- * @throws {@link InternalServerError} (server fault)
+ * @throws {@link StreamServiceException} (server fault)
  *
  * @throws {@link UnauthorizedException} (client fault)
  *