Skip to main content
References

EmailVerification Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/emailverification/types.ts:127

Properties

PropertyTypeDefined in
generateEmailVerifyTokenPOST| undefined | (input) => Promise< | { status: "OK"; } | { newSession?: SessionContainerInterface; status: "EMAIL_ALREADY_VERIFIED_ERROR"; } | GeneralErrorResponse>recipe/emailverification/types.ts:153
isEmailVerifiedGET| undefined | (input) => Promise< | { isVerified: boolean; newSession?: SessionContainerInterface; status: "OK"; } | GeneralErrorResponse>recipe/emailverification/types.ts:142
verifyEmailPOST| undefined | (input) => Promise< | { newSession?: SessionContainerInterface; status: "OK"; user: UserEmailInfo; } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; } | GeneralErrorResponse>recipe/emailverification/types.ts:128

APIOptions

type APIOptions = object;

Defined in: recipe/emailverification/types.ts:116

Properties

GetEmailForRecipeUserIdFunc()

type GetEmailForRecipeUserIdFunc = (user, recipeUserId, userContext) => Promise<
  | {
  email: string;
  status: "OK";
}
  | {
  status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR";
}>;

Defined in: recipe/emailverification/types.ts:180

Parameters

ParameterType
userUser | undefined
recipeUserIdRecipeUserId
userContextUserContext

Returns

Promise< | { email: string; status: "OK"; } | { status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR"; }>

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/emailverification/types.ts:79

Methods

createEmailVerificationToken()​
createEmailVerificationToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/types.ts:80

Parameters​
ParameterType
input{ email: string; recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext; }
input.emailstring
input.recipeUserIdRecipeUserId
input.tenantIdstring
input.userContextUserContext
Returns​

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

isEmailVerified()​
isEmailVerified(input): Promise<boolean>;

Defined in: recipe/emailverification/types.ts:100

Parameters​
ParameterType
input{ email: string; recipeUserId: RecipeUserId; userContext: UserContext; }
input.emailstring
input.recipeUserIdRecipeUserId
input.userContextUserContext
Returns​

Promise<boolean>

revokeEmailVerificationTokens()​
revokeEmailVerificationTokens(input): Promise<{
  status: "OK";
}>;

Defined in: recipe/emailverification/types.ts:102

Parameters​
ParameterType
input{ email: string; recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext; }
input.emailstring
input.recipeUserIdRecipeUserId
input.tenantIdstring
input.userContextUserContext
Returns​

Promise<{ status: "OK"; }>

unverifyEmail()​
unverifyEmail(input): Promise<{
  status: "OK";
}>;

Defined in: recipe/emailverification/types.ts:109

Parameters​
ParameterType
input{ email: string; recipeUserId: RecipeUserId; userContext: UserContext; }
input.emailstring
input.recipeUserIdRecipeUserId
input.userContextUserContext
Returns​

Promise<{ status: "OK"; }>

verifyEmailUsingToken()​
verifyEmailUsingToken(input): Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;

Defined in: recipe/emailverification/types.ts:93

Parameters​
ParameterType
input{ attemptAccountLinking: boolean; tenantId: string; token: string; userContext: UserContext; }
input.attemptAccountLinkingboolean
input.tenantIdstring
input.tokenstring
input.userContextUserContext
Returns​

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

TypeEmailVerificationEmailDeliveryInput

type TypeEmailVerificationEmailDeliveryInput = object;

Defined in: recipe/emailverification/types.ts:166

Properties

TypeInput

type TypeInput = object;

Defined in: recipe/emailverification/types.ts:28

Properties

PropertyTypeDefined in
emailDelivery?EmailDeliveryTypeInput<TypeEmailVerificationEmailDeliveryInput>recipe/emailverification/types.ts:30
getEmailForRecipeUserId?(recipeUserId, userContext) => Promise< | { email: string; status: "OK"; } | { status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR"; }>recipe/emailverification/types.ts:31
mode"REQUIRED" | "OPTIONAL"recipe/emailverification/types.ts:29
override?objectrecipe/emailverification/types.ts:41
override.apis?(originalImplementation, builder) => APIInterfacerecipe/emailverification/types.ts:46
override.functions?(originalImplementation, builder) => RecipeInterfacerecipe/emailverification/types.ts:42

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/emailverification/types.ts:50

Properties

PropertyTypeDefined in
getEmailDeliveryConfig(isInServerlessEnv) => EmailDeliveryTypeInputWithService<TypeEmailVerificationEmailDeliveryInput>recipe/emailverification/types.ts:52
getEmailForRecipeUserId?(recipeUserId, userContext) => Promise< | { email: string; status: "OK"; } | { status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR"; }>recipe/emailverification/types.ts:55
mode"REQUIRED" | "OPTIONAL"recipe/emailverification/types.ts:51
overrideobjectrecipe/emailverification/types.ts:65
override.apis(originalImplementation, builder) => APIInterfacerecipe/emailverification/types.ts:70
override.functions(originalImplementation, builder) => RecipeInterfacerecipe/emailverification/types.ts:66

UserEmailInfo

type UserEmailInfo = object;

Defined in: recipe/emailverification/types.ts:74

Properties