feat(kno-252): added tenancy support

Author: cjbell

README.md

@@ -60,6 +60,7 @@ client.notify(
   actor="dnedry",
   recipients=["jhammond", "agrant", "imalcolm", "esattler"],
   cancellation_key=alert.id,
+  tenant="jurassic-park",
   data={
     "type": "trex",
     "priority": 1
@@ -103,7 +104,7 @@ You can use the `pyjwt` package to [sign JWTs easily](https://pyjwt.readthedocs.
 You will need to generate an environment specific signing key, which you can find in the Knock dashboard.
 
 If you're using a signing token you will need to pass this to your client to perform authentication.
-You can read more about [clientside authentication here](https://docs.knock.app/client-integration/authenticating-users).
+You can read more about [client-side authentication here](https://docs.knock.app/client-integration/authenticating-users).
 
 ```python
 import jwt

knockapi/client.py

@@ -53,7 +53,7 @@ def preferences(self):
         from .resources import Preferences
         return Preferences(self)
 
-    def notify(self, key, actor, recipients, data={}, cancellation_key=None):
+    def notify(self, key, actor, recipients, data={}, cancellation_key=None, tenant=None):
         """
         Triggers a workflow.
 
@@ -62,10 +62,11 @@ def notify(self, key, actor, recipients, data={}, cancellation_key=None):
             actor (str): The ID of the actor performing this action.
             recipients (array): An array of user IDs of who should be notified.
             data (dict): Any data to be passed to the notify call.
+            tenant (str): An optional identifier for the tenant object that the notifications
             cancellation_key (str): A key used to cancel this workflow.
 
         Returns:
             dict: Response from Knock.
         """
         # Note: this is essentially a delegated method
-        return self.workflows.trigger(key, actor, recipients, data=data, cancellation_key=cancellation_key)
+        return self.workflows.trigger(key, actor, recipients, data=data, cancellation_key=cancellation_key, tenant=tenant)

knockapi/resources/workflows.py

@@ -2,7 +2,7 @@
 
 
 class Workflows(Service):
-    def trigger(self, key, actor, recipients, data={}, cancellation_key=None):
+    def trigger(self, key, actor, recipients, data={}, cancellation_key=None, tenant=None):
         """
         Triggers a workflow.
 
@@ -11,6 +11,8 @@ def trigger(self, key, actor, recipients, data={}, cancellation_key=None):
             actor (str): The ID of the actor performing this action.
             recipients (array): An array of user IDs of who should be notified.
             data (dict): Any data to be passed to the notify call.
+            tenant (str): An optional identifier for the tenant object that the notifications
+            belong to.
             cancellation_key (str): A key used to cancel this notify.
 
         Returns:
@@ -22,7 +24,8 @@ def trigger(self, key, actor, recipients, data={}, cancellation_key=None):
             'actor': actor,
             'recipients': recipients,
             'data': data,
-            'cancellation_key': cancellation_key
+            'cancellation_key': cancellation_key,
+            'tenant': tenant
         }
 
         return self.request("post", endpoint, payload=params)