Module `supertokens_python.recipe.thirdparty.types`

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

from supertokens_python.framework.request import BaseRequest

if TYPE_CHECKING:
    from supertokens_python.types import User


class ThirdPartyInfo:
    def __init__(self, third_party_user_id: str, third_party_id: str):
        self.user_id = third_party_user_id
        self.id = third_party_id

    def __eq__(self, other: object) -> bool:
        return (
            isinstance(other, self.__class__)
            and self.user_id == other.user_id
            and self.id == other.id
        )

    def to_json(self) -> Dict[str, Any]:
        return {"userId": self.user_id, "id": self.id}

    @staticmethod
    def from_json(json: Dict[str, Any]) -> "ThirdPartyInfo":
        return ThirdPartyInfo(json["userId"], json["id"])


class RawUserInfoFromProvider:
    def __init__(
        self,
        from_id_token_payload: Optional[Dict[str, Any]],
        from_user_info_api: Optional[Dict[str, Any]],
    ):
        self.from_id_token_payload = from_id_token_payload
        self.from_user_info_api = from_user_info_api

    def to_json(self) -> Dict[str, Any]:
        return {
            "fromIdTokenPayload": self.from_id_token_payload,
            "fromUserInfoApi": self.from_user_info_api,
        }


class UserInfoEmail:
    def __init__(self, email: str, is_verified: bool):
        self.id: str = email
        self.is_verified: bool = is_verified

    def to_json(self) -> Dict[str, Any]:
        return {"id": self.id, "isVerified": self.is_verified}


class UserInfo:
    def __init__(
        self,
        third_party_user_id: str,
        email: Union[UserInfoEmail, None] = None,
        raw_user_info_from_provider: Optional[RawUserInfoFromProvider] = None,
    ):
        self.third_party_user_id: str = third_party_user_id
        self.email: Union[UserInfoEmail, None] = email
        self.raw_user_info_from_provider = (
            raw_user_info_from_provider or RawUserInfoFromProvider({}, {})
        )

    def to_json(self) -> Dict[str, Any]:
        return {
            "thirdPartyUserId": self.third_party_user_id,
            "email": self.email.to_json() if self.email is not None else None,
            "rawUserInfoFromProvider": self.raw_user_info_from_provider.to_json(),
        }


class AccessTokenAPI:
    def __init__(self, url: str, params: Dict[str, str]):
        self.url = url
        self.params = params


class AuthorisationRedirectAPI:
    def __init__(
        self, url: str, params: Dict[str, Union[Callable[[BaseRequest], str], str]]
    ):
        self.url = url
        self.params = params


class SignInUpResponse:
    def __init__(self, user: User, is_new_user: bool):
        self.user = user
        self.is_new_user = is_new_user


class ThirdPartyIngredients:
    pass

Classes

class AccessTokenAPI (url: str, params: Dict[str, str])

Expand source code

class AccessTokenAPI:
    def __init__(self, url: str, params: Dict[str, str]):
        self.url = url
        self.params = params

class AuthorisationRedirectAPI (url: str, params: Dict[str, Union[Callable[[BaseRequest], str], str]])

Expand source code

class AuthorisationRedirectAPI:
    def __init__(
        self, url: str, params: Dict[str, Union[Callable[[BaseRequest], str], str]]
    ):
        self.url = url
        self.params = params

class RawUserInfoFromProvider (from_id_token_payload: Optional[Dict[str, Any]], from_user_info_api: Optional[Dict[str, Any]])

Expand source code

class RawUserInfoFromProvider:
    def __init__(
        self,
        from_id_token_payload: Optional[Dict[str, Any]],
        from_user_info_api: Optional[Dict[str, Any]],
    ):
        self.from_id_token_payload = from_id_token_payload
        self.from_user_info_api = from_user_info_api

    def to_json(self) -> Dict[str, Any]:
        return {
            "fromIdTokenPayload": self.from_id_token_payload,
            "fromUserInfoApi": self.from_user_info_api,
        }

Methods

def to_json(self) ‑> Dict[str, Any]

Expand source code

def to_json(self) -> Dict[str, Any]:
    return {
        "fromIdTokenPayload": self.from_id_token_payload,
        "fromUserInfoApi": self.from_user_info_api,
    }

class SignInUpResponse (user: User, is_new_user: bool)

Expand source code

class SignInUpResponse:
    def __init__(self, user: User, is_new_user: bool):
        self.user = user
        self.is_new_user = is_new_user

class ThirdPartyInfo (third_party_user_id: str, third_party_id: str)

Expand source code

class ThirdPartyInfo:
    def __init__(self, third_party_user_id: str, third_party_id: str):
        self.user_id = third_party_user_id
        self.id = third_party_id

    def __eq__(self, other: object) -> bool:
        return (
            isinstance(other, self.__class__)
            and self.user_id == other.user_id
            and self.id == other.id
        )

    def to_json(self) -> Dict[str, Any]:
        return {"userId": self.user_id, "id": self.id}

    @staticmethod
    def from_json(json: Dict[str, Any]) -> "ThirdPartyInfo":
        return ThirdPartyInfo(json["userId"], json["id"])

Static methods

def from_json(json: Dict[str, Any]) ‑> ThirdPartyInfo

Expand source code

@staticmethod
def from_json(json: Dict[str, Any]) -> "ThirdPartyInfo":
    return ThirdPartyInfo(json["userId"], json["id"])

Methods

def to_json(self) ‑> Dict[str, Any]

Expand source code

def to_json(self) -> Dict[str, Any]:
    return {"userId": self.user_id, "id": self.id}

class ThirdPartyIngredients

Expand source code

class ThirdPartyIngredients:
    pass

class UserInfo (third_party_user_id: str, email: Union[UserInfoEmail, None] = None, raw_user_info_from_provider: Optional[RawUserInfoFromProvider] = None)

Expand source code

class UserInfo:
    def __init__(
        self,
        third_party_user_id: str,
        email: Union[UserInfoEmail, None] = None,
        raw_user_info_from_provider: Optional[RawUserInfoFromProvider] = None,
    ):
        self.third_party_user_id: str = third_party_user_id
        self.email: Union[UserInfoEmail, None] = email
        self.raw_user_info_from_provider = (
            raw_user_info_from_provider or RawUserInfoFromProvider({}, {})
        )

    def to_json(self) -> Dict[str, Any]:
        return {
            "thirdPartyUserId": self.third_party_user_id,
            "email": self.email.to_json() if self.email is not None else None,
            "rawUserInfoFromProvider": self.raw_user_info_from_provider.to_json(),
        }

Methods

def to_json(self) ‑> Dict[str, Any]

Expand source code

def to_json(self) -> Dict[str, Any]:
    return {
        "thirdPartyUserId": self.third_party_user_id,
        "email": self.email.to_json() if self.email is not None else None,
        "rawUserInfoFromProvider": self.raw_user_info_from_provider.to_json(),
    }

class UserInfoEmail (email: str, is_verified: bool)

Expand source code

class UserInfoEmail:
    def __init__(self, email: str, is_verified: bool):
        self.id: str = email
        self.is_verified: bool = is_verified

    def to_json(self) -> Dict[str, Any]:
        return {"id": self.id, "isVerified": self.is_verified}

Methods

def to_json(self) ‑> Dict[str, Any]

Expand source code

def to_json(self) -> Dict[str, Any]:
    return {"id": self.id, "isVerified": self.is_verified}