increase 1.348.0 → 1.350.0

data/rbi/increase/models/pending_transaction.rbi

@@ -17,9 +17,9 @@ module Increase
       attr_accessor :account_id
 
       # The Pending Transaction amount in the minor unit of its currency. For dollars,
-      # for example, this is cents. This amount does not change after the Pending
-      # Transaction is created. If a card authorization settles for a different amount,
-      # the settled amount is available on the resulting Transaction and on the Card
+      # for example, this is cents. For a card authorization this is the amount still
+      # held: it decreases when the merchant reverses part of the authorization. The
+      # amount that settled is available on the resulting Transaction and on the Card
       # Payment's `state.settled_amount`.
       sig { returns(Integer) }
       attr_accessor :amount
@@ -112,9 +112,9 @@ module Increase
         # The identifier for the account this Pending Transaction belongs to.
         account_id:,
         # The Pending Transaction amount in the minor unit of its currency. For dollars,
-        # for example, this is cents. This amount does not change after the Pending
-        # Transaction is created. If a card authorization settles for a different amount,
-        # the settled amount is available on the resulting Transaction and on the Card
+        # for example, this is cents. For a card authorization this is the amount still
+        # held: it decreases when the merchant reverses part of the authorization. The
+        # amount that settled is available on the resulting Transaction and on the Card
         # Payment's `state.settled_amount`.
         amount:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
@@ -1346,9 +1346,9 @@ module Increase
           end
           attr_accessor :actioner
 
