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

from twilio.rest import Client  # type: ignore

_T = TypeVar("_T")


class SMSDeliveryInterface(ABC, Generic[_T]):
    @abstractmethod
    async def send_sms(self, template_vars: _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


class TwilioSettings:
    def __init__(
        self,
        account_sid: str,
        auth_token: str,
        from_: Union[str, None] = None,
        messaging_service_sid: Union[str, None] = None,
        opts: Union[Dict[str, Any], None] = None,
    ) -> None:
        """
        Note: `self.otps` can be used to override values passed to the Twilio Client.
        Read docs from `twilio.rest.Client.__init__` to discover possible args.

        For example, `opts = {"region": "...", "user_agent_extensions": ["..."], }`
        """
        self.account_sid = account_sid
        self.auth_token = auth_token
        self.from_ = from_
        self.messaging_service_sid = messaging_service_sid
        self.opts = opts


class SMSContent:
    def __init__(self, body: str, to_phone: str) -> None:
        self.body = body
        self.to_phone = to_phone


class TwilioServiceInterface(ABC, Generic[_T]):
    def __init__(self, twilio_client: Client) -> None:  # type: ignore
        self.twilio_client = twilio_client  # type: ignore

    @abstractmethod
    async def send_raw_sms(
        self,
        content: SMSContent,
        user_context: Dict[str, Any],
        from_: Union[str, None] = None,
        messaging_service_sid: Union[str, None] = None,
    ) -> None:
        pass

    @abstractmethod
    async def get_content(
        self, template_vars: _T, user_context: Dict[str, Any]
    ) -> SMSContent:
        pass

Classes

class SMSContent (body: str, to_phone: str)

Expand source code

class SMSContent:
    def __init__(self, body: str, to_phone: str) -> None:
        self.body = body
        self.to_phone = to_phone

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, template_vars: _T, user_context: Dict[str, Any]) -> None:
        pass

Ancestors

abc.ABC
typing.Generic

Subclasses

Methods

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

Expand source code

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

class TwilioServiceInterface (twilio_client: twilio.rest.Client)

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

Expand source code

class TwilioServiceInterface(ABC, Generic[_T]):
    def __init__(self, twilio_client: Client) -> None:  # type: ignore
        self.twilio_client = twilio_client  # type: ignore

    @abstractmethod
    async def send_raw_sms(
        self,
        content: SMSContent,
        user_context: Dict[str, Any],
        from_: Union[str, None] = None,
        messaging_service_sid: Union[str, None] = None,
    ) -> None:
        pass

    @abstractmethod
    async def get_content(
        self, template_vars: _T, user_context: Dict[str, Any]
    ) -> SMSContent:
        pass

Ancestors

abc.ABC
typing.Generic

Subclasses

ServiceImplementation

Methods

async def get_content(self, template_vars: ~_T, user_context: Dict[str, Any]) ‑> SMSContent

Expand source code

@abstractmethod
async def get_content(
    self, template_vars: _T, user_context: Dict[str, Any]
) -> SMSContent:
    pass

async def send_raw_sms(self, content: SMSContent, user_context: Dict[str, Any], from_: Optional[str] = None, messaging_service_sid: Optional[str] = None) ‑> None

Expand source code

@abstractmethod
async def send_raw_sms(
    self,
    content: SMSContent,
    user_context: Dict[str, Any],
    from_: Union[str, None] = None,
    messaging_service_sid: Union[str, None] = None,
) -> None:
    pass

class TwilioSettings (account_sid: str, auth_token: str, from_: Optional[str] = None, messaging_service_sid: Optional[str] = None, opts: Optional[Dict[str, Any]] = None)

Note: self.otps can be used to override values passed to the Twilio Client. Read docs from twilio.rest.Client.__init__ to discover possible args.

For example, opts = {"region": "...", "user_agent_extensions": ["..."], }

Expand source code

class TwilioSettings:
    def __init__(
        self,
        account_sid: str,
        auth_token: str,
        from_: Union[str, None] = None,
        messaging_service_sid: Union[str, None] = None,
        opts: Union[Dict[str, Any], None] = None,
    ) -> None:
        """
        Note: `self.otps` can be used to override values passed to the Twilio Client.
        Read docs from `twilio.rest.Client.__init__` to discover possible args.

        For example, `opts = {"region": "...", "user_agent_extensions": ["..."], }`
        """
        self.account_sid = account_sid
        self.auth_token = auth_token
        self.from_ = from_
        self.messaging_service_sid = messaging_service_sid
        self.opts = opts