feat(api): api update

stainless-app[bot] · stainless-app[bot] · commit 14c7bc73e167 · 2026-04-30T13:36:51.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 94
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-4b8499dddbc5ac767491c492be1629f4f10a17442cf84e13e10fe38b7dcb713c.yml
-openapi_spec_hash: 98edfca809c07521259de151d3fc5684
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-0d9b2038188e6e237e90e7d04144af0b48d60f006c49172ffb5e5c0151187d3b.yml
+openapi_spec_hash: a37bbcbd9f496e5469be9a756bdaa0e9
 config_hash: 625db64572b7ee0ee1dd00546e53fc5f
diff --git a/lib/knockapi/models/workflow_cancel_params.rb b/lib/knockapi/models/workflow_cancel_params.rb
@@ -13,11 +13,11 @@ class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
       required :key, String
 
       # @!attribute cancellation_key
-      #   An optional key that is used to reference a specific workflow trigger request
-      #   when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      #   request. Must be provided while triggering a workflow in order to enable
-      #   subsequent cancellation. Should be unique across trigger requests to avoid
-      #   unintentional cancellations.
+      #   A key that is used to reference a specific workflow trigger request when issuing
+      #   a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      #   be provided while triggering a workflow in order to enable subsequent
+      #   cancellation. Should be unique across trigger requests to avoid unintentional
+      #   cancellations.
       #
       #   @return [String]
       required :cancellation_key, String
@@ -37,7 +37,7 @@ class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param key [String]
       #
-      #   @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
+      #   @param cancellation_key [String] A key that is used to reference a specific workflow trigger request when issuing
       #
       #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
       #
diff --git a/lib/knockapi/models/workflow_trigger_params.rb b/lib/knockapi/models/workflow_trigger_params.rb
@@ -28,11 +28,11 @@ class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
       optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
 
       # @!attribute cancellation_key
-      #   An optional key that is used to reference a specific workflow trigger request
-      #   when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      #   request. Must be provided while triggering a workflow in order to enable
-      #   subsequent cancellation. Should be unique across trigger requests to avoid
-      #   unintentional cancellations.
+      #   A key that is used to reference a specific workflow trigger request when issuing
+      #   a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      #   be provided while triggering a workflow in order to enable subsequent
+      #   cancellation. Should be unique across trigger requests to avoid unintentional
+      #   cancellations.
       #
       #   @return [String, nil]
       optional :cancellation_key, String, nil?: true
@@ -62,7 +62,7 @@ class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
       #
       #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
       #
-      #   @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
+      #   @param cancellation_key [String, nil] A key that is used to reference a specific workflow trigger request when issuing
       #
       #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
diff --git a/lib/knockapi/resources/workflows.rb b/lib/knockapi/resources/workflows.rb
@@ -16,7 +16,7 @@ class Workflows
       #
       # @param key [String] The key of the workflow to cancel.
       #
-      # @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
+      # @param cancellation_key [String] A key that is used to reference a specific workflow trigger request when issuing
       #
       # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
       #
@@ -53,7 +53,7 @@ def cancel(key, params)
       #
       # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
       #
-      # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
+      # @param cancellation_key [String, nil] A key that is used to reference a specific workflow trigger request when issuing
       #
       # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
diff --git a/rbi/knockapi/models/workflow_cancel_params.rbi b/rbi/knockapi/models/workflow_cancel_params.rbi
@@ -14,11 +14,11 @@ module Knockapi
       sig { returns(String) }
       attr_accessor :key
 
-      # An optional key that is used to reference a specific workflow trigger request
-      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      # request. Must be provided while triggering a workflow in order to enable
-      # subsequent cancellation. Should be unique across trigger requests to avoid
-      # unintentional cancellations.
+      # A key that is used to reference a specific workflow trigger request when issuing
+      # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      # be provided while triggering a workflow in order to enable subsequent
+      # cancellation. Should be unique across trigger requests to avoid unintentional
+      # cancellations.
       sig { returns(String) }
       attr_accessor :cancellation_key
 
