onehook-api-client 1.0.10 → 1.0.12

package/README.md

@@ -248,6 +248,13 @@ GenerateInvite
 </details>
 <details>
 <summary>
+GetCredentialReadiness
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/onehook/command/GetCredentialReadinessCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-onehook/Interface/GetCredentialReadinessCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-onehook/Interface/GetCredentialReadinessCommandOutput/)
+</details>
+<details>
+<summary>
 GetUser
 </summary>
 

package/dist-cjs/OneHook.js

@@ -12,6 +12,7 @@ const DiscoverCommand_1 = require("./commands/DiscoverCommand");
 const GenerateDownloadUrlCommand_1 = require("./commands/GenerateDownloadUrlCommand");
 const GenerateInviteCommand_1 = require("./commands/GenerateInviteCommand");
 const GenerateUploadUrlCommand_1 = require("./commands/GenerateUploadUrlCommand");
+const GetCredentialReadinessCommand_1 = require("./commands/GetCredentialReadinessCommand");
 const GetLivenessStatusCommand_1 = require("./commands/GetLivenessStatusCommand");
 const GetMatchCommand_1 = require("./commands/GetMatchCommand");
 const GetMyProfileCommand_1 = require("./commands/GetMyProfileCommand");
@@ -52,6 +53,7 @@ const commands = {
     RevokeDeviceCommand: RevokeDeviceCommand_1.RevokeDeviceCommand,
     AuthSocialCommand: AuthSocialCommand_1.AuthSocialCommand,
     GenerateInviteCommand: GenerateInviteCommand_1.GenerateInviteCommand,
+    GetCredentialReadinessCommand: GetCredentialReadinessCommand_1.GetCredentialReadinessCommand,
     GetUserCommand: GetUserCommand_1.GetUserCommand,
     GetUserByEmailCommand: GetUserByEmailCommand_1.GetUserByEmailCommand,
     LinkEmailCommand: LinkEmailCommand_1.LinkEmailCommand,

package/dist-cjs/commands/GetCredentialReadinessCommand.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetCredentialReadinessCommand = exports.$Command = void 0;
+const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
+const middleware_serde_1 = require("@smithy/middleware-serde");
+const smithy_client_1 = require("@smithy/smithy-client");
+Object.defineProperty(exports, "$Command", { enumerable: true, get: function () { return smithy_client_1.Command; } });
+class GetCredentialReadinessCommand extends smithy_client_1.Command.classBuilder()
+    .m(function (Command, cs, config, o) {
+    return [
+        (0, middleware_serde_1.getSerdePlugin)(config, this.serialize, this.deserialize),
+    ];
+})
+    .s("OneHookService", "GetCredentialReadiness", {})
+    .n("OneHookClient", "GetCredentialReadinessCommand")
+    .f(void 0, void 0)
+    .ser(Aws_restJson1_1.se_GetCredentialReadinessCommand)
+    .de(Aws_restJson1_1.de_GetCredentialReadinessCommand)
+    .build() {
+}
+exports.GetCredentialReadinessCommand = GetCredentialReadinessCommand;

package/dist-cjs/commands/index.js

@@ -8,6 +8,7 @@ tslib_1.__exportStar(require("./RegisterDeviceCommand"), exports);
 tslib_1.__exportStar(require("./RevokeDeviceCommand"), exports);
 tslib_1.__exportStar(require("./AuthSocialCommand"), exports);
 tslib_1.__exportStar(require("./GenerateInviteCommand"), exports);
+tslib_1.__exportStar(require("./GetCredentialReadinessCommand"), exports);
 tslib_1.__exportStar(require("./GetUserCommand"), exports);
 tslib_1.__exportStar(require("./GetUserByEmailCommand"), exports);
 tslib_1.__exportStar(require("./LinkEmailCommand"), exports);

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeviceLimitError = exports.NotFoundError = exports.Platform = exports.InternalServerError = exports.BadRequestError = exports.ForbiddenError = void 0;
+exports.CredentialGap = exports.DeviceLimitError = exports.NotFoundError = exports.Platform = exports.InternalServerError = exports.BadRequestError = exports.ForbiddenError = void 0;
 const OneHookServiceException_1 = require("./OneHookServiceException");
 class ForbiddenError extends OneHookServiceException_1.OneHookServiceException {
     name = "ForbiddenError";
@@ -82,3 +82,9 @@ class DeviceLimitError extends OneHookServiceException_1.OneHookServiceException
     }
 }
 exports.DeviceLimitError = DeviceLimitError;
