@wildix/xbees-users-client 1.2.5 → 1.2.6

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

@@ -0,0 +1,86 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { VerifyIdentityInput, VerifyIdentityOutput } 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 VerifyIdentityCommand}.
+ */
+export interface VerifyIdentityCommandInput extends VerifyIdentityInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link VerifyIdentityCommand}.
+ */
+export interface VerifyIdentityCommandOutput extends VerifyIdentityOutput, __MetadataBearer {
+}
+declare const VerifyIdentityCommand_base: {
+    new (input: VerifyIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyIdentityCommandInput, VerifyIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: VerifyIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyIdentityCommandInput, VerifyIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Completes adding an identity by verifying the OTP sent to the new identity. Call after LinkIdentity.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, VerifyIdentityCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, VerifyIdentityCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // VerifyIdentityInput
+ *   accountId: "STRING_VALUE", // required
+ *   identity: "STRING_VALUE", // required
+ *   otp: "STRING_VALUE", // required
+ * };
+ * const command = new VerifyIdentityCommand(input);
+ * const response = await client.send(command);
+ * // { // VerifyIdentityOutput
+ * //   identity: { // Identity
+ * //     identity: "STRING_VALUE", // required
+ * //     account: "STRING_VALUE", // required
+ * //     verified: true || false,
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param VerifyIdentityCommandInput - {@link VerifyIdentityCommandInput}
+ * @returns {@link VerifyIdentityCommandOutput}
+ * @see {@link VerifyIdentityCommandInput} for command's `input` shape.
+ * @see {@link VerifyIdentityCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link AccountNotFoundException} (client fault)
+ *
+ * @throws {@link IdentityNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ *
+ * @public
+ */
+export declare class VerifyIdentityCommand extends VerifyIdentityCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: VerifyIdentityInput;
+            output: VerifyIdentityOutput;
+        };
+        sdk: {
+            input: VerifyIdentityCommandInput;
+            output: VerifyIdentityCommandOutput;
+        };
+    };
+}

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

@@ -1,4 +1,3 @@
-export * from "./AddIdentityCommand";
 export * from "./BatchGetUsersCommand";
 export * from "./BatchGetUsersEmailNotificationsSettingsCommand";
 export * from "./BatchGetUsersPbxLinkDataCommand";
@@ -20,18 +19,19 @@ export * from "./GetUserPbxLinkSuggestionCommand";
 export * from "./GetUserPbxLinkSuggestionV1Command";
 export * from "./IntelligenceSearchCommand";
 export * from "./InviteCommand";
-export * from "./ListAccountIdentitiesCommand";
+export * from "./LinkIdentityCommand";
 export * from "./ListBotApiKeysCommand";
 export * from "./ListBotsCommand";
+export * from "./ListIdentitiesCommand";
 export * from "./ListWorkspacesCommand";
 export * from "./PartialUpdateUserEmailNotificationsSettingsCommand";
 export * from "./QueryColleaguesCommand";
 export * from "./QueryUserCommand";
 export * from "./QueryUsersCommand";
-export * from "./RemoveIdentityCommand";
 export * from "./ToggleTranscriptionEmailNotificationsSubscriptionCommand";
 export * from "./ToggleUnreadEmailNotificationsSubscriptionCommand";
-export * from "./UnbindWorkspaceCommand";
+export * from "./UnlinkIdentityCommand";
+export * from "./UnlinkWorkspaceCommand";
 export * from "./UpdateAccountCommand";
 export * from "./UpdateBotCommand";
 export * from "./UpdateBotCallbackCommand";
@@ -39,6 +39,6 @@ export * from "./UpdateUserEmailNotificationsSettingsCommand";
 export * from "./UpdateWorkspaceCommand";
 export * from "./UploadPictureCommand";
 export * from "./UploadPictureV1Command";
-export * from "./VerifyAddIdentityCommand";
 export * from "./VerifyBotSecretKeyCommand";
 export * from "./VerifyBotSecretKeyV1Command";
+export * from "./VerifyIdentityCommand";

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

