knockapi 1.35.0 → 1.36.0

data/lib/knockapi/models/users/bulk_set_preferences_params.rb

@@ -9,10 +9,11 @@ module Knockapi
         include Knockapi::Internal::Type::RequestParameters
 
         # @!attribute preferences
-        #   A request to set a preference set for a recipient.
+        #   A preference set to apply in a bulk operation. Always replaces existing
+        #   preferences for the specified set.
         #
-        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest]
-        required :preferences, -> { Knockapi::Recipients::PreferenceSetRequest }
+        #   @return [Knockapi::Models::Users::BulkSetPreferencesParams::Preferences]
+        required :preferences, -> { Knockapi::Users::BulkSetPreferencesParams::Preferences }
 
         # @!attribute user_ids
         #   A list of user IDs.
@@ -21,11 +22,227 @@ module Knockapi
         required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
 
         # @!method initialize(preferences:, user_ids:, request_options: {})
-        #   @param preferences [Knockapi::Models::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Users::BulkSetPreferencesParams} for more details.
+        #
+        #   @param preferences [Knockapi::Models::Users::BulkSetPreferencesParams::Preferences] A preference set to apply in a bulk operation. Always replaces existing preferen
         #
         #   @param user_ids [Array<String>] A list of user IDs.
         #
         #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class Preferences < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier for the preference set to update. Can be `default` or a tenant ID.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute categories
+          #   An object where the key is the category and the values are the preference
+          #   settings for that category.
+          #
+          #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
+          optional :categories,
+                   -> {
+                     Knockapi::Internal::Type::HashOf[union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Category]
+                   },
+                   nil?: true
+
+          # @!attribute channel_types
+          #   Channel type preferences.
+          #
+          #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
+          optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+          # @!attribute channels
+          #   Channel preferences.
+          #
+          #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
+          optional :channels,
+                   -> {
+                     Knockapi::Internal::Type::HashOf[union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Channel]
+                   },
+                   nil?: true
+
+          # @!attribute commercial_subscribed
+          #   Whether the recipient is subscribed to commercial communications. When false,
+          #   the recipient will not receive commercial workflow notifications.
+          #
+          #   @return [Boolean, nil]
+          optional :commercial_subscribed, Knockapi::Internal::Type::Boolean, nil?: true
+
+          # @!attribute workflows
+          #   An object where the key is the workflow key and the values are the preference
+          #   settings for that workflow.
+          #
+          #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
+          optional :workflows,
+                   -> {
+                     Knockapi::Internal::Type::HashOf[union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow]
+                   },
+                   nil?: true
+
+          # @!method initialize(id: nil, categories: nil, channel_types: nil, channels: nil, commercial_subscribed: nil, workflows: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Users::BulkSetPreferencesParams::Preferences} for more
+          #   details.
+          #
+          #   A preference set to apply in a bulk operation. Always replaces existing
+          #   preferences for the specified set.
+          #
+          #   @param id [String] Identifier for the preference set to update. Can be `default` or a tenant ID.
+          #
+          #   @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
+          #
+          #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+          #
+          #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
+          #
+          #   @param commercial_subscribed [Boolean, nil] Whether the recipient is subscribed to commercial communications. When false, th
+          #
+          #   @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
+
+          # Workflow or category preferences within a preference set
+          module Category
+            extend Knockapi::Internal::Type::Union
+
+            variant Knockapi::Internal::Type::Boolean
+
+            # The settings object for a workflow or category, where you can specify channel types or conditions.
+            variant -> { Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject }
+
+            class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+              # @!attribute channel_types
+              #   Channel type preferences.
+              #
+              #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
+              optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+              # @!attribute channels
+              #   Channel preferences.
+              #
+              #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
+              optional :channels,
+                       -> do
+                         Knockapi::Internal::Type::HashOf[
+                           union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject::Channel
+                         ]
+                       end,
+                       nil?: true
+
+              # @!attribute conditions
+              #   A list of conditions to apply to a channel type.
+              #
+              #   @return [Array<Knockapi::Models::Condition>, nil]
+              optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+              # @!method initialize(channel_types: nil, channels: nil, conditions: nil)
+              #   The settings object for a workflow or category, where you can specify channel
+              #   types or conditions.
+              #
+              #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+              #
+              #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
+              #
+              #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
+
+              # Whether the specific channel (by channel_id) is enabled for the preference set,
+              # or a settings object with conditions.
+              module Channel
+                extend Knockapi::Internal::Type::Union
+
+                variant Knockapi::Internal::Type::Boolean
+
+                # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+                variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
+
+                # @!method self.variants
+                #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject)]
+          end
+
+          # Whether the specific channel (by channel_id) is enabled for the preference set,
+          # or a settings object with conditions.
+          module Channel
+            extend Knockapi::Internal::Type::Union
+
+            variant Knockapi::Internal::Type::Boolean
+
+            # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+            variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
+
+            # @!method self.variants
+            #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
+          end
+
+          # Workflow or category preferences within a preference set
+          module Workflow
+            extend Knockapi::Internal::Type::Union
+
+            variant Knockapi::Internal::Type::Boolean
+
+            # The settings object for a workflow or category, where you can specify channel types or conditions.
+            variant -> { Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject }
+
+            class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+              # @!attribute channel_types
+              #   Channel type preferences.
+              #
+              #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
+              optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+              # @!attribute channels
+              #   Channel preferences.
+              #
+              #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil]
+              optional :channels,
+                       -> do
+                         Knockapi::Internal::Type::HashOf[
+                           union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel
+                         ]
+                       end,
+                       nil?: true
+
+              # @!attribute conditions
+              #   A list of conditions to apply to a channel type.
+              #
+              #   @return [Array<Knockapi::Models::Condition>, nil]
+              optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+              # @!method initialize(channel_types: nil, channels: nil, conditions: nil)
+              #   The settings object for a workflow or category, where you can specify channel
+              #   types or conditions.
+              #
+              #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+              #
+              #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil] Channel preferences.
+              #
+              #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
+
+              # Whether the specific channel (by channel_id) is enabled for the preference set,
+              # or a settings object with conditions.
+              module Channel
+                extend Knockapi::Internal::Type::Union
+
+                variant Knockapi::Internal::Type::Boolean
+
+                # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+                variant -> { Knockapi::Recipients::PreferenceSetChannelSetting }
+
+                # @!method self.variants
+                #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting)]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(Boolean, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject)]
+          end
+        end
       end
     end
   end

