increase 1.333.1 → 1.334.1

data/lib/increase/models/simulations/entity_update_validation_params.rb

@@ -48,7 +48,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The entity's tax identifier could not be validated. 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.corporation.legal_identifier).
             ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
 
             # 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).

data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb

@@ -97,6 +97,13 @@ module Increase
         #   @return [String, nil]
         optional :instruction_identification, String
 
+        # @!attribute purpose
+        #   The sending bank will set purpose in production. You can simulate any value
+        #   here.
+        #
+        #   @return [String, nil]
+        optional :purpose, String
+
         # @!attribute unique_end_to_end_transaction_reference
         #   The sending bank will set unique_end_to_end_transaction_reference in production.
         #   You can simulate any value here.
@@ -118,7 +125,7 @@ module Increase
         #   @return [String, nil]
         optional :wire_drawdown_request_id, String
 
-        # @!method initialize(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
+        # @!method initialize(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
         #   details.
@@ -149,6 +156,8 @@ module Increase
         #
         #   @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
         #
+        #   @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
+        #
         #   @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
         #
         #   @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You

data/lib/increase/models/simulations/physical_card_create_params.rb

@@ -73,7 +73,7 @@ module Increase
           # The physical card has been processed for delivery.
           PROCESSED_FOR_DELIVERY = :processed_for_delivery
 
-          # The physical card has been delivered.
+          # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card may have more than one delivered event.
           DELIVERED = :delivered
 
           # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.

data/lib/increase/models/transaction.rb

@@ -261,8 +261,10 @@ module Increase
 
         # @!attribute card_financial
         #   A Card Financial object. This field will be present in the JSON response if and
-        #   only if `category` is equal to `card_financial`. Card Financials are temporary
-        #   holds placed on a customer's funds with the intent to later clear a transaction.
+        #   only if `category` is equal to `card_financial`. Card Financials are card
+        #   transactions that have cleared and settled. Unlike a Card Settlement, which
+        #   clears a previous authorization, a Card Financial is authorized and cleared in a
+        #   single message.
         #
         #   @return [Increase::Models::Transaction::Source::CardFinancial, nil]
         optional :card_financial, -> { Increase::Transaction::Source::CardFinancial }, nil?: true
@@ -1650,8 +1652,10 @@ module Increase
           #   {Increase::Models::Transaction::Source::CardFinancial} for more details.
           #
           #   A Card Financial object. This field will be present in the JSON response if and
-          #   only if `category` is equal to `card_financial`. Card Financials are temporary
-          #   holds placed on a customer's funds with the intent to later clear a transaction.
+          #   only if `category` is equal to `card_financial`. Card Financials are card
+          #   transactions that have cleared and settled. Unlike a Card Settlement, which
+          #   clears a previous authorization, a Card Financial is authorized and cleared in a
+          #   single message.
           #
           #   @param id [String] The Card Financial identifier.
           #
@@ -7178,6 +7182,12 @@ module Increase
           #   @return [String, nil]
           required :instruction_identification, String, nil?: true
 
+          # @!attribute purpose
+          #   The reason for the wire transfer, as set by the sender.
+          #
+          #   @return [String, nil]
+          required :purpose, String, nil?: true
+
           # @!attribute transfer_id
           #   The ID of the Inbound Wire Transfer object that resulted in this Transaction.
           #
@@ -7198,7 +7208,7 @@ module Increase
           #   @return [String, nil]
           required :unstructured_remittance_information, String, nil?: true
 
-          # @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
+          # @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Transaction::Source::InboundWireTransfer} for more details.
           #
@@ -7235,6 +7245,8 @@ module Increase
           #
           #   @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
           #
+          #   @param purpose [String, nil] The reason for the wire transfer, as set by the sender.
+          #
           #   @param transfer_id [String] The ID of the Inbound Wire Transfer object that resulted in this Transaction.
           #
           #   @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen

data/lib/increase/models/unwrap_webhook_event.rb

@@ -279,6 +279,18 @@ module Increase
         # Occurs whenever an IntraFi Exclusion is updated.
         INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"
 
+        # Occurs whenever a Loan Application is created.
+        LOAN_APPLICATION_CREATED = :"loan_application.created"
+
+        # Occurs whenever a Loan Application is updated.
+        LOAN_APPLICATION_UPDATED = :"loan_application.updated"
+
+        # Occurs whenever a Loan Offer is created.
+        LOAN_OFFER_CREATED = :"loan_offer.created"
+
+        # Occurs whenever a Loan Offer is updated.
+        LOAN_OFFER_UPDATED = :"loan_offer.updated"
+
         # Occurs whenever a Lockbox is created.
         LOCKBOX_CREATED = :"lockbox.created"
 

data/lib/increase/models/wire_drawdown_request.rb

@@ -79,6 +79,13 @@ module Increase
       #   @return [String]
       required :debtor_routing_number, String
 