+exports.CredentialGap = {
+    NO_COGNITO_USERNAME_ON_PROFILE: "NO_COGNITO_USERNAME_ON_PROFILE",
+    PHONE_NOT_VERIFIED: "PHONE_NOT_VERIFIED",
+    USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO",
+    USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO",
+};

package/dist-cjs/protocols/Aws_restJson1.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.de_GetUserByEmailCommand = exports.de_GetUserCommand = exports.de_GenerateInviteCommand = exports.de_AuthSocialCommand = exports.de_RevokeDeviceCommand = exports.de_RegisterDeviceCommand = exports.de_ListMyDevicesCommand = exports.de_GetParticipantRegistryCommand = exports.de_DeleteMatchMessagesCommand = exports.se_UpgradeUserCommand = exports.se_UnhookCommand = exports.se_InitUserCommand = exports.se_GetStateCommand = exports.se_GetMatchCommand = exports.se_CompleteOnboardingCommand = exports.se_UpdateProfileCommand = exports.se_GetProfileCommand = exports.se_GetMyProfileCommand = exports.se_GetLivenessStatusCommand = exports.se_GenerateUploadUrlCommand = exports.se_GenerateDownloadUrlCommand = exports.se_DeleteProfileCommand = exports.se_CreateLivenessSessionCommand = exports.se_CompleteLivenessSessionCommand = exports.se_UpdatePreferencesCommand = exports.se_SwipeCommand = exports.se_RemoveLocationCommand = exports.se_IndexLocationCommand = exports.se_GetPreferencesCommand = exports.se_DiscoverCommand = exports.se_ValidateInviteCommand = exports.se_UpdateUsernameCommand = exports.se_UpdatePhoneNumberCommand = exports.se_UpdateEntitlementsCommand = exports.se_UnlinkSocialCommand = exports.se_RequestPhoneUpdateOtpCommand = exports.se_RequestPhoneOtpCommand = exports.se_RequestEmailOtpCommand = exports.se_RegisterPhoneCommand = exports.se_LinkSocialCommand = exports.se_LinkEmailCommand = exports.se_GetUserByEmailCommand = exports.se_GetUserCommand = exports.se_GenerateInviteCommand = exports.se_AuthSocialCommand = exports.se_RevokeDeviceCommand = exports.se_RegisterDeviceCommand = exports.se_ListMyDevicesCommand = exports.se_GetParticipantRegistryCommand = exports.se_DeleteMatchMessagesCommand = void 0;
-exports.de_UpgradeUserCommand = exports.de_UnhookCommand = exports.de_InitUserCommand = exports.de_GetStateCommand = exports.de_GetMatchCommand = exports.de_CompleteOnboardingCommand = exports.de_UpdateProfileCommand = exports.de_GetProfileCommand = exports.de_GetMyProfileCommand = exports.de_GetLivenessStatusCommand = exports.de_GenerateUploadUrlCommand = exports.de_GenerateDownloadUrlCommand = exports.de_DeleteProfileCommand = exports.de_CreateLivenessSessionCommand = exports.de_CompleteLivenessSessionCommand = exports.de_UpdatePreferencesCommand = exports.de_SwipeCommand = exports.de_RemoveLocationCommand = exports.de_IndexLocationCommand = exports.de_GetPreferencesCommand = exports.de_DiscoverCommand = exports.de_ValidateInviteCommand = exports.de_UpdateUsernameCommand = exports.de_UpdatePhoneNumberCommand = exports.de_UpdateEntitlementsCommand = exports.de_UnlinkSocialCommand = exports.de_RequestPhoneUpdateOtpCommand = exports.de_RequestPhoneOtpCommand = exports.de_RequestEmailOtpCommand = exports.de_RegisterPhoneCommand = exports.de_LinkSocialCommand = exports.de_LinkEmailCommand = void 0;
+exports.de_GetCredentialReadinessCommand = exports.de_GenerateInviteCommand = exports.de_AuthSocialCommand = exports.de_RevokeDeviceCommand = exports.de_RegisterDeviceCommand = exports.de_ListMyDevicesCommand = exports.de_GetParticipantRegistryCommand = exports.de_DeleteMatchMessagesCommand = exports.se_UpgradeUserCommand = exports.se_UnhookCommand = exports.se_InitUserCommand = exports.se_GetStateCommand = exports.se_GetMatchCommand = exports.se_CompleteOnboardingCommand = exports.se_UpdateProfileCommand = exports.se_GetProfileCommand = exports.se_GetMyProfileCommand = exports.se_GetLivenessStatusCommand = exports.se_GenerateUploadUrlCommand = exports.se_GenerateDownloadUrlCommand = exports.se_DeleteProfileCommand = exports.se_CreateLivenessSessionCommand = exports.se_CompleteLivenessSessionCommand = exports.se_UpdatePreferencesCommand = exports.se_SwipeCommand = exports.se_RemoveLocationCommand = exports.se_IndexLocationCommand = exports.se_GetPreferencesCommand = exports.se_DiscoverCommand = exports.se_ValidateInviteCommand = exports.se_UpdateUsernameCommand = exports.se_UpdatePhoneNumberCommand = exports.se_UpdateEntitlementsCommand = exports.se_UnlinkSocialCommand = exports.se_RequestPhoneUpdateOtpCommand = exports.se_RequestPhoneOtpCommand = exports.se_RequestEmailOtpCommand = exports.se_RegisterPhoneCommand = exports.se_LinkSocialCommand = exports.se_LinkEmailCommand = exports.se_GetUserByEmailCommand = exports.se_GetUserCommand = exports.se_GetCredentialReadinessCommand = exports.se_GenerateInviteCommand = exports.se_AuthSocialCommand = exports.se_RevokeDeviceCommand = exports.se_RegisterDeviceCommand = exports.se_ListMyDevicesCommand = exports.se_GetParticipantRegistryCommand = exports.se_DeleteMatchMessagesCommand = void 0;
+exports.de_UpgradeUserCommand = exports.de_UnhookCommand = exports.de_InitUserCommand = exports.de_GetStateCommand = exports.de_GetMatchCommand = exports.de_CompleteOnboardingCommand = exports.de_UpdateProfileCommand = exports.de_GetProfileCommand = exports.de_GetMyProfileCommand = exports.de_GetLivenessStatusCommand = exports.de_GenerateUploadUrlCommand = exports.de_GenerateDownloadUrlCommand = exports.de_DeleteProfileCommand = exports.de_CreateLivenessSessionCommand = exports.de_CompleteLivenessSessionCommand = exports.de_UpdatePreferencesCommand = exports.de_SwipeCommand = exports.de_RemoveLocationCommand = exports.de_IndexLocationCommand = exports.de_GetPreferencesCommand = exports.de_DiscoverCommand = exports.de_ValidateInviteCommand = exports.de_UpdateUsernameCommand = exports.de_UpdatePhoneNumberCommand = exports.de_UpdateEntitlementsCommand = exports.de_UnlinkSocialCommand = exports.de_RequestPhoneUpdateOtpCommand = exports.de_RequestPhoneOtpCommand = exports.de_RequestEmailOtpCommand = exports.de_RegisterPhoneCommand = exports.de_LinkSocialCommand = exports.de_LinkEmailCommand = exports.de_GetUserByEmailCommand = exports.de_GetUserCommand = void 0;
 const OneHookServiceException_1 = require("../models/OneHookServiceException");
 const models_0_1 = require("../models/models_0");
 const core_1 = require("@aws-sdk/core");
