Merge pull request #8 from knocklabs/jazambuja-kno-1169-python-sdk-add-new-messages-endpoint

feat(messages): add new message endpoint support

Author: juanazam

knockapi/client.py

@@ -20,6 +20,7 @@ def request(self, method, endpoint, payload=None):
         r = requests.request(
             method,
             url,
+            params=payload,
             json=payload,
             headers=self.headers,
         )
@@ -69,6 +70,11 @@ def bulk_operations(self):
         from .resources import BulkOperations
         return BulkOperations(self)
 
+    @property
+    def messages(self):
+        from .resources import Messages
+        return Messages(self)
+
     # Defined at the top level here for convienience
     def notify(self, key, actor, recipients, data={}, cancellation_key=None, tenant=None):
         """

knockapi/resources/__init__.py

@@ -2,4 +2,5 @@
 from .workflows import Workflows
 from .preferences import Preferences
 from .objects import Objects
-from .bulk_operations import BulkOperations
+from .bulk_operations import BulkOperations
+from .messages import Messages

knockapi/resources/messages.py

@@ -0,0 +1,67 @@
+from .service import Service
+
+class Messages(Service):
+    def list(self, options=None):
+        """
+        Gets a paginated list of Message records
+
+        Args:
+            options (dict): An optional set of filtering options to pass to the query
+
+        Returns:
+            dict: a paginated list of Message records
+        """
+        endpoint = '/messages'
+        return self.client.request('get', endpoint, payload=options)
+
+    def get(self, id):
+        """
+        Get a message by its id
+
+        Args:
+            id: The message ID
+
+        Returns:
+            dict: Message response from Knock.
+        """
+        endpoint = '/messages/{}'.format(id)
+        return self.client.request('get', endpoint)
+
+    def get_content(self, id):
+        """
+        Get a message's content by its id
+
+        Args:
+            id: The message ID
+
+        Returns:
+            dict: MessageContent response from Knock.
+        """
+        endpoint = '/messages/{}/content'.format(id)
+        return self.client.request('get', endpoint)
+
+    def get_activities(self, id, options=None):
+        """
+        Get a message's activities by its id
+
+        Args:
+            id: The message ID
+
+        Returns:
+            dict: paginated Activity response from Knock.
+        """
+        endpoint = '/messages/{}/activities'.format(id)
+        return self.client.request('get', endpoint, options)
+
+    def get_events(self, id, options=None):
+        """
+        Get a message's events by its id
+
+        Args:
+            id: The message ID
+
+        Returns:
+            dict: paginated Event response from Knock.
+        """
+        endpoint = '/messages/{}/events'.format(id)
+        return self.client.request('get', endpoint, options)

knockapi/resources/objects.py

@@ -84,7 +84,7 @@ def bulk_delete(self, collection, object_ids):
 
     def get_channel_data(self, collection, id, channel_id):
         """
-        Get user's channel data for the given channel id.
+        Get object's channel data for the given channel id.
 
         Args:
             collection (str): The collection the object belongs to
@@ -99,7 +99,7 @@ def get_channel_data(self, collection, id, channel_id):
 
     def set_channel_data(self, collection, id, channel_id, channel_data):
         """
-        Upserts user's channel data for the given channel id.
+        Upserts object's channel data for the given channel id.
 
         Args:
             collection (str): The collection the object belongs to
@@ -111,4 +111,23 @@ def set_channel_data(self, collection, id, channel_id, channel_data):
             dict: Channel data from Knock.
         """
         endpoint = '/objects/{}/{}/channel_data/{}'.format(collection, id, channel_id)
-        return self.client.request('put', endpoint, payload={'data': channel_data})
+        return self.client.request('put', endpoint, payload={'data': channel_data})
+
+    ##
+    # Messages
+    ##
+
+    def get_messages(self, collection, id, options=None):
+        """
+        Get object's messages
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            options (dict): An optional set of filtering options to pass to the query
+
+        Returns:
+            dict: Paginated Message response.
+        """
+        endpoint = '/objects/{}/{}/messages'.format(collection, id)
+        return self.client.request('get', endpoint, payload=options)

knockapi/resources/users.py

@@ -349,3 +349,21 @@ def set_category_preferences(self, user_id, key, setting, options={}):
         params = setting if type(setting) is dict else {'subscribed': setting}
 
         return self.client.request('put', endpoint, payload=params)
+
+    ##
+    # Messages
+    ##
+
+    def get_messages(self, id, options=None):
+        """
+        Get user's messages
+
+        Args:
+            id (str): The user ID
+            options (dict): An optional set of filtering options to pass to the query
+
+        Returns:
+            dict: Paginated Message response.
+        """
+        endpoint = '/users/{}/messages'.format(id)
+        return self.client.request('get', endpoint, payload=options)