@wildix/xbees-users-client 1.0.24 → 1.0.25

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,6 +11,7 @@ export * from "./GetBotCallbackCommand";
 export * from "./GetUserCommand";
 export * from "./GetUserPbxLinkDataCommand";
 export * from "./GetUserPbxLinkSuggestionCommand";
+export * from "./GetUserPbxLinkSuggestionV1Command";
 export * from "./ListBotApiKeysCommand";
 export * from "./ListBotsCommand";
 export * from "./QueryUserCommand";
@@ -17,4 +19,6 @@ 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
  */
@@ -671,7 +683,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 +730,26 @@ 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
  */
@@ -895,6 +931,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 +969,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;
+}

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,5 +1,6 @@
 import { BatchGetUsersCommandInput, BatchGetUsersCommandOutput } from "../commands/BatchGetUsersCommand";
 import { BatchGetUsersPbxLinkDataCommandInput, BatchGetUsersPbxLinkDataCommandOutput } from "../commands/BatchGetUsersPbxLinkDataCommand";
+import { BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1CommandOutput } from "../commands/BatchGetUsersPbxLinkDataV1Command";
 import { ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput } from "../commands/ChangeUserEmailCommand";
 import { CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput } from "../commands/CreateBotApiKeyCommand";
 import { CreateBotCommandInput, CreateBotCommandOutput } from "../commands/CreateBotCommand";
@@ -10,6 +11,7 @@ import { GetBotCommandInput, GetBotCommandOutput } from "../commands/GetBotComma
 import { GetUserCommandInput, GetUserCommandOutput } from "../commands/GetUserCommand";
 import { GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput } from "../commands/GetUserPbxLinkDataCommand";
 import { GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionCommandOutput } from "../commands/GetUserPbxLinkSuggestionCommand";
+import { GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput } from "../commands/GetUserPbxLinkSuggestionV1Command";
 import { ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput } from "../commands/ListBotApiKeysCommand";
 import { ListBotsCommandInput, ListBotsCommandOutput } from "../commands/ListBotsCommand";
 import { QueryUserCommandInput, QueryUserCommandOutput } from "../commands/QueryUserCommand";
@@ -17,7 +19,9 @@ import { QueryUsersCommandInput, QueryUsersCommandOutput } from "../commands/Que
 import { UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput } from "../commands/UpdateBotCallbackCommand";
 import { UpdateBotCommandInput, UpdateBotCommandOutput } from "../commands/UpdateBotCommand";
 import { UploadPictureCommandInput, UploadPictureCommandOutput } from "../commands/UploadPictureCommand";
+import { UploadPictureV1CommandInput, UploadPictureV1CommandOutput } from "../commands/UploadPictureV1Command";
 import { VerifyBotSecretKeyCommandInput, VerifyBotSecretKeyCommandOutput } from "../commands/VerifyBotSecretKeyCommand";
+import { VerifyBotSecretKeyV1CommandInput, VerifyBotSecretKeyV1CommandOutput } from "../commands/VerifyBotSecretKeyV1Command";
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 /**
@@ -28,6 +32,10 @@ export declare const se_BatchGetUsersCommand: (input: BatchGetUsersCommandInput,
  * serializeAws_restJson1BatchGetUsersPbxLinkDataCommand
  */
 export declare const se_BatchGetUsersPbxLinkDataCommand: (input: BatchGetUsersPbxLinkDataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1BatchGetUsersPbxLinkDataV1Command
+ */
+export declare const se_BatchGetUsersPbxLinkDataV1Command: (input: BatchGetUsersPbxLinkDataV1CommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ChangeUserEmailCommand
  */
@@ -68,6 +76,10 @@ export declare const se_GetUserPbxLinkDataCommand: (input: GetUserPbxLinkDataCom
  * serializeAws_restJson1GetUserPbxLinkSuggestionCommand
  */
 export declare const se_GetUserPbxLinkSuggestionCommand: (input: GetUserPbxLinkSuggestionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetUserPbxLinkSuggestionV1Command
+ */
+export declare const se_GetUserPbxLinkSuggestionV1Command: (input: GetUserPbxLinkSuggestionV1CommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ListBotApiKeysCommand
  */
@@ -96,10 +108,18 @@ export declare const se_UpdateBotCallbackCommand: (input: UpdateBotCallbackComma
  * serializeAws_restJson1UploadPictureCommand
  */
 export declare const se_UploadPictureCommand: (input: UploadPictureCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1UploadPictureV1Command
+ */
+export declare const se_UploadPictureV1Command: (input: UploadPictureV1CommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1VerifyBotSecretKeyCommand
  */
 export declare const se_VerifyBotSecretKeyCommand: (input: VerifyBotSecretKeyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1VerifyBotSecretKeyV1Command
+ */
+export declare const se_VerifyBotSecretKeyV1Command: (input: VerifyBotSecretKeyV1CommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * deserializeAws_restJson1BatchGetUsersCommand
  */
@@ -108,6 +128,10 @@ export declare const de_BatchGetUsersCommand: (output: __HttpResponse, context:
  * deserializeAws_restJson1BatchGetUsersPbxLinkDataCommand
  */
 export declare const de_BatchGetUsersPbxLinkDataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchGetUsersPbxLinkDataCommandOutput>;
+/**
+ * deserializeAws_restJson1BatchGetUsersPbxLinkDataV1Command
+ */
+export declare const de_BatchGetUsersPbxLinkDataV1Command: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchGetUsersPbxLinkDataV1CommandOutput>;
 /**
  * deserializeAws_restJson1ChangeUserEmailCommand
  */
@@ -148,6 +172,10 @@ export declare const de_GetUserPbxLinkDataCommand: (output: __HttpResponse, cont
  * deserializeAws_restJson1GetUserPbxLinkSuggestionCommand
  */
 export declare const de_GetUserPbxLinkSuggestionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetUserPbxLinkSuggestionCommandOutput>;
+/**
+ * deserializeAws_restJson1GetUserPbxLinkSuggestionV1Command
+ */
+export declare const de_GetUserPbxLinkSuggestionV1Command: (output: __HttpResponse, context: __SerdeContext) => Promise<GetUserPbxLinkSuggestionV1CommandOutput>;
 /**
  * deserializeAws_restJson1ListBotApiKeysCommand
  */
@@ -176,7 +204,15 @@ export declare const de_UpdateBotCallbackCommand: (output: __HttpResponse, conte
  * deserializeAws_restJson1UploadPictureCommand
  */
 export declare const de_UploadPictureCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UploadPictureCommandOutput>;
+/**
+ * deserializeAws_restJson1UploadPictureV1Command
+ */
+export declare const de_UploadPictureV1Command: (output: __HttpResponse, context: __SerdeContext) => Promise<UploadPictureV1CommandOutput>;
 /**
  * deserializeAws_restJson1VerifyBotSecretKeyCommand
  */
 export declare const de_VerifyBotSecretKeyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<VerifyBotSecretKeyCommandOutput>;
+/**
+ * deserializeAws_restJson1VerifyBotSecretKeyV1Command
+ */
+export declare const de_VerifyBotSecretKeyV1Command: (output: __HttpResponse, context: __SerdeContext) => Promise<VerifyBotSecretKeyV1CommandOutput>;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/xbees-users-client",
     "description": "@wildix/xbees-users-client client",
-    "version": "1.0.24",
+    "version": "1.0.25",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",