@@ -113,6 +113,18 @@ const se_GenerateInviteCommand = async (input, context) => {
     return b.build();
 };
 exports.se_GenerateInviteCommand = se_GenerateInviteCommand;
+const se_GetCredentialReadinessCommand = async (input, context) => {
+    const b = (0, core_2.requestBuilder)(input, context);
+    const headers = {};
+    b.bp("/identity/users/{userId}/credential-readiness");
+    b.p('userId', () => input.userId, '{userId}', false);
+    let body;
+    b.m("GET")
+        .h(headers)
+        .b(body);
+    return b.build();
+};
+exports.se_GetCredentialReadinessCommand = se_GetCredentialReadinessCommand;
 const se_GetUserCommand = async (input, context) => {
     const b = (0, core_2.requestBuilder)(input, context);
     const headers = {};
@@ -759,6 +771,22 @@ const de_GenerateInviteCommand = async (output, context) => {
     return contents;
 };
 exports.de_GenerateInviteCommand = de_GenerateInviteCommand;
+const de_GetCredentialReadinessCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_CommandError(output, context);
+    }
+    const contents = (0, smithy_client_1.map)({
+        $metadata: deserializeMetadata(output),
+    });
+    const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
+    const doc = (0, smithy_client_1.take)(data, {
+        'gaps': smithy_client_1._json,
+        'ready': smithy_client_1.expectBoolean,
+    });
+    Object.assign(contents, doc);
+    return contents;
+};
+exports.de_GetCredentialReadinessCommand = de_GetCredentialReadinessCommand;
 const de_GetUserCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_CommandError(output, context);

