increase 1.284.0 → 1.286.0

data/rbi/increase/resources/entity_onboarding_sessions.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class EntityOnboardingSessions
+      # Create an Entity Onboarding Session
+      sig do
+        params(
+          program_id: String,
+          redirect_url: String,
+          entity_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityOnboardingSession)
+      end
+      def create(
+        # 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
+
+      # Retrieve an Entity Onboarding Session
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityOnboardingSession)
+      end
+      def retrieve(
+        # The identifier of the Entity Onboarding Session.
+        entity_onboarding_session_id,
+        request_options: {}
+      )
+      end
+
+      # List Entity Onboarding Session
+      sig do
+        params(
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::EntityOnboardingSessionListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::EntityOnboardingSession])
+      end
+      def list(
+        # 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
+
+      # Expire an Entity Onboarding Session
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityOnboardingSession)
+      end
+      def expire(
+        # The identifier of the Entity Onboarding Session to expire.
+        entity_onboarding_session_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/exports.rbi

@@ -16,6 +16,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,
@@ -43,6 +45,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

data/rbi/increase/resources/simulations/entity_onboarding_sessions.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+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.
+        sig do
+          params(
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::EntityOnboardingSession)
+        end
+        def submit(
+          # The identifier of the Entity Onboarding Session you wish to submit.
+          entity_onboarding_session_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations.rbi

@@ -99,6 +99,11 @@ module Increase
       sig { returns(Increase::Resources::Simulations::InboundMailItems) }
       attr_reader :inbound_mail_items
 
+      sig do
+        returns(Increase::Resources::Simulations::EntityOnboardingSessions)
+      end
+      attr_reader :entity_onboarding_sessions
+
       sig { returns(Increase::Resources::Simulations::Programs) }
       attr_reader :programs
 

data/sig/increase/client.rbs

@@ -89,6 +89,8 @@ module Increase
 
     attr_reader supplemental_documents: Increase::Resources::SupplementalDocuments
 
+    attr_reader entity_onboarding_sessions: Increase::Resources::EntityOnboardingSessions
+
     attr_reader programs: Increase::Resources::Programs
 
     attr_reader account_statements: Increase::Resources::AccountStatements

data/sig/increase/models/entity_onboarding_session.rbs

@@ -0,0 +1,89 @@
+module Increase
+  module Models
+    type entity_onboarding_session =
+      {
+        id: String,
+        created_at: Time,
+        entity_id: String?,
+        expires_at: Time,
+        idempotency_key: String?,
+        program_id: String,
+        redirect_url: String,
+        session_url: String?,
+        status: Increase::Models::EntityOnboardingSession::status,
+        type: Increase::Models::EntityOnboardingSession::type_
+      }
+
+    class EntityOnboardingSession < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor entity_id: String?
+
+      attr_accessor expires_at: Time
+
+      attr_accessor idempotency_key: String?
+
+      attr_accessor program_id: String
+
+      attr_accessor redirect_url: String
+
+      attr_accessor session_url: String?
+
+      attr_accessor status: Increase::Models::EntityOnboardingSession::status
+
+      attr_accessor type: Increase::Models::EntityOnboardingSession::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        entity_id: String?,
+        expires_at: Time,
+        idempotency_key: String?,
+        program_id: String,
+        redirect_url: String,
+        session_url: String?,
+        status: Increase::Models::EntityOnboardingSession::status,
+        type: Increase::Models::EntityOnboardingSession::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        entity_id: String?,
+        expires_at: Time,
+        idempotency_key: String?,
+        program_id: String,
+        redirect_url: String,
+        session_url: String?,
+        status: Increase::Models::EntityOnboardingSession::status,
+        type: Increase::Models::EntityOnboardingSession::type_
+      }
+
+      type status = :active | :expired
+
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Entity Onboarding Session is active.
+        ACTIVE: :active
+
+        # The Entity Onboarding Session has expired.
+        EXPIRED: :expired
+
+        def self?.values: -> ::Array[Increase::Models::EntityOnboardingSession::status]
+      end
+
+      type type_ = :entity_onboarding_session
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ENTITY_ONBOARDING_SESSION: :entity_onboarding_session
+
+        def self?.values: -> ::Array[Increase::Models::EntityOnboardingSession::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/entity_onboarding_session_create_params.rbs

@@ -0,0 +1,34 @@
+module Increase
+  module Models
+    type entity_onboarding_session_create_params =
+      { program_id: String, redirect_url: String, entity_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class EntityOnboardingSessionCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor program_id: String
+
+      attr_accessor redirect_url: String
+
+      attr_reader entity_id: String?
+
+      def entity_id=: (String) -> String
+
+      def initialize: (
+        program_id: String,
+        redirect_url: String,
+        ?entity_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        program_id: String,
+        redirect_url: String,
+        entity_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/entity_onboarding_session_expire_params.rbs

@@ -0,0 +1,24 @@
+module Increase
+  module Models
+    type entity_onboarding_session_expire_params =
+      { entity_onboarding_session_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class EntityOnboardingSessionExpireParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor entity_onboarding_session_id: String
+
+      def initialize: (
+        entity_onboarding_session_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        entity_onboarding_session_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/entity_onboarding_session_list_params.rbs

@@ -0,0 +1,86 @@
+module Increase
+  module Models
+    type entity_onboarding_session_list_params =
+      {
+        cursor: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::EntityOnboardingSessionListParams::Status
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class EntityOnboardingSessionListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader status: Increase::EntityOnboardingSessionListParams::Status?
+
+      def status=: (
+        Increase::EntityOnboardingSessionListParams::Status
+      ) -> Increase::EntityOnboardingSessionListParams::Status
+
+      def initialize: (
+        ?cursor: String,
+        ?idempotency_key: String,
+        ?limit: Integer,
+        ?status: Increase::EntityOnboardingSessionListParams::Status,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        cursor: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::EntityOnboardingSessionListParams::Status,
+        request_options: Increase::RequestOptions
+      }
+
+      type status =
+        {
+          in_: ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+        }
+
+      class Status < Increase::Internal::Type::BaseModel
+        attr_reader in_: ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]?
+
+        def in_=: (
+          ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+        ) -> ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+
+        def initialize: (
+          ?in_: ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+        ) -> void
+
+        def to_hash: -> {
+          in_: ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+        }
+
+        type in_ = :active | :expired
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The Entity Onboarding Session is active.
+          ACTIVE: :active
+
+          # The Entity Onboarding Session has expired.
+          EXPIRED: :expired
+
+          def self?.values: -> ::Array[Increase::Models::EntityOnboardingSessionListParams::Status::in_]
+        end
+      end
+    end
+  end
+end

data/sig/increase/models/entity_onboarding_session_retrieve_params.rbs

@@ -0,0 +1,24 @@
+module Increase
+  module Models
+    type entity_onboarding_session_retrieve_params =
+      { entity_onboarding_session_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class EntityOnboardingSessionRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor entity_onboarding_session_id: String
+
+      def initialize: (
+        entity_onboarding_session_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        entity_onboarding_session_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/export.rbs

@@ -10,6 +10,7 @@ module Increase
         bookkeeping_account_balance_csv: Increase::Export::BookkeepingAccountBalanceCsv?,
         category: Increase::Models::Export::category,
         created_at: Time,
+        daily_account_balance_csv: Increase::Export::DailyAccountBalanceCsv?,
         dashboard_table_csv: Increase::Export::DashboardTableCsv?,
         entity_csv: Increase::Export::EntityCsv?,
         fee_csv: Increase::Export::FeeCsv?,
@@ -42,6 +43,8 @@ module Increase
 
       attr_accessor created_at: Time
 
+      attr_accessor daily_account_balance_csv: Increase::Export::DailyAccountBalanceCsv?
+
       attr_accessor dashboard_table_csv: Increase::Export::DashboardTableCsv?
 
       attr_accessor entity_csv: Increase::Export::EntityCsv?
@@ -77,6 +80,7 @@ module Increase
         bookkeeping_account_balance_csv: Increase::Export::BookkeepingAccountBalanceCsv?,
         category: Increase::Models::Export::category,
         created_at: Time,
+        daily_account_balance_csv: Increase::Export::DailyAccountBalanceCsv?,
         dashboard_table_csv: Increase::Export::DashboardTableCsv?,
         entity_csv: Increase::Export::EntityCsv?,
         fee_csv: Increase::Export::FeeCsv?,
@@ -101,6 +105,7 @@ module Increase
         bookkeeping_account_balance_csv: Increase::Export::BookkeepingAccountBalanceCsv?,
         category: Increase::Models::Export::category,
         created_at: Time,
+        daily_account_balance_csv: Increase::Export::DailyAccountBalanceCsv?,
         dashboard_table_csv: Increase::Export::DashboardTableCsv?,
         entity_csv: Increase::Export::EntityCsv?,
         fee_csv: Increase::Export::FeeCsv?,
@@ -269,6 +274,7 @@ module Increase
         | :form_1099_misc
         | :fee_csv
         | :voided_check
+        | :daily_account_balance_csv
 
       module Category
         extend Increase::Internal::Type::Enum
@@ -315,9 +321,39 @@ 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
+
         def self?.values: -> ::Array[Increase::Models::Export::category]
       end
 
+      type daily_account_balance_csv =
+        {
+          account_id: String?,
+          on_or_after_date: Date?,
+          on_or_before_date: Date?
+        }
+
+      class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
+        attr_accessor account_id: String?
+
+        attr_accessor on_or_after_date: Date?
+
+        attr_accessor on_or_before_date: Date?
+
+        def initialize: (
+          account_id: String?,
+          on_or_after_date: Date?,
+          on_or_before_date: Date?
+        ) -> void
+
+        def to_hash: -> {
+          account_id: String?,
+          on_or_after_date: Date?,
+          on_or_before_date: Date?
+        }
+      end
+
       type dashboard_table_csv = {  }
 
       class DashboardTableCsv < Increase::Internal::Type::BaseModel

data/sig/increase/models/export_create_params.rbs

@@ -8,6 +8,7 @@ module Increase
         account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
         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,
         transaction_csv: Increase::ExportCreateParams::TransactionCsv,
@@ -52,6 +53,12 @@ module Increase
         Increase::ExportCreateParams::BookkeepingAccountBalanceCsv
       ) -> Increase::ExportCreateParams::BookkeepingAccountBalanceCsv
 
+      attr_reader daily_account_balance_csv: Increase::ExportCreateParams::DailyAccountBalanceCsv?
+
+      def daily_account_balance_csv=: (
+        Increase::ExportCreateParams::DailyAccountBalanceCsv
+      ) -> Increase::ExportCreateParams::DailyAccountBalanceCsv
+
       attr_reader entity_csv: Increase::ExportCreateParams::EntityCsv?
 
       def entity_csv=: (
@@ -89,6 +96,7 @@ module Increase
         ?account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
         ?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,
         ?transaction_csv: Increase::ExportCreateParams::TransactionCsv,
@@ -104,6 +112,7 @@ module Increase
         account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
         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,
         transaction_csv: Increase::ExportCreateParams::TransactionCsv,
@@ -123,6 +132,7 @@ module Increase
         | :account_verification_letter
         | :funding_instructions
         | :voided_check
+        | :daily_account_balance_csv
 
       module Category
         extend Increase::Internal::Type::Enum
@@ -157,6 +167,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
+
         def self?.values: -> ::Array[Increase::Models::ExportCreateParams::category]
       end
 
@@ -391,6 +404,35 @@ module Increase
         end
       end
 
+      type daily_account_balance_csv =
+        { account_id: String, on_or_after_date: Date, on_or_before_date: Date }
+
+      class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
+        attr_reader account_id: String?
+
+        def account_id=: (String) -> String
+
+        attr_reader on_or_after_date: Date?
+
+        def on_or_after_date=: (Date) -> Date
+
+        attr_reader on_or_before_date: Date?
+
+        def on_or_before_date=: (Date) -> Date
+
+        def initialize: (
+          ?account_id: String,
+          ?on_or_after_date: Date,
+          ?on_or_before_date: Date
+        ) -> void
+
+        def to_hash: -> {
+          account_id: String,
+          on_or_after_date: Date,
+          on_or_before_date: Date
+        }
+      end
+
       type entity_csv = {  }
 
       class EntityCsv < Increase::Internal::Type::BaseModel

data/sig/increase/models/export_list_params.rbs

@@ -98,6 +98,7 @@ module Increase
         | :form_1099_misc
         | :fee_csv
         | :voided_check
+        | :daily_account_balance_csv
 
       module Category
         extend Increase::Internal::Type::Enum
@@ -144,6 +145,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
+
         def self?.values: -> ::Array[Increase::Models::ExportListParams::category]
       end
 

data/sig/increase/models/simulations/entity_onboarding_session_submit_params.rbs

@@ -0,0 +1,26 @@
+module Increase
+  module Models
+    module Simulations
+      type entity_onboarding_session_submit_params =
+        { entity_onboarding_session_id: String }
+        & Increase::Internal::Type::request_parameters
+
+      class EntityOnboardingSessionSubmitParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor entity_onboarding_session_id: String
+
+        def initialize: (
+          entity_onboarding_session_id: String,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/increase/models.rbs

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

data/sig/increase/resources/entity_onboarding_sessions.rbs

@@ -0,0 +1,32 @@
+module Increase
+  module Resources
+    class EntityOnboardingSessions
+      def create: (
+        program_id: String,
+        redirect_url: String,
+        ?entity_id: String,
+        ?request_options: Increase::request_opts
+      ) -> Increase::EntityOnboardingSession
+
+      def retrieve: (
+        String entity_onboarding_session_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::EntityOnboardingSession
+
+      def list: (
+        ?cursor: String,
+        ?idempotency_key: String,
+        ?limit: Integer,
+        ?status: Increase::EntityOnboardingSessionListParams::Status,
+        ?request_options: Increase::request_opts
+      ) -> Increase::Internal::Page[Increase::EntityOnboardingSession]
+
+      def expire: (
+        String entity_onboarding_session_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::EntityOnboardingSession
+
+      def initialize: (client: Increase::Client) -> void
+    end
+  end
+end