`IEmailEnrollResponse`

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

IEmailEnrollResponse

Next email-verification step or completion.

app/interfaces/orionplace/accounts/IEmailVerification.ts

TypeScript

export interface IEmailEnrollResponse {
  // Field or general errors; null on success.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message, or null.
  success_message: string | null;
  // The sending step returns `page_data.next_step: step_email_code`. Successful
  // verification returns `page_data: null`; the email has then been saved.
  page_data: {
    // `step_email_code` after sending. After three failed code submissions, the
    // next verification request clears that flow and returns `step_email` with
    // a general error.
    next_step: 'step_email' | 'step_email_code';
  } | null;
}