Module supertokens_python.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 typing import Union

type_string = {
    'type': 'string'
}

type_boolean = {
    'type': 'boolean'
}

INPUT_SCHEMA = {
    'type': 'object',
    'properties': {
        'supertokens': {
            'type': 'object',
            'properties': {
                'connection_uri': type_string,
                'api_key': type_string
            },
            'required': ['connection_uri'],
            'additionalProperties': False
        },
        'app_info': {
            'type': 'object',
            'properties': {
                'app_name': type_string,
                'website_domain': type_string,
                'api_domain': type_string,
                'api_base_path': type_string,
                'website_base_path': type_string,
                'api_gateway_path': type_string
            },
            'required': ['app_name', 'website_domain', 'api_domain'],
            'additionalProperties': False
        },
        'framework': {
            'type': 'string'
        },
        'mode': {
            'type': 'string',
            'enum': ['asgi', 'wsgi']
        },
        'recipe_list': {
            'type': 'array'
        },
        'telemetry': type_boolean
    },
    'required': ['supertokens', 'app_info', 'recipe_list', 'framework'],
    'additional_properties': False
}


class UsersResponse:
    def __init__(self, users,
                 next_pagination_token: Union[str, None]):
        self.users = users
        self.next_pagination_token = next_pagination_token


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


class User:
    def __init__(self, recipe_id: str, user_id: str, email: str, time_joined: int,
                 third_party_info: Union[ThirdPartyInfo, None] = None):
        self.recipe_id = recipe_id
        self.user_id = user_id
        self.email = email
        self.time_joined = time_joined
        self.third_party_info = third_party_info

Classes

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
class User (recipe_id: str, user_id: str, email: str, time_joined: int, third_party_info: Optional[ThirdPartyInfo] = None)
Expand source code
class User:
    def __init__(self, recipe_id: str, user_id: str, email: str, time_joined: int,
                 third_party_info: Union[ThirdPartyInfo, None] = None):
        self.recipe_id = recipe_id
        self.user_id = user_id
        self.email = email
        self.time_joined = time_joined
        self.third_party_info = third_party_info
class UsersResponse (users, next_pagination_token: Optional[str])
Expand source code
class UsersResponse:
    def __init__(self, users,
                 next_pagination_token: Union[str, None]):
        self.users = users
        self.next_pagination_token = next_pagination_token