+      # @!attribute end_to_end_identification
+      #   A free-form reference string set by the sender, to be mirrored back in the
+      #   subsequent wire transfer.
+      #
+      #   @return [String, nil]
+      required :end_to_end_identification, String, nil?: true
+
       # @!attribute fulfillment_inbound_wire_transfer_id
       #   If the recipient fulfills the drawdown request by sending funds, then this will
       #   be the identifier of the corresponding Transaction.
@@ -114,13 +121,21 @@ module Increase
       #   @return [Symbol, Increase::Models::WireDrawdownRequest::Type]
       required :type, enum: -> { Increase::WireDrawdownRequest::Type }
 
+      # @!attribute unique_end_to_end_transaction_reference
+      #   The unique end-to-end transaction reference
+      #   ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
+      #   of the drawdown request.
+      #
+      #   @return [String, nil]
+      required :unique_end_to_end_transaction_reference, String, nil?: true
+
       # @!attribute unstructured_remittance_information
       #   Remittance information the debtor will see as part of the drawdown request.
       #
       #   @return [String]
       required :unstructured_remittance_information, String
 
-      # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unstructured_remittance_information:)
+      # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::WireDrawdownRequest} for more details.
       #
@@ -155,6 +170,8 @@ module Increase
       #
       #   @param debtor_routing_number [String] The debtor's routing number.
       #
+      #   @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to be mirrored back in the subse
+      #
       #   @param fulfillment_inbound_wire_transfer_id [String, nil] If the recipient fulfills the drawdown request by sending funds, then this will
       #
       #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
@@ -165,6 +182,8 @@ module Increase
       #
       #   @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be `
       #
+      #   @param unique_end_to_end_transaction_reference [String, nil] The unique end-to-end transaction reference ([UETR](https://www.swift.com/paymen
+      #
       #   @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the drawdown request.
 
       # @see Increase::Models::WireDrawdownRequest#creditor_address

data/lib/increase/resources/exports.rb

@@ -8,7 +8,7 @@ module Increase
       #
       # Create an Export
       #
-      # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
+      # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
       #
       # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
       #
@@ -25,6 +25,8 @@ module Increase
       #
       # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
       #
+      # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv] Options for the created export. Required if `category` is equal to `fee_csv`.
+      #
       # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
       #
       # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to

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

@@ -79,6 +79,9 @@ module Increase
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
+        #
         # Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
         # Reserve. This Check Deposit must first have a `status` of `pending`.
         #

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

@@ -10,7 +10,7 @@ module Increase
         #
         # Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
         #
-        # @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
+        # @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
         #
         # @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for.
         #
@@ -38,6 +38,8 @@ module Increase
         #
         # @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
         #
+        # @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
+        #
         # @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
         #
         # @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You

data/lib/increase/version.rb

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

data/rbi/increase/models/ach_prenotification.rbi

@@ -259,14 +259,14 @@ module Increase
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        # The Prenotification is for an anticipated credit.
+        # Credit
         CREDIT =
           T.let(
             :credit,
             Increase::ACHPrenotification::CreditDebitIndicator::TaggedSymbol
           )
 
-        # The Prenotification is for an anticipated debit.
+        # Debit
         DEBIT =
           T.let(
             :debit,
@@ -568,6 +568,13 @@ module Increase
               Increase::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
             )
 
