Module `supertokens_python.ingredients.smsdelivery.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 abc import ABC, abstractmethod
from typing import Any, Callable, Dict, Generic, TypeVar, Union

_T = TypeVar('_T')


class SMSDeliveryInterface(ABC, Generic[_T]):
    @abstractmethod
    async def send_sms(self, input_: _T, user_context: Dict[str, Any]) -> None:
        pass


class SMSDeliveryConfig(ABC, Generic[_T]):
    def __init__(
        self, service: Union[SMSDeliveryInterface[_T], None] = None,
        override: Union[Callable[[SMSDeliveryInterface[_T]], SMSDeliveryInterface[_T]], None] = None,
    ) -> None:
        self.service = service
        self.override = override


class SMSDeliveryConfigWithService(ABC, Generic[_T]):
    def __init__(
        self, service: SMSDeliveryInterface[_T],
        override: Union[Callable[[SMSDeliveryInterface[_T]], SMSDeliveryInterface[_T]], None] = None,
    ) -> None:
        self.service = service
        self.override = override

Classes

class SMSDeliveryConfig (service: Optional[SMSDeliveryInterface[~_T]] = None, override: Optional[Callable[[SMSDeliveryInterface[~_T]], SMSDeliveryInterface[~_T]]] = None)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class SMSDeliveryConfig(ABC, Generic[_T]):
    def __init__(
        self, service: Union[SMSDeliveryInterface[_T], None] = None,
        override: Union[Callable[[SMSDeliveryInterface[_T]], SMSDeliveryInterface[_T]], None] = None,
    ) -> None:
        self.service = service
        self.override = override

Ancestors

abc.ABC
typing.Generic

class SMSDeliveryConfigWithService (service: SMSDeliveryInterface[~_T], override: Optional[Callable[[SMSDeliveryInterface[~_T]], SMSDeliveryInterface[~_T]]] = None)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class SMSDeliveryConfigWithService(ABC, Generic[_T]):
    def __init__(
        self, service: SMSDeliveryInterface[_T],
        override: Union[Callable[[SMSDeliveryInterface[_T]], SMSDeliveryInterface[_T]], None] = None,
    ) -> None:
        self.service = service
        self.override = override

Ancestors

abc.ABC
typing.Generic

class SMSDeliveryInterface

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class SMSDeliveryInterface(ABC, Generic[_T]):
    @abstractmethod
    async def send_sms(self, input_: _T, user_context: Dict[str, Any]) -> None:
        pass

Ancestors

abc.ABC
typing.Generic

Subclasses

Methods

async def send_sms(self, input_: ~_T, user_context: Dict[str, Any]) ‑> None

Expand source code

@abstractmethod
async def send_sms(self, input_: _T, user_context: Dict[str, Any]) -> None:
    pass