@@ -241,6 +241,10 @@ export interface Account {
      * @public
      */
     defaultWorkspace?: string | undefined;
+    /**
+     * The identity value (email address or phone number in E.164).
+     * @public
+     */
     primaryIdentity?: string | undefined;
 }
 /**
@@ -254,106 +258,6 @@ export declare class AccountNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccountNotFoundException, __BaseException>);
 }
-/**
- * @public
- */
-export interface AddIdentityInput {
-    /**
-     * The unique identifier of the account.
-     * @public
-     */
-    accountId: string;
-    /**
-     * The identity value: email address or phone number in E.164.
-     * @public
-     */
-    identity: string;
-}
-/**
- * @public
- */
-export interface Identity {
-    /**
-     * The identity value (email address or phone number in E.164)
-     * @public
-     */
-    identity: string;
-    /**
-     * The unique identifier of the account.
-     * @public
-     */
-    account: string;
-    /**
-     * When the identity was verified.
-     * @public
-     */
-    verified?: boolean | undefined;
-}
-/**
- * @public
- */
-export interface AddIdentityOutput {
-    /**
-     * The identity in pending state. OTP has been sent; call VerifyAddIdentity to complete.
-     * @public
-     */
-    identity: Identity;
-}
-/**
- * @public
- */
-export declare class CannotRemovePrimaryIdentityException extends __BaseException {
-    readonly name: "CannotRemovePrimaryIdentityException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<CannotRemovePrimaryIdentityException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class CannotUnbindDefaultWorkspaceException extends __BaseException {
-    readonly name: "CannotUnbindDefaultWorkspaceException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<CannotUnbindDefaultWorkspaceException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class IdentityAlreadyLinkedException extends __BaseException {
-    readonly name: "IdentityAlreadyLinkedException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<IdentityAlreadyLinkedException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class IdentityNotFoundException extends __BaseException {
-    readonly name: "IdentityNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<IdentityNotFoundException, __BaseException>);
-}
-/**
- * @public
- */
-export declare class WorkspaceNotFoundException extends __BaseException {
-    readonly name: "WorkspaceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<WorkspaceNotFoundException, __BaseException>);
-}
 /**
  * @public
  * @enum
@@ -1235,6 +1139,28 @@ export declare class BotSecretKeyNotValidException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<BotSecretKeyNotValidException, __BaseException>);
 }
+/**
+ * @public
+ */
+export declare class CannotRemovePrimaryIdentityException extends __BaseException {
+    readonly name: "CannotRemovePrimaryIdentityException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CannotRemovePrimaryIdentityException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class CannotUnbindDefaultWorkspaceException extends __BaseException {
+    readonly name: "CannotUnbindDefaultWorkspaceException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CannotUnbindDefaultWorkspaceException, __BaseException>);
+}
 /**
  * @public
  */
@@ -1412,6 +1338,26 @@ export interface GetAccountInput {
      */
     accountId: string;
 }
+/**
+ * @public
+ */
+export interface Identity {
+    /**
+     * The identity value (email address or phone number in E.164)
+     * @public
+     */
+    identity: string;
+    /**
+     * The unique identifier of the account.
+     * @public
+     */
+    account: string;
+    /**
+     * Indicates if the identity is verified.
+     * @public
+     */
+    verified?: boolean | undefined;
+}
 /**
  * @public
  * @enum
@@ -1623,6 +1569,28 @@ export interface GetUserPbxLinkSuggestionV1Output {
      */
     suggestion?: UserPbxLinkSuggestion | undefined;
 }
+/**
+ * @public
+ */
+export declare class IdentityAlreadyLinkedException extends __BaseException {
+    readonly name: "IdentityAlreadyLinkedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IdentityAlreadyLinkedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class IdentityNotFoundException extends __BaseException {
+    readonly name: "IdentityNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IdentityNotFoundException, __BaseException>);
+}
 /**
  * @public
  */
