knockapi 1.35.0 → 1.36.0

data/lib/knockapi/models/workflow_recipient_run_list_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::WorkflowRecipientRuns#list
+    class WorkflowRecipientRunListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute ending_at
+      #   Limits the results to workflow recipient runs started before the given date.
+      #
+      #   @return [Time, nil]
+      optional :ending_at, Time
+
+      # @!attribute has_errors
+      #   Limits the results to workflow recipient runs that have errors.
+      #
+      #   @return [Boolean, nil]
+      optional :has_errors, Knockapi::Internal::Type::Boolean
+
+      # @!attribute page_size
+      #   The number of items per page (defaults to 50).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute recipient
+      #   Limits the results to workflow recipient runs for the given recipient. Accepts a
+      #   user ID string or an object reference with `id` and `collection`.
+      #
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
+      optional :recipient, union: -> { Knockapi::RecipientReference }
+
+      # @!attribute starting_at
+      #   Limits the results to workflow recipient runs started after the given date.
+      #
+      #   @return [Time, nil]
+      optional :starting_at, Time
+
+      # @!attribute status
+      #   Limits the results to workflow recipient runs with the given status.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::WorkflowRecipientRunListParams::Status>, nil]
+      optional :status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::WorkflowRecipientRunListParams::Status] }
+
+      # @!attribute tenant
+      #   Limits the results to workflow recipient runs for the given tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute workflow
+      #   Limits the results to workflow recipient runs for the given workflow key.
+      #
+      #   @return [String, nil]
+      optional :workflow, String
+
+      # @!method initialize(after: nil, before: nil, ending_at: nil, has_errors: nil, page_size: nil, recipient: nil, starting_at: nil, status: nil, tenant: nil, workflow: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowRecipientRunListParams} for more details.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param ending_at [Time] Limits the results to workflow recipient runs started before the given date.
+      #
+      #   @param has_errors [Boolean] Limits the results to workflow recipient runs that have errors.
+      #
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
+      #
+      #   @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] Limits the results to workflow recipient runs for the given recipient. Accepts a
+      #
+      #   @param starting_at [Time] Limits the results to workflow recipient runs started after the given date.
+      #
+      #   @param status [Array<Symbol, Knockapi::Models::WorkflowRecipientRunListParams::Status>] Limits the results to workflow recipient runs with the given status.
+      #
+      #   @param tenant [String] Limits the results to workflow recipient runs for the given tenant.
+      #
+      #   @param workflow [String] Limits the results to workflow recipient runs for the given workflow key.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        PROCESSING = :processing
+        PAUSED = :paused
+        COMPLETED = :completed
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/workflow_trigger_params.rb

@@ -28,11 +28,11 @@ module Knockapi
       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
@@ -46,13 +46,19 @@ module Knockapi
       #   @return [Hash{Symbol=>Object}, nil]
       optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
+      # @!attribute settings
+      #   Optional settings that control how this workflow trigger is executed.
+      #
+      #   @return [Knockapi::Models::WorkflowTriggerParams::Settings, nil]
+      optional :settings, -> { Knockapi::WorkflowTriggerParams::Settings }, nil?: true
+
       # @!attribute tenant
       #   An request to set a tenant inline.
       #
       #   @return [String, Knockapi::Models::TenantRequest, nil]
       optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
 
-      # @!method initialize(key:, recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
+      # @!method initialize(key:, recipients:, actor: nil, cancellation_key: nil, data: nil, settings: nil, tenant: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::WorkflowTriggerParams} for more details.
       #
@@ -62,13 +68,42 @@ module Knockapi
       #
       #   @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
       #
+      #   @param settings [Knockapi::Models::WorkflowTriggerParams::Settings, nil] Optional settings that control how this workflow trigger is executed.
+      #
       #   @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute sandbox_mode
