Skip to content

Commit db342a3

Browse files
feat(api): api update
1 parent 7c7a2a6 commit db342a3

File tree

8 files changed

+56
-13
lines changed

8 files changed

+56
-13
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 89
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-a552e94c4d04a0d44cb4052dbfbaadea6449c254d18eb0c9c93f4c0e8ee27ad3.yml
3-
openapi_spec_hash: f4c271283f332a9868a0ee0cc2d9cd8b
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-91ba231183ed418e20513d0478e4a9dbc808c0506f981bff49b5154c117d10c6.yml
3+
openapi_spec_hash: 2615c3178e2d71280c54392babca0b29
44
config_hash: 2ae8965d371a03bd30c6a56819c04cf2

src/knockapi/resources/schedules/schedules.py

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,10 @@ def create(
100100
101101
workflow: The key of the workflow.
102102
103-
data: An optional map of data to pass into the workflow execution.
103+
data: An optional map of data to pass into the workflow execution. There is a 1024
104+
byte limit on the size of any single string value (with the exception of
105+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
106+
size of the full `data` payload.
104107
105108
ending_at: The ending date and time for the schedule.
106109
@@ -166,7 +169,10 @@ def update(
166169
actor: A reference to a recipient, either a user identifier (string) or an object
167170
reference (ID, collection).
168171
169-
data: An optional map of data to pass into the workflow execution.
172+
data: An optional map of data to pass into the workflow execution. There is a 1024
173+
byte limit on the size of any single string value (with the exception of
174+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
175+
size of the full `data` payload.
170176
171177
ending_at: The ending date and time for the schedule.
172178
@@ -359,7 +365,10 @@ async def create(
359365
360366
workflow: The key of the workflow.
361367
362-
data: An optional map of data to pass into the workflow execution.
368+
data: An optional map of data to pass into the workflow execution. There is a 1024
369+
byte limit on the size of any single string value (with the exception of
370+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
371+
size of the full `data` payload.
363372
364373
ending_at: The ending date and time for the schedule.
365374
@@ -425,7 +434,10 @@ async def update(
425434
actor: A reference to a recipient, either a user identifier (string) or an object
426435
reference (ID, collection).
427436
428-
data: An optional map of data to pass into the workflow execution.
437+
data: An optional map of data to pass into the workflow execution. There is a 1024
438+
byte limit on the size of any single string value (with the exception of
439+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
440+
size of the full `data` payload.
429441
430442
ending_at: The ending date and time for the schedule.
431443

src/knockapi/resources/workflows.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,10 @@ def trigger(
136136
subsequent cancellation. Should be unique across trigger requests to avoid
137137
unintentional cancellations.
138138
139-
data: An optional map of data to pass into the workflow execution.
139+
data: An optional map of data to pass into the workflow execution. There is a 1024
140+
byte limit on the size of any single string value (with the exception of
141+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
142+
size of the full `data` payload.
140143
141144
tenant: An request to set a tenant inline.
142145
@@ -279,7 +282,10 @@ async def trigger(
279282
subsequent cancellation. Should be unique across trigger requests to avoid
280283
unintentional cancellations.
281284
282-
data: An optional map of data to pass into the workflow execution.
285+
data: An optional map of data to pass into the workflow execution. There is a 1024
286+
byte limit on the size of any single string value (with the exception of
287+
[email attachments](/integrations/email/attachments)), and a 10MB limit on the
288+
size of the full `data` payload.
283289
284290
tenant: An request to set a tenant inline.
285291

src/knockapi/types/schedule.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ class Schedule(BaseModel):
3838
"""A recipient of a notification, which is either a user or an object."""
3939

4040
data: Optional[Dict[str, object]] = None
41-
"""An optional map of data to pass into the workflow execution."""
41+
"""An optional map of data to pass into the workflow execution.
42+
43+
There is a 1024 byte limit on the size of any single string value (with the
44+
exception of [email attachments](/integrations/email/attachments)), and a 10MB
45+
limit on the size of the full `data` payload.
46+
"""
4247

4348
last_occurrence_at: Optional[datetime] = None
4449
"""The last occurrence of the schedule."""

src/knockapi/types/schedule_create_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,12 @@ class ScheduleCreateParams(TypedDict, total=False):
2525
"""The key of the workflow."""
2626

2727
data: Optional[Dict[str, object]]
28-
"""An optional map of data to pass into the workflow execution."""
28+
"""An optional map of data to pass into the workflow execution.
29+
30+
There is a 1024 byte limit on the size of any single string value (with the
31+
exception of [email attachments](/integrations/email/attachments)), and a 10MB
32+
limit on the size of the full `data` payload.
33+
"""
2934

3035
ending_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
3136
"""The ending date and time for the schedule."""

src/knockapi/types/schedule_update_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,12 @@ class ScheduleUpdateParams(TypedDict, total=False):
2525
"""
2626

2727
data: Optional[Dict[str, object]]
28-
"""An optional map of data to pass into the workflow execution."""
28+
"""An optional map of data to pass into the workflow execution.
29+
30+
There is a 1024 byte limit on the size of any single string value (with the
31+
exception of [email attachments](/integrations/email/attachments)), and a 10MB
32+
limit on the size of the full `data` payload.
33+
"""
2934

3035
ending_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
3136
"""The ending date and time for the schedule."""

src/knockapi/types/schedules/bulk_create_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ class Schedule(TypedDict, total=False):
3232
"""
3333

3434
data: Optional[Dict[str, object]]
35-
"""An optional map of data to pass into the workflow execution."""
35+
"""An optional map of data to pass into the workflow execution.
36+
37+
There is a 1024 byte limit on the size of any single string value (with the
38+
exception of [email attachments](/integrations/email/attachments)), and a 10MB
39+
limit on the size of the full `data` payload.
40+
"""
3641

3742
ending_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
3843
"""The ending date and time for the schedule."""

src/knockapi/types/workflow_trigger_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@ class WorkflowTriggerParams(TypedDict, total=False):
3737
"""
3838

3939
data: Optional[Dict[str, object]]
40-
"""An optional map of data to pass into the workflow execution."""
40+
"""An optional map of data to pass into the workflow execution.
41+
42+
There is a 1024 byte limit on the size of any single string value (with the
43+
exception of [email attachments](/integrations/email/attachments)), and a 10MB
44+
limit on the size of the full `data` payload.
45+
"""
4146

4247
tenant: Optional[InlineTenantRequestParam]
4348
"""An request to set a tenant inline."""

0 commit comments

Comments
 (0)