increase 1.347.0 → 1.349.0

data/rbi/increase/models/event.rbi

@@ -593,6 +593,13 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Loan Obligation is created.
+        LOAN_OBLIGATION_CREATED =
+          T.let(
+            :"loan_obligation.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Loan Offer is created.
         LOAN_OFFER_CREATED =
           T.let(:"loan_offer.created", Increase::Event::Category::TaggedSymbol)
@@ -616,6 +623,20 @@ module Increase
         LOCKBOX_UPDATED =
           T.let(:"lockbox.updated", Increase::Event::Category::TaggedSymbol)
 
+        # Occurs whenever a Lockbox Address is created.
+        LOCKBOX_ADDRESS_CREATED =
+          T.let(
+            :"lockbox_address.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a Lockbox Address is updated.
+        LOCKBOX_ADDRESS_UPDATED =
+          T.let(
+            :"lockbox_address.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever an OAuth Connection is created.
         OAUTH_CONNECTION_CREATED =
           T.let(
@@ -714,6 +735,13 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Plaid Processor Token is created.
+        PLAID_PROCESSOR_TOKEN_CREATED =
+          T.let(
+            :"plaid_processor_token.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Checkbook is created.
         CHECKBOOK_CREATED =
           T.let(:"checkbook.created", Increase::Event::Category::TaggedSymbol)

data/rbi/increase/models/event_list_params.rbi

@@ -696,6 +696,13 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Loan Obligation is created.
+          LOAN_OBLIGATION_CREATED =
+            T.let(
+              :"loan_obligation.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Loan Offer is created.
           LOAN_OFFER_CREATED =
             T.let(
@@ -731,6 +738,20 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Lockbox Address is created.
+          LOCKBOX_ADDRESS_CREATED =
+            T.let(
+              :"lockbox_address.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a Lockbox Address is updated.
+          LOCKBOX_ADDRESS_UPDATED =
+            T.let(
+              :"lockbox_address.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever an OAuth Connection is created.
           OAUTH_CONNECTION_CREATED =
             T.let(
@@ -829,6 +850,13 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -717,6 +717,13 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Loan Obligation is created.
+          LOAN_OBLIGATION_CREATED =
+            T.let(
+              :"loan_obligation.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Loan Offer is created.
           LOAN_OFFER_CREATED =
             T.let(
@@ -752,6 +759,20 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Lockbox Address is created.
+          LOCKBOX_ADDRESS_CREATED =
+            T.let(
+              :"lockbox_address.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a Lockbox Address is updated.
+          LOCKBOX_ADDRESS_UPDATED =
+            T.let(
+              :"lockbox_address.updated",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an OAuth Connection is created.
           OAUTH_CONNECTION_CREATED =
             T.let(
@@ -850,6 +871,13 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -715,6 +715,13 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Loan Obligation is created.
+          LOAN_OBLIGATION_CREATED =
+            T.let(
+              :"loan_obligation.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Loan Offer is created.
           LOAN_OFFER_CREATED =
             T.let(
@@ -750,6 +757,20 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Lockbox Address is created.
+          LOCKBOX_ADDRESS_CREATED =
+            T.let(
+              :"lockbox_address.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a Lockbox Address is updated.
+          LOCKBOX_ADDRESS_UPDATED =
+            T.let(
+              :"lockbox_address.updated",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an OAuth Connection is created.
           OAUTH_CONNECTION_CREATED =
             T.let(
@@ -848,6 +869,13 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/file.rbi

@@ -47,12 +47,13 @@ module Increase
       sig { returns(Increase::File::Type::TaggedSymbol) }
       attr_accessor :type
 
-      # Files are objects that represent a file hosted on Increase's servers. The file
-      # may have been uploaded by you (for example, when uploading a check image) or it
-      # may have been created by Increase (for example, an autogenerated statement PDF).
-      # If you need to download a File, use the `/files/{file_id}/contents` endpoint. If
-      # you need to share a File with someone who doesn't have access to your API key,
-      # create a File Link.
+      # Files are objects that represent a file hosted on Increase's servers. Each File
+      # has a `purpose` that determines how Increase will use it. You upload a File so
+      # it can be attached to another object in the API (for example, when uploading a
+      # check image), or Increase creates one for you to download (for example, an
+      # autogenerated statement PDF). If you need to download a File, use the
+      # `/files/{file_id}/contents` endpoint. If you need to share a File with someone
+      # who doesn't have access to your API key, create a File Link.
       sig do
         params(
           id: String,

data/rbi/increase/models/inbound_ach_transfer.rbi

@@ -830,7 +830,7 @@ module Increase
         attr_accessor :originating_depository_financial_institution_branch_country
 
         # An identifier for the originating bank. One of an International Bank Account
-        # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+        # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
         # domestic identifier like a US Routing Number.
         sig { returns(String) }
         attr_accessor :originating_depository_financial_institution_id
@@ -924,7 +924,7 @@ module Increase
         attr_accessor :receiving_depository_financial_institution_country
 
         # An identifier for the receiving bank. One of an International Bank Account
-        # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+        # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
         # domestic identifier like a US Routing Number.
         sig { returns(String) }
         attr_accessor :receiving_depository_financial_institution_id
@@ -1015,7 +1015,7 @@ module Increase
           # country code of the originating branch country.
           originating_depository_financial_institution_branch_country:,
           # An identifier for the originating bank. One of an International Bank Account
-          # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+          # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
           # domestic identifier like a US Routing Number.
           originating_depository_financial_institution_id:,
           # An instruction of how to interpret the
@@ -1065,7 +1065,7 @@ module Increase
           # country code of the receiving bank country.
           receiving_depository_financial_institution_country:,
           # An identifier for the receiving bank. One of an International Bank Account
-          # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+          # Number (IBAN) bank identifier, Swift Bank Identification Code (BIC), or a
           # domestic identifier like a US Routing Number.
           receiving_depository_financial_institution_id:,
           # An instruction of how to interpret the
@@ -1400,7 +1400,7 @@ module Increase
               Increase::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol
             )
 
-          # The SWIFT Bank Identifier Code (BIC) of the bank.
+          # The Swift Bank Identifier Code (BIC) of the bank.
           BIC_CODE =
             T.let(
               :bic_code,
@@ -1446,7 +1446,7 @@ module Increase
               Increase::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol
             )
 
-          # The SWIFT Bank Identifier Code (BIC) of the bank.
+          # The Swift Bank Identifier Code (BIC) of the bank.
           BIC_CODE =
             T.let(
               :bic_code,

data/rbi/increase/models/inbound_check_deposit.rbi

@@ -255,7 +255,8 @@ module Increase
         sig { returns(Time) }
         attr_accessor :adjusted_at
 
-        # The amount of the adjustment.
+        # The amount of the adjustment in USD cents. A positive amount is a credit to your
+        # account and a negative amount is a debit.
         sig { returns(Integer) }
         attr_accessor :amount
 
@@ -282,7 +283,8 @@ module Increase
         def self.new(
           # The time at which the return adjustment was received.
           adjusted_at:,
-          # The amount of the adjustment.
+          # The amount of the adjustment in USD cents. A positive amount is a credit to your
+          # account and a negative amount is a debit.
           amount:,
           # The reason for the adjustment.
           reason:,

data/rbi/increase/models/inbound_fednow_transfer.rbi

@@ -73,6 +73,10 @@ module Increase
       end
       attr_writer :decline
 
+      # A free-form reference string set by the sender, to help identify the transfer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :end_to_end_identification
+
       # The lifecycle status of the transfer.
       sig { returns(Increase::InboundFednowTransfer::Status::TaggedSymbol) }
       attr_accessor :status
@@ -82,6 +86,10 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :transaction_id
 
+      # The FedNow network identification of the transfer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :transaction_identification
+
       # A constant representing the object's type. For this resource it will always be
       # `inbound_fednow_transfer`.
       sig { returns(Increase::InboundFednowTransfer::Type::TaggedSymbol) }
@@ -114,8 +122,10 @@ module Increase
           debtor_name: String,
           debtor_routing_number: String,
           decline: T.nilable(Increase::InboundFednowTransfer::Decline::OrHash),
+          end_to_end_identification: T.nilable(String),
           status: Increase::InboundFednowTransfer::Status::OrSymbol,
           transaction_id: T.nilable(String),
+          transaction_identification: T.nilable(String),
           type: Increase::InboundFednowTransfer::Type::OrSymbol,
           unique_end_to_end_transaction_reference: T.nilable(String),
           unstructured_remittance_information: T.nilable(String)
@@ -148,11 +158,15 @@ module Increase
         debtor_routing_number:,
         # If your transfer is declined, this will contain details of the decline.
         decline:,
+        # A free-form reference string set by the sender, to help identify the transfer.
+        end_to_end_identification:,
         # The lifecycle status of the transfer.
         status:,
         # The identifier of the Transaction object created when the transfer was
         # confirmed.
         transaction_id:,
+        # The FedNow network identification of the transfer.
+        transaction_identification:,
         # A constant representing the object's type. For this resource it will always be
         # `inbound_fednow_transfer`.
         type:,
@@ -181,8 +195,10 @@ module Increase
             debtor_name: String,
             debtor_routing_number: String,
             decline: T.nilable(Increase::InboundFednowTransfer::Decline),
+            end_to_end_identification: T.nilable(String),
             status: Increase::InboundFednowTransfer::Status::TaggedSymbol,
             transaction_id: T.nilable(String),
+            transaction_identification: T.nilable(String),
             type: Increase::InboundFednowTransfer::Type::TaggedSymbol,
             unique_end_to_end_transaction_reference: T.nilable(String),
             unstructured_remittance_information: T.nilable(String)

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
@@ -1491,6 +1491,14 @@ module Increase
           sig { returns(T.nilable(Integer)) }
           attr_accessor :network_risk_score
 
+          # The ID of the Card Payment containing the original authorization or card
+          # validation this transaction references. For a merchant-initiated transaction,
+          # this is the Card Payment from when the card was first stored, which is typically
+          # where the CVV2 was verified. The reference this is derived from is supplied by
+          # the merchant or their acquirer, so it is not guaranteed to be present.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :original_card_payment_id
+
           # The identifier of the Pending Transaction associated with this Transaction.
           sig { returns(T.nilable(String)) }
           attr_accessor :pending_transaction_id
@@ -1598,6 +1606,7 @@ module Increase
               network_identifiers:
                 Increase::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers::OrHash,
               network_risk_score: T.nilable(Integer),
+              original_card_payment_id: T.nilable(String),
               pending_transaction_id: T.nilable(String),
               physical_card_id: T.nilable(String),
               presentment_amount: Integer,
@@ -1671,6 +1680,12 @@ module Increase
             # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
             # score is from 0 to 999, where 999 is the riskiest.
             network_risk_score:,
+            # The ID of the Card Payment containing the original authorization or card
+            # validation this transaction references. For a merchant-initiated transaction,
+            # this is the Card Payment from when the card was first stored, which is typically
+            # where the CVV2 was verified. The reference this is derived from is supplied by
+            # the merchant or their acquirer, so it is not guaranteed to be present.
+            original_card_payment_id:,
             # The identifier of the Pending Transaction associated with this Transaction.
             pending_transaction_id:,
             # If the authorization was made in-person with a physical card, the Physical Card
@@ -1732,6 +1747,7 @@ module Increase
                 network_identifiers:
                   Increase::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers,
                 network_risk_score: T.nilable(Integer),
+                original_card_payment_id: T.nilable(String),
                 pending_transaction_id: T.nilable(String),
                 physical_card_id: T.nilable(String),
                 presentment_amount: Integer,
@@ -4988,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

@@ -477,7 +477,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_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

@@ -1870,6 +1870,14 @@ module Increase
         sig { returns(T.nilable(Integer)) }
         attr_accessor :network_risk_score
 
+        # The identifier of the Card Payment containing the original authorization or card
+        # validation this transaction references. For a merchant-initiated transaction,
+        # this is the Card Payment from when the card was first stored, which is typically
+        # where the CVV2 was verified. The reference this is derived from is supplied by
+        # the merchant or their acquirer, so it is not guaranteed to be present.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :original_card_payment_id
+
         # Whether or not the authorization supports partial approvals.
         sig do
           returns(
@@ -1989,6 +1997,7 @@ module Increase
             network_identifiers:
               Increase::RealTimeDecision::CardAuthorization::NetworkIdentifiers::OrHash,
             network_risk_score: T.nilable(Integer),
+            original_card_payment_id: T.nilable(String),
             partial_approval_capability:
               Increase::RealTimeDecision::CardAuthorization::PartialApprovalCapability::OrSymbol,
             physical_card_id: T.nilable(String),
@@ -2057,6 +2066,12 @@ module Increase
           # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
           # score is from 0 to 999, where 999 is the riskiest.
           network_risk_score:,
+          # The identifier of the Card Payment containing the original authorization or card
+          # validation this transaction references. For a merchant-initiated transaction,
+          # this is the Card Payment from when the card was first stored, which is typically
+          # where the CVV2 was verified. The reference this is derived from is supplied by
+          # the merchant or their acquirer, so it is not guaranteed to be present.
+          original_card_payment_id:,
           # Whether or not the authorization supports partial approvals.
           partial_approval_capability:,
           # If the authorization was made in-person with a physical card, the Physical Card
@@ -2129,6 +2144,7 @@ module Increase
               network_identifiers:
                 Increase::RealTimeDecision::CardAuthorization::NetworkIdentifiers,
               network_risk_score: T.nilable(Integer),
+              original_card_payment_id: T.nilable(String),
               partial_approval_capability:
                 Increase::RealTimeDecision::CardAuthorization::PartialApprovalCapability::TaggedSymbol,
               physical_card_id: T.nilable(String),