Module supertokens_python.recipe.thirdpartypasswordless

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, List, Union

from supertokens_python.ingredients.emaildelivery.types import EmailDeliveryConfig
from supertokens_python.ingredients.smsdelivery.types import SMSDeliveryConfig
from supertokens_python.recipe.thirdparty import provider
from typing_extensions import Literal

from .. import passwordless
from . import exceptions as ex
from . import utils
from .emaildelivery import services as emaildelivery_services
from .recipe import ThirdPartyPasswordlessRecipe
from .smsdelivery import services as smsdelivery_services
from .types import EmailTemplateVars, SMSTemplateVars
from supertokens_python.ingredients.emaildelivery import types as emaildelivery_types
from supertokens_python.ingredients.smsdelivery import types as smsdelivery_types

InputOverrideConfig = utils.InputOverrideConfig
exceptions = ex
ContactConfig = passwordless.ContactConfig
PhoneOrEmailInput = passwordless.PhoneOrEmailInput
ContactPhoneOnlyConfig = passwordless.ContactPhoneOnlyConfig
ContactEmailOnlyConfig = passwordless.ContactEmailOnlyConfig
ContactEmailOrPhoneConfig = passwordless.ContactEmailOrPhoneConfig
SMTPService = emaildelivery_services.SMTPService
TwilioService = smsdelivery_services.TwilioService
SuperTokensSMSService = smsdelivery_services.SuperTokensSMSService
ProviderInput = provider.ProviderInput
ProviderConfig = provider.ProviderConfig
ProviderClientConfig = provider.ProviderClientConfig
ProviderConfigForClientType = provider.ProviderConfigForClient
EmailDeliveryInterface = emaildelivery_types.EmailDeliveryInterface
SMSDeliveryInterface = smsdelivery_types.SMSDeliveryInterface

if TYPE_CHECKING:
    from supertokens_python.supertokens import AppInfo

    from ...recipe_module import RecipeModule


def init(
    contact_config: ContactConfig,
    flow_type: Literal[
        "USER_INPUT_CODE", "MAGIC_LINK", "USER_INPUT_CODE_AND_MAGIC_LINK"
    ],
    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,
    override: Union[InputOverrideConfig, None] = None,
    providers: Union[List[ProviderInput], None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return ThirdPartyPasswordlessRecipe.init(
        contact_config,
        flow_type,
        get_custom_user_input_code,
        email_delivery,
        sms_delivery,
        override,
        providers,
    )

Sub-modules

supertokens_python.recipe.thirdpartypasswordless.api
supertokens_python.recipe.thirdpartypasswordless.asyncio
supertokens_python.recipe.thirdpartypasswordless.emaildelivery
supertokens_python.recipe.thirdpartypasswordless.exceptions
supertokens_python.recipe.thirdpartypasswordless.interfaces
supertokens_python.recipe.thirdpartypasswordless.recipe
supertokens_python.recipe.thirdpartypasswordless.recipeimplementation
supertokens_python.recipe.thirdpartypasswordless.smsdelivery
supertokens_python.recipe.thirdpartypasswordless.syncio
supertokens_python.recipe.thirdpartypasswordless.types
supertokens_python.recipe.thirdpartypasswordless.utils

Functions

def init(contact_config: ContactConfig, flow_type: "Literal[('USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK')]", 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, override: Union[InputOverrideConfig, None] = None, providers: Union[List[ProviderInput], 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"
    ],
    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,
    override: Union[InputOverrideConfig, None] = None,
    providers: Union[List[ProviderInput], None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return ThirdPartyPasswordlessRecipe.init(
        contact_config,
        flow_type,
        get_custom_user_input_code,
        email_delivery,
        sms_delivery,
        override,
        providers,
    )