knockapi 1.34.0 → 1.36.0

data/sig/knockapi/models/workflow_recipient_run_event.rbs

@@ -0,0 +1,73 @@
+module Knockapi
+  module Models
+    type workflow_recipient_run_event =
+      {
+        id: String,
+        _typename: String,
+        event: String,
+        inserted_at: Time,
+        status: Knockapi::Models::WorkflowRecipientRunEvent::status,
+        attempt: Integer,
+        data: ::Hash[Symbol, top]?,
+        step_ref: String?,
+        step_type: String?
+      }
+
+    class WorkflowRecipientRunEvent < Knockapi::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor _typename: String
+
+      attr_accessor event: String
+
+      attr_accessor inserted_at: Time
+
+      attr_accessor status: Knockapi::Models::WorkflowRecipientRunEvent::status
+
+      attr_reader attempt: Integer?
+
+      def attempt=: (Integer) -> Integer
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor step_ref: String?
+
+      attr_accessor step_type: String?
+
+      def initialize: (
+        id: String,
+        _typename: String,
+        event: String,
+        inserted_at: Time,
+        status: Knockapi::Models::WorkflowRecipientRunEvent::status,
+        ?attempt: Integer,
+        ?data: ::Hash[Symbol, top]?,
+        ?step_ref: String?,
+        ?step_type: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        _typename: String,
+        event: String,
+        inserted_at: Time,
+        status: Knockapi::Models::WorkflowRecipientRunEvent::status,
+        attempt: Integer,
+        data: ::Hash[Symbol, top]?,
+        step_ref: String?,
+        step_type: String?
+      }
+
+      type status = :ok | :error
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        OK: :ok
+        ERROR: :error
+
+        def self?.values: -> ::Array[Knockapi::Models::WorkflowRecipientRunEvent::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/workflow_recipient_run_get_params.rbs

@@ -0,0 +1,20 @@
+module Knockapi
+  module Models
+    type workflow_recipient_run_get_params =
+      { id: String } & Knockapi::Internal::Type::request_parameters
+
+    class WorkflowRecipientRunGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Knockapi::RequestOptions }
+    end
+  end
+end

data/sig/knockapi/models/workflow_recipient_run_list_params.rbs

@@ -0,0 +1,109 @@
+module Knockapi
+  module Models
+    type workflow_recipient_run_list_params =
+      {
+        after: String,
+        before: String,
+        ending_at: Time,
+        has_errors: bool,
+        page_size: Integer,
+        recipient: Knockapi::Models::recipient_reference,
+        starting_at: Time,
+        status: ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status],
+        tenant: String,
+        workflow: String
+      }
+      & Knockapi::Internal::Type::request_parameters
+
+    class WorkflowRecipientRunListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      attr_reader ending_at: Time?
+
+      def ending_at=: (Time) -> Time
+
+      attr_reader has_errors: bool?
+
+      def has_errors=: (bool) -> bool
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader recipient: Knockapi::Models::recipient_reference?
+
+      def recipient=: (
+        Knockapi::Models::recipient_reference
+      ) -> Knockapi::Models::recipient_reference
+
+      attr_reader starting_at: Time?
+
+      def starting_at=: (Time) -> Time
+
+      attr_reader status: ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status]?
+
+      def status=: (
+        ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status]
+      ) -> ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status]
+
+      attr_reader tenant: String?
+
+      def tenant=: (String) -> String
+
+      attr_reader workflow: String?
+
+      def workflow=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?ending_at: Time,
+        ?has_errors: bool,
+        ?page_size: Integer,
+        ?recipient: Knockapi::Models::recipient_reference,
+        ?starting_at: Time,
+        ?status: ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status],
+        ?tenant: String,
+        ?workflow: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        ending_at: Time,
+        has_errors: bool,
+        page_size: Integer,
+        recipient: Knockapi::Models::recipient_reference,
+        starting_at: Time,
+        status: ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status],
+        tenant: String,
+        workflow: String,
+        request_options: Knockapi::RequestOptions
+      }
+
+      type status = :queued | :processing | :paused | :completed | :cancelled
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED: :queued
+        PROCESSING: :processing
+        PAUSED: :paused
+        COMPLETED: :completed
+        CANCELLED: :cancelled
+
+        def self?.values: -> ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status]
+      end
+    end
+  end
+end

