Skip to content

Commit dcd4339

Browse files
authored
chore(KNO-5028): update comments (#25)
1 parent 6963aba commit dcd4339

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

knockapi/resources/workflows.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ def trigger(
2727
2828
data (dict): Any data to be passed to the notify call.
2929
30-
tenant (str): An optional identifier for the tenant object that the notifications belong to.
30+
tenant (str | dict[str, Any]): An optional reference for the tenant that the notifications belong to. This can be A) a tenant
31+
id, B) an object reference without the collection, or C) a dictionary with data to identify a tenant.
3132
3233
cancellation_key (str): A key used to cancel this notify.
3334
@@ -97,7 +98,8 @@ def create_schedules(
9798
9899
scheduled_at (datetime): Date when the schedule must start
99100
100-
tenant (str): An optional identifier for the tenant object that the notifications belong to.
101+
tenant (str | dict[str, Any]): An optional reference for the tenant that the notifications belong to. This can be A) a tenant
102+
id, B) an object reference without the collection, or C) a dictionary with data to identify a tenant.
101103
102104
Returns:
103105
list[dict]: list of created schedules

0 commit comments

Comments
 (0)