package/dist-es/OneHook.js

@@ -9,6 +9,7 @@ import { DiscoverCommand, } from "./commands/DiscoverCommand";
 import { GenerateDownloadUrlCommand, } from "./commands/GenerateDownloadUrlCommand";
 import { GenerateInviteCommand, } from "./commands/GenerateInviteCommand";
 import { GenerateUploadUrlCommand, } from "./commands/GenerateUploadUrlCommand";
+import { GetCredentialReadinessCommand, } from "./commands/GetCredentialReadinessCommand";
 import { GetLivenessStatusCommand, } from "./commands/GetLivenessStatusCommand";
 import { GetMatchCommand, } from "./commands/GetMatchCommand";
 import { GetMyProfileCommand, } from "./commands/GetMyProfileCommand";
@@ -49,6 +50,7 @@ const commands = {
     RevokeDeviceCommand,
     AuthSocialCommand,
     GenerateInviteCommand,
+    GetCredentialReadinessCommand,
     GetUserCommand,
     GetUserByEmailCommand,
     LinkEmailCommand,

package/dist-es/commands/GetCredentialReadinessCommand.js

@@ -0,0 +1,17 @@
+import { de_GetCredentialReadinessCommand, se_GetCredentialReadinessCommand, } from "../protocols/Aws_restJson1";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+export { $Command };
+export class GetCredentialReadinessCommand extends $Command.classBuilder()
+    .m(function (Command, cs, config, o) {
+    return [
+        getSerdePlugin(config, this.serialize, this.deserialize),
+    ];
+})
+    .s("OneHookService", "GetCredentialReadiness", {})
+    .n("OneHookClient", "GetCredentialReadinessCommand")
+    .f(void 0, void 0)
+    .ser(se_GetCredentialReadinessCommand)
+    .de(de_GetCredentialReadinessCommand)
+    .build() {
+}

package/dist-es/commands/index.js

@@ -5,6 +5,7 @@ export * from "./RegisterDeviceCommand";
 export * from "./RevokeDeviceCommand";
 export * from "./AuthSocialCommand";
 export * from "./GenerateInviteCommand";
+export * from "./GetCredentialReadinessCommand";
 export * from "./GetUserCommand";
 export * from "./GetUserByEmailCommand";
 export * from "./LinkEmailCommand";

package/dist-es/models/models_0.js

@@ -74,3 +74,9 @@ export class DeviceLimitError extends __BaseException {
         this.error = opts.error;
     }
 }
+export const CredentialGap = {
+    NO_COGNITO_USERNAME_ON_PROFILE: "NO_COGNITO_USERNAME_ON_PROFILE",
+    PHONE_NOT_VERIFIED: "PHONE_NOT_VERIFIED",
+    USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO",
+    USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO",
+};

package/dist-es/protocols/Aws_restJson1.js

@@ -102,6 +102,17 @@ export const se_GenerateInviteCommand = async (input, context) => {
         .b(body);
     return b.build();
 };
+export const se_GetCredentialReadinessCommand = async (input, context) => {
+    const b = rb(input, context);
+    const headers = {};
+    b.bp("/identity/users/{userId}/credential-readiness");
+    b.p('userId', () => input.userId, '{userId}', false);
+    let body;
+    b.m("GET")
+        .h(headers)
+        .b(body);
+    return b.build();
+};
 export const se_GetUserCommand = async (input, context) => {
     const b = rb(input, context);
     const headers = {};
@@ -707,6 +718,21 @@ export const de_GenerateInviteCommand = async (output, context) => {
     Object.assign(contents, doc);
     return contents;
 };
+export const de_GetCredentialReadinessCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_CommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
+    const doc = take(data, {
+        'gaps': _json,
+        'ready': __expectBoolean,
+    });
+    Object.assign(contents, doc);
+    return contents;
+};
 export const de_GetUserCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_CommandError(output, context);

package/dist-types/OneHook.d.ts