data/sig/knockapi/models/workflow_trigger_params.rbs

@@ -7,6 +7,7 @@ module Knockapi
         actor: Knockapi::Models::recipient_request?,
         cancellation_key: String?,
         data: ::Hash[Symbol, top]?,
+        settings: Knockapi::WorkflowTriggerParams::Settings?,
         tenant: Knockapi::Models::inline_tenant_request?
       }
       & Knockapi::Internal::Type::request_parameters
@@ -25,6 +26,8 @@ module Knockapi
 
       attr_accessor data: ::Hash[Symbol, top]?
 
+      attr_accessor settings: Knockapi::WorkflowTriggerParams::Settings?
+
       attr_accessor tenant: Knockapi::Models::inline_tenant_request?
 
       def initialize: (
@@ -33,6 +36,7 @@ module Knockapi
         ?actor: Knockapi::Models::recipient_request?,
         ?cancellation_key: String?,
         ?data: ::Hash[Symbol, top]?,
+        ?settings: Knockapi::WorkflowTriggerParams::Settings?,
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts
       ) -> void
@@ -43,9 +47,22 @@ module Knockapi
         actor: Knockapi::Models::recipient_request?,
         cancellation_key: String?,
         data: ::Hash[Symbol, top]?,
+        settings: Knockapi::WorkflowTriggerParams::Settings?,
         tenant: Knockapi::Models::inline_tenant_request?,
         request_options: Knockapi::RequestOptions
       }
+
+      type settings = { sandbox_mode: bool?, skip_delay: bool? }
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        attr_accessor sandbox_mode: bool?
+
+        attr_accessor skip_delay: bool?
+
+        def initialize: (?sandbox_mode: bool?, ?skip_delay: bool?) -> void
+
+        def to_hash: -> { sandbox_mode: bool?, skip_delay: bool? }
+      end
     end
   end
 end

data/sig/knockapi/models.rbs

@@ -95,6 +95,8 @@ module Knockapi
 
   class ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
 
+  class ObjectUnsetPreferencesParams = Knockapi::Models::ObjectUnsetPreferencesParams
+
   class PageInfo = Knockapi::Models::PageInfo
 
   module Providers = Knockapi::Models::Providers
@@ -165,9 +167,21 @@ module Knockapi
 
   class UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
 
+  class UserUnsetPreferencesParams = Knockapi::Models::UserUnsetPreferencesParams
+
   class UserUpdateParams = Knockapi::Models::UserUpdateParams
 
   class WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
 
+  class WorkflowRecipientRun = Knockapi::Models::WorkflowRecipientRun
+
+  class WorkflowRecipientRunDetail = Knockapi::Models::WorkflowRecipientRunDetail
+
+  class WorkflowRecipientRunEvent = Knockapi::Models::WorkflowRecipientRunEvent
+
+  class WorkflowRecipientRunGetParams = Knockapi::Models::WorkflowRecipientRunGetParams
+
+  class WorkflowRecipientRunListParams = Knockapi::Models::WorkflowRecipientRunListParams
+
   class WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
 end

data/sig/knockapi/resources/objects.rbs

@@ -142,6 +142,13 @@ module Knockapi
         ?request_options: Knockapi::request_opts
       ) -> nil
 
+      def unset_preferences: (
+        String collection,
+        String object_id_,
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> nil
+
       def initialize: (client: Knockapi::Client) -> void
     end
   end

data/sig/knockapi/resources/users/bulk.rbs

@@ -13,7 +13,7 @@ module Knockapi
         ) -> Knockapi::BulkOperation
 
         def set_preferences: (
-          preferences: Knockapi::Recipients::PreferenceSetRequest,
+          preferences: Knockapi::Users::BulkSetPreferencesParams::Preferences,
           user_ids: ::Array[String],
           ?request_options: Knockapi::request_opts
         ) -> Knockapi::BulkOperation