data/lib/knockapi/models/users/guide_get_channel_response.rb

@@ -88,6 +88,12 @@ module Knockapi
           #   @return [String, nil]
           optional :channel_id, String
 
+          # @!attribute dashboard_url
+          #   URL to this guide in the Knock dashboard
+          #
+          #   @return [String, nil]
+          optional :dashboard_url, String
+
           # @!attribute inserted_at
           #
           #   @return [Time, nil]
@@ -121,7 +127,7 @@ module Knockapi
           #   @return [Time, nil]
           optional :updated_at, Time
 
-          # @!method initialize(id: nil, _typename: nil, activation_url_patterns: nil, activation_url_rules: nil, active: nil, bypass_global_group_limit: nil, channel_id: nil, inserted_at: nil, key: nil, semver: nil, steps: nil, type: nil, updated_at: nil)
+          # @!method initialize(id: nil, _typename: nil, activation_url_patterns: nil, activation_url_rules: nil, active: nil, bypass_global_group_limit: nil, channel_id: nil, dashboard_url: nil, inserted_at: nil, key: nil, semver: nil, steps: nil, type: nil, updated_at: nil)
           #   Some parameter documentations has been truncated, see
           #   {Knockapi::Models::Users::GuideGetChannelResponse::Entry} for more details.
           #
@@ -139,6 +145,8 @@ module Knockapi
           #
           #   @param channel_id [String]
           #
+          #   @param dashboard_url [String] URL to this guide in the Knock dashboard
+          #
           #   @param inserted_at [Time]
           #
           #   @param key [String] The key of the guide.

data/lib/knockapi/models/workflow_cancel_params.rb

@@ -13,11 +13,11 @@ module Knockapi
       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 @@ module Knockapi
       #
       #   @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
       #