@@ -9,6 +9,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "./commands/Discover
 import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "./commands/GenerateDownloadUrlCommand";
 import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "./commands/GenerateInviteCommand";
 import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "./commands/GenerateUploadUrlCommand";
+import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "./commands/GetCredentialReadinessCommand";
 import { GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput } from "./commands/GetLivenessStatusCommand";
 import { GetMatchCommandInput, GetMatchCommandOutput } from "./commands/GetMatchCommand";
 import { GetMyProfileCommandInput, GetMyProfileCommandOutput } from "./commands/GetMyProfileCommand";
@@ -85,6 +86,12 @@ export interface OneHook {
     generateInvite(args: GenerateInviteCommandInput, options?: __HttpHandlerOptions): Promise<GenerateInviteCommandOutput>;
     generateInvite(args: GenerateInviteCommandInput, cb: (err: any, data?: GenerateInviteCommandOutput) => void): void;
     generateInvite(args: GenerateInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateInviteCommandOutput) => void): void;
+    /**
+     * @see {@link GetCredentialReadinessCommand}
+     */
+    getCredentialReadiness(args: GetCredentialReadinessCommandInput, options?: __HttpHandlerOptions): Promise<GetCredentialReadinessCommandOutput>;
+    getCredentialReadiness(args: GetCredentialReadinessCommandInput, cb: (err: any, data?: GetCredentialReadinessCommandOutput) => void): void;
+    getCredentialReadiness(args: GetCredentialReadinessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCredentialReadinessCommandOutput) => void): void;
     /**
      * @see {@link GetUserCommand}
      */

package/dist-types/OneHookClient.d.ts

@@ -9,6 +9,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "./commands/Discover
 import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "./commands/GenerateDownloadUrlCommand";
 import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "./commands/GenerateInviteCommand";
 import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "./commands/GenerateUploadUrlCommand";
+import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "./commands/GetCredentialReadinessCommand";
 import { GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput } from "./commands/GetLivenessStatusCommand";
 import { GetMatchCommandInput, GetMatchCommandOutput } from "./commands/GetMatchCommand";
 import { GetMyProfileCommandInput, GetMyProfileCommandOutput } from "./commands/GetMyProfileCommand";
@@ -52,11 +53,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CreateLivenessSessionCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetParticipantRegistryCommandInput | GetPreferencesCommandInput | GetProfileCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput;
+export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CreateLivenessSessionCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetCredentialReadinessCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetParticipantRegistryCommandInput | GetPreferencesCommandInput | GetProfileCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CreateLivenessSessionCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetParticipantRegistryCommandOutput | GetPreferencesCommandOutput | GetProfileCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput;
+export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CreateLivenessSessionCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetCredentialReadinessCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetParticipantRegistryCommandOutput | GetPreferencesCommandOutput | GetProfileCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput;
 /**
  * @public
  */

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

@@ -0,0 +1,93 @@
+import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
+import { GetCredentialReadinessRequest, GetCredentialReadinessResponse } 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 GetCredentialReadinessCommand}.
+ */
+export interface GetCredentialReadinessCommandInput extends GetCredentialReadinessRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetCredentialReadinessCommand}.
+ */
+export interface GetCredentialReadinessCommandOutput extends GetCredentialReadinessResponse, __MetadataBearer {
+}
+declare const GetCredentialReadinessCommand_base: {
+    new (input: GetCredentialReadinessCommandInput): import("@smithy/smithy-client").CommandImpl<GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetCredentialReadinessCommandInput): import("@smithy/smithy-client").CommandImpl<GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Reports whether the user holds a working set of PORTABLE login credentials — ones that let them
+ * sign in on a DIFFERENT device from the one they registered on.
+ *
+ * Read-only and IAM-authenticated: it is called service-to-service by State to gate onboarding
+ * completion, never by an end user. Identity owns the Cognito user pool, so it is the only service
+ * that may inspect the live alias attributes; State must not read Cognito directly.
+ *
+ * "Portable" means a Cognito sign-in ALIAS (phone_number, email, preferred_username). A WebAuthn
+ * passkey is deliberately NOT counted: it is bound to the device that created it, so a user holding
+ * only a passkey is locked out everywhere else.
+ *
+ * The response lists what is missing rather than returning a bare boolean, so the caller can tell
+ * the user which credential to fix instead of failing opaquely.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OneHookClient, GetCredentialReadinessCommand } from "onehook-api-client"; // ES Modules import
+ * // const { OneHookClient, GetCredentialReadinessCommand } = require("onehook-api-client"); // CommonJS import
+ * const client = new OneHookClient(config);
+ * const input = { // GetCredentialReadinessRequest
+ *   userId: "STRING_VALUE", // required
+ * };
+ * const command = new GetCredentialReadinessCommand(input);
+ * const response = await client.send(command);
+ * // { // GetCredentialReadinessResponse
+ * //   ready: true || false, // required
+ * //   gaps: [ // CredentialGapList // required
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetCredentialReadinessCommandInput - {@link GetCredentialReadinessCommandInput}
+ * @returns {@link GetCredentialReadinessCommandOutput}
+ * @see {@link GetCredentialReadinessCommandInput} for command's `input` shape.
+ * @see {@link GetCredentialReadinessCommandOutput} for command's `response` shape.
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *
+ * @throws {@link NotFoundError} (client fault)
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *
+ * @throws {@link OneHookServiceException}
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetCredentialReadinessCommand extends GetCredentialReadinessCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetCredentialReadinessRequest;
+            output: GetCredentialReadinessResponse;
+        };
+        sdk: {
+            input: GetCredentialReadinessCommandInput;
+            output: GetCredentialReadinessCommandOutput;
+        };
+    };
+}

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

