feat: object preferences and unset channel data (#9)

* feat: object preferences and unset channel data

* feat(users): add unset channel data

Author: cjbell

knockapi/resources/objects.py

@@ -19,7 +19,7 @@ def get(self, collection, id):
         return self.client.request('get', endpoint)
 
     # NOTE: This is `set_object` as `set` is a reserved keyword
-    def set_object(self, collection, id, data = {}):
+    def set_object(self, collection, id, data={}):
         """
         Returns an object in a collection with the id given.
 
@@ -32,7 +32,7 @@ def set_object(self, collection, id, data = {}):
             dict: A Knock Object
         """
         endpoint = '/objects/{}/{}'.format(collection, id)
-        return self.client.request('put', endpoint, payload = data)
+        return self.client.request('put', endpoint, payload=data)
 
     def bulk_set(self, collection, objects):
         """
@@ -45,7 +45,7 @@ def bulk_set(self, collection, objects):
         Returns:
             dict: BulkOperation from Knock
         """
-        data = { 'objects': objects }
+        data = {'objects': objects}
         endpoint = '/objects/{}/bulk/set'.format(collection)
         return self.client.request('post', endpoint, payload=data)
 
@@ -74,7 +74,7 @@ def bulk_delete(self, collection, object_ids):
         Returns:
             dict: BulkOperation from Knock
         """
-        data = { 'object_ids': object_ids }
+        data = {'object_ids': object_ids}
         endpoint = '/objects/{}/bulk/delete'.format(collection)
         return self.client.request('post', endpoint, payload=data)
 
@@ -94,7 +94,8 @@ def get_channel_data(self, collection, id, channel_id):
         Returns:
             dict: Channel data from Knock.
         """
-        endpoint = '/objects/{}/{}/channel_data/{}'.format(collection, id, channel_id)
+        endpoint = '/objects/{}/{}/channel_data/{}'.format(
+            collection, id, channel_id)
         return self.client.request('get', endpoint)
 
     def set_channel_data(self, collection, id, channel_id, channel_data):
@@ -110,9 +111,26 @@ def set_channel_data(self, collection, id, channel_id, channel_data):
         Returns:
             dict: Channel data from Knock.
         """
-        endpoint = '/objects/{}/{}/channel_data/{}'.format(collection, id, channel_id)
+        endpoint = '/objects/{}/{}/channel_data/{}'.format(
+            collection, id, channel_id)
         return self.client.request('put', endpoint, payload={'data': channel_data})
 
+    def unset_channel_data(self, collection, id, channel_id):
+        """
+        Unsets the object's channel data for the given channel id.
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            channel_id (str): Target channel ID
+
+        Returns:
+            None: No response
+        """
+        endpoint = '/objects/{}/{}/channel_data/{}'.format(
+            collection, id, channel_id)
+        return self.client.request('delete', endpoint)
+
     ##
     # Messages
     ##
@@ -131,3 +149,195 @@ def get_messages(self, collection, id, options=None):
         """
         endpoint = '/objects/{}/{}/messages'.format(collection, id)
         return self.client.request('get', endpoint, payload=options)
+
+    ##
+    # Preferences
+    ##
+
+    def get_all_preferences(self, collection, id):
+        """
+        Get an objects full set of preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        endpoint = '/objects/{}/{}/preferences'.format(collection, id)
+        return self.client.request('get', endpoint)
+
+    def get_preferences(self, collection, id, options={}):
+        """
+        Get a preference set
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            options (dict):
+                preference_set (str): The preference set to retrieve (defaults to "default")
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+        endpoint = '/objects/{}/{}/preferences/{}'.format(
+            collection, id, preference_set_id)
+
+        return self.client.request('get', endpoint)
+
+    def set_preferences(self, collection, id, channel_types=None, categories=None, workflows=None, options={}):
+        """
+        Sets the preference set
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            channel_types (dict): A dictionary of channel type preferences
+            categories (dict): A dictionary of category preferences
+            workflows (dict): A dictionary of workflow preferences
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}'.format(
+            collection, id, preference_set_id)
+
+        params = {
+            'channel_types': channel_types,
+            'categories': categories,
+            'workflows': workflows
+        }
+
+        return self.client.request('put', endpoint, payload=params)
+
+    def set_channel_types_preferences(self, collection, id, preferences, options={}):
+        """
+        Sets the channel type preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            preferences (dict): A dictionary of channel type preferences
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/channel_types'.format(
+            collection, id, preference_set_id)
+
+        return self.client.request('put', endpoint, payload=preferences)
+
+    def set_channel_type_preferences(self, collection, id, channel_type, setting, options={}):
+        """
+        Sets the channel type preference
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            channel_type (str): The channel_type to set
+            setting (boolean): The preference setting 
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/channel_types/{}'.format(
+            collection, id, preference_set_id, channel_type)
+
+        return self.client.request('put', endpoint, payload={'subscribed': setting})
+
+    def set_workflows_preferences(self, collection, id, preferences, options={}):
+        """
+        Sets the workflow preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            preferences (dict): A dictionary of workflow preferences
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/workflows'.format(
+            collection, id, preference_set_id)
+
+        return self.client.request('put', endpoint, payload=preferences)
+
+    def set_workflow_preferences(self, collection, id, key, setting, options={}):
+        """
+        Sets the workflow preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            key (str): The workflow key
+            setting (boolean or dict): The preference setting 
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/workflows/{}'.format(
+            collection, id, preference_set_id, key)
+
+        params = setting if type(setting) is dict else {'subscribed': setting}
+
+        return self.client.request('put', endpoint, payload=params)
+
+    def set_categories_preferences(self, collection, id, preferences, options={}):
+        """
+        Sets the categories preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            preferences (dict): A dictionary of category preferences
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/categories'.format(
+            collection, id, preference_set_id)
+
+        return self.client.request('put', endpoint, payload=preferences)
+
+    def set_category_preferences(self, collection, id, key, setting, options={}):
+        """
+        Sets the category preferences
+
+        Args:
+            collection (str): The collection the object belongs to
+            id (str): The id of the object in the collection
+            key (str): The category key
+            setting (boolean or dict): The preference setting 
+            options (dict): A dictionary of options
+
+        Returns:
+            dict: PreferenceSet response from Knock.
+        """
+        preference_set_id = options.get('preference_set', default_set_id)
+
+        endpoint = '/objects/{}/{}/preferences/{}/categories/{}'.format(
+            collection, id, preference_set_id, key)
+
+        params = setting if type(setting) is dict else {'subscribed': setting}
+
+        return self.client.request('put', endpoint, payload=params)

