@wildix/xbees-users-client 1.0.24 → 1.0.26

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

@@ -36,7 +36,7 @@ declare const GetUserPbxLinkDataCommand_base: {
  * // const { UsersClient, GetUserPbxLinkDataCommand } = require("@wildix/xbees-users-client"); // CommonJS import
  * const client = new UsersClient(config);
  * const input = { // GetUserPbxLinkDataInput
- *   id: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE", // required
  * };
  * const command = new GetUserPbxLinkDataCommand(input);
  * const response = await client.send(command);

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

@@ -0,0 +1,67 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { GetUserPbxLinkSuggestionV1Input, GetUserPbxLinkSuggestionV1Output } 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 GetUserPbxLinkSuggestionV1Command}.
+ */
+export interface GetUserPbxLinkSuggestionV1CommandInput extends GetUserPbxLinkSuggestionV1Input {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetUserPbxLinkSuggestionV1Command}.
+ */
+export interface GetUserPbxLinkSuggestionV1CommandOutput extends GetUserPbxLinkSuggestionV1Output, __MetadataBearer {
+}
+declare const GetUserPbxLinkSuggestionV1Command_base: {
+    new (input: GetUserPbxLinkSuggestionV1CommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetUserPbxLinkSuggestionV1CommandInput]): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, GetUserPbxLinkSuggestionV1Command } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, GetUserPbxLinkSuggestionV1Command } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // GetUserPbxLinkSuggestionV1Input
+ *   email: "STRING_VALUE",
+ * };
+ * const command = new GetUserPbxLinkSuggestionV1Command(input);
+ * const response = await client.send(command);
+ * // { // GetUserPbxLinkSuggestionV1Output
+ * //   suggestion: { // UserPbxLinkSuggestion
+ * //     domain: "STRING_VALUE", // required
+ * //     port: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetUserPbxLinkSuggestionV1CommandInput - {@link GetUserPbxLinkSuggestionV1CommandInput}
+ * @returns {@link GetUserPbxLinkSuggestionV1CommandOutput}
+ * @see {@link GetUserPbxLinkSuggestionV1CommandInput} for command's `input` shape.
+ * @see {@link GetUserPbxLinkSuggestionV1CommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class GetUserPbxLinkSuggestionV1Command extends GetUserPbxLinkSuggestionV1Command_base {
+}

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

@@ -0,0 +1,69 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { GetUserSettingsInput, GetUserSettingsOutput } 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 GetUserSettingsCommand}.
+ */
+export interface GetUserSettingsCommandInput extends GetUserSettingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetUserSettingsCommand}.
+ */
+export interface GetUserSettingsCommandOutput extends GetUserSettingsOutput, __MetadataBearer {
+}
+declare const GetUserSettingsCommand_base: {
+    new (input: GetUserSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserSettingsCommandInput, GetUserSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetUserSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserSettingsCommandInput, GetUserSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Getting settings for the user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, GetUserSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, GetUserSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // GetUserSettingsInput
+ *   userId: "STRING_VALUE", // required
+ * };
+ * const command = new GetUserSettingsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetUserSettingsOutput
+ * //   emailNotifications: { // EmailNotificationsSettings
+ * //     unread: true || false, // required
+ * //     transcription: true || false, // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetUserSettingsCommandInput - {@link GetUserSettingsCommandInput}
+ * @returns {@link GetUserSettingsCommandOutput}
+ * @see {@link GetUserSettingsCommandInput} for command's `input` shape.
+ * @see {@link GetUserSettingsCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link UserNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ * @public
+ */
+export declare class GetUserSettingsCommand extends GetUserSettingsCommand_base {
+}

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

@@ -0,0 +1,76 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { PartialUpdateUserSettingsInput, PartialUpdateUserSettingsOutput } 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 PartialUpdateUserSettingsCommand}.
+ */
+export interface PartialUpdateUserSettingsCommandInput extends PartialUpdateUserSettingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PartialUpdateUserSettingsCommand}.
+ */
+export interface PartialUpdateUserSettingsCommandOutput extends PartialUpdateUserSettingsOutput, __MetadataBearer {
+}
+declare const PartialUpdateUserSettingsCommand_base: {
+    new (input: PartialUpdateUserSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserSettingsCommandInput, PartialUpdateUserSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PartialUpdateUserSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserSettingsCommandInput, PartialUpdateUserSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Getting settings for the user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, PartialUpdateUserSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, PartialUpdateUserSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // PartialUpdateUserSettingsInput
+ *   userId: "STRING_VALUE",
+ *   token: "STRING_VALUE",
+ *   settings: { // PartialUserSettings
+ *     emailNotifications: { // PartialEmailNotificationsSettings
+ *       unread: true || false,
+ *       transcription: true || false,
+ *     },
+ *   },
+ * };
+ * const command = new PartialUpdateUserSettingsCommand(input);
+ * const response = await client.send(command);
+ * // { // PartialUpdateUserSettingsOutput
+ * //   emailNotifications: { // EmailNotificationsSettings
+ * //     unread: true || false, // required
+ * //     transcription: true || false, // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PartialUpdateUserSettingsCommandInput - {@link PartialUpdateUserSettingsCommandInput}
+ * @returns {@link PartialUpdateUserSettingsCommandOutput}
+ * @see {@link PartialUpdateUserSettingsCommandInput} for command's `input` shape.
+ * @see {@link PartialUpdateUserSettingsCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link UserNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ * @public
+ */
+export declare class PartialUpdateUserSettingsCommand extends PartialUpdateUserSettingsCommand_base {
+}

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

@@ -0,0 +1,64 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { UploadPictureV1Input, UploadPictureV1Output } 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 UploadPictureV1Command}.
+ */
+export interface UploadPictureV1CommandInput extends UploadPictureV1Input {
+}
+/**
+ * @public
+ *
+ * The output of {@link UploadPictureV1Command}.
+ */
+export interface UploadPictureV1CommandOutput extends UploadPictureV1Output, __MetadataBearer {
+}
+declare const UploadPictureV1Command_base: {
+    new (input: UploadPictureV1CommandInput): import("@smithy/smithy-client").CommandImpl<UploadPictureV1CommandInput, UploadPictureV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UploadPictureV1CommandInput): import("@smithy/smithy-client").CommandImpl<UploadPictureV1CommandInput, UploadPictureV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, UploadPictureV1Command } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, UploadPictureV1Command } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // UploadPictureV1Input
+ *   picture: "STRING_VALUE", // required
+ * };
+ * const command = new UploadPictureV1Command(input);
+ * const response = await client.send(command);
+ * // { // UploadPictureV1Output
+ * //   url: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UploadPictureV1CommandInput - {@link UploadPictureV1CommandInput}
+ * @returns {@link UploadPictureV1CommandOutput}
+ * @see {@link UploadPictureV1CommandInput} for command's `input` shape.
+ * @see {@link UploadPictureV1CommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class UploadPictureV1Command extends UploadPictureV1Command_base {
+}

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

@@ -0,0 +1,68 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { VerifyBotSecretKeyV1Input, VerifyBotSecretKeyV1Output } 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 VerifyBotSecretKeyV1Command}.
+ */
+export interface VerifyBotSecretKeyV1CommandInput extends VerifyBotSecretKeyV1Input {
+}
+/**
+ * @public
+ *
+ * The output of {@link VerifyBotSecretKeyV1Command}.
+ */
+export interface VerifyBotSecretKeyV1CommandOutput extends VerifyBotSecretKeyV1Output, __MetadataBearer {
+}
+declare const VerifyBotSecretKeyV1Command_base: {
+    new (input: VerifyBotSecretKeyV1CommandInput): import("@smithy/smithy-client").CommandImpl<VerifyBotSecretKeyV1CommandInput, VerifyBotSecretKeyV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: VerifyBotSecretKeyV1CommandInput): import("@smithy/smithy-client").CommandImpl<VerifyBotSecretKeyV1CommandInput, VerifyBotSecretKeyV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, VerifyBotSecretKeyV1Command } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, VerifyBotSecretKeyV1Command } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // VerifyBotSecretKeyV1Input
+ *   secret: "STRING_VALUE", // required
+ * };
+ * const command = new VerifyBotSecretKeyV1Command(input);
+ * const response = await client.send(command);
+ * // { // VerifyBotSecretKeyV1Output
+ * //   company: "STRING_VALUE", // required
+ * //   id: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param VerifyBotSecretKeyV1CommandInput - {@link VerifyBotSecretKeyV1CommandInput}
+ * @returns {@link VerifyBotSecretKeyV1CommandOutput}
+ * @see {@link VerifyBotSecretKeyV1CommandInput} for command's `input` shape.
+ * @see {@link VerifyBotSecretKeyV1CommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link BotSecretKeyNotValidException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class VerifyBotSecretKeyV1Command extends VerifyBotSecretKeyV1Command_base {
+}

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

@@ -1,5 +1,6 @@
 export * from "./BatchGetUsersCommand";
 export * from "./BatchGetUsersPbxLinkDataCommand";
+export * from "./BatchGetUsersPbxLinkDataV1Command";
 export * from "./ChangeUserEmailCommand";
 export * from "./CreateBotCommand";
 export * from "./CreateBotApiKeyCommand";
@@ -10,11 +11,16 @@ export * from "./GetBotCallbackCommand";
 export * from "./GetUserCommand";
 export * from "./GetUserPbxLinkDataCommand";
 export * from "./GetUserPbxLinkSuggestionCommand";
+export * from "./GetUserPbxLinkSuggestionV1Command";
+export * from "./GetUserSettingsCommand";
 export * from "./ListBotApiKeysCommand";
 export * from "./ListBotsCommand";
+export * from "./PartialUpdateUserSettingsCommand";
 export * from "./QueryUserCommand";
 export * from "./QueryUsersCommand";
 export * from "./UpdateBotCommand";
 export * from "./UpdateBotCallbackCommand";
 export * from "./UploadPictureCommand";
+export * from "./UploadPictureV1Command";
 export * from "./VerifyBotSecretKeyCommand";
+export * from "./VerifyBotSecretKeyV1Command";

package/dist-types/models/models_0.d.ts

@@ -386,6 +386,18 @@ export interface UserPbxLinkData {
 export interface BatchGetUsersPbxLinkDataOutput {
     users: (UserPbxLinkData)[];
 }
+/**
+ * @public
+ */
+export interface BatchGetUsersPbxLinkDataV1Input {
+    id: (string)[];
+}
+/**
+ * @public
+ */
+export interface BatchGetUsersPbxLinkDataV1Output {
+    users: (UserPbxLinkData)[];
+}
 /**
  * @public
  */
@@ -625,6 +637,21 @@ export interface DeleteBotApiKeyInput {
  */
 export interface DeleteBotApiKeyOutput {
 }
+/**
+ * @public
+ */
+export interface EmailNotificationsSettings {
+    /**
+     * Indicates whether the user wants to receive email notifications about unread messages.
+     * @public
+     */
+    unread: boolean;
+    /**
+     * Indicates whether the user wants to receive email notifications about AI transcription.
+     * @public
+     */
+    transcription: boolean;
+}
 /**
  * @public
  */
@@ -671,7 +698,11 @@ export interface GetUserOutput {
  * @public
  */
 export interface GetUserPbxLinkDataInput {
-    id: string;
+    /**
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
+     * @public
+     */
+    userId: string;
 }
 /**
  * @public
@@ -714,6 +745,46 @@ export interface GetUserPbxLinkSuggestionOutput {
      */
     suggestion?: UserPbxLinkSuggestion;
 }
+/**
+ * @public
+ */
+export interface GetUserPbxLinkSuggestionV1Input {
+    /**
+     * An email address of the user when a service token is used. If not provided, the email will be taken from the token.
+     * @public
+     */
+    email?: string;
+}
+/**
+ * @public
+ */
+export interface GetUserPbxLinkSuggestionV1Output {
+    /**
+     * If the PBX data link information is available, the user can attempt to connect using the provided PBX domain and port. Can be empty if no information found for the specified email.
+     * @public
+     */
+    suggestion?: UserPbxLinkSuggestion;
+}
+/**
+ * @public
+ */
+export interface GetUserSettingsInput {
+    /**
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
+     * @public
+     */
+    userId: string;
+}
+/**
+ * @public
+ */
+export interface GetUserSettingsOutput {
+    /**
+     * Indicates whether the user wants to receive email notifications.
+     * @public
+     */
+    emailNotifications?: EmailNotificationsSettings;
+}
 /**
  * @public
  */
@@ -739,6 +810,53 @@ export interface ListBotsInput {
 export interface ListBotsOutput {
     bots: (Bot)[];
 }
+/**
+ * @public
+ */
+export interface PartialEmailNotificationsSettings {
+    /**
+     * Indicates whether the user wants to receive email notifications about unread messages.
+     * @public
+     */
+    unread?: boolean;
+    /**
+     * Indicates whether the user wants to receive email notifications about AI transcription.
+     * @public
+     */
+    transcription?: boolean;
+}
+/**
+ * @public
+ */
+export interface PartialUserSettings {
+    /**
+     * Indicates whether the user wants to receive email notifications.
+     * @public
+     */
+    emailNotifications?: PartialEmailNotificationsSettings;
+}
+/**
+ * @public
+ */
+export interface PartialUpdateUserSettingsInput {
+    /**
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
+     * @public
+     */
+    userId?: string;
+    /**
+     * Email unsubscribe token.
+     * @public
+     */
+    token?: string;
+    settings: PartialUserSettings;
+}
+/**
+ * @public
+ */
+export interface PartialUpdateUserSettingsOutput {
+    emailNotifications?: EmailNotificationsSettings;
+}
 /**
  * @public
  */
@@ -895,6 +1013,22 @@ export interface UploadPictureInput {
 export interface UploadPictureOutput {
     url: string;
 }
+/**
+ * @public
+ */
+export interface UploadPictureV1Input {
+    /**
+     * A base64 encoded image file in PNG or JPG format, with dimensions of 140 x 140 pixels.
+     * @public
+     */
+    picture: string;
+}
+/**
+ * @public
+ */
+export interface UploadPictureV1Output {
+    url: string;
+}
 /**
  * @public
  */
@@ -917,3 +1051,25 @@ export interface VerifyBotSecretKeyOutput {
     id: string;
     name?: string;
 }
+/**
+ * @public
+ */
+export interface VerifyBotSecretKeyV1Input {
+    /**
+     * A secret key string with "sk-"
+     * @public
+     */
+    secret: string;
+}
+/**
+ * @public
+ */
+export interface VerifyBotSecretKeyV1Output {
+    company: string;
+    /**
+     * A unique ID for the Bot that corresponds to the bot's x-bees user ID.
+     * @public
+     */
+    id: string;
+    name?: string;
+}