increase 1.284.0 → 1.286.0

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

data/rbi/increase/models/entity_onboarding_session_expire_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionExpireParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionExpireParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Entity Onboarding Session to expire.
+      sig { returns(String) }
+      attr_accessor :entity_onboarding_session_id
+
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Entity Onboarding Session to expire.
+        entity_onboarding_session_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_list_params.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Filter records to the one with the specified `idempotency_key` you chose for
+      # that 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_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        returns(T.nilable(Increase::EntityOnboardingSessionListParams::Status))
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::EntityOnboardingSessionListParams::Status::OrHash
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::EntityOnboardingSessionListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that 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: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::EntityOnboardingSessionListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityOnboardingSessionListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Entity Onboarding Session for those with the specified status or
+        # statuses. For GET requests, this should be encoded as a comma-delimited string,
+        # such as `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Entity Onboarding Session for those with the specified status or
+          # statuses. For GET requests, this should be encoded as a comma-delimited string,
+          # such as `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::EntityOnboardingSessionListParams::Status::In
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The Entity Onboarding Session is active.
+          ACTIVE =
+            T.let(
+              :active,
+              Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+            )
+
+          # The Entity Onboarding Session has expired.
+          EXPIRED =
+            T.let(
+              :expired,
+              Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Entity Onboarding Session.
+      sig { returns(String) }
+      attr_accessor :entity_onboarding_session_id
+
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Entity Onboarding Session.
+        entity_onboarding_session_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/export.rbi

@@ -83,6 +83,19 @@ module Increase
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # Details of the daily account balance CSV export. This field will be present when
+      # the `category` is equal to `daily_account_balance_csv`.
+      sig { returns(T.nilable(Increase::Export::DailyAccountBalanceCsv)) }
+      attr_reader :daily_account_balance_csv
+
+      sig do
+        params(
+          daily_account_balance_csv:
+            T.nilable(Increase::Export::DailyAccountBalanceCsv::OrHash)
+        ).void
+      end
+      attr_writer :daily_account_balance_csv
+
       # Details of the dashboard table CSV export. This field will be present when the
       # `category` is equal to `dashboard_table_csv`.
       sig { returns(T.nilable(Increase::Export::DashboardTableCsv)) }
@@ -227,6 +240,8 @@ module Increase
             T.nilable(Increase::Export::BookkeepingAccountBalanceCsv::OrHash),
           category: Increase::Export::Category::OrSymbol,
           created_at: Time,
+          daily_account_balance_csv:
+            T.nilable(Increase::Export::DailyAccountBalanceCsv::OrHash),
           dashboard_table_csv:
             T.nilable(Increase::Export::DashboardTableCsv::OrHash),
           entity_csv: T.nilable(Increase::Export::EntityCsv::OrHash),
@@ -267,6 +282,9 @@ module Increase
         category:,
         # The time the Export was created.
         created_at:,
+        # Details of the daily account balance CSV export. This field will be present when
+        # the `category` is equal to `daily_account_balance_csv`.
+        daily_account_balance_csv:,
         # Details of the dashboard table CSV export. This field will be present when the
         # `category` is equal to `dashboard_table_csv`.
         dashboard_table_csv:,
@@ -324,6 +342,8 @@ module Increase
               T.nilable(Increase::Export::BookkeepingAccountBalanceCsv),
             category: Increase::Export::Category::TaggedSymbol,
             created_at: Time,
+            daily_account_balance_csv:
+              T.nilable(Increase::Export::DailyAccountBalanceCsv),
             dashboard_table_csv: T.nilable(Increase::Export::DashboardTableCsv),
             entity_csv: T.nilable(Increase::Export::EntityCsv),
             fee_csv: T.nilable(Increase::Export::FeeCsv),
@@ -812,6 +832,13 @@ module Increase
         VOIDED_CHECK =
           T.let(:voided_check, Increase::Export::Category::TaggedSymbol)
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV =
+          T.let(
+            :daily_account_balance_csv,
+            Increase::Export::Category::TaggedSymbol
+          )
+
         sig do
           override.returns(T::Array[Increase::Export::Category::TaggedSymbol])
         end
@@ -819,6 +846,59 @@ module Increase
         end
       end
 
+      class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Export::DailyAccountBalanceCsv,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter results by Account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :account_id
+
+        # Filter balances on or after this date.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :on_or_after_date
+
+        # Filter balances on or before this date.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :on_or_before_date
+
+        # Details of the daily account balance CSV export. This field will be present when
+        # the `category` is equal to `daily_account_balance_csv`.
+        sig do
+          params(
+            account_id: T.nilable(String),
+            on_or_after_date: T.nilable(Date),
+            on_or_before_date: T.nilable(Date)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter results by Account.
+          account_id:,
+          # Filter balances on or after this date.
+          on_or_after_date:,
+          # Filter balances on or before this date.
+          on_or_before_date:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_id: T.nilable(String),
+              on_or_after_date: T.nilable(Date),
+              on_or_before_date: T.nilable(Date)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class DashboardTableCsv < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/export_create_params.rbi

@@ -91,6 +91,21 @@ module Increase
       end
       attr_writer :bookkeeping_account_balance_csv
 
+      # Options for the created export. Required if `category` is equal to
+      # `daily_account_balance_csv`.
+      sig do
+        returns(T.nilable(Increase::ExportCreateParams::DailyAccountBalanceCsv))
+      end
+      attr_reader :daily_account_balance_csv
+
+      sig do
+        params(
+          daily_account_balance_csv:
+            Increase::ExportCreateParams::DailyAccountBalanceCsv::OrHash
+        ).void
+      end
+      attr_writer :daily_account_balance_csv
+
       # Options for the created export. Required if `category` is equal to `entity_csv`.
       sig { returns(T.nilable(Increase::ExportCreateParams::EntityCsv)) }
       attr_reader :entity_csv
@@ -160,6 +175,8 @@ module Increase
           balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
           bookkeeping_account_balance_csv:
             Increase::ExportCreateParams::BookkeepingAccountBalanceCsv::OrHash,
+          daily_account_balance_csv:
+            Increase::ExportCreateParams::DailyAccountBalanceCsv::OrHash,
           entity_csv: Increase::ExportCreateParams::EntityCsv::OrHash,
           funding_instructions:
             Increase::ExportCreateParams::FundingInstructions::OrHash,
@@ -187,6 +204,9 @@ module Increase
         # Options for the created export. Required if `category` is equal to
         # `bookkeeping_account_balance_csv`.
         bookkeeping_account_balance_csv: nil,
+        # Options for the created export. Required if `category` is equal to
+        # `daily_account_balance_csv`.
+        daily_account_balance_csv: nil,
         # Options for the created export. Required if `category` is equal to `entity_csv`.
         entity_csv: nil,
         # Options for the created export. Required if `category` is equal to
@@ -217,6 +237,8 @@ module Increase
             balance_csv: Increase::ExportCreateParams::BalanceCsv,
             bookkeeping_account_balance_csv:
               Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
+            daily_account_balance_csv:
+              Increase::ExportCreateParams::DailyAccountBalanceCsv,
             entity_csv: Increase::ExportCreateParams::EntityCsv,
             funding_instructions:
               Increase::ExportCreateParams::FundingInstructions,
@@ -308,6 +330,13 @@ module Increase
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV =
+          T.let(
+            :daily_account_balance_csv,
+            Increase::ExportCreateParams::Category::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[Increase::ExportCreateParams::Category::TaggedSymbol]
@@ -855,6 +884,68 @@ module Increase
         end
       end
 
+      class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::ExportCreateParams::DailyAccountBalanceCsv,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter exported Balances to the specified Account.
+        sig { returns(T.nilable(String)) }
+        attr_reader :account_id
+
+        sig { params(account_id: String).void }
+        attr_writer :account_id
+
+        # Filter exported Balances to those on or after this date.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :on_or_after_date
+
+        sig { params(on_or_after_date: Date).void }
+        attr_writer :on_or_after_date
+
+        # Filter exported Balances to those on or before this date.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :on_or_before_date
+
+        sig { params(on_or_before_date: Date).void }
+        attr_writer :on_or_before_date
+
+        # Options for the created export. Required if `category` is equal to
+        # `daily_account_balance_csv`.
+        sig do
+          params(
+            account_id: String,
+            on_or_after_date: Date,
+            on_or_before_date: Date
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter exported Balances to the specified Account.
+          account_id: nil,
+          # Filter exported Balances to those on or after this date.
+          on_or_after_date: nil,
+          # Filter exported Balances to those on or before this date.
+          on_or_before_date: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_id: String,
+              on_or_after_date: Date,
+              on_or_before_date: Date
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class EntityCsv < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/export_list_params.rbi

@@ -228,6 +228,13 @@ module Increase
             Increase::ExportListParams::Category::TaggedSymbol
           )
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV =
+          T.let(
+            :daily_account_balance_csv,
+            Increase::ExportListParams::Category::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[Increase::ExportListParams::Category::TaggedSymbol]

data/rbi/increase/models/simulations/entity_onboarding_session_submit_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class EntityOnboardingSessionSubmitParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::EntityOnboardingSessionSubmitParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Entity Onboarding Session you wish to submit.
+        sig { returns(String) }
+        attr_accessor :entity_onboarding_session_id
+
+        sig do
+          params(
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Entity Onboarding Session you wish to submit.
+          entity_onboarding_session_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              entity_onboarding_session_id: String,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -257,6 +257,20 @@ 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