Module supertokens_python.recipe.passwordless.smsdelivery.services.twilio

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

from supertokens_python.ingredients.smsdelivery.services.twilio import (
    ServiceInterface, SMSDeliveryTwilioConfig, normalize_twilio_config)
from supertokens_python.ingredients.smsdelivery.types import \
    SMSDeliveryInterface
from supertokens_python.recipe.passwordless.types import \
    TypePasswordlessSmsDeliveryInput

from twilio.rest import Client  # type: ignore

from .service_implementation import ServiceImplementation


class TwilioService(SMSDeliveryInterface[TypePasswordlessSmsDeliveryInput]):
    service_implementation: ServiceInterface[TypePasswordlessSmsDeliveryInput]

    def __init__(self, config: SMSDeliveryTwilioConfig[TypePasswordlessSmsDeliveryInput]) -> None:
        self.config = normalize_twilio_config(config)
        otps = config.twilio_settings.opts if config.twilio_settings.opts else {}
        self.twilio_client = Client(  # type: ignore
            config.twilio_settings.account_sid,
            config.twilio_settings.auth_token,
            **otps
        )
        oi = ServiceImplementation(self.twilio_client)  # type: ignore
        self.service_implementation = oi if config.override is None else config.override(oi)

    async def send_sms(self, input_: TypePasswordlessSmsDeliveryInput, user_context: Dict[str, Any]) -> None:
        content = await self.service_implementation.get_content(input_, user_context)
        await self.service_implementation.send_raw_sms(
            content,
            user_context,
            from_=self.config.twilio_settings.from_,
            messaging_service_sid=self.config.twilio_settings.messaging_service_sid,
        )

Sub-modules

supertokens_python.recipe.passwordless.smsdelivery.services.twilio.passwordless_login
supertokens_python.recipe.passwordless.smsdelivery.services.twilio.service_implementation

Classes

class TwilioService (config: SMSDeliveryTwilioConfig[TypePasswordlessSmsDeliveryInput])

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

Expand source code
class TwilioService(SMSDeliveryInterface[TypePasswordlessSmsDeliveryInput]):
    service_implementation: ServiceInterface[TypePasswordlessSmsDeliveryInput]

    def __init__(self, config: SMSDeliveryTwilioConfig[TypePasswordlessSmsDeliveryInput]) -> None:
        self.config = normalize_twilio_config(config)
        otps = config.twilio_settings.opts if config.twilio_settings.opts else {}
        self.twilio_client = Client(  # type: ignore
            config.twilio_settings.account_sid,
            config.twilio_settings.auth_token,
            **otps
        )
        oi = ServiceImplementation(self.twilio_client)  # type: ignore
        self.service_implementation = oi if config.override is None else config.override(oi)

    async def send_sms(self, input_: TypePasswordlessSmsDeliveryInput, user_context: Dict[str, Any]) -> None:
        content = await self.service_implementation.get_content(input_, user_context)
        await self.service_implementation.send_raw_sms(
            content,
            user_context,
            from_=self.config.twilio_settings.from_,
            messaging_service_sid=self.config.twilio_settings.messaging_service_sid,
        )

Ancestors

Class variables

var service_implementationServiceInterface[CreateAndSendCustomTextMessageParameters]

Methods

async def send_sms(self, input_: TypePasswordlessSmsDeliveryInput, user_context: Dict[str, Any]) ‑> None
Expand source code
async def send_sms(self, input_: TypePasswordlessSmsDeliveryInput, user_context: Dict[str, Any]) -> None:
    content = await self.service_implementation.get_content(input_, user_context)
    await self.service_implementation.send_raw_sms(
        content,
        user_context,
        from_=self.config.twilio_settings.from_,
        messaging_service_sid=self.config.twilio_settings.messaging_service_sid,
    )