[SMS] service plan id version of the API (#17)

.github/workflows/run-tests.yml

@@ -7,6 +7,8 @@ env:
   PROJECT_ID: ${{ secrets.PROJECT_ID }}
   NUMBERS_ORIGIN: ${{ secrets.NUMBERS_ORIGIN }}
   SMS_ORIGIN: ${{ secrets.SMS_ORIGIN }}
+  SERVICE_PLAN_ID: ${{ secrets.SERVICE_PLAN_ID }}
+  SMS_API_TOKEN: ${{ secrets.SMS_API_TOKEN }}
   CONVERSATION_ORIGIN: ${{ secrets.CONVERSATION_ORIGIN }}
   AUTH_ORIGIN: ${{ secrets.AUTH_ORIGIN }}
   DISABLE_SSL: ${{ secrets.DISABLE_SSL }}

sinch/core/clients/sinch_client_async.py

@@ -25,7 +25,9 @@ def __init__(
         logger_name: str = None,
         logger: Logger = None,
         application_key: str = None,
-        application_secret: str = None
+        application_secret: str = None,
+        service_plan_id: str = None,
+        sms_api_token: str = None
     ):
         self.configuration = Configuration(
             key_id=key_id,
@@ -36,7 +38,9 @@ def __init__(
             transport=HTTPXTransport(self),
             token_manager=TokenManagerAsync(self),
             application_secret=application_secret,
-            application_key=application_key
+            application_key=application_key,
+            service_plan_id=service_plan_id,
+            sms_api_token=sms_api_token
         )
 
         self.authentication = AuthenticationAsync(self)

sinch/core/clients/sinch_client_base.py

@@ -30,7 +30,9 @@ def __init__(
         logger_name: str = None,
         logger: Logger = None,
         application_key: str = None,
-        application_secret: str = None
+        application_secret: str = None,
+        service_plan_id: str = None,
+        sms_api_token: str = None
     ):
         pass
 

sinch/core/clients/sinch_client_configuration.py

@@ -4,6 +4,7 @@
 
 from sinch.core.ports.http_transport import HTTPTransport
 from sinch.core.token_manager import TokenManager, TokenManagerAsync
+from sinch.core.enums import HTTPAuthentication
 
 
 class Configuration:
@@ -22,14 +23,18 @@ def __init__(
         disable_https=False,
         connection_timeout=10,
         application_key: str = None,
-        application_secret: str = None
+        application_secret: str = None,
+        service_plan_id: str = None,
+        sms_api_token: str = None
     ):
         self.key_id = key_id
         self.key_secret = key_secret
         self.project_id = project_id
         self.application_key = application_key
         self.application_secret = application_secret
         self.connection_timeout = connection_timeout
+        self.sms_api_token = sms_api_token
+        self.service_plan_id = service_plan_id
         self.auth_origin = "auth.sinch.com"
         self.numbers_origin = "numbers.api.sinch.com"
         self.verification_origin = "verification.api.sinch.com"
@@ -39,7 +44,10 @@ def __init__(
         self._conversation_region = "eu"
         self._conversation_domain = ".conversation.api.sinch.com"
         self._sms_region = "us"
+        self._sms_region_with_service_plan_id = "us"
         self._sms_domain = "zt.{}.sms.api.sinch.com"
+        self._sms_domain_with_service_plan_id = "{}.sms.api.sinch.com"
+        self._sms_authentication = HTTPAuthentication.OAUTH.value
         self._templates_region = "eu"
         self._templates_domain = ".template.api.sinch.com"
         self.token_manager = token_manager
@@ -48,6 +56,7 @@ def __init__(
 
         self._set_conversation_origin()
         self._set_sms_origin()
+        self._set_sms_origin_with_service_plan_id()
         self._set_templates_origin()
         self._set_voice_origin()
 
@@ -58,23 +67,35 @@ def __init__(
         else:
             self.logger = logging.getLogger("Sinch")
 
-    def _set_voice_origin(self):
-        if not self._voice_region:
-            self.voice_origin = self._voice_domain.format("calling")
-        else:
-            self.voice_origin = self._voice_domain.format("calling-" + self._voice_region)
+    def _set_sms_origin_with_service_plan_id(self):
+        self.sms_origin_with_service_plan_id = self._sms_domain_with_service_plan_id.format(
+            self._sms_region_with_service_plan_id
+        )
 
-    def _set_voice_region(self, region):
-        self._voice_region = region
-        self._set_voice_origin()
+    def _set_sms_region_with_service_plan_id(self, region):
+        self._sms_region_with_service_plan_id = region
+        self._set_sms_origin_with_service_plan_id()
 
-    def _get_voice_region(self):
-        return self._voice_region
+    def _get_sms_region_with_service_plan_id(self):
+        return self._sms_region_with_service_plan_id
 
-    voice_region = property(
-        _get_voice_region,
-        _set_voice_region,
-        doc="Voice Region"
+    sms_region_with_service_plan_id = property(
+        _get_sms_region_with_service_plan_id,
+        _set_sms_region_with_service_plan_id,
+        doc="SMS Region for service plan id version of the SMS API"
+    )
+
+    def _set_sms_domain_with_service_plan_id(self, domain):
+        self._sms_domain_with_service_plan_id = domain
+        self._set_sms_origin_with_service_plan_id()
+
+    def _get_sms_domain_with_service_plan_id(self):
+        return self._sms_domain_with_service_plan_id
+
+    sms_domain_with_service_plan_id = property(
+        _get_sms_domain_with_service_plan_id,
+        _set_sms_domain_with_service_plan_id,
+        doc="SMS Domain for service plan id version of the SMS API"
     )
 
     def _set_sms_origin(self):
@@ -163,3 +184,22 @@ def _get_templates_domain(self):
         _set_templates_domain,
         doc="Conversation API Templates Domain"
     )
+
+    def _set_voice_origin(self):
+        if not self._voice_region:
+            self.voice_origin = self._voice_domain.format("calling")
+        else:
+            self.voice_origin = self._voice_domain.format("calling-" + self._voice_region)
+
+    def _set_voice_region(self, region):
+        self._voice_region = region
+        self._set_voice_origin()
+
+    def _get_voice_region(self):
+        return self._voice_region
+
+    voice_region = property(
+        _get_voice_region,
+        _set_voice_region,
+        doc="Voice Region"
+    )

sinch/core/clients/sinch_client_sync.py

@@ -25,7 +25,9 @@ def __init__(
         logger_name: str = None,
         logger: Logger = None,
         application_key: str = None,
-        application_secret: str = None
+        application_secret: str = None,
+        service_plan_id: str = None,
+        sms_api_token: str = None
     ):
         self.configuration = Configuration(
             key_id=key_id,
@@ -36,7 +38,9 @@ def __init__(
             transport=HTTPTransportRequests(self),
             token_manager=TokenManager(self),
             application_key=application_key,
-            application_secret=application_secret
+            application_secret=application_secret,
+            service_plan_id=service_plan_id,
+            sms_api_token=sms_api_token
         )
 
         self.authentication = Authentication(self)

sinch/core/enums.py

@@ -13,3 +13,4 @@ class HTTPAuthentication(Enum):
     BASIC = "BASIC"
     OAUTH = "OAUTH"
     SIGNED = "SIGNED"
+    SMS_TOKEN = "SMS_TOKEN"

sinch/core/ports/http_transport.py

@@ -63,6 +63,20 @@ def authenticate(self, endpoint, request_data):
                 endpoint.get_url_without_origin(self.sinch)
             )
             request_data.headers = signature.get_http_headers_with_signature()
+        elif endpoint.HTTP_AUTHENTICATION == HTTPAuthentication.SMS_TOKEN.value:
+            if not self.sinch.configuration.sms_api_token or not self.sinch.configuration.service_plan_id:
+                raise ValidationException(
+                    message=(
+                        "sms_api_token and service_plan_id are required by this API. "
+                        "Those credentials can be obtained from Sinch portal."
+                    ),
+                    is_from_server=False,
+                    response=None
+                )
+            request_data.headers.update({
+                "Authorization": f"Bearer {self.sinch.configuration.sms_api_token}",
+                "Content-Type": "application/json"
+            })
 
         return request_data