`IEmailEnrollRequest`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IEmailEnrollRequest

Two-step email verification request.

src/lib/interfaces/orionplace/accounts/IEmailVerification.ts

TypeScript

export type IEmailEnrollRequest =
  | {
      // `step_email` sends the code; `step_email_code` verifies it. Both calls
      // must use the same session.
      step: 'step_email';
      // Required valid email address on the first step. Use a new address: an
      // already registered address, including the account’s current address,
      // returns an error.
      email: string;
    }
  | {
      // `step_email` sends the code; `step_email_code` verifies it. Both calls
      // must use the same session.
      step: 'step_email_code';
      // Four-character verification code from the email. Send it as text to
      // preserve leading zeroes.
      code: string;
    };