@wildix/stream-client 0.0.4 → 0.0.6

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

@@ -0,0 +1,108 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { AddChannelMembersInput, AddChannelMembersOutput } 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 AddChannelMembersCommand}.
+ */
+export interface AddChannelMembersCommandInput extends AddChannelMembersInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link AddChannelMembersCommand}.
+ */
+export interface AddChannelMembersCommandOutput extends AddChannelMembersOutput, __MetadataBearer {
+}
+declare const AddChannelMembersCommand_base: {
+    new (input: AddChannelMembersCommandInput): import("@smithy/smithy-client").CommandImpl<AddChannelMembersCommandInput, AddChannelMembersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: AddChannelMembersCommandInput): import("@smithy/smithy-client").CommandImpl<AddChannelMembersCommandInput, AddChannelMembersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Adds members to a channel.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, AddChannelMembersCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, AddChannelMembersCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // AddChannelMembersInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   silent: true || false,
+ *   members: [ // UserIdList
+ *     "STRING_VALUE",
+ *   ],
+ *   membersToInvite: [ // UserToInviteList
+ *     { // UserToInvite
+ *       email: "STRING_VALUE",
+ *       phone: "STRING_VALUE",
+ *       name: "STRING_VALUE",
+ *       colleague: true || false,
+ *     },
+ *   ],
+ *   hideHistory: true || false,
+ *   unreadMessageId: "STRING_VALUE",
+ * };
+ * const command = new AddChannelMembersCommand(input);
+ * const response = await client.send(command);
+ * // { // AddChannelMembersOutput
+ * //   members: [ // ChannelMemberList // required
+ * //     { // ChannelMember
+ * //       userId: "STRING_VALUE", // required
+ * //       joinedAt: "STRING_VALUE", // required
+ * //       role: "member" || "supervisor", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param AddChannelMembersCommandInput - {@link AddChannelMembersCommandInput}
+ * @returns {@link AddChannelMembersCommandOutput}
+ * @see {@link AddChannelMembersCommandInput} for command's `input` shape.
+ * @see {@link AddChannelMembersCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link MemberAlreadyExistException} (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 AddChannelMembersCommand extends AddChannelMembersCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AddChannelMembersInput;
+            output: AddChannelMembersOutput;
+        };
+        sdk: {
+            input: AddChannelMembersCommandInput;
+            output: AddChannelMembersCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,96 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { AssignChannelInput, AssignChannelOutput } 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 AssignChannelCommand}.
+ */
+export interface AssignChannelCommandInput extends AssignChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link AssignChannelCommand}.
+ */
+export interface AssignChannelCommandOutput extends AssignChannelOutput, __MetadataBearer {
+}
+declare const AssignChannelCommand_base: {
+    new (input: AssignChannelCommandInput): import("@smithy/smithy-client").CommandImpl<AssignChannelCommandInput, AssignChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: AssignChannelCommandInput): import("@smithy/smithy-client").CommandImpl<AssignChannelCommandInput, AssignChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Assigns a channel to a service and/or assignee.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, AssignChannelCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, AssignChannelCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // AssignChannelInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   channelId: "STRING_VALUE", // required
+ *   silent: true || false,
+ *   service: { // AssignChannelServiceRequest Union: only one key present
+ *     uri: "STRING_VALUE",
+ *   },
+ *   assignee: { // AssignChannelAssigneeRequest Union: only one key present
+ *     id: "STRING_VALUE",
+ *     email: "STRING_VALUE",
+ *   },
+ *   variant: "ADAPTIVE" || "SELECTED" || "EVERYBODY" || "SKIP",
+ * };
+ * const command = new AssignChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // AssignChannelOutput
+ * //   assigneeId: "STRING_VALUE",
+ * //   serviceUri: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param AssignChannelCommandInput - {@link AssignChannelCommandInput}
+ * @returns {@link AssignChannelCommandOutput}
+ * @see {@link AssignChannelCommandInput} for command's `input` shape.
+ * @see {@link AssignChannelCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link StreamServiceException} (server fault)
+ *
+ * @throws {@link UnauthorizedException} (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 AssignChannelCommand extends AssignChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AssignChannelInput;
+            output: AssignChannelOutput;
+        };
+        sdk: {
+            input: AssignChannelCommandInput;
+            output: AssignChannelCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,201 @@
+import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
+import { CreateGroupChannelInput, CreateGroupChannelOutput } 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 CreateGroupChannelCommand}.
+ */
+export interface CreateGroupChannelCommandInput extends CreateGroupChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateGroupChannelCommand}.
+ */
+export interface CreateGroupChannelCommandOutput extends CreateGroupChannelOutput, __MetadataBearer {
+}
+declare const CreateGroupChannelCommand_base: {
+    new (input: CreateGroupChannelCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGroupChannelCommandInput, CreateGroupChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [CreateGroupChannelCommandInput]): import("@smithy/smithy-client").CommandImpl<CreateGroupChannelCommandInput, CreateGroupChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Creates a new group channel with specified members and members to invite.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StreamServiceClient, CreateGroupChannelCommand } from "@wildix/stream-client"; // ES Modules import
+ * // const { StreamServiceClient, CreateGroupChannelCommand } = require("@wildix/stream-client"); // CommonJS import
+ * const client = new StreamServiceClient(config);
+ * const input = { // CreateGroupChannelInput
+ *   companyId: "STRING_VALUE",
+ *   userId: "STRING_VALUE",
+ *   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,
+ *   channelId: "STRING_VALUE",
+ *   members: [ // UserIdList
+ *     "STRING_VALUE",
+ *   ],
+ *   membersToInvite: [ // UserToInviteList
+ *     { // UserToInvite
+ *       email: "STRING_VALUE",
+ *       phone: "STRING_VALUE",
+ *       name: "STRING_VALUE",
+ *       colleague: true || false,
+ *     },
+ *   ],
+ *   creationEventType: "conversation_created" || "conversation_created_with_name",
+ * };
+ * const command = new CreateGroupChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateGroupChannelOutput
+ * //   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 CreateGroupChannelCommandInput - {@link CreateGroupChannelCommandInput}
+ * @returns {@link CreateGroupChannelCommandOutput}
+ * @see {@link CreateGroupChannelCommandInput} for command's `input` shape.
+ * @see {@link CreateGroupChannelCommandOutput} for command's `response` shape.
+ * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
+ *
+ * @throws {@link ChannelAlreadyExistException} (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 CreateGroupChannelCommand extends CreateGroupChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateGroupChannelInput;
+            output: CreateGroupChannelOutput;
+        };
+        sdk: {
+            input: CreateGroupChannelCommandInput;
+            output: CreateGroupChannelCommandOutput;
+        };
+    };
+}