feat(kno-3534): add support for schedules endpoints (#21)

* feat(kno-3534): add support for schedules endpoints

* feat(kno-3534): add missing scheduled_at param

* chore: code review tweaks

Author: juanazam

knockapi/resources/objects.py

@@ -157,6 +157,29 @@ def get_messages(self, collection, id, options=None):
 
         return self.client.request('get', endpoint, payload=options)
 
+    ##
+    # Schedules
+    ##
+
+    def get_schedules(self, collection, id, options=None):
+        """
+        Get an objects's schedules
+
+        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. These are:
+                - page_size: specify size of the page to be returned by the api. (max limit: 50)
+                - after:  after cursor for pagination
+                - before: before cursor for pagination
+                - tenant: tenant_id to filter schedules with
+
+        Returns:
+            dict: Paginated Schedule response.
+        """
+        endpoint = '/objects/{}/{}/schedules'.format(collection, id)
+        return self.client.request('get', endpoint, payload=options)
+
     ##
     # Preferences
     ##

knockapi/resources/users.py

@@ -403,3 +403,25 @@ def get_messages(self, id, options=None):
         """
         endpoint = '/users/{}/messages'.format(id)
         return self.client.request('get', endpoint, payload=options)
+
+    ##
+    # Schedules
+    ##
+
+    def get_schedules(self, id, options=None):
+        """
+        Get user's schedules
+
+        Args:
+            id (str): The user ID
+            options (dict): An optional set of filtering options to pass to the query. These are:
+                - page_size: specify size of the page to be returned by the api. (max limit: 50)
+                - after:  after cursor for pagination
+                - before: before cursor for pagination
+                - tenant: tenant_id to filter schedules with
+
+        Returns:
+            dict: Paginated Schedule response.
+        """
+        endpoint = '/users/{}/schedules'.format(id)
+        return self.client.request('get', endpoint, payload=options)

knockapi/resources/workflows.py

@@ -1,3 +1,4 @@
+import datetime
 from .service import Service
 
 
@@ -69,3 +70,115 @@ def cancel(self, key, cancellation_key, recipients=None):
         }
 
         return self.client.request("post", endpoint, payload=params)
+
+    def create_schedules(
+            self,
+            key,
+            recipients,
+            repeats,
+            data={},
+            scheduled_at=datetime.datetime.now(),
+            actor=None,
+            tenant=None):
+        """
+        Creates schedules for recipients.
+
+        Args:
+            key (str): The key of the workflow to invoke.
+
+            actor (str | dict[str, Any]): An optional reference for who/what performed the action. This can be A) a user
+            id, B) an object reference, or C) a dictionary with data to identify a user or object.
+
+            recipients (list[str | dict[str, Any]]): A list of recipients that should be notified. This can be a list of
+            A) user ids, B) object references, C) dictionaries with data to identify a user or object, or D) a
+            combination thereof.
+
+            data (dict): Any data to be passed to the scheduled trigger call.
+
+            scheduled_at (datetime): Date when the schedule must start
+
+            tenant (str): An optional identifier for the tenant object that the notifications belong to.
+
+        Returns:
+            list[dict]: list of created schedules
+        """
+        endpoint = '/schedules'
+
+        params = {
+            'workflow': key,
+            'recipients': recipients,
+            'repeats': repeats,
+            'actor': actor,
+            'data': data,
+            'tenant': tenant,
+            'scheduled_at': scheduled_at.isoformat()
+        }
+
+        return self.client.request("post", endpoint, payload=params)
+
+    def update_schedules(
+            self,
+            schedule_ids,
+            schedule_attrs):
+        """
+        Updates schedules with given attributes.
+
+        Args:
+            schedule_ids (list[str]): the ids of the schedules to be updated (max 100)
+
+            schedule_attrs (dict): Schedule attributes to be updated, these can be: repeats, actor, data and tenant.
+
+        Returns:
+            list[dict]: list of updated schedules
+        """
+        endpoint = '/schedules'
+
+        schedule_attrs['schedule_ids'] = schedule_ids
+
+        return self.client.request("put", endpoint, payload=schedule_attrs)
+
+    def list_schedules(
+            self,
+            key,
+            options = {}):
+        """
+        List workflow schedules
+
+        Args:
+            key (string): workflow key
+
+            options (dict): Supports the following optional arguments:
+                - page_size: specify size of the page to be returned by the api. (max limit: 50)
+                - after:  after cursor for pagination
+                - before: before cursor for pagination
+                - tenant: tenant_id to filter schedules with
+                - recipients: list of recipients to filter schedules with
+
+        Returns:
+            dict: list of updated schedules
+        """
+
+        endpoint = '/schedules'
+        options['workflow'] = key
+
+        return self.client.request('get', endpoint, payload=options)
+
+    def delete_schedules(
+            self,
+            schedule_ids):
+        """
+        Delete schedules.
+
+        Args:
+            schedule_ids (list[str]): the ids of the schedules to be updated (max 100)
+
+        Returns:
+            list[dict]: list of updated schedules
+        """
+        endpoint = '/schedules'
+
+        params = {
+            'schedule_ids': schedule_ids,
+        }
+
+        return self.client.request("delete", endpoint, payload=params)