data/sig/knockapi/resources/users.rbs

@@ -127,6 +127,12 @@ module Knockapi
         ?request_options: Knockapi::request_opts
       ) -> nil
 
+      def unset_preferences: (
+        String user_id,
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> nil
+
       def initialize: (client: Knockapi::Client) -> void
     end
   end

data/sig/knockapi/resources/workflow_recipient_runs.rbs

@@ -0,0 +1,26 @@
+module Knockapi
+  module Resources
+    class WorkflowRecipientRuns
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?ending_at: Time,
+        ?has_errors: bool,
+        ?page_size: Integer,
+        ?recipient: Knockapi::Models::recipient_reference,
+        ?starting_at: Time,
+        ?status: ::Array[Knockapi::Models::WorkflowRecipientRunListParams::status],
+        ?tenant: String,
+        ?workflow: String,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::WorkflowRecipientRun]
+
+      def get: (
+        String id,
+        ?request_options: Knockapi::request_opts
+      ) -> Knockapi::WorkflowRecipientRunDetail
+
+      def initialize: (client: Knockapi::Client) -> void
+    end
+  end
+end

data/sig/knockapi/resources/workflows.rbs

@@ -14,6 +14,7 @@ module Knockapi
         ?actor: Knockapi::Models::recipient_request?,
         ?cancellation_key: String?,
         ?data: ::Hash[Symbol, top]?,
+        ?settings: Knockapi::WorkflowTriggerParams::Settings?,
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Models::WorkflowTriggerResponse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -143,6 +143,7 @@ files:
 - lib/knockapi/models/object_set_params.rb
 - lib/knockapi/models/object_set_preferences_params.rb
 - lib/knockapi/models/object_unset_channel_data_params.rb
+- lib/knockapi/models/object_unset_preferences_params.rb
 - lib/knockapi/models/objects/bulk_add_subscriptions_params.rb
 - lib/knockapi/models/objects/bulk_delete_params.rb
 - lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb
@@ -216,6 +217,7 @@ files:
 - lib/knockapi/models/user_set_channel_data_params.rb
 - lib/knockapi/models/user_set_preferences_params.rb
 - lib/knockapi/models/user_unset_channel_data_params.rb
+- lib/knockapi/models/user_unset_preferences_params.rb
 - lib/knockapi/models/user_update_params.rb
 - lib/knockapi/models/users/bulk_delete_params.rb
 - lib/knockapi/models/users/bulk_identify_params.rb
@@ -233,6 +235,11 @@ files:
 - lib/knockapi/models/users/guide_mark_message_as_seen_params.rb
 - lib/knockapi/models/users/guide_mark_message_as_seen_response.rb
 - lib/knockapi/models/workflow_cancel_params.rb
+- lib/knockapi/models/workflow_recipient_run.rb
+- lib/knockapi/models/workflow_recipient_run_detail.rb
+- lib/knockapi/models/workflow_recipient_run_event.rb
+- lib/knockapi/models/workflow_recipient_run_get_params.rb
+- lib/knockapi/models/workflow_recipient_run_list_params.rb
 - lib/knockapi/models/workflow_trigger_params.rb
 - lib/knockapi/models/workflow_trigger_response.rb
 - lib/knockapi/request_options.rb
@@ -262,6 +269,7 @@ files:
 - lib/knockapi/resources/users/bulk.rb
 - lib/knockapi/resources/users/feeds.rb
 - lib/knockapi/resources/users/guides.rb
+- lib/knockapi/resources/workflow_recipient_runs.rb
 - lib/knockapi/resources/workflows.rb
 - lib/knockapi/version.rb
 - manifest.yaml
@@ -358,6 +366,7 @@ files:
 - rbi/knockapi/models/object_set_params.rbi
 - rbi/knockapi/models/object_set_preferences_params.rbi
 - rbi/knockapi/models/object_unset_channel_data_params.rbi
