Module `supertokens_python.recipe.emailpassword.syncio`

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 Any, Dict, Union

from supertokens_python.async_to_sync_wrapper import sync

from ..interfaces import SignInOkResult, SignInWrongCredentialsError
from ..types import EmailTemplateVars, User


def create_email_verification_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        create_email_verification_token,
    )

    return sync(create_email_verification_token(user_id, user_context))


def verify_email_using_token(
    token: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import verify_email_using_token

    return sync(verify_email_using_token(token, user_context))


def unverify_email(user_id: str, user_context: Union[None, Dict[str, Any]] = None):
    from supertokens_python.recipe.emailpassword.asyncio import unverify_email

    return sync(unverify_email(user_id, user_context))


def is_email_verified(user_id: str, user_context: Union[None, Dict[str, Any]] = None):
    from supertokens_python.recipe.emailpassword.asyncio import is_email_verified

    return sync(is_email_verified(user_id, user_context))


def update_email_or_password(
    user_id: str,
    email: Union[str, None] = None,
    password: Union[str, None] = None,
    user_context: Union[None, Dict[str, Any]] = None,
):
    from supertokens_python.recipe.emailpassword.asyncio import update_email_or_password

    return sync(update_email_or_password(user_id, email, password, user_context))


def get_user_by_id(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[None, User]:
    from supertokens_python.recipe.emailpassword.asyncio import get_user_by_id

    return sync(get_user_by_id(user_id, user_context))


def get_user_by_email(
    email: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[None, User]:
    from supertokens_python.recipe.emailpassword.asyncio import get_user_by_email

    return sync(get_user_by_email(email, user_context))


def create_reset_password_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        create_reset_password_token,
    )

    return sync(create_reset_password_token(user_id, user_context))


def reset_password_using_token(
    token: str, new_password: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        reset_password_using_token,
    )

    return sync(reset_password_using_token(token, new_password, user_context))


def sign_in(
    email: str, password: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[SignInOkResult, SignInWrongCredentialsError]:
    from supertokens_python.recipe.emailpassword.asyncio import sign_in

    return sync(sign_in(email, password, user_context))


def sign_up(
    email: str, password: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import sign_up

    return sync(sign_up(email, password, user_context))


def revoke_email_verification_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        revoke_email_verification_token,
    )

    return sync(revoke_email_verification_token(user_id, user_context))


def send_email(
    input_: EmailTemplateVars, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import send_email

    return sync(send_email(input_, user_context))

Functions

def create_email_verification_token(user_id: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def create_email_verification_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        create_email_verification_token,
    )

    return sync(create_email_verification_token(user_id, user_context))

def create_reset_password_token(user_id: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def create_reset_password_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        create_reset_password_token,
    )

    return sync(create_reset_password_token(user_id, user_context))

def get_user_by_email(email: str, user_context: Optional[Dict[str, Any]] = None) ‑> Optional[User]

Expand source code

def get_user_by_email(
    email: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[None, User]:
    from supertokens_python.recipe.emailpassword.asyncio import get_user_by_email

    return sync(get_user_by_email(email, user_context))

def get_user_by_id(user_id: str, user_context: Optional[Dict[str, Any]] = None) ‑> Optional[User]

Expand source code

def get_user_by_id(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[None, User]:
    from supertokens_python.recipe.emailpassword.asyncio import get_user_by_id

    return sync(get_user_by_id(user_id, user_context))

def is_email_verified(user_id: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def is_email_verified(user_id: str, user_context: Union[None, Dict[str, Any]] = None):
    from supertokens_python.recipe.emailpassword.asyncio import is_email_verified

    return sync(is_email_verified(user_id, user_context))

def reset_password_using_token(token: str, new_password: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def reset_password_using_token(
    token: str, new_password: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        reset_password_using_token,
    )

    return sync(reset_password_using_token(token, new_password, user_context))

def revoke_email_verification_token(user_id: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def revoke_email_verification_token(
    user_id: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import (
        revoke_email_verification_token,
    )

    return sync(revoke_email_verification_token(user_id, user_context))

def send_email(input_: Union[PasswordResetEmailTemplateVars, VerificationEmailTemplateVars], user_context: Optional[Dict[str, Any]] = None)

Expand source code

def send_email(
    input_: EmailTemplateVars, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import send_email

    return sync(send_email(input_, user_context))

def sign_in(email: str, password: str, user_context: Optional[Dict[str, Any]] = None) ‑> Union[SignInOkResult, SignInWrongCredentialsError]

Expand source code

def sign_in(
    email: str, password: str, user_context: Union[None, Dict[str, Any]] = None
) -> Union[SignInOkResult, SignInWrongCredentialsError]:
    from supertokens_python.recipe.emailpassword.asyncio import sign_in

    return sync(sign_in(email, password, user_context))

def sign_up(email: str, password: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def sign_up(
    email: str, password: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import sign_up

    return sync(sign_up(email, password, user_context))

def unverify_email(user_id: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def unverify_email(user_id: str, user_context: Union[None, Dict[str, Any]] = None):
    from supertokens_python.recipe.emailpassword.asyncio import unverify_email

    return sync(unverify_email(user_id, user_context))

def update_email_or_password(user_id: str, email: Optional[str] = None, password: Optional[str] = None, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def update_email_or_password(
    user_id: str,
    email: Union[str, None] = None,
    password: Union[str, None] = None,
    user_context: Union[None, Dict[str, Any]] = None,
):
    from supertokens_python.recipe.emailpassword.asyncio import update_email_or_password

    return sync(update_email_or_password(user_id, email, password, user_context))

def verify_email_using_token(token: str, user_context: Optional[Dict[str, Any]] = None)

Expand source code

def verify_email_using_token(
    token: str, user_context: Union[None, Dict[str, Any]] = None
):
    from supertokens_python.recipe.emailpassword.asyncio import verify_email_using_token

    return sync(verify_email_using_token(token, user_context))