+          # A loan account used in a lender-borrower relationship. Uncommon.
+          LOAN =
+            T.let(
+              :loan,
+              Increase::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
+            )
+
           # A bank's general ledger. Uncommon.
           GENERAL_LEDGER =
             T.let(

data/rbi/increase/models/ach_prenotification_create_params.rbi

@@ -217,14 +217,14 @@ module Increase
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        # The Prenotification is for an anticipated credit.
+        # Credit
         CREDIT =
           T.let(
             :credit,
             Increase::ACHPrenotificationCreateParams::CreditDebitIndicator::TaggedSymbol
           )
 
-        # The Prenotification is for an anticipated debit.
+        # Debit
         DEBIT =
           T.let(
             :debit,

data/rbi/increase/models/ach_transfer.rbi

@@ -161,8 +161,8 @@ module Increase
       sig { returns(Increase::ACHTransfer::Network::TaggedSymbol) }
       attr_accessor :network
 
-      # If the receiving bank accepts the transfer but notifies that future transfers
-      # should use different details, this will contain those details.
+      # If the receiving bank notifies that future transfers should use different
+      # details, this will contain those details.
       sig { returns(T::Array[Increase::ACHTransfer::NotificationsOfChange]) }
       attr_accessor :notifications_of_change
 
@@ -363,8 +363,8 @@ module Increase
         individual_name:,
         # The transfer's network.
         network:,
-        # If the receiving bank accepts the transfer but notifies that future transfers
-        # should use different details, this will contain those details.
+        # If the receiving bank notifies that future transfers should use different
+        # details, this will contain those details.
         notifications_of_change:,
         # The ID for the pending transaction representing the transfer. A pending
         # transaction is created when the transfer
@@ -1676,6 +1676,13 @@ module Increase
               Increase::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
             )
 
+          # A loan account used in a lender-borrower relationship. Uncommon.
+          LOAN =
+            T.let(
+              :loan,
+              Increase::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding::TaggedSymbol
+            )
+
           # A bank's general ledger. Uncommon.
           GENERAL_LEDGER =
             T.let(

data/rbi/increase/models/card.rbi

@@ -35,6 +35,10 @@ module Increase
       end
       attr_writer :billing_address
 
+      # The Bank Identification Number (BIN) of the Card.
+      sig { returns(String) }
+      attr_accessor :bin
+
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       # the Card was created.
       sig { returns(Time) }
@@ -100,6 +104,7 @@ module Increase
           authorization_controls:
             T.nilable(Increase::Card::AuthorizationControls::OrHash),
           billing_address: Increase::Card::BillingAddress::OrHash,
+          bin: String,
           created_at: Time,
           description: T.nilable(String),
           digital_wallet: T.nilable(Increase::Card::DigitalWallet::OrHash),
@@ -121,6 +126,8 @@ module Increase
         authorization_controls:,
         # The Card's billing address.
         billing_address:,
+        # The Bank Identification Number (BIN) of the Card.
+        bin:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         # the Card was created.
         created_at:,
@@ -158,6 +165,7 @@ module Increase
             authorization_controls:
               T.nilable(Increase::Card::AuthorizationControls),
             billing_address: Increase::Card::BillingAddress,
+            bin: String,
             created_at: Time,
             description: T.nilable(String),
             digital_wallet: T.nilable(Increase::Card::DigitalWallet),

data/rbi/increase/models/card_dispute.rbi

@@ -47,6 +47,18 @@ module Increase
       sig { returns(Increase::CardDispute::Network::TaggedSymbol) }
       attr_accessor :network
 
+      # If the Card Dispute has been rejected, this will contain details of the
+      # rejection.
+      sig { returns(T.nilable(Increase::CardDispute::Rejection)) }
+      attr_reader :rejection
+
+      sig do
+        params(
+          rejection: T.nilable(Increase::CardDispute::Rejection::OrHash)
+        ).void
+      end
+      attr_writer :rejection
+
       # The status of the Card Dispute.
       sig { returns(Increase::CardDispute::Status::TaggedSymbol) }
       attr_accessor :status
@@ -104,6 +116,7 @@ module Increase
           idempotency_key: T.nilable(String),
           loss: T.nilable(Increase::CardDispute::Loss::OrHash),
           network: Increase::CardDispute::Network::OrSymbol,
+          rejection: T.nilable(Increase::CardDispute::Rejection::OrHash),
           status: Increase::CardDispute::Status::OrSymbol,
           type: Increase::CardDispute::Type::OrSymbol,
           user_submission_required_by: T.nilable(Time),
@@ -133,6 +146,9 @@ module Increase
         loss:,
         # The network that the Card Dispute is associated with.
         network:,
+        # If the Card Dispute has been rejected, this will contain details of the
+        # rejection.
+        rejection:,
         # The status of the Card Dispute.
         status:,
         # A constant representing the object's type. For this resource it will always be
@@ -167,6 +183,7 @@ module Increase
             idempotency_key: T.nilable(String),
             loss: T.nilable(Increase::CardDispute::Loss),
             network: Increase::CardDispute::Network::TaggedSymbol,
+            rejection: T.nilable(Increase::CardDispute::Rejection),
             status: Increase::CardDispute::Status::TaggedSymbol,
             type: Increase::CardDispute::Type::TaggedSymbol,
             user_submission_required_by: T.nilable(Time),
@@ -273,6 +290,42 @@ module Increase
         end
       end
 
+      class Rejection < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::CardDispute::Rejection, Increase::Internal::AnyHash)
+          end
+
+        # Why the Card Dispute was rejected.
+        sig { returns(String) }
+        attr_accessor :explanation
+
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Card Dispute was rejected.
+        sig { returns(Time) }
+        attr_accessor :rejected_at
+
+        # If the Card Dispute has been rejected, this will contain details of the
+        # rejection.
+        sig do
+          params(explanation: String, rejected_at: Time).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Why the Card Dispute was rejected.
+          explanation:,
+          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+          # the Card Dispute was rejected.
+          rejected_at:
+        )
+        end
+
+        sig { override.returns({ explanation: String, rejected_at: Time }) }
+        def to_hash
+        end
+      end
+
       # The status of the Card Dispute.
       module Status
         extend Increase::Internal::Type::Enum
@@ -319,6 +372,9 @@ module Increase
         # The Card Dispute has been won and no further action can be taken.
         WON = T.let(:won, Increase::CardDispute::Status::TaggedSymbol)
 
+        # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
+        REJECTED = T.let(:rejected, Increase::CardDispute::Status::TaggedSymbol)
+
         sig do
           override.returns(
             T::Array[Increase::CardDispute::Status::TaggedSymbol]

data/rbi/increase/models/card_dispute_list_params.rbi

@@ -280,6 +280,13 @@ module Increase
               Increase::CardDisputeListParams::Status::In::TaggedSymbol
             )
 
+          # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
+          REJECTED =
+            T.let(
+              :rejected,
+              Increase::CardDisputeListParams::Status::In::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[