increase 1.187.0 → 1.189.0

data/lib/increase/resources/accounts.rb

@@ -8,14 +8,18 @@ module Increase
       #
       # Create an Account
       #
-      # @overload create(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {})
+      # @overload create(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
       #
       # @param name [String] The name you choose for the Account.
       #
       # @param entity_id [String] The identifier for the Entity that will own the Account.
       #
+      # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding] Whether the Account is funded by a loan or by deposits.
+      #
       # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
       #
+      # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
+      #
       # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -56,10 +60,12 @@ module Increase
 
       # Update an Account
       #
-      # @overload update(account_id, name: nil, request_options: {})
+      # @overload update(account_id, loan: nil, name: nil, request_options: {})
       #
       # @param account_id [String] The identifier of the Account to update.
       #
+      # @param loan [Increase::Models::AccountUpdateParams::Loan] The loan details for the account.
+      #
       # @param name [String] The new name of the Account.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/intrafi_exclusions.rb

@@ -3,14 +3,17 @@
 module Increase
   module Resources
     class IntrafiExclusions
-      # Create an IntraFi Exclusion
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::IntrafiExclusionCreateParams} for more details.
       #
-      # @overload create(bank_name:, entity_id:, request_options: {})
+      # Create an IntraFi Exclusion
       #
-      # @param bank_name [String] The name of the financial institution to be excluded.
+      # @overload create(entity_id:, fdic_certificate_number:, request_options: {})
       #
       # @param entity_id [String] The identifier of the Entity whose deposits will be excluded.
       #
+      # @param fdic_certificate_number [String] The FDIC certificate number of the financial institution to be excluded. An FDIC
+      #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Increase::Models::IntrafiExclusion]

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

@@ -9,12 +9,14 @@ module Increase
         # operates more than one program, `program_id` is a required field when creating
         # accounts.
         #
-        # @overload create(name:, bank: nil, reserve_account_id: nil, request_options: {})
+        # @overload create(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
         #
         # @param name [String] The name of the program being added.
         #
         # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank] The bank for the program's accounts, defaults to First Internet Bank.
         #
+        # @param lending_maximum_extendable_credit [Integer] The maximum extendable credit of the program being added.
+        #
         # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/version.rb

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

data/rbi/increase/models/account.rbi

@@ -40,6 +40,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :entity_id
 
+      # Whether the Account is funded by a loan or by deposits.
+      sig { returns(T.nilable(Increase::Account::Funding::TaggedSymbol)) }
+      attr_accessor :funding
+
       # 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).
@@ -67,6 +71,13 @@ module Increase
       sig { returns(String) }
       attr_accessor :interest_rate
 
+      # The Account's loan-related information, if the Account is a loan account.
+      sig { returns(T.nilable(Increase::Account::Loan)) }
+      attr_reader :loan
+
+      sig { params(loan: T.nilable(Increase::Account::Loan::OrHash)).void }
+      attr_writer :loan
+
       # The name you choose for the Account.
       sig { returns(String) }
       attr_accessor :name
@@ -96,11 +107,13 @@ module Increase
           created_at: Time,
           currency: Increase::Account::Currency::OrSymbol,
           entity_id: String,
+          funding: T.nilable(Increase::Account::Funding::OrSymbol),
           idempotency_key: T.nilable(String),
           informational_entity_id: T.nilable(String),
           interest_accrued: String,
           interest_accrued_at: T.nilable(Date),
           interest_rate: String,
+          loan: T.nilable(Increase::Account::Loan::OrHash),
           name: String,
           program_id: String,
           status: Increase::Account::Status::OrSymbol,
@@ -128,6 +141,8 @@ module Increase
         currency:,
         # The identifier for the Entity the Account belongs to.
         entity_id:,
+        # Whether the Account is funded by a loan or by deposits.
+        funding:,
         # 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).
@@ -145,6 +160,8 @@ module Increase
         # a decimal number. For example, a 1% interest rate would be represented as
         # "0.01".
         interest_rate:,
+        # The Account's loan-related information, if the Account is a loan account.
+        loan:,
         # The name you choose for the Account.
         name:,
         # The identifier of the Program determining the compliance and commercial terms of