-          # Additional amounts associated with the card authorization, such as ATM
-          # surcharges fees. These are usually a subset of the `amount` field and are used
-          # to provide more detailed information about the transaction.
+          # Additional amounts associated with the card authorization, such as ATM surcharge
+          # fees. These are usually a subset of the `amount` field and are used to provide
+          # more detailed information about the transaction.
           sig do
             returns(
               Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts
@@ -1396,8 +1396,8 @@ module Increase
           end
           attr_accessor :direction
 
-          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
-          # will expire and the pending transaction will be released.
+          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
+          # authorization will expire and the pending transaction will be released.
           sig { returns(Time) }
           attr_accessor :expires_at
 
@@ -1631,9 +1631,9 @@ module Increase
             # Whether this authorization was approved by Increase, the card network through
             # stand-in processing, or the user through a real-time decision.
             actioner:,
-            # Additional amounts associated with the card authorization, such as ATM
-            # surcharges fees. These are usually a subset of the `amount` field and are used
-            # to provide more detailed information about the transaction.
+            # Additional amounts associated with the card authorization, such as ATM surcharge
+            # fees. These are usually a subset of the `amount` field and are used to provide
+            # more detailed information about the transaction.
             additional_amounts:,
             # The pending amount in the minor unit of the transaction's currency. For dollars,
             # for example, this is cents.
@@ -1649,8 +1649,8 @@ module Increase
             # The direction describes the direction the funds will move, either from the
             # cardholder to the merchant or from the merchant to the cardholder.
             direction:,
-            # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
-            # will expire and the pending transaction will be released.
+            # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
+            # authorization will expire and the pending transaction will be released.
             expires_at:,
             # The healthcare-related fields for this authorization. Only present for specific
             # programs.
@@ -2025,9 +2025,9 @@ module Increase
             end
             attr_writer :vision
 
-            # Additional amounts associated with the card authorization, such as ATM
-            # surcharges fees. These are usually a subset of the `amount` field and are used
-            # to provide more detailed information about the transaction.
+            # Additional amounts associated with the card authorization, such as ATM surcharge
+            # fees. These are usually a subset of the `amount` field and are used to provide
+            # more detailed information about the transaction.
             sig do
               params(
                 clinic:
@@ -5004,7 +5004,7 @@ module Increase
         PENDING =
           T.let(:pending, Increase::PendingTransaction::Status::TaggedSymbol)
 
-        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
         COMPLETE =
           T.let(:complete, Increase::PendingTransaction::Status::TaggedSymbol)
 

data/rbi/increase/models/pending_transaction_list_params.rbi

@@ -407,9 +407,8 @@ module Increase
           end
 
         # Filter Pending Transactions for those with the specified status. By default only
-        # Pending Transactions in with status `pending` will be returned. For GET
-        # requests, this should be encoded as a comma-delimited string, such as
-        # `?in=one,two,three`.
+        # Pending Transactions with status `pending` will be returned. For GET requests,
+        # this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
         sig do
           returns(
             T.nilable(
@@ -441,9 +440,8 @@ module Increase
         end
         def self.new(
           # Filter Pending Transactions for those with the specified status. By default only
-          # Pending Transactions in with status `pending` will be returned. For GET
-          # requests, this should be encoded as a comma-delimited string, such as
-          # `?in=one,two,three`.
+          # Pending Transactions with status `pending` will be returned. For GET requests,
+          # this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
           in_: nil
         )
         end
@@ -477,7 +475,7 @@ module Increase
               Increase::PendingTransactionListParams::Status::In::TaggedSymbol
             )
 
-          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
           COMPLETE =
             T.let(
               :complete,

data/rbi/increase/models/physical_card.rbi

@@ -12,6 +12,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :id
 
+      # The identifier for the Account this Physical Card belongs to.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The identifier for the Card this Physical Card represents.
       sig { returns(String) }
       attr_accessor :card_id
@@ -64,6 +68,7 @@ module Increase
       sig do
         params(
           id: String,
+          account_id: String,
           card_id: String,
           cardholder: Increase::PhysicalCard::Cardholder::OrHash,
           created_at: Time,
@@ -77,6 +82,8 @@ module Increase
       def self.new(
         # The physical card identifier.
         id:,
+        # The identifier for the Account this Physical Card belongs to.
+        account_id:,
         # The identifier for the Card this Physical Card represents.
         card_id:,
         # Details about the cardholder, as it appears on the printed card.
@@ -104,6 +111,7 @@ module Increase
         override.returns(
           {
             id: String,
+            account_id: String,
             card_id: String,
             cardholder: Increase::PhysicalCard::Cardholder,
             created_at: Time,

data/rbi/increase/models/physical_card_create_params.rbi

@@ -15,7 +15,8 @@ module Increase
       sig { returns(String) }
       attr_accessor :card_id
 
-      # Details about the cardholder, as it will appear on the physical card.
+      # Details about the cardholder, as it will appear on the physical card. The
+      # combined first name and last name cannot exceed 25 characters.
       sig { returns(Increase::PhysicalCardCreateParams::Cardholder) }
       attr_reader :cardholder
 
@@ -57,7 +58,8 @@ module Increase
       def self.new(
         # The underlying card representing this physical card.
         card_id:,
-        # Details about the cardholder, as it will appear on the physical card.
+        # Details about the cardholder, as it will appear on the physical card. The
+        # combined first name and last name cannot exceed 25 characters.
         cardholder:,
         # The details used to ship this physical card.
         shipment:,
@@ -99,7 +101,8 @@ module Increase
         sig { returns(String) }
         attr_accessor :last_name
 
-        # Details about the cardholder, as it will appear on the physical card.
+        # Details about the cardholder, as it will appear on the physical card. The
+        # combined first name and last name cannot exceed 25 characters.
         sig do
           params(first_name: String, last_name: String).returns(
             T.attached_class

data/rbi/increase/models/real_time_decision.rbi

@@ -1700,9 +1700,9 @@ module Increase
         sig { returns(String) }
         attr_accessor :account_id
 
-        # Additional amounts associated with the card authorization, such as ATM
-        # surcharges fees. These are usually a subset of the `amount` field and are used
-        # to provide more detailed information about the transaction.
+        # Additional amounts associated with the card authorization, such as ATM surcharge
+        # fees. These are usually a subset of the `amount` field and are used to provide
+        # more detailed information about the transaction.
         sig do
           returns(
             Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts
@@ -2018,9 +2018,9 @@ module Increase
         def self.new(
           # The identifier of the Account the authorization will debit.
           account_id:,
-          # Additional amounts associated with the card authorization, such as ATM
-          # surcharges fees. These are usually a subset of the `amount` field and are used
-          # to provide more detailed information about the transaction.
+          # Additional amounts associated with the card authorization, such as ATM surcharge
+          # fees. These are usually a subset of the `amount` field and are used to provide
+          # more detailed information about the transaction.
           additional_amounts:,
           # Present if and only if `decision` is `approve`. Contains information related to
           # the approval of the authorization.
@@ -2375,9 +2375,9 @@ module Increase
           end
           attr_writer :vision
 
-          # Additional amounts associated with the card authorization, such as ATM
-          # surcharges fees. These are usually a subset of the `amount` field and are used
-          # to provide more detailed information about the transaction.
+          # Additional amounts associated with the card authorization, such as ATM surcharge
+          # fees. These are usually a subset of the `amount` field and are used to provide
+          # more detailed information about the transaction.
           sig do
             params(
               clinic:
@@ -4669,9 +4669,9 @@ module Increase
         sig { returns(String) }
         attr_accessor :account_id
 
-        # Additional amounts associated with the card authorization, such as ATM
-        # surcharges fees. These are usually a subset of the `amount` field and are used
-        # to provide more detailed information about the transaction.
+        # Additional amounts associated with the card authorization, such as ATM surcharge
+        # fees. These are usually a subset of the `amount` field and are used to provide
+        # more detailed information about the transaction.
         sig do
           returns(
             Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts
@@ -4861,9 +4861,9 @@ module Increase
         def self.new(
           # The identifier of the Account the authorization will debit.
           account_id:,
-          # Additional amounts associated with the card authorization, such as ATM
-          # surcharges fees. These are usually a subset of the `amount` field and are used
-          # to provide more detailed information about the transaction.
+          # Additional amounts associated with the card authorization, such as ATM surcharge
+          # fees. These are usually a subset of the `amount` field and are used to provide
+          # more detailed information about the transaction.
           additional_amounts:,
           # Present if and only if `decision` is `approve`. Contains information related to
           # the approval of the balance inquiry.
@@ -5162,9 +5162,9 @@ module Increase
           end
           attr_writer :vision
 
-          # Additional amounts associated with the card authorization, such as ATM
-          # surcharges fees. These are usually a subset of the `amount` field and are used
-          # to provide more detailed information about the transaction.
+          # Additional amounts associated with the card authorization, such as ATM surcharge
+          # fees. These are usually a subset of the `amount` field and are used to provide
+          # more detailed information about the transaction.
           sig do
             params(
               clinic:

data/rbi/increase/models/simulations/card_authentication_create_params.rbi

@@ -78,7 +78,7 @@ module Increase
         sig { params(merchant_country: String).void }
         attr_writer :merchant_country
 
-        # The name of the merchant
+        # The name of the merchant.
         sig { returns(T.nilable(String)) }
         attr_reader :merchant_name
 
@@ -122,7 +122,7 @@ module Increase
           merchant_category_code: nil,
           # The country the merchant resides in.
           merchant_country: nil,
-          # The name of the merchant
+          # The name of the merchant.
           merchant_name: nil,
           # The purchase amount in cents.
           purchase_amount: nil,

data/rbi/increase/models/simulations/card_dispute_action_params.rbi

@@ -28,8 +28,8 @@ module Increase
         end
         attr_accessor :network
 
-        # The Visa-specific parameters for the taking action on the dispute. Required if
-        # and only if `network` is `visa`.
+        # The Visa-specific parameters for taking action on the dispute. Required if and
+        # only if `network` is `visa`.
         sig do
           returns(
             T.nilable(Increase::Simulations::CardDisputeActionParams::Visa)
@@ -59,8 +59,8 @@ module Increase
           # The network of the Card Dispute. Details specific to the network are required
           # under the sub-object with the same identifier as the network.
           network:,
-          # The Visa-specific parameters for the taking action on the dispute. Required if
-          # and only if `network` is `visa`.
+          # The Visa-specific parameters for taking action on the dispute. Required if and
+          # only if `network` is `visa`.
           visa: nil,
           request_options: {}
         )
@@ -339,8 +339,8 @@ module Increase
           end
           attr_writer :time_out_user_prearbitration
 
-          # The Visa-specific parameters for the taking action on the dispute. Required if
-          # and only if `network` is `visa`.
+          # The Visa-specific parameters for taking action on the dispute. Required if and
+          # only if `network` is `visa`.
           sig do
             params(
               action:

data/rbi/increase/models/simulations/entity_update_validation_params.rbi

@@ -116,21 +116,21 @@ module Increase
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
+            # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity).
             ENTITY_TAX_IDENTIFIER =
               T.let(
                 :entity_tax_identifier,
                 Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
               )
 
-            # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
+            # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity).
             ENTITY_ADDRESS =
               T.let(
                 :entity_address,
                 Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
               )
 
-            # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
+            # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity).
             ENTITY_IDENTITY =
               T.let(
                 :entity_identity,

data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi

@@ -19,7 +19,10 @@ module Increase
         sig { returns(String) }
         attr_accessor :inbound_check_deposit_id
 
-        # The adjustment amount in cents. Defaults to the amount of the Inbound Check
+        # The adjustment amount in cents. A positive amount means that the funds are being
+        # returned to you by the other bank and is a credit to your account, as happens
+        # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
+        # happens for a `late_return`. Defaults to the amount of the Inbound Check
         # Deposit.
         sig { returns(T.nilable(Integer)) }
         attr_reader :amount
@@ -57,7 +60,10 @@ module Increase
         def self.new(
           # The identifier of the Inbound Check Deposit to adjust.
           inbound_check_deposit_id:,
-          # The adjustment amount in cents. Defaults to the amount of the Inbound Check
+          # The adjustment amount in cents. A positive amount means that the funds are being
+          # returned to you by the other bank and is a credit to your account, as happens
+          # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
+          # happens for a `late_return`. Defaults to the amount of the Inbound Check
           # Deposit.
           amount: nil,
           # The reason for the adjustment. Defaults to `wrong_payee_credit`.
@@ -107,27 +113,6 @@ module Increase
               Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
             )
 
-          # The check was deposited with a different amount than what was written on the check.
-          ADJUSTED_AMOUNT =
-            T.let(
-              :adjusted_amount,
-              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
-            )
-
-          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
-          NON_CONFORMING_ITEM =
-            T.let(
-              :non_conforming_item,
-              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
-            )
-
-          # The check has already been deposited elsewhere and so this is a duplicate.
-          PAID =
-            T.let(
-              :paid,
-              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
-            )
-
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/simulations/interest_payment_create_params.rbi

@@ -15,7 +15,7 @@ module Increase
             )
           end
 
-        # The identifier of the Account the Interest Payment should be paid to is for.
+        # The identifier of the Account the Interest Payment should be paid to.
         sig { returns(String) }
         attr_accessor :account_id
 
@@ -55,7 +55,7 @@ module Increase
           ).returns(T.attached_class)
         end
         def self.new(
-          # The identifier of the Account the Interest Payment should be paid to is for.
+          # The identifier of the Account the Interest Payment should be paid to.
           account_id:,
           # The interest amount in cents. Must be positive.
           amount:,

data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi

@@ -15,7 +15,7 @@ module Increase
             )
           end
 
-        # The pending transaction to release. The pending transaction must have a
+        # The pending transaction to release. The pending transaction must have an
         # `inbound_funds_hold` source.
         sig { returns(String) }
         attr_accessor :pending_transaction_id
@@ -27,7 +27,7 @@ module Increase
           ).returns(T.attached_class)
         end
         def self.new(
-          # The pending transaction to release. The pending transaction must have a
+          # The pending transaction to release. The pending transaction must have an
           # `inbound_funds_hold` source.
           pending_transaction_id:,
           request_options: {}

data/rbi/increase/models/simulations/program_create_params.rbi

@@ -43,7 +43,15 @@ module Increase
         sig { params(lending_maximum_extendable_credit: Integer).void }
         attr_writer :lending_maximum_extendable_credit
 
-        # The identifier of the Account the Program should be added to is for.
+        # Whether opening a loan Account under this Program requires an accepted Loan
+        # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :loan_accounts_require_loan_offers
+
+        sig { params(loan_accounts_require_loan_offers: T::Boolean).void }
+        attr_writer :loan_accounts_require_loan_offers
+
+        # The identifier of the Account the Program should be added to.
         sig { returns(T.nilable(String)) }
         attr_reader :reserve_account_id
 
@@ -55,6 +63,7 @@ module Increase
             name: String,
             bank: Increase::Simulations::ProgramCreateParams::Bank::OrSymbol,
             lending_maximum_extendable_credit: Integer,
+            loan_accounts_require_loan_offers: T::Boolean,
             reserve_account_id: String,
             request_options: Increase::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -66,7 +75,10 @@ module Increase
           bank: nil,
           # The maximum extendable credit of the program being added.
           lending_maximum_extendable_credit: nil,
-          # The identifier of the Account the Program should be added to is for.
+          # Whether opening a loan Account under this Program requires an accepted Loan
+          # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
+          loan_accounts_require_loan_offers: nil,
+          # The identifier of the Account the Program should be added to.
           reserve_account_id: nil,
           request_options: {}
         )
@@ -78,6 +90,7 @@ module Increase
               name: String,
               bank: Increase::Simulations::ProgramCreateParams::Bank::OrSymbol,
               lending_maximum_extendable_credit: Integer,
+              loan_accounts_require_loan_offers: T::Boolean,
               reserve_account_id: String,
               request_options: Increase::RequestOptions
             }