Skip to content

Commit 0c514bf

Browse files
feat(api): api update
1 parent 95d95f5 commit 0c514bf

4 files changed

Lines changed: 32 additions & 32 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 94
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-4b8499dddbc5ac767491c492be1629f4f10a17442cf84e13e10fe38b7dcb713c.yml
3-
openapi_spec_hash: 98edfca809c07521259de151d3fc5684
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-0d9b2038188e6e237e90e7d04144af0b48d60f006c49172ffb5e5c0151187d3b.yml
3+
openapi_spec_hash: a37bbcbd9f496e5469be9a756bdaa0e9
44
config_hash: 625db64572b7ee0ee1dd00546e53fc5f

src/knockapi/resources/workflows.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ def cancel(
7070
pair. Can optionally be provided one or more recipients to scope the request to.
7171
7272
Args:
73-
cancellation_key: An optional key that is used to reference a specific workflow trigger request
74-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
75-
request. Must be provided while triggering a workflow in order to enable
76-
subsequent cancellation. Should be unique across trigger requests to avoid
77-
unintentional cancellations.
73+
cancellation_key: A key that is used to reference a specific workflow trigger request when issuing
74+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
75+
be provided while triggering a workflow in order to enable subsequent
76+
cancellation. Should be unique across trigger requests to avoid unintentional
77+
cancellations.
7878
7979
recipients: A list of recipients to cancel the notification for. If omitted, cancels for all
8080
recipients associated with the cancellation key.
@@ -143,11 +143,11 @@ def trigger(
143143
(string), an inline user request (object), or an inline object request, which is
144144
determined by the presence of a `collection` property.
145145
146-
cancellation_key: An optional key that is used to reference a specific workflow trigger request
147-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
148-
request. Must be provided while triggering a workflow in order to enable
149-
subsequent cancellation. Should be unique across trigger requests to avoid
150-
unintentional cancellations.
146+
cancellation_key: A key that is used to reference a specific workflow trigger request when issuing
147+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
148+
be provided while triggering a workflow in order to enable subsequent
149+
cancellation. Should be unique across trigger requests to avoid unintentional
150+
cancellations.
151151
152152
data: An optional map of data to pass into the workflow execution. There is a 10MB
153153
limit on the size of the full `data` payload. Any individual string value
@@ -235,11 +235,11 @@ async def cancel(
235235
pair. Can optionally be provided one or more recipients to scope the request to.
236236
237237
Args:
238-
cancellation_key: An optional key that is used to reference a specific workflow trigger request
239-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
240-
request. Must be provided while triggering a workflow in order to enable
241-
subsequent cancellation. Should be unique across trigger requests to avoid
242-
unintentional cancellations.
238+
cancellation_key: A key that is used to reference a specific workflow trigger request when issuing
239+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
240+
be provided while triggering a workflow in order to enable subsequent
241+
cancellation. Should be unique across trigger requests to avoid unintentional
242+
cancellations.
243243
244244
recipients: A list of recipients to cancel the notification for. If omitted, cancels for all
245245
recipients associated with the cancellation key.
@@ -308,11 +308,11 @@ async def trigger(
308308
(string), an inline user request (object), or an inline object request, which is
309309
determined by the presence of a `collection` property.
310310
311-
cancellation_key: An optional key that is used to reference a specific workflow trigger request
312-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
313-
request. Must be provided while triggering a workflow in order to enable
314-
subsequent cancellation. Should be unique across trigger requests to avoid
315-
unintentional cancellations.
311+
cancellation_key: A key that is used to reference a specific workflow trigger request when issuing
312+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
313+
be provided while triggering a workflow in order to enable subsequent
314+
cancellation. Should be unique across trigger requests to avoid unintentional
315+
cancellations.
316316
317317
data: An optional map of data to pass into the workflow execution. There is a 10MB
318318
limit on the size of the full `data` payload. Any individual string value

src/knockapi/types/workflow_cancel_params.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414
class WorkflowCancelParams(TypedDict, total=False):
1515
cancellation_key: Required[str]
1616
"""
17-
An optional key that is used to reference a specific workflow trigger request
18-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
19-
request. Must be provided while triggering a workflow in order to enable
20-
subsequent cancellation. Should be unique across trigger requests to avoid
21-
unintentional cancellations.
17+
A key that is used to reference a specific workflow trigger request when issuing
18+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
19+
be provided while triggering a workflow in order to enable subsequent
20+
cancellation. Should be unique across trigger requests to avoid unintentional
21+
cancellations.
2222
"""
2323

2424
recipients: Optional[SequenceNotStr[RecipientReferenceParam]]

src/knockapi/types/workflow_trigger_params.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ class WorkflowTriggerParams(TypedDict, total=False):
3030

3131
cancellation_key: Optional[str]
3232
"""
33-
An optional key that is used to reference a specific workflow trigger request
34-
when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
35-
request. Must be provided while triggering a workflow in order to enable
36-
subsequent cancellation. Should be unique across trigger requests to avoid
37-
unintentional cancellations.
33+
A key that is used to reference a specific workflow trigger request when issuing
34+
a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
35+
be provided while triggering a workflow in order to enable subsequent
36+
cancellation. Should be unique across trigger requests to avoid unintentional
37+
cancellations.
3838
"""
3939

4040
data: Optional[Dict[str, object]]

0 commit comments

Comments
 (0)