@@ -53,11 +53,11 @@ module Knockapi
       end
       def self.new(
         key:,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key:,
         # A list of recipients to cancel the notification for. If omitted, cancels for all
         # recipients associated with the cancellation key.
diff --git a/rbi/knockapi/models/workflow_trigger_params.rbi b/rbi/knockapi/models/workflow_trigger_params.rbi
@@ -45,11 +45,11 @@ module Knockapi
       end
       attr_accessor :actor
 
-      # An optional key that is used to reference a specific workflow trigger request
-      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      # request. Must be provided while triggering a workflow in order to enable
-      # subsequent cancellation. Should be unique across trigger requests to avoid
-      # unintentional cancellations.
+      # A key that is used to reference a specific workflow trigger request when issuing
+      # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      # be provided while triggering a workflow in order to enable subsequent
+      # cancellation. Should be unique across trigger requests to avoid unintentional
+      # cancellations.
       sig { returns(T.nilable(String)) }
       attr_accessor :cancellation_key
 
@@ -98,11 +98,11 @@ module Knockapi
         # (string), an inline user request (object), or an inline object request, which is
         # determined by the presence of a `collection` property.
         actor: nil,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key: nil,
         # An optional map of data to pass into the workflow execution. There is a 10MB
         # limit on the size of the full `data` payload. Any individual string value
diff --git a/rbi/knockapi/resources/workflows.rbi b/rbi/knockapi/resources/workflows.rbi
@@ -27,11 +27,11 @@ module Knockapi
       def cancel(
         # The key of the workflow to cancel.
         key,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key:,
         # A list of recipients to cancel the notification for. If omitted, cancels for all
         # recipients associated with the cancellation key.
@@ -80,11 +80,11 @@ module Knockapi
         # (string), an inline user request (object), or an inline object request, which is
         # determined by the presence of a `collection` property.
         actor: nil,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key: nil,
         # An optional map of data to pass into the workflow execution. There is a 10MB
         # limit on the size of the full `data` payload. Any individual string value

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,11 @@ class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel`
`13`	`13`	`required :key, String`
`14`	`14`
`15`	`15`	`# @!attribute cancellation_key`
`16`		`- # An optional key that is used to reference a specific workflow trigger request`
`17`		`- # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)`
`18`		`- # request. Must be provided while triggering a workflow in order to enable`
`19`		`- # subsequent cancellation. Should be unique across trigger requests to avoid`
`20`		`- # unintentional cancellations.`
	`16`	`+ # A key that is used to reference a specific workflow trigger request when issuing`
	`17`	`+ # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must`
	`18`	`+ # be provided while triggering a workflow in order to enable subsequent`
	`19`	`+ # cancellation. Should be unique across trigger requests to avoid unintentional`
	`20`	`+ # cancellations.`
`21`	`21`	`#`
`22`	`22`	`# @return [String]`
`23`	`23`	`required :cancellation_key, String`
`@@ -37,7 +37,7 @@ class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel`
`37`	`37`	`#`
`38`	`38`	`# @param key [String]`
`39`	`39`	`#`
`40`		`- # @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh`
	`40`	`+ # @param cancellation_key [String] A key that is used to reference a specific workflow trigger request when issuing`
`41`	`41`	`#`
`42`	`42`	`# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all`
`43`	`43`	`#`
Original file line number	Diff line number	Diff line change
`@@ -28,11 +28,11 @@ class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel`
`28`	`28`	`optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true`
`29`	`29`
`30`	`30`	`# @!attribute cancellation_key`
`31`		`- # An optional key that is used to reference a specific workflow trigger request`
`32`		`- # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)`
`33`		`- # request. Must be provided while triggering a workflow in order to enable`
`34`		`- # subsequent cancellation. Should be unique across trigger requests to avoid`
`35`		`- # unintentional cancellations.`
	`31`	`+ # A key that is used to reference a specific workflow trigger request when issuing`
	`32`	`+ # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must`
	`33`	`+ # be provided while triggering a workflow in order to enable subsequent`
	`34`	`+ # cancellation. Should be unique across trigger requests to avoid unintentional`
	`35`	`+ # cancellations.`
`36`	`36`	`#`
`37`	`37`	`# @return [String, nil]`
`38`	`38`	`optional :cancellation_key, String, nil?: true`
`@@ -62,7 +62,7 @@ class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel`
`62`	`62`	`#`
`63`	`63`	`# @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string`
`64`	`64`	`#`
`65`		`- # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh`
	`65`	`+ # @param cancellation_key [String, nil] A key that is used to reference a specific workflow trigger request when issuing`
`66`	`66`	`#`
`67`	`67`	`# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim`
`68`	`68`	`#`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class Workflows`
`16`	`16`	`#`
`17`	`17`	`# @param key [String] The key of the workflow to cancel.`
`18`	`18`	`#`
`19`		`- # @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh`
	`19`	`+ # @param cancellation_key [String] A key that is used to reference a specific workflow trigger request when issuing`
`20`	`20`	`#`
`21`	`21`	`# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all`
`22`	`22`	`#`
`@@ -53,7 +53,7 @@ def cancel(key, params)`
`53`	`53`	`#`
`54`	`54`	`# @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string`
`55`	`55`	`#`
`56`		`- # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh`
	`56`	`+ # @param cancellation_key [String, nil] A key that is used to reference a specific workflow trigger request when issuing`
`57`	`57`	`#`
`58`	`58`	`# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim`
`59`	`59`	`#`