data/lib/knockapi/models/workflow_recipient_run.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::WorkflowRecipientRuns#list
+    class WorkflowRecipientRun < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the workflow recipient run (per-recipient).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute inserted_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time]
+      required :inserted_at, Time
+
+      # @!attribute recipient
+      #   A reference to a recipient, either a user identifier (string) or an object
+      #   reference (ID, collection).
+      #
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference]
+      required :recipient, union: -> { Knockapi::RecipientReference }
+
+      # @!attribute status
+      #   The current status of the workflow recipient run. One of `queued`, `processing`,
+      #   `paused`, `completed`, or `cancelled`.
+      #
+      #   @return [Symbol, Knockapi::Models::WorkflowRecipientRun::Status]
+      required :status, enum: -> { Knockapi::WorkflowRecipientRun::Status }
+
+      # @!attribute trigger_source
+      #   Describes how the workflow was triggered.
+      #
+      #   @return [Knockapi::Models::WorkflowRecipientRun::TriggerSource]
+      required :trigger_source, -> { Knockapi::WorkflowRecipientRun::TriggerSource }
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute workflow
+      #   The key of the workflow that was executed.
+      #
+      #   @return [String]
+      required :workflow, String
+
+      # @!attribute workflow_run_id
+      #   The identifier for the top-level workflow run shared across all recipients in a
+      #   single trigger.
+      #
+      #   @return [String]
+      required :workflow_run_id, String
+
+      # @!attribute actor
+      #   A reference to a recipient, either a user identifier (string) or an object
+      #   reference (ID, collection).
+      #
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
+      optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true
+
+      # @!attribute error_count
+      #   The number of errors encountered during the workflow recipient run.
+      #
+      #   @return [Integer, nil]
+      optional :error_count, Integer
+
+      # @!attribute tenant
+      #   The tenant associated with the workflow recipient run.
+      #
+      #   @return [String, nil]
+      optional :tenant, String, nil?: true
+
+      # @!method initialize(id:, _typename:, inserted_at:, recipient:, status:, trigger_source:, updated_at:, workflow:, workflow_run_id:, actor: nil, error_count: nil, tenant: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowRecipientRun} for more details.
+      #
+      #   A workflow recipient run represents an individual execution of a workflow for a
+      #   specific recipient.
+      #
+      #   @param id [String] The unique identifier for the workflow recipient run (per-recipient).
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param inserted_at [Time] Timestamp when the resource was created.
+      #
+      #   @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
+      #
+      #   @param status [Symbol, Knockapi::Models::WorkflowRecipientRun::Status] The current status of the workflow recipient run. One of `queued`, `processing`,
+      #
+      #   @param trigger_source [Knockapi::Models::WorkflowRecipientRun::TriggerSource] Describes how the workflow was triggered.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param workflow [String] The key of the workflow that was executed.
+      #
+      #   @param workflow_run_id [String] The identifier for the top-level workflow run shared across all recipients in a
+      #
+      #   @param actor [String, Knockapi::Models::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
+      #
+      #   @param error_count [Integer] The number of errors encountered during the workflow recipient run.
+      #
+      #   @param tenant [String, nil] The tenant associated with the workflow recipient run.
+
+      # The current status of the workflow recipient run. One of `queued`, `processing`,
+      # `paused`, `completed`, or `cancelled`.
+      #
+      # @see Knockapi::Models::WorkflowRecipientRun#status
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        PROCESSING = :processing
+        PAUSED = :paused
+        COMPLETED = :completed
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Knockapi::Models::WorkflowRecipientRun#trigger_source
+      class TriggerSource < Knockapi::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`,
+        #   `workflow_step`, `integration`, or `rehearsal`.
+        #
+        #   @return [Symbol, Knockapi::Models::WorkflowRecipientRun::TriggerSource::Type]
+        required :type, enum: -> { Knockapi::WorkflowRecipientRun::TriggerSource::Type }
+
+        # @!attribute audience_key
+        #   The key of the audience that triggered the workflow.
+        #
+        #   @return [String, nil]
+        optional :audience_key, String, nil?: true
+
+        # @!attribute cancellation_key
+        #   The cancellation key provided when the workflow was triggered via the API.
+        #
+        #   @return [String, nil]
+        optional :cancellation_key, String, nil?: true
+
+        # @!attribute schedule_id
+        #   The ID of the schedule that triggered the workflow.
+        #
+        #   @return [String, nil]
+        optional :schedule_id, String, nil?: true
+
+        # @!method initialize(type:, audience_key: nil, cancellation_key: nil, schedule_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::WorkflowRecipientRun::TriggerSource} for more details.
+        #
+        #   Describes how the workflow was triggered.
+        #
+        #   @param type [Symbol, Knockapi::Models::WorkflowRecipientRun::TriggerSource::Type] The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`, `
+        #
+        #   @param audience_key [String, nil] The key of the audience that triggered the workflow.
+        #
+        #   @param cancellation_key [String, nil] The cancellation key provided when the workflow was triggered via the API.
+        #
+        #   @param schedule_id [String, nil] The ID of the schedule that triggered the workflow.
+
+        # The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`,
+        # `workflow_step`, `integration`, or `rehearsal`.
+        #
+        # @see Knockapi::Models::WorkflowRecipientRun::TriggerSource#type
+        module Type
+          extend Knockapi::Internal::Type::Enum
+
+          API = :api
+          AUDIENCE = :audience
+          SCHEDULE = :schedule
+          BROADCAST = :broadcast
+          WORKFLOW_STEP = :workflow_step
+          INTEGRATION = :integration
+          REHEARSAL = :rehearsal
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/workflow_recipient_run_detail.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::WorkflowRecipientRuns#get
+    class WorkflowRecipientRunDetail < Knockapi::Models::WorkflowRecipientRun
+      # @!attribute events
+      #   A list of events that occurred during the workflow recipient run.
+      #
+      #   @return [Array<Knockapi::Models::WorkflowRecipientRunEvent>]
+      required :events, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::WorkflowRecipientRunEvent] }
+
+      # @!method initialize(events:)
+      #   A single workflow recipient run with its events.
+      #
+      #   @param events [Array<Knockapi::Models::WorkflowRecipientRunEvent>] A list of events that occurred during the workflow recipient run.
+    end
+  end
+end

