increase 1.284.1 → 1.286.0

data/lib/increase/models/export_create_params.rb

@@ -49,6 +49,13 @@ module Increase
       optional :bookkeeping_account_balance_csv,
                -> { Increase::ExportCreateParams::BookkeepingAccountBalanceCsv }
 
+      # @!attribute daily_account_balance_csv
+      #   Options for the created export. Required if `category` is equal to
+      #   `daily_account_balance_csv`.
+      #
+      #   @return [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv, nil]
+      optional :daily_account_balance_csv, -> { Increase::ExportCreateParams::DailyAccountBalanceCsv }
+
       # @!attribute entity_csv
       #   Options for the created export. Required if `category` is equal to `entity_csv`.
       #
@@ -82,7 +89,7 @@ module Increase
       #   @return [Increase::Models::ExportCreateParams::VoidedCheck, nil]
       optional :voided_check, -> { Increase::ExportCreateParams::VoidedCheck }
 
-      # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
+      # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::ExportCreateParams} for more details.
       #
@@ -99,6 +106,8 @@ module Increase
       #   @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
       #   `bookkeeping\_
       #
+      #   @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
+      #
       #   @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
       #
       #   @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
@@ -146,6 +155,9 @@ module Increase
         # A PDF of a voided check.
         VOIDED_CHECK = :voided_check
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end
@@ -418,6 +430,36 @@ module Increase
         end
       end
 
+      class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
+        # @!attribute account_id
+        #   Filter exported Balances to the specified Account.
+        #
+        #   @return [String, nil]
+        optional :account_id, String
+
+        # @!attribute on_or_after_date
+        #   Filter exported Balances to those on or after this date.
+        #
+        #   @return [Date, nil]
+        optional :on_or_after_date, Date
+
+        # @!attribute on_or_before_date
+        #   Filter exported Balances to those on or before this date.
+        #
+        #   @return [Date, nil]
+        optional :on_or_before_date, Date
+
+        # @!method initialize(account_id: nil, on_or_after_date: nil, on_or_before_date: nil)
+        #   Options for the created export. Required if `category` is equal to
+        #   `daily_account_balance_csv`.
+        #
+        #   @param account_id [String] Filter exported Balances to the specified Account.
+        #
+        #   @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
+        #
+        #   @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
+      end
+
       class EntityCsv < Increase::Internal::Type::BaseModel
         # @!method initialize
         #   Options for the created export. Required if `category` is equal to `entity_csv`.

data/lib/increase/models/export_list_params.rb

@@ -123,6 +123,9 @@ module Increase
         # A PDF of a voided check.
         VOIDED_CHECK = :voided_check
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::EntityOnboardingSessions#submit
+      class EntityOnboardingSessionSubmitParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute entity_onboarding_session_id
+        #   The identifier of the Entity Onboarding Session you wish to submit.
+        #
+        #   @return [String]
+        required :entity_onboarding_session_id, String
+
+        # @!method initialize(entity_onboarding_session_id:, request_options: {})
+        #   @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session you wish to submit.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -269,6 +269,16 @@ module Increase
 
   EntityListParams = Increase::Models::EntityListParams
 
+  EntityOnboardingSession = Increase::Models::EntityOnboardingSession
+
+  EntityOnboardingSessionCreateParams = Increase::Models::EntityOnboardingSessionCreateParams
+
+  EntityOnboardingSessionExpireParams = Increase::Models::EntityOnboardingSessionExpireParams
+
+  EntityOnboardingSessionListParams = Increase::Models::EntityOnboardingSessionListParams
+
+  EntityOnboardingSessionRetrieveParams = Increase::Models::EntityOnboardingSessionRetrieveParams
+
   EntityRetrieveParams = Increase::Models::EntityRetrieveParams
 
   EntitySupplementalDocument = Increase::Models::EntitySupplementalDocument

