@wix/identity 1.0.23 → 1.0.25

package/build/es/src/iam-verification-v1-start-response.http.d.ts

@@ -0,0 +1,13 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { StateMachineResponse, StartRequest, StartResponse, VerifyDuringAuthenticationRequest } from './iam-verification-v1-start-response.types';
+/**
+ * starts a verification process
+ * example: sends a code to the identity's email
+ */
+export declare function start(payload: StartRequest): RequestOptionsFactory<StartResponse>;
+/**
+ * verifies the code in the request.
+ * this endpoint is meant to be called during the authentication process only, thus it requires a stateToken.
+ * the identity_id and the verification_id are extracted from the stateToken
+ */
+export declare function verifyDuringAuthentication(payload: VerifyDuringAuthenticationRequest): RequestOptionsFactory<StateMachineResponse>;

package/build/es/src/iam-verification-v1-start-response.http.js

@@ -0,0 +1,86 @@
+import { serializer } from '@wix/metro-runtime/ambassador';
+import { resolveUrl } from '@wix/metro-runtime';
+const _customField = { value: '_customValue' };
+const _customValue = {
+    numValue: 'DOUBLE',
+    dateValue: 'google.protobuf.Timestamp',
+    listValue: '_listValue',
+    mapValue: '_mapValue',
+};
+const _identity = {
+    createdDate: 'google.protobuf.Timestamp',
+    updatedDate: 'google.protobuf.Timestamp',
+    identityProfile: '_identityProfile',
+};
+const _identityProfile = { customFields: '_customField' };
+const _listValue = { value: '_customValue' };
+const _mapValue = { value: 'Map#_customValue' };
+const _startRequest = {};
+const _startResponse = {};
+const _stateMachineResponse = { identity: '_identity' };
+const _verifyDuringAuthenticationRequest = {};
+function resolveWixIamVerificationV1VerificationServiceUrl(opts) {
+    const domainToMappings = {};
+    return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+/**
+ * starts a verification process
+ * example: sends a code to the identity's email
+ */
+export function start(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_startRequest, {});
+    const { fromJSON: fromRes } = serializer(_startResponse, {});
+    function __start({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.iam.verification.v1.start_response',
+            method: 'POST',
+            methodFqn: 'wix.iam.verification.v1.VerificationService.Start',
+            url: resolveWixIamVerificationV1VerificationServiceUrl({
+                protoPath: '/v1/Start',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __start.fromReq = fromReq;
+    return __start;
+}
+/**
+ * verifies the code in the request.
+ * this endpoint is meant to be called during the authentication process only, thus it requires a stateToken.
+ * the identity_id and the verification_id are extracted from the stateToken
+ */
+export function verifyDuringAuthentication(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_verifyDuringAuthenticationRequest, {});
+    const { fromJSON: fromRes } = serializer(_stateMachineResponse, {
+        _customField,
+        _customValue,
+        _identity,
+        _identityProfile,
+        _listValue,
+        _mapValue,
+    });
+    function __verifyDuringAuthentication({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.iam.verification.v1.start_response',
+            method: 'POST',
+            methodFqn: 'wix.iam.verification.v1.VerificationService.VerifyDuringAuthentication',
+            url: resolveWixIamVerificationV1VerificationServiceUrl({
+                protoPath: '/v1/auth/verify',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __verifyDuringAuthentication.fromReq = fromReq;
+    return __verifyDuringAuthentication;
+}
+//# sourceMappingURL=iam-verification-v1-start-response.http.js.map

package/build/es/src/iam-verification-v1-start-response.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iam-verification-v1-start-response.http.js","sourceRoot":"","sources":["../../../src/iam-verification-v1-start-response.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAUhD,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC/C,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,WAAW;CACtB,CAAC;AACF,MAAM,SAAS,GAAG;IAChB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,eAAe,EAAE,kBAAkB;CACpC,CAAC;AACF,MAAM,gBAAgB,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAC1D,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC7C,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAChD,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACxD,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAE9C,SAAS,iDAAiD,CACxD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CACnB,OAAqB;IAErB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAE7D,SAAS,OAAO,CAAC,EAAE,IAAI,EAAO;QAC5B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,mDAAmD;YAC9D,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAA0C;IAE1C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,kCAAkC,EAClC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE;QAC9D,YAAY;QACZ,YAAY;QACZ,SAAS;QACT,gBAAgB;QAChB,UAAU;QACV,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,4BAA4B,CAAC,EAAE,IAAI,EAAO;QACjD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,wCAAwC;YACpD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,wEAAwE;YAC1E,GAAG,EAAE,iDAAiD,CAAC;gBACrD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4BAA4B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/C,OAAO,4BAA4B,CAAC;AACtC,CAAC"}

package/build/es/src/iam-verification-v1-start-response.public.d.ts

@@ -0,0 +1,9 @@
+import { HttpClient } from '@wix/sdk-types';
+import { StartOptions, VerifyDuringAuthenticationOptions } from './iam-verification-v1-start-response.universal';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function start(httpClient: HttpClient): (options?: StartOptions | undefined) => Promise<import("./iam-verification-v1-start-response.universal").StartResponse>;
+export declare function verifyDuringAuthentication(httpClient: HttpClient): (code: string, options: VerifyDuringAuthenticationOptions) => Promise<import("./iam-verification-v1-start-response.universal").StateMachineResponse>;
+export { Target, StateType, Status, PrivacyStatus, StatusName, Reason, } from './iam-verification-v1-start-response.universal';
+export { StartResponse, StartRequest, VerifyRequest, VerifyResponse, VerifyDuringAuthenticationRequest, StateMachineResponse, Identity, Identifier, IdentifierValueOneOf, Connection, ConnectionTypeOneOf, IdpConnection, AuthenticatorConnection, IdentityProfile, CustomField, CustomValue, CustomValueValueOneOf, ListValue, MapValue, Metadata, Email, StatusV2, StartOptions, VerifyDuringAuthenticationOptions, } from './iam-verification-v1-start-response.universal';

package/build/es/src/iam-verification-v1-start-response.public.js

@@ -0,0 +1,14 @@
+import { start as universalStart, verifyDuringAuthentication as universalVerifyDuringAuthentication, } from './iam-verification-v1-start-response.universal';
+export const __metadata = { PACKAGE_NAME: '@wix/identity' };
+export function start(httpClient) {
+    return (options) => universalStart(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function verifyDuringAuthentication(httpClient) {
+    return (code, options) => universalVerifyDuringAuthentication(code, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export { Target, StateType, Status, PrivacyStatus, StatusName, Reason, } from './iam-verification-v1-start-response.universal';
+//# sourceMappingURL=iam-verification-v1-start-response.public.js.map

package/build/es/src/iam-verification-v1-start-response.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iam-verification-v1-start-response.public.js","sourceRoot":"","sources":["../../../src/iam-verification-v1-start-response.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,IAAI,cAAc,EAEvB,0BAA0B,IAAI,mCAAmC,GAElE,MAAM,gDAAgD,CAAC;AAExD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,MAAM,UAAU,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,OAAsB,EAAE,EAAE,CAChC,cAAc,CACZ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,UAAsB;IAC/D,OAAO,CAAC,IAAY,EAAE,OAA0C,EAAE,EAAE,CAClE,mCAAmC,CACjC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,MAAM,EACN,SAAS,EACT,MAAM,EACN,aAAa,EACb,UAAU,EACV,MAAM,GACP,MAAM,gDAAgD,CAAC"}

package/build/es/src/iam-verification-v1-start-response.types.d.ts

@@ -0,0 +1,173 @@
+export interface StartResponse {
+    /** the identifier of the verification process */
+    verificationId?: string;
+}
+export interface StartRequest {
+    /**
+     * an identity_Id.
+     * If not provided - currently, an exception is thrown. In the future the identity from identity response will be taken.
+     */
+    identityId?: string | null;
+    /** the delivery target */
+    target?: Target;
+}
+export declare enum Target {
+    UNKNOWN_TARGET = "UNKNOWN_TARGET",
+    EMAIL = "EMAIL"
+}
+export interface VerifyRequest {
+    /** the code to verify */
+    code?: string;
+    /** the identifier of the verification process */
+    verificationId?: string;
+}
+export interface VerifyResponse {
+}
+export interface VerifyDuringAuthenticationRequest {
+    /** the code to verify */
+    code: string;
+    /** a state token with a REQUIRE_EMAIL_VERIFICATION state */
+    stateToken: string;
+}
+export interface StateMachineResponse {
+    state?: StateType;
+    sessionToken?: string | null;
+    stateToken?: string | null;
+    identity?: Identity;
+}
+export declare enum StateType {
+    UNKNOWN_STATE = "UNKNOWN_STATE",
+    SUCCESS = "SUCCESS",
+    REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
+    REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
+    STATUS_CHECK = "STATUS_CHECK"
+}
+export interface Identity {
+    /** Identity ID */
+    id?: string | null;
+    identifiers?: Identifier[];
+    /** @readonly */
+    status?: Status;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    /**
+     * Represents the time this Identity was created
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Represents the time this Identity was last updated
+     * @readonly
+     */
+    updatedDate?: Date;
+    /** All the identity configured connections to authenticate with */
+    connections?: Connection[];
+    identityProfile?: IdentityProfile;
+    /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
+    metadata?: Metadata;
+    email?: Email;
+    statusV2?: StatusV2;
+}
+export interface Identifier extends IdentifierValueOneOf {
+    email?: string;
+    userName?: string;
+}
+/** @oneof */
+export interface IdentifierValueOneOf {
+    email?: string;
+    userName?: string;
+}
+export declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    BLOCKED = "BLOCKED",
+    ACTIVE = "ACTIVE",
+    PROVISIONED = "PROVISIONED",
+    DELETED = "DELETED",
+    UNPROVISIONED = "UNPROVISIONED"
+}
+export interface Connection extends ConnectionTypeOneOf {
+    idpConnection?: IdpConnection;
+    authenticatorConnection?: AuthenticatorConnection;
+}
+/** @oneof */
+export interface ConnectionTypeOneOf {
+    idpConnection?: IdpConnection;
+    authenticatorConnection?: AuthenticatorConnection;
+}
+export interface IdpConnection {
+    idpConnectionId?: string;
+    idpUserId?: string;
+}
+export interface AuthenticatorConnection {
+    authenticatorConnectionId?: string;
+}
+export interface IdentityProfile {
+    firstName?: string | null;
+    lastName?: string | null;
+    nickname?: string | null;
+    picture?: string | null;
+    emails?: string[];
+    phones?: string[];
+    labels?: string[];
+    language?: string | null;
+    privacyStatus?: PrivacyStatus;
+    /** custom profile fields */
+    customFields?: CustomField[];
+}
+export declare enum PrivacyStatus {
+    UNDEFINED = "UNDEFINED",
+    PUBLIC = "PUBLIC",
+    PRIVATE = "PRIVATE"
+}
+export interface CustomField {
+    name?: string;
+    value?: CustomValue;
+}
+export interface CustomValue extends CustomValueValueOneOf {
+    strValue?: string;
+    numValue?: number;
+    dateValue?: Date;
+    listValue?: ListValue;
+    mapValue?: MapValue;
+}
+/** @oneof */
+export interface CustomValueValueOneOf {
+    strValue?: string;
+    numValue?: number;
+    dateValue?: Date;
+    listValue?: ListValue;
+    mapValue?: MapValue;
+}
+export interface ListValue {
+    value?: CustomValue[];
+}
+export interface MapValue {
+    value?: Record<string, CustomValue>;
+}
+export interface Metadata {
+    /**
+     * represents general tags such as "isOwner", "isContributor"
+     * @readonly
+     */
+    tags?: string[];
+}
+export interface Email {
+    address?: string;
+    isVerified?: boolean;
+}
+export interface StatusV2 {
+    name?: StatusName;
+    reasons?: Reason[];
+}
+export declare enum StatusName {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    DELETED = "DELETED",
+    BLOCKED = "BLOCKED"
+}
+export declare enum Reason {
+    UNKNOWN_REASON = "UNKNOWN_REASON",
+    PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
+    PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
+}

package/build/es/src/iam-verification-v1-start-response.types.js

@@ -0,0 +1,43 @@
+export var Target;
+(function (Target) {
+    Target["UNKNOWN_TARGET"] = "UNKNOWN_TARGET";
+    Target["EMAIL"] = "EMAIL";
+})(Target || (Target = {}));
+export var StateType;
+(function (StateType) {
+    StateType["UNKNOWN_STATE"] = "UNKNOWN_STATE";
+    StateType["SUCCESS"] = "SUCCESS";
+    StateType["REQUIRE_OWNER_APPROVAL"] = "REQUIRE_OWNER_APPROVAL";
+    StateType["REQUIRE_EMAIL_VERIFICATION"] = "REQUIRE_EMAIL_VERIFICATION";
+    StateType["STATUS_CHECK"] = "STATUS_CHECK";
+})(StateType || (StateType = {}));
+export var Status;
+(function (Status) {
+    Status["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+    Status["BLOCKED"] = "BLOCKED";
+    Status["ACTIVE"] = "ACTIVE";
+    Status["PROVISIONED"] = "PROVISIONED";
+    Status["DELETED"] = "DELETED";
+    Status["UNPROVISIONED"] = "UNPROVISIONED";
+})(Status || (Status = {}));
+export var PrivacyStatus;
+(function (PrivacyStatus) {
+    PrivacyStatus["UNDEFINED"] = "UNDEFINED";
+    PrivacyStatus["PUBLIC"] = "PUBLIC";
+    PrivacyStatus["PRIVATE"] = "PRIVATE";
+})(PrivacyStatus || (PrivacyStatus = {}));
+export var StatusName;
+(function (StatusName) {
+    StatusName["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+    StatusName["PENDING"] = "PENDING";
+    StatusName["ACTIVE"] = "ACTIVE";
+    StatusName["DELETED"] = "DELETED";
+    StatusName["BLOCKED"] = "BLOCKED";
+})(StatusName || (StatusName = {}));
+export var Reason;
+(function (Reason) {
+    Reason["UNKNOWN_REASON"] = "UNKNOWN_REASON";
+    Reason["PENDING_ADMIN_APPROVAL_REQUIRED"] = "PENDING_ADMIN_APPROVAL_REQUIRED";
+    Reason["PENDING_EMAIL_VERIFICATION_REQUIRED"] = "PENDING_EMAIL_VERIFICATION_REQUIRED";
+})(Reason || (Reason = {}));
+//# sourceMappingURL=iam-verification-v1-start-response.types.js.map

package/build/es/src/iam-verification-v1-start-response.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iam-verification-v1-start-response.types.js","sourceRoot":"","sources":["../../../src/iam-verification-v1-start-response.types.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,MAGX;AAHD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,yBAAe,CAAA;AACjB,CAAC,EAHW,MAAM,KAAN,MAAM,QAGjB;AAyBD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IACzD,0CAA6B,CAAA;AAC/B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAwCD,MAAM,CAAN,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6BAAmB,CAAA;IACnB,2BAAiB,CAAA;IACjB,qCAA2B,CAAA;IAC3B,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;AACjC,CAAC,EAPW,MAAM,KAAN,MAAM,QAOjB;AAoCD,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;AACrB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAkDD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,+CAAiC,CAAA;IACjC,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,6EAAmE,CAAA;IACnE,qFAA2E,CAAA;AAC7E,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB"}

package/build/es/src/iam-verification-v1-start-response.universal.d.ts

@@ -0,0 +1,211 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface StartResponse {
+    /** the identifier of the verification process */
+    verificationId?: string;
+}
+export interface StartRequest {
+    /**
+     * an identity_Id.
+     * If not provided - currently, an exception is thrown. In the future the identity from identity response will be taken.
+     */
+    identityId?: string | null;
+    /** the delivery target */
+    target?: Target;
+}
+export declare enum Target {
+    UNKNOWN_TARGET = "UNKNOWN_TARGET",
+    EMAIL = "EMAIL"
+}
+export interface VerifyRequest {
+    /** the code to verify */
+    code?: string;
+    /** the identifier of the verification process */
+    verificationId?: string;
+}
+export interface VerifyResponse {
+}
+export interface VerifyDuringAuthenticationRequest {
+    /** the code to verify */
+    code: string;
+    /** a state token with a REQUIRE_EMAIL_VERIFICATION state */
+    stateToken: string;
+}
+export interface StateMachineResponse {
+    state?: StateType;
+    sessionToken?: string | null;
+    stateToken?: string | null;
+    identity?: Identity;
+}
+export declare enum StateType {
+    UNKNOWN_STATE = "UNKNOWN_STATE",
+    SUCCESS = "SUCCESS",
+    REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
+    REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
+    STATUS_CHECK = "STATUS_CHECK"
+}
+export interface Identity {
+    /** Identity ID */
+    _id?: string | null;
+    identifiers?: Identifier[];
+    /** @readonly */
+    status?: Status;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    /**
+     * Represents the time this Identity was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Identity was last updated
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** All the identity configured connections to authenticate with */
+    connections?: Connection[];
+    identityProfile?: IdentityProfile;
+    /** Stores additional information about the identity that can impact user access. This data can't be set by users. */
+    metadata?: Metadata;
+    email?: Email;
+    statusV2?: StatusV2;
+}
+export interface Identifier extends IdentifierValueOneOf {
+    email?: string;
+    userName?: string;
+}
+/** @oneof */
+export interface IdentifierValueOneOf {
+    email?: string;
+    userName?: string;
+}
+export declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    BLOCKED = "BLOCKED",
+    ACTIVE = "ACTIVE",
+    PROVISIONED = "PROVISIONED",
+    DELETED = "DELETED",
+    UNPROVISIONED = "UNPROVISIONED"
+}
+export interface Connection extends ConnectionTypeOneOf {
+    idpConnection?: IdpConnection;
+    authenticatorConnection?: AuthenticatorConnection;
+}
+/** @oneof */
+export interface ConnectionTypeOneOf {
+    idpConnection?: IdpConnection;
+    authenticatorConnection?: AuthenticatorConnection;
+}
+export interface IdpConnection {
+    idpConnectionId?: string;
+    idpUserId?: string;
+}
+export interface AuthenticatorConnection {
+    authenticatorConnectionId?: string;
+}
+export interface IdentityProfile {
+    firstName?: string | null;
+    lastName?: string | null;
+    nickname?: string | null;
+    picture?: string | null;
+    emails?: string[];
+    phones?: string[];
+    labels?: string[];
+    language?: string | null;
+    privacyStatus?: PrivacyStatus;
+    /** custom profile fields */
+    customFields?: CustomField[];
+}
+export declare enum PrivacyStatus {
+    UNDEFINED = "UNDEFINED",
+    PUBLIC = "PUBLIC",
+    PRIVATE = "PRIVATE"
+}
+export interface CustomField {
+    name?: string;
+    value?: CustomValue;
+}
+export interface CustomValue extends CustomValueValueOneOf {
+    strValue?: string;
+    numValue?: number;
+    dateValue?: Date;
+    listValue?: ListValue;
+    mapValue?: MapValue;
+}
+/** @oneof */
+export interface CustomValueValueOneOf {
+    strValue?: string;
+    numValue?: number;
+    dateValue?: Date;
+    listValue?: ListValue;
+    mapValue?: MapValue;
+}
+export interface ListValue {
+    value?: CustomValue[];
+}
+export interface MapValue {
+    value?: Record<string, CustomValue>;
+}
+export interface Metadata {
+    /**
+     * represents general tags such as "isOwner", "isContributor"
+     * @readonly
+     */
+    tags?: string[];
+}
+export interface Email {
+    address?: string;
+    isVerified?: boolean;
+}
+export interface StatusV2 {
+    name?: StatusName;
+    reasons?: Reason[];
+}
+export declare enum StatusName {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    DELETED = "DELETED",
+    BLOCKED = "BLOCKED"
+}
+export declare enum Reason {
+    UNKNOWN_REASON = "UNKNOWN_REASON",
+    PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
+    PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
+}
+/**
+ * starts a verification process
+ * example: sends a code to the identity's email
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function start(options?: StartOptions): Promise<StartResponse>;
+export interface StartOptions {
+    /**
+     * an identity_Id.
+     * If not provided - currently, an exception is thrown. In the future the identity from identity response will be taken.
+     */
+    identityId?: string | null;
+    /** the delivery target */
+    target?: Target;
+}
+/**
+ * verifies the code in the request.
+ * this endpoint is meant to be called during the authentication process only, thus it requires a stateToken.
+ * the identity_id and the verification_id are extracted from the stateToken
+ * @param code - the code to verify
+ * @public
+ * @documentationMaturity preview
+ * @requiredField code
+ * @requiredField options
+ * @requiredField options.stateToken
+ */
+export declare function verifyDuringAuthentication(code: string, options: VerifyDuringAuthenticationOptions): Promise<StateMachineResponse>;
+export interface VerifyDuringAuthenticationOptions {
+    /** a state token with a REQUIRE_EMAIL_VERIFICATION state */
+    stateToken: string;
+}