+        #   When set to true, overrides the sandbox mode for all channels in this workflow
+        #   run, messages are not delivered to the underlying providers. If false or not
+        #   set, the workflow delivers messages normally.
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox_mode, Knockapi::Internal::Type::Boolean, nil?: true
+
+        # @!attribute skip_delay
+        #   When set to true, skips all delay steps in the workflow for this trigger
+        #   request. If false or not set, delay steps execute normally.
+        #
+        #   @return [Boolean, nil]
+        optional :skip_delay, Knockapi::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(sandbox_mode: nil, skip_delay: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::WorkflowTriggerParams::Settings} for more details.
+        #
+        #   Optional settings that control how this workflow trigger is executed.
+        #
+        #   @param sandbox_mode [Boolean, nil] When set to true, overrides the sandbox mode for all channels in this workflow r
+        #
+        #   @param skip_delay [Boolean, nil] When set to true, skips all delay steps in the workflow for this trigger request
+      end
     end
   end
 end

data/lib/knockapi/models.rb

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

data/lib/knockapi/resources/objects.rb

@@ -503,6 +503,30 @@ module Knockapi
         )
       end
 
+      # Unsets the preference set for the object, removing it entirely.
+      #
+      # @overload unset_preferences(collection, object_id_, id, request_options: {})
+      #
+      # @param collection [String] The collection this object belongs to.
+      #
+      # @param object_id_ [String] Unique identifier for the object.
+      #
+      # @param id [String] Unique identifier for the preference set.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Knockapi::Models::ObjectUnsetPreferencesParams
+      def unset_preferences(collection, object_id_, id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/objects/%1$s/%2$s/preferences/%3$s", collection, object_id_, id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Knockapi::Client]

data/lib/knockapi/resources/users/bulk.rb

@@ -52,6 +52,9 @@ module Knockapi
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Knockapi::Models::Users::BulkSetPreferencesParams} for more details.
+        #
         # Bulk sets the preferences for up to 1,000 users at a time. The preference
         # set `:id` can be either `default` or a `tenant.id`. Learn more
         # about [per-tenant preferences](/preferences/tenant-preferences). Note that this
@@ -60,7 +63,7 @@ module Knockapi
         #
         # @overload set_preferences(preferences:, user_ids:, request_options: {})
         #
-        # @param preferences [Knockapi::Models::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
+        # @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.
         #

data/lib/knockapi/resources/users.rb

@@ -449,6 +449,28 @@ module Knockapi
         )
       end
 
+      # Unsets the preference set for the user, removing it entirely.
+      #
+      # @overload unset_preferences(user_id, id, request_options: {})
+      #
+      # @param user_id [String] The unique identifier of the user.
+      #
+      # @param id [String] Unique identifier for the preference set.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Knockapi::Models::UserUnsetPreferencesParams
+      def unset_preferences(user_id, id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/users/%1$s/preferences/%2$s", user_id, id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Knockapi::Client]

data/lib/knockapi/resources/workflow_recipient_runs.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    # A workflow run represents an individual execution of a workflow for a specific
+    # recipient.
+    class WorkflowRecipientRuns
+      # Some parameter documentations has been truncated, see
+      # {Knockapi::Models::WorkflowRecipientRunListParams} for more details.
+      #
+      # Returns a paginated list of workflow recipient runs for the current environment.
+      #
+      # @overload list(after: nil, before: nil, ending_at: nil, has_errors: nil, page_size: nil, recipient: nil, starting_at: nil, status: nil, tenant: nil, workflow: nil, request_options: {})
+      #
+      # @param after [String] The cursor to fetch entries after.
+      #
+      # @param before [String] The cursor to fetch entries before.
+      #
+      # @param ending_at [Time] Limits the results to workflow recipient runs started before the given date.
+      #
+      # @param has_errors [Boolean] Limits the results to workflow recipient runs that have errors.
+      #
+      # @param page_size [Integer] The number of items per page (defaults to 50).
+      #
+      # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] Limits the results to workflow recipient runs for the given recipient. Accepts a
+      #
+      # @param starting_at [Time] Limits the results to workflow recipient runs started after the given date.
+      #
+      # @param status [Array<Symbol, Knockapi::Models::WorkflowRecipientRunListParams::Status>] Limits the results to workflow recipient runs with the given status.
+      #
+      # @param tenant [String] Limits the results to workflow recipient runs for the given tenant.
+      #
+      # @param workflow [String] Limits the results to workflow recipient runs for the given workflow key.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::WorkflowRecipientRun>]
+      #
+      # @see Knockapi::Models::WorkflowRecipientRunListParams
+      def list(params = {})
+        parsed, options = Knockapi::WorkflowRecipientRunListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/workflow_recipient_runs",
+          query: query,
+          page: Knockapi::Internal::ItemsCursor,
+          model: Knockapi::WorkflowRecipientRun,
+          options: options
+        )
+      end
+
+      # Returns a single workflow recipient run with its associated events.
+      #
+      # @overload get(id, request_options: {})
+      #
+      # @param id [String] The unique identifier for the workflow recipient run (per-recipient).
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Models::WorkflowRecipientRunDetail]
+      #
+      # @see Knockapi::Models::WorkflowRecipientRunGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/workflow_recipient_runs/%1$s", id],
+          model: Knockapi::WorkflowRecipientRunDetail,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/knockapi/resources/workflows.rb