@@ -168,11 +185,13 @@ module Increase
             created_at: Time,
             currency: Increase::Account::Currency::TaggedSymbol,
             entity_id: String,
+            funding: T.nilable(Increase::Account::Funding::TaggedSymbol),
             idempotency_key: T.nilable(String),
             informational_entity_id: T.nilable(String),
             interest_accrued: String,
             interest_accrued_at: T.nilable(Date),
             interest_rate: String,
+            loan: T.nilable(Increase::Account::Loan),
             name: String,
             program_id: String,
             status: Increase::Account::Status::TaggedSymbol,
@@ -227,6 +246,133 @@ module Increase
         end
       end
 
+      # Whether the Account is funded by a loan or by deposits.
+      module Funding
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::Account::Funding) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.
+        LOAN = T.let(:loan, Increase::Account::Funding::TaggedSymbol)
+
+        # An account funded by deposits.
+        DEPOSITS = T.let(:deposits, Increase::Account::Funding::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Increase::Account::Funding::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      class Loan < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::Account::Loan, Increase::Internal::AnyHash)
+          end
+
+        # The maximum amount of money that can be borrowed on the Account.
+        sig { returns(Integer) }
+        attr_accessor :credit_limit
+
+        # The number of days after the statement date that the Account can be past due
+        # before being considered delinquent.
+        sig { returns(Integer) }
+        attr_accessor :grace_period_days
+
+        # The date on which the loan matures.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :maturity_date
+
+        # The day of the month on which the loan statement is generated.
+        sig { returns(Integer) }
+        attr_accessor :statement_day_of_month
+
+        # The type of payment for the loan.
+        sig do
+          returns(Increase::Account::Loan::StatementPaymentType::TaggedSymbol)
+        end
+        attr_accessor :statement_payment_type
+
+        # The Account's loan-related information, if the Account is a loan account.
+        sig do
+          params(
+            credit_limit: Integer,
+            grace_period_days: Integer,
+            maturity_date: T.nilable(Date),
+            statement_day_of_month: Integer,
+            statement_payment_type:
+              Increase::Account::Loan::StatementPaymentType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The maximum amount of money that can be borrowed on the Account.
+          credit_limit:,
+          # The number of days after the statement date that the Account can be past due
+          # before being considered delinquent.
+          grace_period_days:,
+          # The date on which the loan matures.
+          maturity_date:,
+          # The day of the month on which the loan statement is generated.
+          statement_day_of_month:,
+          # The type of payment for the loan.
+          statement_payment_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credit_limit: Integer,
+              grace_period_days: Integer,
+              maturity_date: T.nilable(Date),
+              statement_day_of_month: Integer,
+              statement_payment_type:
+                Increase::Account::Loan::StatementPaymentType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of payment for the loan.
+        module StatementPaymentType
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::Account::Loan::StatementPaymentType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The borrower must pay the full balance of the loan at the end of the statement period.
+          BALANCE =
+            T.let(
+              :balance,
+              Increase::Account::Loan::StatementPaymentType::TaggedSymbol
+            )
+
+          # The borrower must pay the accrued interest at the end of the statement period.
+          INTEREST_UNTIL_MATURITY =
+            T.let(
+              :interest_until_maturity,
+              Increase::Account::Loan::StatementPaymentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Account::Loan::StatementPaymentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # The status of the Account.
       module Status
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/account_create_params.rbi

@@ -22,6 +22,17 @@ module Increase
       sig { params(entity_id: String).void }
       attr_writer :entity_id
 
+      # Whether the Account is funded by a loan or by deposits.
+      sig do
+        returns(T.nilable(Increase::AccountCreateParams::Funding::OrSymbol))
+      end
+      attr_reader :funding
+
+      sig do
+        params(funding: Increase::AccountCreateParams::Funding::OrSymbol).void
+      end
+      attr_writer :funding
+
       # The identifier of an Entity that, while not owning the Account, is associated
       # with its activity. This is generally the beneficiary of the funds.
       sig { returns(T.nilable(String)) }
@@ -30,6 +41,13 @@ module Increase
       sig { params(informational_entity_id: String).void }
       attr_writer :informational_entity_id
 
+      # The loan details for the account.
+      sig { returns(T.nilable(Increase::AccountCreateParams::Loan)) }
+      attr_reader :loan
+
+      sig { params(loan: Increase::AccountCreateParams::Loan::OrHash).void }
+      attr_writer :loan
+
       # The identifier for the Program that this Account falls under. Required if you
       # operate more than one Program.
       sig { returns(T.nilable(String)) }
@@ -42,7 +60,9 @@ module Increase
         params(
           name: String,
           entity_id: String,
+          funding: Increase::AccountCreateParams::Funding::OrSymbol,
           informational_entity_id: String,
+          loan: Increase::AccountCreateParams::Loan::OrHash,
           program_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -52,9 +72,13 @@ module Increase
         name:,
         # The identifier for the Entity that will own the Account.
         entity_id: nil,
+        # Whether the Account is funded by a loan or by deposits.
+        funding: nil,
         # The identifier of an Entity that, while not owning the Account, is associated
         # with its activity. This is generally the beneficiary of the funds.
         informational_entity_id: nil,
+        # The loan details for the account.
+        loan: nil,
         # The identifier for the Program that this Account falls under. Required if you
         # operate more than one Program.
         program_id: nil,
@@ -67,7 +91,9 @@ module Increase
           {
             name: String,
             entity_id: String,
+            funding: Increase::AccountCreateParams::Funding::OrSymbol,
             informational_entity_id: String,
+            loan: Increase::AccountCreateParams::Loan,
             program_id: String,
             request_options: Increase::RequestOptions
           }
@@ -75,6 +101,148 @@ module Increase
       end
       def to_hash
       end
+
+      # Whether the Account is funded by a loan or by deposits.
+      module Funding
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::AccountCreateParams::Funding) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.
+        LOAN =
+          T.let(:loan, Increase::AccountCreateParams::Funding::TaggedSymbol)
+
+        # An account funded by deposits.
+        DEPOSITS =
+          T.let(:deposits, Increase::AccountCreateParams::Funding::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::AccountCreateParams::Funding::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Loan < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::AccountCreateParams::Loan,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The maximum amount of money that can be drawn from the Account.
+        sig { returns(Integer) }
+        attr_accessor :credit_limit
+
+        # The number of days after the statement date that the Account can be past due
+        # before being considered delinquent.
+        sig { returns(Integer) }
+        attr_accessor :grace_period_days
+
+        # The day of the month on which the loan statement is generated.
+        sig { returns(Integer) }
+        attr_accessor :statement_day_of_month
+
+        # The type of statement payment for the account.
+        sig do
+          returns(
+            Increase::AccountCreateParams::Loan::StatementPaymentType::OrSymbol
+          )
+        end
+        attr_accessor :statement_payment_type
+
+        # The date on which the loan matures.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :maturity_date
+
+        sig { params(maturity_date: Date).void }
+        attr_writer :maturity_date
+
+        # The loan details for the account.
+        sig do
+          params(
+            credit_limit: Integer,
+            grace_period_days: Integer,
+            statement_day_of_month: Integer,
+            statement_payment_type:
+              Increase::AccountCreateParams::Loan::StatementPaymentType::OrSymbol,
+            maturity_date: Date
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The maximum amount of money that can be drawn from the Account.
+          credit_limit:,
+          # The number of days after the statement date that the Account can be past due
+          # before being considered delinquent.
+          grace_period_days:,
+          # The day of the month on which the loan statement is generated.
+          statement_day_of_month:,
+          # The type of statement payment for the account.
+          statement_payment_type:,
+          # The date on which the loan matures.
+          maturity_date: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credit_limit: Integer,
+              grace_period_days: Integer,
+              statement_day_of_month: Integer,
+              statement_payment_type:
+                Increase::AccountCreateParams::Loan::StatementPaymentType::OrSymbol,
+              maturity_date: Date
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of statement payment for the account.
+        module StatementPaymentType
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::AccountCreateParams::Loan::StatementPaymentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The borrower must pay the full balance of the loan at the end of the statement period.
+          BALANCE =
+            T.let(
+              :balance,
+              Increase::AccountCreateParams::Loan::StatementPaymentType::TaggedSymbol
+            )
+
+          # The borrower must pay the accrued interest at the end of the statement period.
+          INTEREST_UNTIL_MATURITY =
+            T.let(
+              :interest_until_maturity,
+              Increase::AccountCreateParams::Loan::StatementPaymentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::AccountCreateParams::Loan::StatementPaymentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/increase/models/account_statement.rbi

@@ -29,6 +29,15 @@ module Increase
       sig { returns(String) }
       attr_accessor :file_id
 
+      # The loan balances.
+      sig { returns(T.nilable(Increase::AccountStatement::Loan)) }
+      attr_reader :loan
+
+      sig do
+        params(loan: T.nilable(Increase::AccountStatement::Loan::OrHash)).void
+      end
+      attr_writer :loan
+
       # The Account's balance at the start of its statement period.
       sig { returns(Integer) }
       attr_accessor :starting_balance
@@ -58,6 +67,7 @@ module Increase
           created_at: Time,
           ending_balance: Integer,
           file_id: String,
+          loan: T.nilable(Increase::AccountStatement::Loan::OrHash),
           starting_balance: Integer,
           statement_period_end: Time,
           statement_period_start: Time,
@@ -76,6 +86,8 @@ module Increase
         ending_balance:,
         # The identifier of the File containing a PDF of the statement.
         file_id:,
+        # The loan balances.
+        loan:,
         # The Account's balance at the start of its statement period.
         starting_balance:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
@@ -98,6 +110,7 @@ module Increase
             created_at: Time,
             ending_balance: Integer,
             file_id: String,
+            loan: T.nilable(Increase::AccountStatement::Loan),
             starting_balance: Integer,
             statement_period_end: Time,
             statement_period_start: Time,
@@ -108,6 +121,57 @@ module Increase
       def to_hash
       end
 
+      class Loan < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::AccountStatement::Loan, Increase::Internal::AnyHash)
+          end
+
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
+        # payment is due.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :due_at
+
+        # The total amount due on the loan.
+        sig { returns(Integer) }
+        attr_accessor :due_balance
+
+        # The amount past due on the loan.
+        sig { returns(Integer) }
+        attr_accessor :past_due_balance
+
+        # The loan balances.
+        sig do
+          params(
+            due_at: T.nilable(Time),
+            due_balance: Integer,
+            past_due_balance: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
+          # payment is due.
+          due_at:,
+          # The total amount due on the loan.
+          due_balance:,
+          # The amount past due on the loan.
+          past_due_balance:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              due_at: T.nilable(Time),
+              due_balance: Integer,
+              past_due_balance: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       # A constant representing the object's type. For this resource it will always be
       # `account_statement`.
       module Type

data/rbi/increase/models/account_update_params.rbi

@@ -11,6 +11,13 @@ module Increase
           T.any(Increase::AccountUpdateParams, Increase::Internal::AnyHash)
         end
 
+      # The loan details for the account.
+      sig { returns(T.nilable(Increase::AccountUpdateParams::Loan)) }
+      attr_reader :loan
+
+      sig { params(loan: Increase::AccountUpdateParams::Loan::OrHash).void }
+      attr_writer :loan
+
       # The new name of the Account.
       sig { returns(T.nilable(String)) }
       attr_reader :name
@@ -20,11 +27,14 @@ module Increase
 
       sig do
         params(
+          loan: Increase::AccountUpdateParams::Loan::OrHash,
           name: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The loan details for the account.
+        loan: nil,
         # The new name of the Account.
         name: nil,
         request_options: {}
@@ -33,11 +43,41 @@ module Increase
 
       sig do
         override.returns(
-          { name: String, request_options: Increase::RequestOptions }
+          {
+            loan: Increase::AccountUpdateParams::Loan,
+            name: String,
+            request_options: Increase::RequestOptions
+          }
         )
       end
       def to_hash
       end
+
+      class Loan < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::AccountUpdateParams::Loan,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The maximum amount of money that can be drawn from the Account.
+        sig { returns(Integer) }
+        attr_accessor :credit_limit
+
+        # The loan details for the account.
+        sig { params(credit_limit: Integer).returns(T.attached_class) }
+        def self.new(
+          # The maximum amount of money that can be drawn from the Account.
+          credit_limit:
+        )
+        end
+
+        sig { override.returns({ credit_limit: Integer }) }
+        def to_hash
+        end
+      end
     end
   end
 end