chore(KNO-5028): update comments (#25)

knocklabs · Jan 24, 2024 · dcd4339 · dcd4339
1 parent 6963aba
commit dcd4339
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/knockapi/resources/workflows.py b/knockapi/resources/workflows.py
@@ -27,7 +27,8 @@ def trigger(
 
             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.
+            tenant (str | dict[str, Any]): An optional reference for the tenant that the notifications belong to. This can be A) a tenant
+            id, B) an object reference without the collection, or C) a dictionary with data to identify a tenant.
 
             cancellation_key (str): A key used to cancel this notify.
 
@@ -97,7 +98,8 @@ def create_schedules(
 
             scheduled_at (datetime): Date when the schedule must start
 
-            tenant (str): An optional identifier for the tenant object that the notifications belong to.
+            tenant (str | dict[str, Any]): An optional reference for the tenant that the notifications belong to. This can be A) a tenant
+            id, B) an object reference without the collection, or C) a dictionary with data to identify a tenant.
 
         Returns:
             list[dict]: list of created schedules