@@ -16,7 +16,7 @@ module Knockapi
       #
       # @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
       #
@@ -45,7 +45,7 @@ module Knockapi
       # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
       # for the `actor`, `recipient`, and `tenant` fields.
       #
-      # @overload trigger(key, recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
+      # @overload trigger(key, recipients:, actor: nil, cancellation_key: nil, data: nil, settings: nil, tenant: nil, request_options: {})
       #
       # @param key [String] Key of the workflow to trigger.
       #
@@ -53,10 +53,12 @@ module Knockapi
       #
       # @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
       #
+      # @param settings [Knockapi::Models::WorkflowTriggerParams::Settings, nil] Optional settings that control how this workflow trigger is executed.
+      #
       # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.35.0"
+  VERSION = "1.36.0"
 end

data/lib/knockapi.rb

@@ -59,6 +59,7 @@ require_relative "knockapi/internal/slack_channels_cursor"
 require_relative "knockapi/models/recipients/channel_data_request"
 require_relative "knockapi/models/recipients/preference_set_request"
 require_relative "knockapi/models/identify_user_request"
+require_relative "knockapi/models/workflow_recipient_run"
 require_relative "knockapi/models/activity"
 require_relative "knockapi/models/audience_add_members_params"
 require_relative "knockapi/models/audience_list_members_params"
@@ -132,6 +133,7 @@ require_relative "knockapi/models/object_set_channel_data_params"
 require_relative "knockapi/models/object_set_params"
 require_relative "knockapi/models/object_set_preferences_params"
 require_relative "knockapi/models/object_unset_channel_data_params"
+require_relative "knockapi/models/object_unset_preferences_params"
 require_relative "knockapi/models/page_info"
 require_relative "knockapi/models/providers/ms_team_check_auth_params"
 require_relative "knockapi/models/providers/ms_team_check_auth_response"
@@ -214,8 +216,13 @@ require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
 require_relative "knockapi/models/user_set_channel_data_params"
 require_relative "knockapi/models/user_set_preferences_params"
 require_relative "knockapi/models/user_unset_channel_data_params"
+require_relative "knockapi/models/user_unset_preferences_params"
 require_relative "knockapi/models/user_update_params"
 require_relative "knockapi/models/workflow_cancel_params"
+require_relative "knockapi/models/workflow_recipient_run_detail"
+require_relative "knockapi/models/workflow_recipient_run_event"
+require_relative "knockapi/models/workflow_recipient_run_get_params"
+require_relative "knockapi/models/workflow_recipient_run_list_params"
 require_relative "knockapi/models/workflow_trigger_params"
 require_relative "knockapi/models/workflow_trigger_response"
 require_relative "knockapi/models"
