Module supertokens_python.recipe.passwordless.interfaces
Expand source code
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import annotations
from abc import ABC, abstractmethod
from typing import Any, Dict, List, Union
from typing_extensions import Literal
from supertokens_python.framework import BaseRequest, BaseResponse
from supertokens_python.ingredients.emaildelivery import EmailDeliveryIngredient
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.types import APIResponse, GeneralErrorResponse
from ...supertokens import AppInfo
# if TYPE_CHECKING:
from .types import (
DeviceType,
PasswordlessLoginEmailTemplateVars,
PasswordlessLoginSMSTemplateVars,
SMSDeliveryIngredient,
User,
)
from .utils import PasswordlessConfig
class CreateCodeOkResult:
def __init__(
self,
pre_auth_session_id: str,
code_id: str,
device_id: str,
user_input_code: str,
link_code: str,
code_life_time: int,
time_created: int,
):
self.pre_auth_session_id = pre_auth_session_id
self.code_id = code_id
self.device_id = device_id
self.user_input_code = user_input_code
self.link_code = link_code
self.code_life_time = code_life_time
self.time_created = time_created
class CreateNewCodeForDeviceOkResult:
def __init__(
self,
pre_auth_session_id: str,
code_id: str,
device_id: str,
user_input_code: str,
link_code: str,
code_life_time: int,
time_created: int,
):
self.pre_auth_session_id = pre_auth_session_id
self.code_id = code_id
self.device_id = device_id
self.user_input_code = user_input_code
self.link_code = link_code
self.code_life_time = code_life_time
self.time_created = time_created
class CreateNewCodeForDeviceRestartFlowError:
pass
class CreateNewCodeForDeviceUserInputCodeAlreadyUsedError:
pass
class ConsumeCodeOkResult:
def __init__(self, created_new_user: bool, user: User):
self.created_new_user = created_new_user
self.user = user
class ConsumeCodeIncorrectUserInputCodeError:
def __init__(
self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int
):
self.failed_code_input_attempt_count = failed_code_input_attempt_count
self.maximum_code_input_attempts = maximum_code_input_attempts
class ConsumeCodeExpiredUserInputCodeError:
def __init__(
self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int
):
self.failed_code_input_attempt_count = failed_code_input_attempt_count
self.maximum_code_input_attempts = maximum_code_input_attempts
class ConsumeCodeRestartFlowError:
pass
class UpdateUserOkResult:
pass
class UpdateUserUnknownUserIdError:
pass
class UpdateUserEmailAlreadyExistsError:
pass
class UpdateUserPhoneNumberAlreadyExistsError:
pass
class DeleteUserInfoOkResult:
pass
class DeleteUserInfoUnknownUserIdError:
pass
class RevokeAllCodesOkResult:
pass
class RevokeCodeOkResult:
pass
class RecipeInterface(ABC):
def __init__(self):
pass
@abstractmethod
async def create_code(
self,
email: Union[None, str],
phone_number: Union[None, str],
user_input_code: Union[None, str],
tenant_id: str,
user_context: Dict[str, Any],
) -> CreateCodeOkResult:
pass
@abstractmethod
async def create_new_code_for_device(
self,
device_id: str,
user_input_code: Union[str, None],
tenant_id: str,
user_context: Dict[str, Any],
) -> Union[
CreateNewCodeForDeviceOkResult,
CreateNewCodeForDeviceRestartFlowError,
CreateNewCodeForDeviceUserInputCodeAlreadyUsedError,
]:
pass
@abstractmethod
async def consume_code(
self,
pre_auth_session_id: str,
user_input_code: Union[str, None],
device_id: Union[str, None],
link_code: Union[str, None],
tenant_id: str,
user_context: Dict[str, Any],
) -> Union[
ConsumeCodeOkResult,
ConsumeCodeIncorrectUserInputCodeError,
ConsumeCodeExpiredUserInputCodeError,
ConsumeCodeRestartFlowError,
]:
pass
@abstractmethod
async def get_user_by_id(
self, user_id: str, user_context: Dict[str, Any]
) -> Union[User, None]:
pass
@abstractmethod
async def get_user_by_email(
self, email: str, tenant_id: str, user_context: Dict[str, Any]
) -> Union[User, None]:
pass
@abstractmethod
async def get_user_by_phone_number(
self, phone_number: str, tenant_id: str, user_context: Dict[str, Any]
) -> Union[User, None]:
pass
@abstractmethod
async def update_user(
self,
user_id: str,
email: Union[str, None],
phone_number: Union[str, None],
user_context: Dict[str, Any],
) -> Union[
UpdateUserOkResult,
UpdateUserUnknownUserIdError,
UpdateUserEmailAlreadyExistsError,
UpdateUserPhoneNumberAlreadyExistsError,
]:
pass
@abstractmethod
async def delete_email_for_user(
self, user_id: str, user_context: Dict[str, Any]
) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]:
pass
@abstractmethod
async def delete_phone_number_for_user(
self, user_id: str, user_context: Dict[str, Any]
) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]:
pass
@abstractmethod
async def revoke_all_codes(
self,
email: Union[str, None],
phone_number: Union[str, None],
tenant_id: str,
user_context: Dict[str, Any],
) -> RevokeAllCodesOkResult:
pass
@abstractmethod
async def revoke_code(
self, code_id: str, tenant_id: str, user_context: Dict[str, Any]
) -> RevokeCodeOkResult:
pass
@abstractmethod
async def list_codes_by_email(
self, email: str, tenant_id: str, user_context: Dict[str, Any]
) -> List[DeviceType]:
pass
@abstractmethod
async def list_codes_by_phone_number(
self, phone_number: str, tenant_id: str, user_context: Dict[str, Any]
) -> List[DeviceType]:
pass
@abstractmethod
async def list_codes_by_device_id(
self, device_id: str, tenant_id: str, user_context: Dict[str, Any]
) -> Union[DeviceType, None]:
pass
@abstractmethod
async def list_codes_by_pre_auth_session_id(
self, pre_auth_session_id: str, tenant_id: str, user_context: Dict[str, Any]
) -> Union[DeviceType, None]:
pass
class APIOptions:
def __init__(
self,
request: BaseRequest,
response: BaseResponse,
recipe_id: str,
config: PasswordlessConfig,
recipe_implementation: RecipeInterface,
app_info: AppInfo,
email_delivery: EmailDeliveryIngredient[PasswordlessLoginEmailTemplateVars],
sms_delivery: SMSDeliveryIngredient[PasswordlessLoginSMSTemplateVars],
):
self.request = request
self.response = response
self.recipe_id = recipe_id
self.config = config
self.recipe_implementation = recipe_implementation
self.app_info = app_info
self.email_delivery = email_delivery
self.sms_delivery = sms_delivery
class CreateCodePostOkResult(APIResponse):
status: str = "OK"
def __init__(
self,
device_id: str,
pre_auth_session_id: str,
flow_type: Literal[
"USER_INPUT_CODE", "MAGIC_LINK", "USER_INPUT_CODE_AND_MAGIC_LINK"
],
):
self.device_id = device_id
self.pre_auth_session_id = pre_auth_session_id
self.flow_type = flow_type
def to_json(self):
return {
"status": self.status,
"deviceId": self.device_id,
"preAuthSessionId": self.pre_auth_session_id,
"flowType": self.flow_type,
}
class ResendCodePostOkResult(APIResponse):
status: str = "OK"
def to_json(self):
return {"status": self.status}
class ResendCodePostRestartFlowError(APIResponse):
status: str = "RESTART_FLOW_ERROR"
def to_json(self):
return {"status": self.status}
class ConsumeCodePostOkResult(APIResponse):
status: str = "OK"
def __init__(self, created_new_user: bool, user: User, session: SessionContainer):
self.created_new_user = created_new_user
self.user = user
self.session = session
def to_json(self):
user = {"id": self.user.user_id, "time_joined": self.user.time_joined}
if self.user.email is not None:
user = {**user, "email": self.user.email}
if self.user.phone_number is not None:
user = {**user, "phoneNumber": self.user.phone_number}
return {
"status": self.status,
"createdNewUser": self.created_new_user,
"user": user,
}
class ConsumeCodePostRestartFlowError(APIResponse):
status: str = "RESTART_FLOW_ERROR"
def to_json(self):
return {"status": self.status}
class ConsumeCodePostIncorrectUserInputCodeError(APIResponse):
status: str = "INCORRECT_USER_INPUT_CODE_ERROR"
def __init__(
self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int
):
self.failed_code_input_attempt_count = failed_code_input_attempt_count
self.maximum_code_input_attempts = maximum_code_input_attempts
def to_json(self):
return {
"status": self.status,
"failedCodeInputAttemptCount": self.failed_code_input_attempt_count,
"maximumCodeInputAttempts": self.maximum_code_input_attempts,
}
class ConsumeCodePostExpiredUserInputCodeError(APIResponse):
status: str = "EXPIRED_USER_INPUT_CODE_ERROR"
def __init__(
self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int
):
self.failed_code_input_attempt_count = failed_code_input_attempt_count
self.maximum_code_input_attempts = maximum_code_input_attempts
def to_json(self):
return {
"status": self.status,
"failedCodeInputAttemptCount": self.failed_code_input_attempt_count,
"maximumCodeInputAttempts": self.maximum_code_input_attempts,
}
class PhoneNumberExistsGetOkResult(APIResponse):
status: str = "OK"
def __init__(self, exists: bool):
self.exists = exists
def to_json(self):
return {"status": self.status, "exists": self.exists}
class EmailExistsGetOkResult(APIResponse):
status: str = "OK"
def __init__(self, exists: bool):
self.exists = exists
def to_json(self):
return {"status": self.status, "exists": self.exists}
class APIInterface:
def __init__(self):
self.disable_create_code_post = False
self.disable_resend_code_post = False
self.disable_consume_code_post = False
self.disable_email_exists_get = False
self.disable_phone_number_exists_get = False
@abstractmethod
async def create_code_post(
self,
email: Union[str, None],
phone_number: Union[str, None],
tenant_id: str,
api_options: APIOptions,
user_context: Dict[str, Any],
) -> Union[CreateCodePostOkResult, GeneralErrorResponse]:
pass
@abstractmethod
async def resend_code_post(
self,
device_id: str,
pre_auth_session_id: str,
tenant_id: str,
api_options: APIOptions,
user_context: Dict[str, Any],
) -> Union[
ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse
]:
pass
@abstractmethod
async def consume_code_post(
self,
pre_auth_session_id: str,
user_input_code: Union[str, None],
device_id: Union[str, None],
link_code: Union[str, None],
tenant_id: str,
api_options: APIOptions,
user_context: Dict[str, Any],
) -> Union[
ConsumeCodePostOkResult,
ConsumeCodePostRestartFlowError,
GeneralErrorResponse,
ConsumeCodePostIncorrectUserInputCodeError,
ConsumeCodePostExpiredUserInputCodeError,
]:
pass
@abstractmethod
async def email_exists_get(
self,
email: str,
tenant_id: str,
api_options: APIOptions,
user_context: Dict[str, Any],
) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]:
pass
@abstractmethod
async def phone_number_exists_get(
self,
phone_number: str,
tenant_id: str,
api_options: APIOptions,
user_context: Dict[str, Any],
) -> Union[PhoneNumberExistsGetOkResult, GeneralErrorResponse]:
pass
Classes
class APIInterface
-
Expand source code
class APIInterface: def __init__(self): self.disable_create_code_post = False self.disable_resend_code_post = False self.disable_consume_code_post = False self.disable_email_exists_get = False self.disable_phone_number_exists_get = False @abstractmethod async def create_code_post( self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[CreateCodePostOkResult, GeneralErrorResponse]: pass @abstractmethod async def resend_code_post( self, device_id: str, pre_auth_session_id: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[ ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse ]: pass @abstractmethod async def consume_code_post( self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[ ConsumeCodePostOkResult, ConsumeCodePostRestartFlowError, GeneralErrorResponse, ConsumeCodePostIncorrectUserInputCodeError, ConsumeCodePostExpiredUserInputCodeError, ]: pass @abstractmethod async def email_exists_get( self, email: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]: pass @abstractmethod async def phone_number_exists_get( self, phone_number: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[PhoneNumberExistsGetOkResult, GeneralErrorResponse]: pass
Subclasses
Methods
async def consume_code_post(self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[ConsumeCodePostOkResult, ConsumeCodePostRestartFlowError, ConsumeCodePostIncorrectUserInputCodeError, ConsumeCodePostExpiredUserInputCodeError, GeneralErrorResponse]
-
Expand source code
@abstractmethod async def consume_code_post( self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[ ConsumeCodePostOkResult, ConsumeCodePostRestartFlowError, GeneralErrorResponse, ConsumeCodePostIncorrectUserInputCodeError, ConsumeCodePostExpiredUserInputCodeError, ]: pass
async def create_code_post(self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[CreateCodePostOkResult, GeneralErrorResponse]
-
Expand source code
@abstractmethod async def create_code_post( self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[CreateCodePostOkResult, GeneralErrorResponse]: pass
async def email_exists_get(self, email: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[EmailExistsGetOkResult, GeneralErrorResponse]
-
Expand source code
@abstractmethod async def email_exists_get( self, email: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]: pass
async def phone_number_exists_get(self, phone_number: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[PhoneNumberExistsGetOkResult, GeneralErrorResponse]
-
Expand source code
@abstractmethod async def phone_number_exists_get( self, phone_number: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[PhoneNumberExistsGetOkResult, GeneralErrorResponse]: pass
async def resend_code_post(self, device_id: str, pre_auth_session_id: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse]
-
Expand source code
@abstractmethod async def resend_code_post( self, device_id: str, pre_auth_session_id: str, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any], ) -> Union[ ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse ]: pass
class APIOptions (request: BaseRequest, response: BaseResponse, recipe_id: str, config: PasswordlessConfig, recipe_implementation: RecipeInterface, app_info: AppInfo, email_delivery: EmailDeliveryIngredient[PasswordlessLoginEmailTemplateVars], sms_delivery: SMSDeliveryIngredient[PasswordlessLoginSMSTemplateVars])
-
Expand source code
class APIOptions: def __init__( self, request: BaseRequest, response: BaseResponse, recipe_id: str, config: PasswordlessConfig, recipe_implementation: RecipeInterface, app_info: AppInfo, email_delivery: EmailDeliveryIngredient[PasswordlessLoginEmailTemplateVars], sms_delivery: SMSDeliveryIngredient[PasswordlessLoginSMSTemplateVars], ): self.request = request self.response = response self.recipe_id = recipe_id self.config = config self.recipe_implementation = recipe_implementation self.app_info = app_info self.email_delivery = email_delivery self.sms_delivery = sms_delivery
class ConsumeCodeExpiredUserInputCodeError (failed_code_input_attempt_count: int, maximum_code_input_attempts: int)
-
Expand source code
class ConsumeCodeExpiredUserInputCodeError: def __init__( self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int ): self.failed_code_input_attempt_count = failed_code_input_attempt_count self.maximum_code_input_attempts = maximum_code_input_attempts
class ConsumeCodeIncorrectUserInputCodeError (failed_code_input_attempt_count: int, maximum_code_input_attempts: int)
-
Expand source code
class ConsumeCodeIncorrectUserInputCodeError: def __init__( self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int ): self.failed_code_input_attempt_count = failed_code_input_attempt_count self.maximum_code_input_attempts = maximum_code_input_attempts
class ConsumeCodeOkResult (created_new_user: bool, user: User)
-
Expand source code
class ConsumeCodeOkResult: def __init__(self, created_new_user: bool, user: User): self.created_new_user = created_new_user self.user = user
class ConsumeCodePostExpiredUserInputCodeError (failed_code_input_attempt_count: int, maximum_code_input_attempts: int)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ConsumeCodePostExpiredUserInputCodeError(APIResponse): status: str = "EXPIRED_USER_INPUT_CODE_ERROR" def __init__( self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int ): self.failed_code_input_attempt_count = failed_code_input_attempt_count self.maximum_code_input_attempts = maximum_code_input_attempts def to_json(self): return { "status": self.status, "failedCodeInputAttemptCount": self.failed_code_input_attempt_count, "maximumCodeInputAttempts": self.maximum_code_input_attempts, }
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return { "status": self.status, "failedCodeInputAttemptCount": self.failed_code_input_attempt_count, "maximumCodeInputAttempts": self.maximum_code_input_attempts, }
class ConsumeCodePostIncorrectUserInputCodeError (failed_code_input_attempt_count: int, maximum_code_input_attempts: int)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ConsumeCodePostIncorrectUserInputCodeError(APIResponse): status: str = "INCORRECT_USER_INPUT_CODE_ERROR" def __init__( self, failed_code_input_attempt_count: int, maximum_code_input_attempts: int ): self.failed_code_input_attempt_count = failed_code_input_attempt_count self.maximum_code_input_attempts = maximum_code_input_attempts def to_json(self): return { "status": self.status, "failedCodeInputAttemptCount": self.failed_code_input_attempt_count, "maximumCodeInputAttempts": self.maximum_code_input_attempts, }
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return { "status": self.status, "failedCodeInputAttemptCount": self.failed_code_input_attempt_count, "maximumCodeInputAttempts": self.maximum_code_input_attempts, }
class ConsumeCodePostOkResult (created_new_user: bool, user: User, session: SessionContainer)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ConsumeCodePostOkResult(APIResponse): status: str = "OK" def __init__(self, created_new_user: bool, user: User, session: SessionContainer): self.created_new_user = created_new_user self.user = user self.session = session def to_json(self): user = {"id": self.user.user_id, "time_joined": self.user.time_joined} if self.user.email is not None: user = {**user, "email": self.user.email} if self.user.phone_number is not None: user = {**user, "phoneNumber": self.user.phone_number} return { "status": self.status, "createdNewUser": self.created_new_user, "user": user, }
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): user = {"id": self.user.user_id, "time_joined": self.user.time_joined} if self.user.email is not None: user = {**user, "email": self.user.email} if self.user.phone_number is not None: user = {**user, "phoneNumber": self.user.phone_number} return { "status": self.status, "createdNewUser": self.created_new_user, "user": user, }
class ConsumeCodePostRestartFlowError
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ConsumeCodePostRestartFlowError(APIResponse): status: str = "RESTART_FLOW_ERROR" def to_json(self): return {"status": self.status}
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return {"status": self.status}
class ConsumeCodeRestartFlowError
-
Expand source code
class ConsumeCodeRestartFlowError: pass
class CreateCodeOkResult (pre_auth_session_id: str, code_id: str, device_id: str, user_input_code: str, link_code: str, code_life_time: int, time_created: int)
-
Expand source code
class CreateCodeOkResult: def __init__( self, pre_auth_session_id: str, code_id: str, device_id: str, user_input_code: str, link_code: str, code_life_time: int, time_created: int, ): self.pre_auth_session_id = pre_auth_session_id self.code_id = code_id self.device_id = device_id self.user_input_code = user_input_code self.link_code = link_code self.code_life_time = code_life_time self.time_created = time_created
class CreateCodePostOkResult (device_id: str, pre_auth_session_id: str, flow_type: "Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK']")
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class CreateCodePostOkResult(APIResponse): status: str = "OK" def __init__( self, device_id: str, pre_auth_session_id: str, flow_type: Literal[ "USER_INPUT_CODE", "MAGIC_LINK", "USER_INPUT_CODE_AND_MAGIC_LINK" ], ): self.device_id = device_id self.pre_auth_session_id = pre_auth_session_id self.flow_type = flow_type def to_json(self): return { "status": self.status, "deviceId": self.device_id, "preAuthSessionId": self.pre_auth_session_id, "flowType": self.flow_type, }
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return { "status": self.status, "deviceId": self.device_id, "preAuthSessionId": self.pre_auth_session_id, "flowType": self.flow_type, }
class CreateNewCodeForDeviceOkResult (pre_auth_session_id: str, code_id: str, device_id: str, user_input_code: str, link_code: str, code_life_time: int, time_created: int)
-
Expand source code
class CreateNewCodeForDeviceOkResult: def __init__( self, pre_auth_session_id: str, code_id: str, device_id: str, user_input_code: str, link_code: str, code_life_time: int, time_created: int, ): self.pre_auth_session_id = pre_auth_session_id self.code_id = code_id self.device_id = device_id self.user_input_code = user_input_code self.link_code = link_code self.code_life_time = code_life_time self.time_created = time_created
class CreateNewCodeForDeviceRestartFlowError
-
Expand source code
class CreateNewCodeForDeviceRestartFlowError: pass
class CreateNewCodeForDeviceUserInputCodeAlreadyUsedError
-
Expand source code
class CreateNewCodeForDeviceUserInputCodeAlreadyUsedError: pass
class DeleteUserInfoOkResult
-
Expand source code
class DeleteUserInfoOkResult: pass
class DeleteUserInfoUnknownUserIdError
-
Expand source code
class DeleteUserInfoUnknownUserIdError: pass
class EmailExistsGetOkResult (exists: bool)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class EmailExistsGetOkResult(APIResponse): status: str = "OK" def __init__(self, exists: bool): self.exists = exists def to_json(self): return {"status": self.status, "exists": self.exists}
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return {"status": self.status, "exists": self.exists}
class PhoneNumberExistsGetOkResult (exists: bool)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class PhoneNumberExistsGetOkResult(APIResponse): status: str = "OK" def __init__(self, exists: bool): self.exists = exists def to_json(self): return {"status": self.status, "exists": self.exists}
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return {"status": self.status, "exists": self.exists}
class RecipeInterface
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class RecipeInterface(ABC): def __init__(self): pass @abstractmethod async def create_code( self, email: Union[None, str], phone_number: Union[None, str], user_input_code: Union[None, str], tenant_id: str, user_context: Dict[str, Any], ) -> CreateCodeOkResult: pass @abstractmethod async def create_new_code_for_device( self, device_id: str, user_input_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> Union[ CreateNewCodeForDeviceOkResult, CreateNewCodeForDeviceRestartFlowError, CreateNewCodeForDeviceUserInputCodeAlreadyUsedError, ]: pass @abstractmethod async def consume_code( self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> Union[ ConsumeCodeOkResult, ConsumeCodeIncorrectUserInputCodeError, ConsumeCodeExpiredUserInputCodeError, ConsumeCodeRestartFlowError, ]: pass @abstractmethod async def get_user_by_id( self, user_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass @abstractmethod async def get_user_by_email( self, email: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass @abstractmethod async def get_user_by_phone_number( self, phone_number: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass @abstractmethod async def update_user( self, user_id: str, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any], ) -> Union[ UpdateUserOkResult, UpdateUserUnknownUserIdError, UpdateUserEmailAlreadyExistsError, UpdateUserPhoneNumberAlreadyExistsError, ]: pass @abstractmethod async def delete_email_for_user( self, user_id: str, user_context: Dict[str, Any] ) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]: pass @abstractmethod async def delete_phone_number_for_user( self, user_id: str, user_context: Dict[str, Any] ) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]: pass @abstractmethod async def revoke_all_codes( self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> RevokeAllCodesOkResult: pass @abstractmethod async def revoke_code( self, code_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> RevokeCodeOkResult: pass @abstractmethod async def list_codes_by_email( self, email: str, tenant_id: str, user_context: Dict[str, Any] ) -> List[DeviceType]: pass @abstractmethod async def list_codes_by_phone_number( self, phone_number: str, tenant_id: str, user_context: Dict[str, Any] ) -> List[DeviceType]: pass @abstractmethod async def list_codes_by_device_id( self, device_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[DeviceType, None]: pass @abstractmethod async def list_codes_by_pre_auth_session_id( self, pre_auth_session_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[DeviceType, None]: pass
Ancestors
- abc.ABC
Subclasses
Methods
async def consume_code(self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any]) ‑> Union[ConsumeCodeOkResult, ConsumeCodeIncorrectUserInputCodeError, ConsumeCodeExpiredUserInputCodeError, ConsumeCodeRestartFlowError]
-
Expand source code
@abstractmethod async def consume_code( self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> Union[ ConsumeCodeOkResult, ConsumeCodeIncorrectUserInputCodeError, ConsumeCodeExpiredUserInputCodeError, ConsumeCodeRestartFlowError, ]: pass
async def create_code(self, email: Union[None, str], phone_number: Union[None, str], user_input_code: Union[None, str], tenant_id: str, user_context: Dict[str, Any]) ‑> CreateCodeOkResult
-
Expand source code
@abstractmethod async def create_code( self, email: Union[None, str], phone_number: Union[None, str], user_input_code: Union[None, str], tenant_id: str, user_context: Dict[str, Any], ) -> CreateCodeOkResult: pass
async def create_new_code_for_device(self, device_id: str, user_input_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any]) ‑> Union[CreateNewCodeForDeviceOkResult, CreateNewCodeForDeviceRestartFlowError, CreateNewCodeForDeviceUserInputCodeAlreadyUsedError]
-
Expand source code
@abstractmethod async def create_new_code_for_device( self, device_id: str, user_input_code: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> Union[ CreateNewCodeForDeviceOkResult, CreateNewCodeForDeviceRestartFlowError, CreateNewCodeForDeviceUserInputCodeAlreadyUsedError, ]: pass
async def delete_email_for_user(self, user_id: str, user_context: Dict[str, Any]) ‑> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]
-
Expand source code
@abstractmethod async def delete_email_for_user( self, user_id: str, user_context: Dict[str, Any] ) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]: pass
async def delete_phone_number_for_user(self, user_id: str, user_context: Dict[str, Any]) ‑> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]
-
Expand source code
@abstractmethod async def delete_phone_number_for_user( self, user_id: str, user_context: Dict[str, Any] ) -> Union[DeleteUserInfoOkResult, DeleteUserInfoUnknownUserIdError]: pass
async def get_user_by_email(self, email: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Optional[User]
-
Expand source code
@abstractmethod async def get_user_by_email( self, email: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass
async def get_user_by_id(self, user_id: str, user_context: Dict[str, Any]) ‑> Optional[User]
-
Expand source code
@abstractmethod async def get_user_by_id( self, user_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass
async def get_user_by_phone_number(self, phone_number: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Optional[User]
-
Expand source code
@abstractmethod async def get_user_by_phone_number( self, phone_number: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[User, None]: pass
async def list_codes_by_device_id(self, device_id: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Optional[DeviceType]
-
Expand source code
@abstractmethod async def list_codes_by_device_id( self, device_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[DeviceType, None]: pass
async def list_codes_by_email(self, email: str, tenant_id: str, user_context: Dict[str, Any]) ‑> List[DeviceType]
-
Expand source code
@abstractmethod async def list_codes_by_email( self, email: str, tenant_id: str, user_context: Dict[str, Any] ) -> List[DeviceType]: pass
async def list_codes_by_phone_number(self, phone_number: str, tenant_id: str, user_context: Dict[str, Any]) ‑> List[DeviceType]
-
Expand source code
@abstractmethod async def list_codes_by_phone_number( self, phone_number: str, tenant_id: str, user_context: Dict[str, Any] ) -> List[DeviceType]: pass
async def list_codes_by_pre_auth_session_id(self, pre_auth_session_id: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Optional[DeviceType]
-
Expand source code
@abstractmethod async def list_codes_by_pre_auth_session_id( self, pre_auth_session_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> Union[DeviceType, None]: pass
async def revoke_all_codes(self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, user_context: Dict[str, Any]) ‑> RevokeAllCodesOkResult
-
Expand source code
@abstractmethod async def revoke_all_codes( self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, user_context: Dict[str, Any], ) -> RevokeAllCodesOkResult: pass
async def revoke_code(self, code_id: str, tenant_id: str, user_context: Dict[str, Any]) ‑> RevokeCodeOkResult
-
Expand source code
@abstractmethod async def revoke_code( self, code_id: str, tenant_id: str, user_context: Dict[str, Any] ) -> RevokeCodeOkResult: pass
async def update_user(self, user_id: str, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) ‑> Union[UpdateUserOkResult, UpdateUserUnknownUserIdError, UpdateUserEmailAlreadyExistsError, UpdateUserPhoneNumberAlreadyExistsError]
-
Expand source code
@abstractmethod async def update_user( self, user_id: str, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any], ) -> Union[ UpdateUserOkResult, UpdateUserUnknownUserIdError, UpdateUserEmailAlreadyExistsError, UpdateUserPhoneNumberAlreadyExistsError, ]: pass
class ResendCodePostOkResult
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ResendCodePostOkResult(APIResponse): status: str = "OK" def to_json(self): return {"status": self.status}
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return {"status": self.status}
class ResendCodePostRestartFlowError
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ResendCodePostRestartFlowError(APIResponse): status: str = "RESTART_FLOW_ERROR" def to_json(self): return {"status": self.status}
Ancestors
- APIResponse
- abc.ABC
Class variables
var status : str
Methods
def to_json(self)
-
Expand source code
def to_json(self): return {"status": self.status}
class RevokeAllCodesOkResult
-
Expand source code
class RevokeAllCodesOkResult: pass
class RevokeCodeOkResult
-
Expand source code
class RevokeCodeOkResult: pass
class UpdateUserEmailAlreadyExistsError
-
Expand source code
class UpdateUserEmailAlreadyExistsError: pass
class UpdateUserOkResult
-
Expand source code
class UpdateUserOkResult: pass
class UpdateUserPhoneNumberAlreadyExistsError
-
Expand source code
class UpdateUserPhoneNumberAlreadyExistsError: pass
class UpdateUserUnknownUserIdError
-
Expand source code
class UpdateUserUnknownUserIdError: pass