@wildix/xbees-conversations-client 1.1.14 → 1.1.16

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

@@ -0,0 +1,81 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { GetSmsChannelIdInput, GetSmsChannelIdOutput } 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 GetSmsChannelIdCommand}.
+ */
+export interface GetSmsChannelIdCommandInput extends GetSmsChannelIdInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSmsChannelIdCommand}.
+ */
+export interface GetSmsChannelIdCommandOutput extends GetSmsChannelIdOutput, __MetadataBearer {
+}
+declare const GetSmsChannelIdCommand_base: {
+    new (input: GetSmsChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetSmsChannelIdCommandInput, GetSmsChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetSmsChannelIdCommandInput]): import("@smithy/smithy-client").CommandImpl<GetSmsChannelIdCommandInput, GetSmsChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Gets the channel ID of an existing or non-existing SMS channel between the specified user and another member.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, GetSmsChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, GetSmsChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // GetSmsChannelIdInput
+ *   userId: "STRING_VALUE",
+ *   serviceUri: "STRING_VALUE",
+ *   recipientId: "STRING_VALUE",
+ *   recipientNumber: "STRING_VALUE",
+ * };
+ * const command = new GetSmsChannelIdCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSmsChannelIdOutput
+ * //   channelId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetSmsChannelIdCommandInput - {@link GetSmsChannelIdCommandInput}
+ * @returns {@link GetSmsChannelIdCommandOutput}
+ * @see {@link GetSmsChannelIdCommandInput} for command's `input` shape.
+ * @see {@link GetSmsChannelIdCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (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 GetSmsChannelIdCommand extends GetSmsChannelIdCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSmsChannelIdInput;
+            output: GetSmsChannelIdOutput;
+        };
+        sdk: {
+            input: GetSmsChannelIdCommandInput;
+            output: GetSmsChannelIdCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,81 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { GetTelephonyChannelIdInput, GetTelephonyChannelIdOutput } 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 GetTelephonyChannelIdCommand}.
+ */
+export interface GetTelephonyChannelIdCommandInput extends GetTelephonyChannelIdInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetTelephonyChannelIdCommand}.
+ */
+export interface GetTelephonyChannelIdCommandOutput extends GetTelephonyChannelIdOutput, __MetadataBearer {
+}
+declare const GetTelephonyChannelIdCommand_base: {
+    new (input: GetTelephonyChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetTelephonyChannelIdCommandInput, GetTelephonyChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetTelephonyChannelIdCommandInput]): import("@smithy/smithy-client").CommandImpl<GetTelephonyChannelIdCommandInput, GetTelephonyChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Gets the channel ID of an existing or non-existing telephony channel between the specified user and another member.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, GetTelephonyChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, GetTelephonyChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // GetTelephonyChannelIdInput
+ *   userId: "STRING_VALUE",
+ *   serviceUri: "STRING_VALUE",
+ *   recipientId: "STRING_VALUE",
+ *   recipientNumber: "STRING_VALUE",
+ * };
+ * const command = new GetTelephonyChannelIdCommand(input);
+ * const response = await client.send(command);
+ * // { // GetTelephonyChannelIdOutput
+ * //   channelId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetTelephonyChannelIdCommandInput - {@link GetTelephonyChannelIdCommandInput}
+ * @returns {@link GetTelephonyChannelIdCommandOutput}
+ * @see {@link GetTelephonyChannelIdCommandInput} for command's `input` shape.
+ * @see {@link GetTelephonyChannelIdCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (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 GetTelephonyChannelIdCommand extends GetTelephonyChannelIdCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetTelephonyChannelIdInput;
+            output: GetTelephonyChannelIdOutput;
+        };
+        sdk: {
+            input: GetTelephonyChannelIdCommandInput;
+            output: GetTelephonyChannelIdCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,81 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { GetWhatsAppChannelIdInput, GetWhatsAppChannelIdOutput } 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 GetWhatsAppChannelIdCommand}.
+ */
+export interface GetWhatsAppChannelIdCommandInput extends GetWhatsAppChannelIdInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetWhatsAppChannelIdCommand}.
+ */
+export interface GetWhatsAppChannelIdCommandOutput extends GetWhatsAppChannelIdOutput, __MetadataBearer {
+}
+declare const GetWhatsAppChannelIdCommand_base: {
+    new (input: GetWhatsAppChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetWhatsAppChannelIdCommandInput, GetWhatsAppChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetWhatsAppChannelIdCommandInput]): import("@smithy/smithy-client").CommandImpl<GetWhatsAppChannelIdCommandInput, GetWhatsAppChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Gets the channel ID of an existing or non-existing WhatsApp channel between the specified user and another member.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, GetWhatsAppChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, GetWhatsAppChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // GetWhatsAppChannelIdInput
+ *   userId: "STRING_VALUE",
+ *   serviceUri: "STRING_VALUE",
+ *   recipientId: "STRING_VALUE",
+ *   recipientNumber: "STRING_VALUE",
+ * };
+ * const command = new GetWhatsAppChannelIdCommand(input);
+ * const response = await client.send(command);
+ * // { // GetWhatsAppChannelIdOutput
+ * //   channelId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetWhatsAppChannelIdCommandInput - {@link GetWhatsAppChannelIdCommandInput}
+ * @returns {@link GetWhatsAppChannelIdCommandOutput}
+ * @see {@link GetWhatsAppChannelIdCommandInput} for command's `input` shape.
+ * @see {@link GetWhatsAppChannelIdCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (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 GetWhatsAppChannelIdCommand extends GetWhatsAppChannelIdCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetWhatsAppChannelIdInput;
+            output: GetWhatsAppChannelIdOutput;
+        };
+        sdk: {
+            input: GetWhatsAppChannelIdCommandInput;
+            output: GetWhatsAppChannelIdCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,103 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { ListChannelMembersReadStatusInput, ListChannelMembersReadStatusOutput } 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 ListChannelMembersReadStatusCommand}.
+ */
+export interface ListChannelMembersReadStatusCommandInput extends ListChannelMembersReadStatusInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListChannelMembersReadStatusCommand}.
+ */
+export interface ListChannelMembersReadStatusCommandOutput extends ListChannelMembersReadStatusOutput, __MetadataBearer {
+}
+declare const ListChannelMembersReadStatusCommand_base: {
+    new (input: ListChannelMembersReadStatusCommandInput): import("@smithy/smithy-client").CommandImpl<ListChannelMembersReadStatusCommandInput, ListChannelMembersReadStatusCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListChannelMembersReadStatusCommandInput): import("@smithy/smithy-client").CommandImpl<ListChannelMembersReadStatusCommandInput, ListChannelMembersReadStatusCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a list of members read status for a specific channel. Read status does not work for conversations with more than 100 members.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, ListChannelMembersReadStatusCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, ListChannelMembersReadStatusCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // ListChannelMembersReadStatusInput
+ *   channelId: "STRING_VALUE", // required
+ * };
+ * const command = new ListChannelMembersReadStatusCommand(input);
+ * const response = await client.send(command);
+ * // { // ListChannelMembersReadStatusOutput
+ * //   members: [ // ChannelMembersReadStatusList // required
+ * //     { // ChannelMemberReadStatus
+ * //       user: { // User
+ * //         id: "STRING_VALUE", // required
+ * //         name: "STRING_VALUE",
+ * //         email: "STRING_VALUE",
+ * //         phone: "STRING_VALUE",
+ * //         picture: "STRING_VALUE",
+ * //         locale: "STRING_VALUE",
+ * //         timeZone: "STRING_VALUE",
+ * //         company: "STRING_VALUE",
+ * //         bot: true || false,
+ * //         pbxDomain: "STRING_VALUE",
+ * //         pbxPort: "STRING_VALUE",
+ * //         pbxExtension: "STRING_VALUE",
+ * //         pbxSerial: "STRING_VALUE",
+ * //         pbxUserId: "STRING_VALUE",
+ * //         createdAt: "STRING_VALUE",
+ * //         updatedAt: "STRING_VALUE",
+ * //       },
+ * //       lastRead: "STRING_VALUE",
+ * //       lastReadMessageId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListChannelMembersReadStatusCommandInput - {@link ListChannelMembersReadStatusCommandInput}
+ * @returns {@link ListChannelMembersReadStatusCommandOutput}
+ * @see {@link ListChannelMembersReadStatusCommandInput} for command's `input` shape.
+ * @see {@link ListChannelMembersReadStatusCommandOutput} 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 ListChannelMembersReadStatusCommand extends ListChannelMembersReadStatusCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListChannelMembersReadStatusInput;
+            output: ListChannelMembersReadStatusOutput;
+        };
+        sdk: {
+            input: ListChannelMembersReadStatusCommandInput;
+            output: ListChannelMembersReadStatusCommandOutput;
+        };
+    };
+}