@@ -1673,18 +1641,27 @@ export interface InviteOutput {
 /**
  * @public
  */
-export interface ListAccountIdentitiesInput {
+export interface LinkIdentityInput {
     /**
      * The unique identifier of the account.
      * @public
      */
     accountId: string;
+    /**
+     * The identity value: email address or phone number in E.164.
+     * @public
+     */
+    identity: string;
 }
 /**
  * @public
  */
-export interface ListAccountIdentitiesOutput {
-    identities: (Identity)[];
+export interface LinkIdentityOutput {
+    /**
+     * The identity in pending state. OTP has been sent; call VerifyIdentity to complete.
+     * @public
+     */
+    identity: Identity;
 }
 /**
  * @public
@@ -1711,6 +1688,22 @@ export interface ListBotsInput {
 export interface ListBotsOutput {
     bots: (Bot)[];
 }
+/**
+ * @public
+ */
+export interface ListIdentitiesInput {
+    /**
+     * The unique identifier of the account.
+     * @public
+     */
+    accountId: string;
+}
+/**
+ * @public
+ */
+export interface ListIdentitiesOutput {
+    identities: (Identity)[];
+}
 /**
  * @public
  */
@@ -1926,30 +1919,26 @@ export interface QueryUsersOutput {
 /**
  * @public
  */
-export interface RemoveIdentityInput {
-    /**
-     * The unique identifier of the account.
-     * @public
-     */
-    accountId: string;
+export interface ToggleTranscriptionEmailNotificationsSubscriptionInput {
+    unsubscribeToken: string;
     /**
-     * The identity value (email or phone) to remove.
+     * A flag that indicates whether the system should send email notifications about AI transcription.
      * @public
      */
-    identity: string;
+    subscribe: boolean;
 }
 /**
  * @public
  */
-export interface RemoveIdentityOutput {
+export interface ToggleTranscriptionEmailNotificationsSubscriptionOutput {
 }
 /**
  * @public
  */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionInput {
+export interface ToggleUnreadEmailNotificationsSubscriptionInput {
     unsubscribeToken: string;
     /**
-     * A flag that indicates whether the system should send email notifications about AI transcription.
+     * A flag that indicates whether the system should send email notifications about unread messages.
      * @public
      */
     subscribe: boolean;
@@ -1957,28 +1946,32 @@ export interface ToggleTranscriptionEmailNotificationsSubscriptionInput {
 /**
  * @public
  */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionOutput {
+export interface ToggleUnreadEmailNotificationsSubscriptionOutput {
 }
 /**
  * @public
  */
-export interface ToggleUnreadEmailNotificationsSubscriptionInput {
-    unsubscribeToken: string;
+export interface UnlinkIdentityInput {
     /**
-     * A flag that indicates whether the system should send email notifications about unread messages.
+     * The unique identifier of the account.
      * @public
      */
-    subscribe: boolean;
+    accountId: string;
+    /**
+     * The identity value (email or phone) to remove.
+     * @public
+     */
+    identity: string;
 }
 /**
  * @public
  */
-export interface ToggleUnreadEmailNotificationsSubscriptionOutput {
+export interface UnlinkIdentityOutput {
 }
 /**
  * @public
  */
-export interface UnbindWorkspaceInput {
+export interface UnlinkWorkspaceInput {
     /**
      * The unique identifier of the workspace (Stream user ID).
      * @public
@@ -1993,7 +1986,18 @@ export interface UnbindWorkspaceInput {
 /**
  * @public
  */
-export interface UnbindWorkspaceOutput {
+export interface UnlinkWorkspaceOutput {
+}
+/**
+ * @public
+ */
+export declare class WorkspaceNotFoundException extends __BaseException {
+    readonly name: "WorkspaceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<WorkspaceNotFoundException, __BaseException>);
 }
 /**
  * @public
@@ -2158,37 +2162,6 @@ export interface UploadPictureV1Input {
 export interface UploadPictureV1Output {
     url: string;
 }
-/**
- * @public
- */
-export interface VerifyAddIdentityInput {
-    /**
-     * The unique identifier of the account.
-     * @public
-     */
-    accountId: string;
-    /**
-     * The identity value that was added (email or phone).
-     * @public
-     */
-    identity: string;
-    /**
-     * OTP sent to the new identity to prove ownership.
-     * @public
-     */
-    otp: string;
-    /**
-     * OTP sent to the primary identity for verification.
-     * @public
-     */
-    primaryOtp: string;
-}
-/**
- * @public
- */
-export interface VerifyAddIdentityOutput {
-    identity: Identity;
-}
 /**
  * @public
  */
@@ -2233,3 +2206,29 @@ export interface VerifyBotSecretKeyV1Output {
     id: string;
     name?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface VerifyIdentityInput {
+    /**
+     * The unique identifier of the account.
+     * @public
+     */
+    accountId: string;
+    /**
+     * The identity value that was added (email or phone).
+     * @public
+     */
+    identity: string;
+    /**
+     * OTP sent to the new identity to prove ownership.
+     * @public
+     */
+    otp: string;
+}
+/**
+ * @public
+ */
+export interface VerifyIdentityOutput {
+    identity: Identity;
+}