+- rbi/knockapi/models/object_unset_preferences_params.rbi
 - rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi
 - rbi/knockapi/models/objects/bulk_delete_params.rbi
 - rbi/knockapi/models/objects/bulk_delete_subscriptions_params.rbi
@@ -431,6 +440,7 @@ files:
 - rbi/knockapi/models/user_set_channel_data_params.rbi
 - rbi/knockapi/models/user_set_preferences_params.rbi
 - rbi/knockapi/models/user_unset_channel_data_params.rbi
+- rbi/knockapi/models/user_unset_preferences_params.rbi
 - rbi/knockapi/models/user_update_params.rbi
 - rbi/knockapi/models/users/bulk_delete_params.rbi
 - rbi/knockapi/models/users/bulk_identify_params.rbi
@@ -448,6 +458,11 @@ files:
 - rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi
 - rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi
 - rbi/knockapi/models/workflow_cancel_params.rbi
+- rbi/knockapi/models/workflow_recipient_run.rbi
+- rbi/knockapi/models/workflow_recipient_run_detail.rbi
+- rbi/knockapi/models/workflow_recipient_run_event.rbi
+- rbi/knockapi/models/workflow_recipient_run_get_params.rbi
+- rbi/knockapi/models/workflow_recipient_run_list_params.rbi
 - rbi/knockapi/models/workflow_trigger_params.rbi
 - rbi/knockapi/models/workflow_trigger_response.rbi
 - rbi/knockapi/request_options.rbi
@@ -477,6 +492,7 @@ files:
 - rbi/knockapi/resources/users/bulk.rbi
 - rbi/knockapi/resources/users/feeds.rbi
 - rbi/knockapi/resources/users/guides.rbi
+- rbi/knockapi/resources/workflow_recipient_runs.rbi
 - rbi/knockapi/resources/workflows.rbi
 - rbi/knockapi/version.rbi
 - sig/knockapi/client.rbs
@@ -572,6 +588,7 @@ files:
 - sig/knockapi/models/object_set_params.rbs
 - sig/knockapi/models/object_set_preferences_params.rbs
 - sig/knockapi/models/object_unset_channel_data_params.rbs
+- sig/knockapi/models/object_unset_preferences_params.rbs
 - sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs
 - sig/knockapi/models/objects/bulk_delete_params.rbs
 - sig/knockapi/models/objects/bulk_delete_subscriptions_params.rbs
@@ -645,6 +662,7 @@ files:
 - sig/knockapi/models/user_set_channel_data_params.rbs
 - sig/knockapi/models/user_set_preferences_params.rbs
 - sig/knockapi/models/user_unset_channel_data_params.rbs
+- sig/knockapi/models/user_unset_preferences_params.rbs
 - sig/knockapi/models/user_update_params.rbs
 - sig/knockapi/models/users/bulk_delete_params.rbs
 - sig/knockapi/models/users/bulk_identify_params.rbs
@@ -662,6 +680,11 @@ files:
 - sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs
 - sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs
 - sig/knockapi/models/workflow_cancel_params.rbs
+- sig/knockapi/models/workflow_recipient_run.rbs
+- sig/knockapi/models/workflow_recipient_run_detail.rbs
+- sig/knockapi/models/workflow_recipient_run_event.rbs
+- sig/knockapi/models/workflow_recipient_run_get_params.rbs
+- sig/knockapi/models/workflow_recipient_run_list_params.rbs
 - sig/knockapi/models/workflow_trigger_params.rbs
 - sig/knockapi/models/workflow_trigger_response.rbs
 - sig/knockapi/request_options.rbs
@@ -691,6 +714,7 @@ files:
 - sig/knockapi/resources/users/bulk.rbs
 - sig/knockapi/resources/users/feeds.rbs
 - sig/knockapi/resources/users/guides.rbs
+- sig/knockapi/resources/workflow_recipient_runs.rbs
 - sig/knockapi/resources/workflows.rbs
 - sig/knockapi/version.rbs
 homepage: https://gemdocs.org/gems/knockapi