@@ -245,4 +252,5 @@ require_relative "knockapi/resources/users"
 require_relative "knockapi/resources/users/bulk"
 require_relative "knockapi/resources/users/feeds"
 require_relative "knockapi/resources/users/guides"
+require_relative "knockapi/resources/workflow_recipient_runs"
 require_relative "knockapi/resources/workflows"

data/rbi/knockapi/client.rbi

@@ -54,6 +54,11 @@ module Knockapi
     sig { returns(Knockapi::Resources::Workflows) }
     attr_reader :workflows
 
+    # A workflow run represents an individual execution of a workflow for a specific
+    # recipient.
+    sig { returns(Knockapi::Resources::WorkflowRecipientRuns) }
+    attr_reader :workflow_recipient_runs
+
     # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
     # workflow.
     sig { returns(Knockapi::Resources::Schedules) }

data/rbi/knockapi/internal/util.rbi

@@ -148,12 +148,20 @@ module Knockapi
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)

data/rbi/knockapi/models/condition.rbi

@@ -84,6 +84,8 @@ module Knockapi
           T.let(:not_exists, Knockapi::Condition::Operator::TaggedSymbol)
         CONTAINS_ALL =
           T.let(:contains_all, Knockapi::Condition::Operator::TaggedSymbol)
+        NOT_CONTAINS_ALL =
+          T.let(:not_contains_all, Knockapi::Condition::Operator::TaggedSymbol)
         IS_TIMESTAMP =
           T.let(:is_timestamp, Knockapi::Condition::Operator::TaggedSymbol)
         IS_NOT_TIMESTAMP =

data/rbi/knockapi/models/message.rbi

@@ -108,6 +108,19 @@ module Knockapi
       sig { returns(T.nilable(Time)) }
       attr_accessor :read_at
 
+      # Recipient contact information captured at email send time. Null for non-email
+      # channels.
+      sig { returns(T.nilable(Knockapi::Message::RecipientSnapshot)) }
+      attr_reader :recipient_snapshot
+
+      sig do
+        params(
+          recipient_snapshot:
+            T.nilable(Knockapi::Message::RecipientSnapshot::OrHash)
+        ).void
+      end
+      attr_writer :recipient_snapshot
+
       # Timestamp when the message was scheduled to be sent.
       sig { returns(T.nilable(Time)) }
       attr_accessor :scheduled_at
@@ -158,6 +171,8 @@ module Knockapi
           link_clicked_at: T.nilable(Time),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           read_at: T.nilable(Time),
+          recipient_snapshot:
+            T.nilable(Knockapi::Message::RecipientSnapshot::OrHash),
           scheduled_at: T.nilable(Time),
           seen_at: T.nilable(Time),
           tenant: T.nilable(String),
@@ -208,6 +223,9 @@ module Knockapi
         metadata: nil,
         # Timestamp when the message was read.
         read_at: nil,
+        # Recipient contact information captured at email send time. Null for non-email
+        # channels.
+        recipient_snapshot: nil,
         # Timestamp when the message was scheduled to be sent.
         scheduled_at: nil,
         # Timestamp when the message was seen.
@@ -242,6 +260,7 @@ module Knockapi
             link_clicked_at: T.nilable(Time),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             read_at: T.nilable(Time),
+            recipient_snapshot: T.nilable(Knockapi::Message::RecipientSnapshot),
             scheduled_at: T.nilable(Time),
             seen_at: T.nilable(Time),
             tenant: T.nilable(String),
@@ -534,6 +553,46 @@ module Knockapi
           end
         end
       end
+
+      class RecipientSnapshot < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Message::RecipientSnapshot,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The email address the message was delivered to
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # The recipient name at send time
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Recipient contact information captured at email send time. Null for non-email
+        # channels.
+        sig do
+          params(email: String, name: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The email address the message was delivered to
+          email: nil,
+          # The recipient name at send time
+          name: nil
+        )
+        end
+
+        sig { override.returns({ email: String, name: T.nilable(String) }) }
+        def to_hash
+        end
+      end
     end
   end
 end