@@ -5,6 +5,7 @@ export * from "./RegisterDeviceCommand";
 export * from "./RevokeDeviceCommand";
 export * from "./AuthSocialCommand";
 export * from "./GenerateInviteCommand";
+export * from "./GetCredentialReadinessCommand";
 export * from "./GetUserCommand";
 export * from "./GetUserByEmailCommand";
 export * from "./LinkEmailCommand";

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

@@ -285,6 +285,41 @@ export interface GenerateInviteResponse {
     expiresAt: number | undefined;
     maxUses: number | undefined;
 }
+/**
+ * @public
+ */
+export interface GetCredentialReadinessRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CredentialGap: {
+    readonly NO_COGNITO_USERNAME_ON_PROFILE: "NO_COGNITO_USERNAME_ON_PROFILE";
+    readonly PHONE_NOT_VERIFIED: "PHONE_NOT_VERIFIED";
+    readonly USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO";
+    readonly USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO";
+};
+/**
+ * @public
+ */
+export type CredentialGap = typeof CredentialGap[keyof typeof CredentialGap];
+/**
+ * @public
+ */
+export interface GetCredentialReadinessResponse {
+    /**
+     * True only when EVERY portable credential the profile advertises is live in Cognito.
+     * @public
+     */
+    ready: boolean | undefined;
+    /**
+     * Empty when ready. Machine-readable so the caller can explain the specific gap.
+     * @public
+     */
+    gaps: (CredentialGap)[] | undefined;
+}
 /**
  * @public
  */

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

@@ -8,6 +8,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "../commands/Discove
 import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "../commands/GenerateDownloadUrlCommand";
 import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "../commands/GenerateInviteCommand";
 import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "../commands/GenerateUploadUrlCommand";
+import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "../commands/GetCredentialReadinessCommand";
 import { GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput } from "../commands/GetLivenessStatusCommand";
 import { GetMatchCommandInput, GetMatchCommandOutput } from "../commands/GetMatchCommand";
 import { GetMyProfileCommandInput, GetMyProfileCommandOutput } from "../commands/GetMyProfileCommand";
@@ -69,6 +70,10 @@ export declare const se_AuthSocialCommand: (input: AuthSocialCommandInput, conte
  * serializeAws_restJson1GenerateInviteCommand
  */
 export declare const se_GenerateInviteCommand: (input: GenerateInviteCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetCredentialReadinessCommand
+ */
+export declare const se_GetCredentialReadinessCommand: (input: GetCredentialReadinessCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetUserCommand
  */
@@ -233,6 +238,10 @@ export declare const de_AuthSocialCommand: (output: __HttpResponse, context: __S
  * deserializeAws_restJson1GenerateInviteCommand
  */
 export declare const de_GenerateInviteCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GenerateInviteCommandOutput>;
+/**
+ * deserializeAws_restJson1GetCredentialReadinessCommand
+ */
+export declare const de_GetCredentialReadinessCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetCredentialReadinessCommandOutput>;
 /**
  * deserializeAws_restJson1GetUserCommand
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "onehook-api-client",
   "description": "OneHook API Client",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",