data/lib/increase/resources/entity_onboarding_sessions.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class EntityOnboardingSessions
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::EntityOnboardingSessionCreateParams} for more details.
+      #
+      # Create an Entity Onboarding Session
+      #
+      # @overload create(program_id:, redirect_url:, entity_id: nil, request_options: {})
+      #
+      # @param program_id [String] The identifier of the Program the Entity will be onboarded to.
+      #
+      # @param redirect_url [String] The URL to redirect the customer to after they complete the onboarding form. The
+      #
+      # @param entity_id [String] The identifier of an existing Entity to associate with the onboarding session. I
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityOnboardingSession]
+      #
+      # @see Increase::Models::EntityOnboardingSessionCreateParams
+      def create(params)
+        parsed, options = Increase::EntityOnboardingSessionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "entity_onboarding_sessions",
+          body: parsed,
+          model: Increase::EntityOnboardingSession,
+          options: options
+        )
+      end
+
+      # Retrieve an Entity Onboarding Session
+      #
+      # @overload retrieve(entity_onboarding_session_id, request_options: {})
+      #
+      # @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityOnboardingSession]
+      #
+      # @see Increase::Models::EntityOnboardingSessionRetrieveParams
+      def retrieve(entity_onboarding_session_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["entity_onboarding_sessions/%1$s", entity_onboarding_session_id],
+          model: Increase::EntityOnboardingSession,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::EntityOnboardingSessionListParams} for more details.
+      #
+      # List Entity Onboarding Session
+      #
+      # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::EntityOnboardingSessionListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::EntityOnboardingSession>]
+      #
+      # @see Increase::Models::EntityOnboardingSessionListParams
+      def list(params = {})
+        parsed, options = Increase::EntityOnboardingSessionListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "entity_onboarding_sessions",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::EntityOnboardingSession,
+          options: options
+        )
+      end
+
+      # Expire an Entity Onboarding Session
+      #
+      # @overload expire(entity_onboarding_session_id, request_options: {})
+      #
+      # @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session to expire.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityOnboardingSession]
+      #
+      # @see Increase::Models::EntityOnboardingSessionExpireParams
+      def expire(entity_onboarding_session_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["entity_onboarding_sessions/%1$s/expire", entity_onboarding_session_id],
+          model: Increase::EntityOnboardingSession,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/exports.rb

@@ -8,7 +8,7 @@ module Increase
       #
       # Create an Export
       #
-      # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
+      # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
       #
       # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
       #
@@ -23,6 +23,8 @@ module Increase
       # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
       # `bookkeeping\_
       #
+      # @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
+      #
       # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
       #
       # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst

data/lib/increase/resources/simulations/entity_onboarding_sessions.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class EntityOnboardingSessions
+        # Simulates the submission of an
+        # [Entity Onboarding Session](#entity-onboarding-sessions). This session must have
+        # a `status` of `active`. After submission, the session will transition to
+        # `expired` and a new Entity will be created.
+        #
+        # @overload submit(entity_onboarding_session_id, request_options: {})
+        #
+        # @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session you wish to submit.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::EntityOnboardingSession]
+        #
+        # @see Increase::Models::Simulations::EntityOnboardingSessionSubmitParams
+        def submit(entity_onboarding_session_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/entity_onboarding_sessions/%1$s/submit", entity_onboarding_session_id],
+            model: Increase::EntityOnboardingSession,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -87,6 +87,9 @@ module Increase
       # @return [Increase::Resources::Simulations::InboundMailItems]
       attr_reader :inbound_mail_items
 
+      # @return [Increase::Resources::Simulations::EntityOnboardingSessions]
+      attr_reader :entity_onboarding_sessions
+
       # @return [Increase::Resources::Simulations::Programs]
       attr_reader :programs
 
@@ -137,6 +140,8 @@ module Increase
         @inbound_fednow_transfers = Increase::Resources::Simulations::InboundFednowTransfers.new(client: client)
         @check_deposits = Increase::Resources::Simulations::CheckDeposits.new(client: client)
         @inbound_mail_items = Increase::Resources::Simulations::InboundMailItems.new(client: client)
+        @entity_onboarding_sessions =
+          Increase::Resources::Simulations::EntityOnboardingSessions.new(client: client)
         @programs = Increase::Resources::Simulations::Programs.new(client: client)
         @account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
         @exports = Increase::Resources::Simulations::Exports.new(client: client)

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.284.1"
+  VERSION = "1.286.0"
 end

data/lib/increase.rb

@@ -169,6 +169,11 @@ require_relative "increase/models/entity_archive_params"
 require_relative "increase/models/entity_beneficial_owner"
 require_relative "increase/models/entity_create_params"
 require_relative "increase/models/entity_list_params"
+require_relative "increase/models/entity_onboarding_session"
+require_relative "increase/models/entity_onboarding_session_create_params"
+require_relative "increase/models/entity_onboarding_session_expire_params"
+require_relative "increase/models/entity_onboarding_session_list_params"
+require_relative "increase/models/entity_onboarding_session_retrieve_params"
 require_relative "increase/models/entity_retrieve_params"
 require_relative "increase/models/entity_supplemental_document"
 require_relative "increase/models/entity_update_params"
@@ -315,6 +320,7 @@ require_relative "increase/models/simulations/check_deposit_submit_params"
 require_relative "increase/models/simulations/check_transfer_mail_params"
 require_relative "increase/models/simulations/digital_wallet_token_request_create_params"
 require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
+require_relative "increase/models/simulations/entity_onboarding_session_submit_params"
 require_relative "increase/models/simulations/export_create_params"
 require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
 require_relative "increase/models/simulations/inbound_check_deposit_adjustment_params"
@@ -380,6 +386,7 @@ require_relative "increase/resources/declined_transactions"
 require_relative "increase/resources/digital_card_profiles"
 require_relative "increase/resources/digital_wallet_tokens"
 require_relative "increase/resources/entities"
+require_relative "increase/resources/entity_onboarding_sessions"
 require_relative "increase/resources/events"
 require_relative "increase/resources/event_subscriptions"
 require_relative "increase/resources/exports"
@@ -427,6 +434,7 @@ require_relative "increase/resources/simulations/card_tokens"
 require_relative "increase/resources/simulations/check_deposits"
 require_relative "increase/resources/simulations/check_transfers"
 require_relative "increase/resources/simulations/digital_wallet_token_requests"
+require_relative "increase/resources/simulations/entity_onboarding_sessions"
 require_relative "increase/resources/simulations/exports"
 require_relative "increase/resources/simulations/inbound_ach_transfers"
 require_relative "increase/resources/simulations/inbound_check_deposits"

data/rbi/increase/client.rbi

@@ -133,6 +133,9 @@ module Increase
     sig { returns(Increase::Resources::SupplementalDocuments) }
     attr_reader :supplemental_documents
 
+    sig { returns(Increase::Resources::EntityOnboardingSessions) }
+    attr_reader :entity_onboarding_sessions
+
     sig { returns(Increase::Resources::Programs) }
     attr_reader :programs
 

data/rbi/increase/models/entity_onboarding_session.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSession < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::EntityOnboardingSession, Increase::Internal::AnyHash)
+        end
+
+      # The Entity Onboarding Session's identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the Entity Onboarding Session was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The identifier of the Entity associated with this session, if one has been
+      # created or was provided when creating the session.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :entity_id
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the Entity Onboarding Session will expire.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The idempotency key you chose for this object. This value is unique across
+      # Increase and is used to ensure that a request is only processed once. Learn more
+      # about [idempotency](https://increase.com/documentation/idempotency-keys).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotency_key
+
+      # The identifier of the Program the Entity will be onboarded to.
+      sig { returns(String) }
+      attr_accessor :program_id
+
+      # The URL to redirect to after the onboarding session is complete. Increase will
+      # include the query parameters `entity_onboarding_session_id` and `entity_id` when
+      # redirecting.
+      sig { returns(String) }
+      attr_accessor :redirect_url
+
+      # The URL containing the onboarding form. You should share this link with your
+      # customer. Only present when the session is active.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :session_url
+
+      # The status of the onboarding session.
+      sig { returns(Increase::EntityOnboardingSession::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_onboarding_session`.
+      sig { returns(Increase::EntityOnboardingSession::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Entity Onboarding Sessions let your customers onboard themselves by completing
+      # Increase-hosted forms. Create a session and redirect your customer to the
+      # returned URL. When they're done, they'll be redirected back to your site. This
+      # API is used for [hosted onboarding](/documentation/hosted-onboarding).
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          entity_id: T.nilable(String),
+          expires_at: Time,
+          idempotency_key: T.nilable(String),
+          program_id: String,
+          redirect_url: String,
+          session_url: T.nilable(String),
+          status: Increase::EntityOnboardingSession::Status::OrSymbol,
+          type: Increase::EntityOnboardingSession::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Entity Onboarding Session's identifier.
+        id:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Entity Onboarding Session was created.
+        created_at:,
+        # The identifier of the Entity associated with this session, if one has been
+        # created or was provided when creating the session.
+        entity_id:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Entity Onboarding Session will expire.
+        expires_at:,
+        # The idempotency key you chose for this object. This value is unique across
+        # Increase and is used to ensure that a request is only processed once. Learn more
+        # about [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key:,
+        # The identifier of the Program the Entity will be onboarded to.
+        program_id:,
+        # The URL to redirect to after the onboarding session is complete. Increase will
+        # include the query parameters `entity_onboarding_session_id` and `entity_id` when
+        # redirecting.
+        redirect_url:,
+        # The URL containing the onboarding form. You should share this link with your
+        # customer. Only present when the session is active.
+        session_url:,
+        # The status of the onboarding session.
+        status:,
+        # A constant representing the object's type. For this resource it will always be
+        # `entity_onboarding_session`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            entity_id: T.nilable(String),
+            expires_at: Time,
+            idempotency_key: T.nilable(String),
+            program_id: String,
+            redirect_url: String,
+            session_url: T.nilable(String),
+            status: Increase::EntityOnboardingSession::Status::TaggedSymbol,
+            type: Increase::EntityOnboardingSession::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the onboarding session.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::EntityOnboardingSession::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # The Entity Onboarding Session is active.
+        ACTIVE =
+          T.let(
+            :active,
+            Increase::EntityOnboardingSession::Status::TaggedSymbol
+          )
+
+        # The Entity Onboarding Session has expired.
+        EXPIRED =
+          T.let(
+            :expired,
+            Increase::EntityOnboardingSession::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::EntityOnboardingSession::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_onboarding_session`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::EntityOnboardingSession::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITY_ONBOARDING_SESSION =
+          T.let(
+            :entity_onboarding_session,
+            Increase::EntityOnboardingSession::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::EntityOnboardingSession::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_create_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Program the Entity will be onboarded to.
+      sig { returns(String) }
+      attr_accessor :program_id
+
+      # The URL to redirect the customer to after they complete the onboarding form. The
+      # redirect will include `entity_onboarding_session_id` and `entity_id` query
+      # parameters.
+      sig { returns(String) }
+      attr_accessor :redirect_url
+
+      # The identifier of an existing Entity to associate with the onboarding session.
+      # If provided, the onboarding form will display any outstanding tasks required to
+      # complete the Entity's onboarding.
+      sig { returns(T.nilable(String)) }
+      attr_reader :entity_id
+
+      sig { params(entity_id: String).void }
+      attr_writer :entity_id
+
+      sig do
+        params(
+          program_id: String,
+          redirect_url: String,
+          entity_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Program the Entity will be onboarded to.
+        program_id:,
+        # The URL to redirect the customer to after they complete the onboarding form. The
+        # redirect will include `entity_onboarding_session_id` and `entity_id` query
+        # parameters.
+        redirect_url:,
+        # The identifier of an existing Entity to associate with the onboarding session.
+        # If provided, the onboarding form will display any outstanding tasks required to
+        # complete the Entity's onboarding.
+        entity_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            program_id: String,
+            redirect_url: String,
+            entity_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end