transactional sms

Author: hownowstephen

customerio/__init__.py

@@ -2,5 +2,5 @@
 
 from customerio.client_base import CustomerIOException
 from customerio.track import CustomerIO
-from customerio.api import APIClient, SendEmailRequest, SendPushRequest
+from customerio.api import APIClient, SendEmailRequest, SendPushRequest, SendSMSRequest
 from customerio.regions import Regions

customerio/api.py

@@ -27,6 +27,12 @@ def send_push(self, request):
             request = request._to_dict()
         resp = self.send_request('POST', self.url + "/v1/send/push", request)
         return json.loads(resp)
+    
+    def send_sms(self, request):
+        if isinstance(request, SendSMSRequest):
+            request = request._to_dict()
+        resp = self.send_request('POST', self.url + "/v1/send/sms", request)
+        return json.loads(resp)
 
     # builds the session.
     def _build_session(self):
@@ -211,3 +217,50 @@ def _to_dict(self):
                 data[name] = value
 
         return data
+
+class SendSMSRequest(object):
+    '''An object with all the options avaiable for triggering a transactional push message'''
+    def __init__(self,
+            transactional_message_id=None,
+            to=None,
+            identifiers=None,
+            disable_message_retention=None,
+            send_to_unsubscribed=None,
+            queue_draft=None,
+            message_data=None,
+            send_at=None,
+            language=None,
+        ):
+
+        self.transactional_message_id = transactional_message_id
+        self.to = to
+        self.identifiers = identifiers
+        self.disable_message_retention = disable_message_retention
+        self.send_to_unsubscribed = send_to_unsubscribed
+        self.queue_draft = queue_draft
+        self.message_data = message_data
+        self.send_at = send_at
+        self.language = language
+
+    def _to_dict(self):
+        '''Build a request payload from the object'''
+        field_map = dict(
+            # field name is the same as the payload field name
+            transactional_message_id="transactional_message_id",
+            to="to",
+            identifiers="identifiers",
+            disable_message_retention="disable_message_retention",
+            send_to_unsubscribed="send_to_unsubscribed",
+            queue_draft="queue_draft",
+            message_data="message_data",
+            send_at="send_at",
+            language="language",
+        )
+
+        data = {}
+        for field, name in field_map.items():
+            value = getattr(self, field, None)
+            if value is not None:
+                data[name] = value
+
+        return data

tests/test_api.py

@@ -5,7 +5,7 @@
 import sys
 import unittest
 
-from customerio import APIClient, SendEmailRequest, SendPushRequest, Regions, CustomerIOException
+from customerio import APIClient, SendEmailRequest, SendPushRequest, SendSMSRequest, Regions, CustomerIOException
 from customerio.__version__ import __version__ as ClientVersion
 from tests.server import HTTPSTestCase
 
@@ -95,5 +95,21 @@ def test_send_push(self):
 
         self.client.send_push(push)
 
+    def test_send_sms(self):
+        self.client.http.hooks = dict(response=partial(self._check_request, rq={
+            'method': 'POST',
+            'authorization': "Bearer app_api_key",
+            'content_type': 'application/json',
+            'url_suffix': '/v1/send/sms',
+            'body': {"identifiers": {"id":"customer_1"}, "transactional_message_id": 100}
+        }))
+
+        push = SendSMSRequest(
+            identifiers={"id":"customer_1"},
+            transactional_message_id=100,
+        )
+
+        self.client.send_sms(push)
+
 if __name__ == '__main__':
     unittest.main()