knockapi/resources/users.py

@@ -141,6 +141,20 @@ def set_channel_data(self, id, channel_id, channel_data):
         endpoint = '/users/{}/channel_data/{}'.format(id, channel_id)
         return self.client.request('put', endpoint, payload={'data': channel_data})
 
+    def unset_channel_data(self, id, channel_id):
+        """
+        Unsets the user's channel data for the given channel id.
+
+        Args:
+            id (str): The user ID
+            channel_id (str): Target channel ID
+
+        Returns:
+            None: no response
+        """
+        endpoint = '/users/{}/channel_data/{}'.format(id, channel_id)
+        return self.client.request('delete', endpoint)
+
     ##
     # Preferences
     ##
@@ -319,7 +333,7 @@ def set_categories_preferences(self, user_id, preferences, options={}):
             options (dict): A dictionary of options
 
         Returns:
-            dict: User response from Knock.
+            dict: PreferenceSet response from Knock.
         """
         preference_set_id = options.get('preference_set', default_set_id)
 
@@ -339,7 +353,7 @@ def set_category_preferences(self, user_id, key, setting, options={}):
             options (dict): A dictionary of options
 
         Returns:
-            dict: User response from Knock.
+            dict: PreferenceSet response from Knock.
         """
         preference_set_id = options.get('preference_set', default_set_id)