Skip to content

GenerateOtpWithEmail

Type: schema

TypeScript Definition

typescript
GenerateOtpWithEmail: {{
            /** @constant */
            channel: "email";
            email: string;
            /** @enum {string} */
            otp_action: "register" | "reset-password" | "verify-email" | "update-email";
        };
        /** GenerateOtpWithPhone */
}

OpenAPI Schema

json
{
  "title": "GenerateOtpWithEmail",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/GenerateOtpWithEmail",
    "description": "API reference for the GenerateOtpWithEmail schema"
  },
  "required": [
    "channel",
    "email",
    "otp_action"
  ],
  "properties": {
    "channel": {
      "type": "string",
      "const": "email"
    },
    "email": {
      "type": "string"
    },
    "otp_action": {
      "type": "string",
      "enum": [
        "register",
        "reset-password",
        "verify-email",
        "update-email"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: