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 __future__ import annotations

from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, Union

from supertokens_python.ingredients.emaildelivery.types import EmailDeliveryConfig
from supertokens_python.ingredients.smsdelivery.types import SMSDeliveryConfig
from supertokens_python.recipe.passwordless.types import (
    EmailTemplateVars,
    SMSTemplateVars,
)
from typing_extensions import Literal

from . import types, utils
from .emaildelivery import services as emaildelivery_services
from .recipe import PasswordlessRecipe
from .smsdelivery import services as smsdelivery_services

if TYPE_CHECKING:
    from supertokens_python.supertokens import AppInfo

    from ...recipe_module import RecipeModule

InputOverrideConfig = utils.OverrideConfig
ContactEmailOnlyConfig = utils.ContactEmailOnlyConfig
ContactConfig = utils.ContactConfig
PhoneOrEmailInput = utils.PhoneOrEmailInput
CreateAndSendCustomTextMessageParameters = (
    types.CreateAndSendCustomTextMessageParameters
)
CreateAndSendCustomEmailParameters = types.CreateAndSendCustomEmailParameters
ContactPhoneOnlyConfig = utils.ContactPhoneOnlyConfig
ContactEmailOrPhoneConfig = utils.ContactEmailOrPhoneConfig
SMTPService = emaildelivery_services.SMTPService
TwilioService = smsdelivery_services.TwilioService
SuperTokensSMSService = smsdelivery_services.SuperTokensSMSService
EmailDeliveryInterface = types.EmailDeliveryInterface
SMSDeliveryInterface = types.SMSDeliveryInterface


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_custom_user_input_code: Union[
        Callable[[str, Dict[str, Any]], Awaitable[str]], None
    ] = None,
    email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None,
    sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return PasswordlessRecipe.init(
        contact_config,
        flow_type,
        override,
        get_custom_user_input_code,
        email_delivery,
        sms_delivery,
    )

Sub-modules

supertokens_python.recipe.passwordless.api
supertokens_python.recipe.passwordless.asyncio
supertokens_python.recipe.passwordless.constants
supertokens_python.recipe.passwordless.emaildelivery
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.smsdelivery
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: Union[InputOverrideConfig, None] = None, get_custom_user_input_code: Union[Callable[[str, Dict[str, Any]], Awaitable[str]], None] = None, email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None, sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None) ‑> Callable[[AppInfo], RecipeModule]
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_custom_user_input_code: Union[
        Callable[[str, Dict[str, Any]], Awaitable[str]], None
    ] = None,
    email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None,
    sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return PasswordlessRecipe.init(
        contact_config,
        flow_type,
        override,
        get_custom_user_input_code,
        email_delivery,
        sms_delivery,
    )