customerio 2.0__tar.gz → 2.2__tar.gz

{customerio-2.0/customerio.egg-info → customerio-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: customerio
-Version: 2.0
+Version: 2.2
 Summary: Customer.io Python bindings.
 Home-page: https://github.com/customerio/customerio-python
 Author: Peaberry Software Inc.

{customerio-2.0 → customerio-2.2}/README.md

@@ -1,8 +1,7 @@
-<p align="center">
+<p align=center>
   <a href="https://customer.io">
-    <img src="https://user-images.githubusercontent.com/6409227/144680509-907ee093-d7ad-4a9c-b0a5-f640eeb060cd.png" height="60">
+    <img src="https://avatars.githubusercontent.com/u/1152079?s=200&v=4" height="60">
   </a>
-  <p align="center">Power automated communication that people like to receive.</p>
 </p>
 
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-python/)
@@ -14,7 +13,7 @@
 
 # Customer.io Python 
 
-This module has been tested with Python 3.6, 3.7, 3.8 and 3.9.
+This module has been tested with Python 3.6, 3.7, 3.8 and 3.9. If you're new to Customer.io, we recommend that you integrate with our [Data Pipelines Python library](https://github.com/customerio/cdp-analytics-python) instead.
 
 ## Installing
 
@@ -54,7 +53,7 @@ values for that field.
 
 You can pass any keyword arguments to the `identify` and `track` methods. These kwargs will be converted to custom attributes.
 
