Module supertokens_python.recipe.passwordless

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 typing import Union, Callable, Awaitable
try:
    from typing import Literal
except ImportError:
    from typing_extensions import Literal

from .utils import ContactConfig, OverrideConfig as InputOverrideConfig, ContactPhoneOnlyConfig, \
    ContactEmailOnlyConfig, ContactEmailOrPhoneConfig, CreateAndSendCustomTextMessageParameters, \
    CreateAndSendCustomEmailParameters

from .recipe import PasswordlessRecipe


def init(contact_config: ContactConfig,
         flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
         override: Union[InputOverrideConfig, None] = None,
         get_link_domain_and_path: Union[Callable[[str], Awaitable[Union[str, None]]]] = None,
         get_custom_user_input_code: Union[Callable[[], Awaitable[str]], None] = None):
    return PasswordlessRecipe.init(contact_config,
                                   flow_type,
                                   override,
                                   get_link_domain_and_path,
                                   get_custom_user_input_code)

Sub-modules

supertokens_python.recipe.passwordless.api
supertokens_python.recipe.passwordless.asyncio
supertokens_python.recipe.passwordless.constants
supertokens_python.recipe.passwordless.exceptions
supertokens_python.recipe.passwordless.interfaces
supertokens_python.recipe.passwordless.recipe
supertokens_python.recipe.passwordless.recipe_implementation
supertokens_python.recipe.passwordless.syncio
supertokens_python.recipe.passwordless.types
supertokens_python.recipe.passwordless.utils

Functions

def init(contact_config: ContactConfig, flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'], override: Optional[OverrideConfig] = None, get_link_domain_and_path: Callable[[str], Awaitable[Optional[str]]] = None, get_custom_user_input_code: Optional[Callable[[], Awaitable[str]]] = None)
Expand source code
def init(contact_config: ContactConfig,
         flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
         override: Union[InputOverrideConfig, None] = None,
         get_link_domain_and_path: Union[Callable[[str], Awaitable[Union[str, None]]]] = None,
         get_custom_user_input_code: Union[Callable[[], Awaitable[str]], None] = None):
    return PasswordlessRecipe.init(contact_config,
                                   flow_type,
                                   override,
                                   get_link_domain_and_path,
                                   get_custom_user_input_code)