data/lib/knockapi/models/workflow_recipient_run_event.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class WorkflowRecipientRunEvent < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute event
+      #   The type of event that occurred.
+      #
+      #   @return [String]
+      required :event, String
+
+      # @!attribute inserted_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time]
+      required :inserted_at, Time
+
+      # @!attribute status
+      #   Whether the event represents a successful or error state.
+      #
+      #   @return [Symbol, Knockapi::Models::WorkflowRecipientRunEvent::Status]
+      required :status, enum: -> { Knockapi::WorkflowRecipientRunEvent::Status }
+
+      # @!attribute attempt
+      #   The attempt number of the workflow recipient run event. Increments for each
+      #   retry.
+      #
+      #   @return [Integer, nil]
+      optional :attempt, Integer
+
+      # @!attribute data
+      #   Event-specific data associated with the event.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute step_ref
+      #   The reference of the workflow step associated with this event.
+      #
+      #   @return [String, nil]
+      optional :step_ref, String, nil?: true
+
+      # @!attribute step_type
+      #   The type of workflow step associated with this event.
+      #
+      #   @return [String, nil]
+      optional :step_type, String, nil?: true
+
+      # @!method initialize(id:, _typename:, event:, inserted_at:, status:, attempt: nil, data: nil, step_ref: nil, step_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowRecipientRunEvent} for more details.
+      #
+      #   An event that occurred during a workflow recipient run.
+      #
+      #   @param id [String] The unique identifier for the event.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param event [String] The type of event that occurred.
+      #
+      #   @param inserted_at [Time] Timestamp when the resource was created.
+      #
+      #   @param status [Symbol, Knockapi::Models::WorkflowRecipientRunEvent::Status] Whether the event represents a successful or error state.
+      #
+      #   @param attempt [Integer] The attempt number of the workflow recipient run event. Increments for each retr
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] Event-specific data associated with the event.
+      #
+      #   @param step_ref [String, nil] The reference of the workflow step associated with this event.
+      #
+      #   @param step_type [String, nil] The type of workflow step associated with this event.
+
+      # Whether the event represents a successful or error state.
+      #
+      # @see Knockapi::Models::WorkflowRecipientRunEvent#status
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        OK = :ok
+        ERROR = :error
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/workflow_recipient_run_get_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::WorkflowRecipientRuns#get
+    class WorkflowRecipientRunGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end