-See original REST documentation [here](http://customer.io/docs/api/rest.html#section-Creating_or_updating_customers)
+See original REST documentation [here](http://customer.io/docs/api/track/#operation/identify)
 
 ### Track a custom event
 
@@ -70,7 +69,7 @@ cio.track(customer_id="5", name='purchased', price=23.45, product="widget")
 
 You can pass any keyword arguments to the `identify` and `track` methods. These kwargs will be converted to custom attributes.
 
-See original REST documentation [here](http://customer.io/docs/api/rest.html#section-Track_a_custom_event)
+See original REST documentation [here](http://customer.io/docs/api/track/#operation/track)
 
 ### Backfill a custom event
 
@@ -95,7 +94,7 @@ Event timestamp may be passed as a ```datetime.datetime``` object, an integer or
 
 Keyword arguments to backfill work the same as a call to ```cio.track```.
 
-See original REST documentation [here](http://customer.io/docs/api/rest.html#section-Track_a_custom_event)
+See original REST documentation [here](http://customer.io/docs/api/track/#operation/track)
 
 ### Track an anonymous event
 
@@ -107,7 +106,7 @@ An anonymous event is an event associated with a person you haven't identified.
 
 #### Anonymous invite events
 
-If you previously sent [invite events](https://customer.io/docs/anonymous-invite-emails/), you can achieve the same functionality by sending an anonymous event with the anonymous identifier set to `None`. To send anonymous invites, your event *must* include a `recipient` attribute. 
+If you previously sent [invite events](https://customer.io/docs/journeys/anonymous-invite-emails/), you can achieve the same functionality by sending an anonymous event with the anonymous identifier set to `None`. To send anonymous invites, your event *must* include a `recipient` attribute. 
 
 ```python
 cio.track_anonymous(anonymous_id=None, name="invite", first_name="alex", recipient="alex.person@example.com")
@@ -122,7 +121,7 @@ Deletes the customer profile for a specified customer.
 
 This method returns nothing.  Attempts to delete non-existent customers will not raise any errors.
 
-See original REST documentation [here](http://customer.io/docs/api/rest.html#section-Deleting_customers)
+See original REST documentation [here](https://customer.io/docs/api/track/#operation/delete)
 
 
 You can pass any keyword arguments to the `identify` and `track` methods. These kwargs will be converted to custom attributes.
@@ -175,7 +174,7 @@ cio.suppress(customer_id="1")
 
 Suppresses the specified customer. They will be deleted from Customer.io, and we will ignore all further attempts to identify or track activity for the suppressed customer ID
 
-See REST documentation [here](https://learn.customer.io/api/#apisuppress_add)
+See REST documentation [here](https://customer.io/docs/api/track/#operation/suppress)
 
 ### Unsuppress a customer
 ```python
@@ -184,19 +183,22 @@ cio.unsuppress(customer_id="1")
 
 Unsuppresses the specified customer. We will remove the supplied id from our suppression list and start accepting new identify and track calls for the customer as normal
 
-See REST documentation [here](https://learn.customer.io/api/#apisuppress_delete)
+See REST documentation [here](https://customer.io/docs/api/track/#operation/unsuppress)
 
 ### Send Transactional Messages
 
-To use the [Transactional API](https://customer.io/docs/transactional-api), instantiate the Customer.io object using an [app key](https://customer.io/docs/managing-credentials#app-api-keys) and create a request object containing:
+To use the [Transactional API](https://customer.io/docs/journeys/transactional-api), instantiate the Customer.io object using an [app key](https://customer.io/docs/managing-credentials#app-api-keys) and create a request object for your message type.
 
-* `transactional_message_id`: the ID of the transactional message you want to send, or the `body`, `from`, and `subject` of a new message.
+## Email
+
+SendEmailRequest requires:
+* `transactional_message_id`: the ID of the transactional message you want to send, or the `body`, `_from`, and `subject` of a new message.
 * `to`: the email address of your recipients 
 * an `identifiers` object containing the `id` of your recipient. If the `id` does not exist, Customer.io will create it.
 * a `message_data` object containing properties that you want reference in your message using Liquid.
 * You can also send attachments with your message. Use `attach` to encode attachments.
 
-Use `send_email` referencing your request to send a transactional message. [Learn more about transactional messages and `SendEmailRequest` properties](https://customer.io/docs/transactional-api).
+Use `send_email` referencing your request to send a transactional message. [Learn more about transactional messages and `SendEmailRequest` properties](https://customer.io/docs/journeys/transactional-api).
 
 ```python
 from customerio import APIClient, Regions, SendEmailRequest
@@ -204,6 +206,7 @@ client = APIClient("your API key", region=Regions.US)
 
 request = SendEmailRequest(
   to="person@example.com",
+  _from="override.sender@example.com",
   transactional_message_id="3",
   message_data={
     "name": "person",
@@ -219,13 +222,45 @@ request = SendEmailRequest(
   }
 )
 
-with open("path to file", "rb") as f:
+with open("receipt.pdf", "rb") as f:
   request.attach('receipt.pdf', f.read())
 
 response = client.send_email(request)
 print(response)
 ```
 
+## Push
+
+SendPushRequest requires:
+* `transactional_message_id`: the ID of the transactional push message you want to send.
+* an `identifiers` object containing the `id` or `email` of your recipient. If the profile does not exist, Customer.io will create it.
+
+Use `send_push` referencing your request to send a transactional message. [Learn more about transactional messages and `SendPushRequest` properties](https://customer.io/docs/journeys/transactional-api).
+
+```python
+from customerio import APIClient, Regions, SendPushRequest
+client = APIClient("your API key", region=Regions.US)
+
+request = SendPushRequest(
+  transactional_message_id="3",
+  message_data={
+    "name": "person",
+    "items": [
+      {
+        "name": "shoes",
+        "price": "59.99",
+      },
+    ]
+  },
+  identifiers={
+    "id": "2",
+  }
+)
+
+response = client.send_push(request)
+print(response)
+```
+
 ## Notes
 - The Customer.io Python SDK depends on the [`Requests`](https://pypi.org/project/requests/) library which includes [`urllib3`](https://pypi.org/project/urllib3/) as a transitive dependency.  The [`Requests`](https://pypi.org/project/requests/) library leverages connection pooling defined in [`urllib3`](https://pypi.org/project/urllib3/).  [`urllib3`](https://pypi.org/project/urllib3/) only attempts to retry invocations of `HTTP` methods which are understood to be idempotent (See: [`Retry.DEFAULT_ALLOWED_METHODS`](https://github.com/urllib3/urllib3/blob/main/src/urllib3/util/retry.py#L184)).  Since the `POST` method is not considered to be idempotent, any invocations which require `POST` are not retried.
 

{customerio-2.0 → customerio-2.2}/customerio/__init__.py

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

{customerio-2.0 → customerio-2.2}/customerio/__version__.py

@@ -1,4 +1,4 @@
-VERSION = (2, 0, 0, 'final', 0)
+VERSION = (2, 2, 0, 'final', 0)
 
 def get_version():
     version = '%s.%s' % (VERSION[0], VERSION[1])

{customerio-2.0 → customerio-2.2}/customerio/api.py

@@ -22,6 +22,18 @@ class APIClient(ClientBase):
         resp = self.send_request('POST', self.url + "/v1/send/email", request)
         return json.loads(resp)
 
+    def send_push(self, request):
+        if isinstance(request, SendPushRequest):
+            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):
         session = super()._build_session()
@@ -30,7 +42,7 @@ class APIClient(ClientBase):
         return session
 
 class SendEmailRequest(object):
-    '''An object with all the options avaiable for triggering a transactional message'''
+    '''An object with all the options avaiable for triggering a transactional email message'''
     def __init__(self,
             transactional_message_id=None,
             to=None,
@@ -96,7 +108,7 @@ class SendEmailRequest(object):
         self.attachments[name] = content
 
     def _to_dict(self):
-        '''Build a request payload fromt the object'''
+        '''Build a request payload from the object'''
         field_map = dict(
             # from is reservered keyword hence the object has the field
             # `_from` but in the request payload we map it to `from`
@@ -132,3 +144,123 @@ class SendEmailRequest(object):
                 data[name] = value
 
         return data
+
+class SendPushRequest(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,
+            title=None,
+            message=None,
+            disable_message_retention=None,
+            send_to_unsubscribed=None,
+            queue_draft=None,
+            message_data=None,
+            send_at=None,
+            language=None,
+            image_url=None,
+            link=None,
+            custom_data=None,
+            custom_payload=None,
+            device=None,
+            sound=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
+
+        self.title = title
+        self.message = message
+        self.image_url = image_url
+        self.link = link
+        self.custom_data = custom_data
+        self.custom_payload = custom_payload
+        self.device = device
+        self.sound = sound
+
+    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",
+
+            title="title",
+            message="message",
+            image_url="image_url",
+            link="link",
+            custom_data="custom_data",
+            custom_payload="custom_payload",
+            device="custom_device",
+            sound="sound"
+        )
+
+        data = {}
+        for field, name in field_map.items():
+            value = getattr(self, field, None)
+            if value is not None:
+                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

{customerio-2.0 → customerio-2.2/customerio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: customerio
-Version: 2.0
+Version: 2.2
 Summary: Customer.io Python bindings.
 Home-page: https://github.com/customerio/customerio-python
 Author: Peaberry Software Inc.

{customerio-2.0 → customerio-2.2}/tests/server.py

@@ -3,7 +3,6 @@ try:
 except ImportError:
     from http.server import BaseHTTPRequestHandler, HTTPServer
 
-from functools import wraps
 from random import randint
 import json
 import ssl
@@ -11,12 +10,11 @@ import time
 import threading
 import unittest
 
-def sslwrap(func):
-    @wraps(func)
-    def bar(*args, **kw):
-        kw['ssl_version'] = ssl.PROTOCOL_SSLv23
-        return func(*args, **kw)
-    return bar
+def create_ssl_context():
+    """Create SSL context for Python 3.12+ compatibility"""
+    context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
+    context.minimum_version = ssl.TLSVersion.TLSv1_2
+    return context
 
 request_counts = dict()
 
@@ -75,12 +73,11 @@ class HTTPSTestCase(unittest.TestCase):
     def setUpClass(cls):
         # create a server
         cls.server = HTTPServer(("localhost", 0), Handler)
-        # hack needed to setup ssl server
-        ssl.wrap_socket = sslwrap(ssl.wrap_socket)
+        # create SSL context for Python 3.12+ compatibility
+        context = create_ssl_context()
+        context.load_cert_chain('./tests/server.pem')
         # upgrade to https
-        cls.server.socket = ssl.wrap_socket(cls.server.socket,
-            certfile='./tests/server.pem',
-            server_side=True)
+        cls.server.socket = context.wrap_socket(cls.server.socket, server_side=True)
         # start server instance in new thread
         cls.server_thread = threading.Thread(target=cls.server.serve_forever)
         cls.server_thread.start()

{customerio-2.0 → customerio-2.2}/tests/test_api.py

@@ -5,7 +5,7 @@ import json
 import sys
 import unittest
 
-from customerio import APIClient, SendEmailRequest, Regions, CustomerIOException
+from customerio import APIClient, SendEmailRequest, SendPushRequest, SendSMSRequest, Regions, CustomerIOException
 from customerio.__version__ import __version__ as ClientVersion
 from tests.server import HTTPSTestCase
 
@@ -77,5 +77,39 @@ class TestAPIClient(HTTPSTestCase):
 
         self.client.send_email(email)
 
+    def test_send_push(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/push',
+            'body': {"identifiers": {"id":"customer_1"}, "transactional_message_id": 100, "title": "transactional push message", "message": "push message content"}
+        }))
+
+        push = SendPushRequest(
+            identifiers={"id":"customer_1"},
+            transactional_message_id=100,
+            title="transactional push message",
+            message="push message content"
+        )
+
+        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}
+        }))
+
+        sms = SendSMSRequest(
+            identifiers={"id":"customer_1"},
+            transactional_message_id=100,
+        )
+
+        self.client.send_sms(sms)
+
 if __name__ == '__main__':
     unittest.main()