Class default

constructor

• new default(): default

  Returns default

StaticEmailVerificationClaim

StaticError

Staticinit

StaticcreateEmailVerificationLink

• createEmailVerificationLink(
      tenantId: string,
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<
      | { link: string; status: "OK" }
      | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
  >

  Parameters

  • tenantId: string
  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { link: string; status: "OK" }
      | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
  >

StaticcreateEmailVerificationToken

• createEmailVerificationToken(
      tenantId: string,
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK"; token: string }
      | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
  >

  Parameters

  • tenantId: string
  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK"; token: string }
      | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
  >

StaticisEmailVerified

• isEmailVerified(
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<boolean>

  Parameters

  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<boolean>

StaticrevokeEmailVerificationTokens

• revokeEmailVerificationTokens(
      tenantId: string,
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<{ status: string }>

  Parameters

  • tenantId: string
  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: string }>

StaticsendEmail

• sendEmail(
      input: TypeEmailVerificationEmailDeliveryInput & {
          userContext?: Record<string, any>;
      },
  ): Promise<void>

  Parameters

  • input: TypeEmailVerificationEmailDeliveryInput & { userContext?: Record<string, any> }

  Returns Promise<void>

StaticsendEmailVerificationEmail

• sendEmailVerificationEmail(
      tenantId: string,
      userId: string,
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK" } | { status: "EMAIL_ALREADY_VERIFIED_ERROR" }>

  Parameters

  • tenantId: string
  • userId: string
  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK" } | { status: "EMAIL_ALREADY_VERIFIED_ERROR" }>

StaticunverifyEmail

• unverifyEmail(
      recipeUserId: RecipeUserId,
      email?: string,
      userContext?: Record<string, any>,
  ): Promise<{ status: string }>

  Parameters

  • recipeUserId: RecipeUserId
  • Optionalemail: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: string }>

StaticverifyEmailUsingToken

• verifyEmailUsingToken(
      tenantId: string,
      token: string,
      attemptAccountLinking?: boolean,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK"; user: UserEmailInfo }
      | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" },
  >

  Parameters

  • tenantId: string
  • token: string
  • attemptAccountLinking: boolean = true
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK"; user: UserEmailInfo }
      | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" },
  >