release: 1.42.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.41.0"
+  ".": "1.42.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 215
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-289025fcb79a47841395734231b11fd75ad3d80dec533e0eb4533e6afaf82cdf.yml
-openapi_spec_hash: 511ad2e7d8c798641f073775ccdab523
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-ce8ac7ef645ad6089e9730ae2b44492a6a958a2abcc8bb50130c5ebd7ba1a390.yml
+openapi_spec_hash: 90a27266ac1eeab3464f6825d8fd8650
 config_hash: 0b0a2503208283b283fc5bc6df6a07a5

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.42.0 (2025-08-20)
+
+Full Changelog: [v1.41.0...v1.42.0](https://github.com/Increase/increase-ruby/compare/v1.41.0...v1.42.0)
+
+### Features
+
+* **api:** api update ([e975675](https://github.com/Increase/increase-ruby/commit/e9756757032d120e4a778dc5ce990386e03f05bf))
+* **api:** api update ([965f3c0](https://github.com/Increase/increase-ruby/commit/965f3c0470e25fb0be5eafe1d0d3ae339bafa72a))
+
 ## 1.41.0 (2025-08-20)
 
 Full Changelog: [v1.40.0...v1.41.0](https://github.com/Increase/increase-ruby/compare/v1.40.0...v1.41.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.41.0)
+    increase (1.42.0)
       connection_pool
 
 GEM

README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.41.0"
+gem "increase", "~> 1.42.0"
 ```
 
 <!-- x-release-please-end -->

lib/increase/models/ach_prenotification.rb

@@ -10,6 +10,12 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #   @return [String]
       required :id, String
 
+      # @!attribute account_id
+      #   The account that sent the ACH Prenotification.
+      #
+      #   @return [String, nil]
+      required :account_id, String, nil?: true
+
       # @!attribute account_number
       #   The destination account number.
       #
@@ -75,6 +81,19 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :idempotency_key, String, nil?: true
 
+      # @!attribute individual_id
+      #   Your identifier for the recipient.
+      #
+      #   @return [String, nil]
+      required :individual_id, String, nil?: true
+
+      # @!attribute individual_name
+      #   The name of the recipient. This value is informational and not verified by the
+      #   recipient's bank.
+      #
+      #   @return [String, nil]
+      required :individual_name, String, nil?: true
+
       # @!attribute notifications_of_change
       #   If the receiving bank notifies that future transfers should use different
       #   details, this will contain those details.
@@ -95,6 +114,14 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #   @return [String]
       required :routing_number, String
 
+      # @!attribute standard_entry_class_code
+      #   The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+      #
+      #   @return [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil]
+      required :standard_entry_class_code,
+               enum: -> { Increase::ACHPrenotification::StandardEntryClassCode },
+               nil?: true
+
       # @!attribute status
       #   The lifecycle status of the ACH Prenotification.
       #
@@ -108,7 +135,7 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #   @return [Symbol, Increase::Models::ACHPrenotification::Type]
       required :type, enum: -> { Increase::ACHPrenotification::Type }
 
-      # @!method initialize(id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, notifications_of_change:, prenotification_return:, routing_number:, status:, type:)
+      # @!method initialize(id:, account_id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, individual_id:, individual_name:, notifications_of_change:, prenotification_return:, routing_number:, standard_entry_class_code:, status:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::ACHPrenotification} for more details.
       #
@@ -117,6 +144,8 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #
       #   @param id [String] The ACH Prenotification's identifier.
       #
+      #   @param account_id [String, nil] The account that sent the ACH Prenotification.
+      #
       #   @param account_number [String] The destination account number.
       #
       #   @param addendum [String, nil] Additional information for the recipient.
@@ -137,12 +166,18 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel
       #
       #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
       #
+      #   @param individual_id [String, nil] Your identifier for the recipient.
+      #
+      #   @param individual_name [String, nil] The name of the recipient. This value is informational and not verified by the r
+      #
       #   @param notifications_of_change [Array<Increase::Models::ACHPrenotification::NotificationsOfChange>] If the receiving bank notifies that future transfers should use different detail
       #
       #   @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] If your prenotification is returned, this will contain details of the return.
       #
       #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
       #
+      #   @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil] The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+      #
       #   @param status [Symbol, Increase::Models::ACHPrenotification::Status] The lifecycle status of the ACH Prenotification.
       #
       #   @param type [Symbol, Increase::Models::ACHPrenotification::Type] A constant representing the object's type. For this resource it will always be `
@@ -523,6 +558,28 @@ module ReturnReasonCode
         end
       end
 
+      # The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+      #
+      # @see Increase::Models::ACHPrenotification#standard_entry_class_code
+      module StandardEntryClassCode
+        extend Increase::Internal::Type::Enum
+
+        # Corporate Credit and Debit (CCD).
+        CORPORATE_CREDIT_OR_DEBIT = :corporate_credit_or_debit
+
+        # Corporate Trade Exchange (CTX).
+        CORPORATE_TRADE_EXCHANGE = :corporate_trade_exchange
+
+        # Prearranged Payments and Deposits (PPD).
+        PREARRANGED_PAYMENTS_AND_DEPOSIT = :prearranged_payments_and_deposit
+
+        # Internet Initiated (WEB).
+        INTERNET_INITIATED = :internet_initiated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The lifecycle status of the ACH Prenotification.
       #
       # @see Increase::Models::ACHPrenotification#status

lib/increase/models/ach_prenotification_create_params.rb

@@ -8,7 +8,7 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
       include Increase::Internal::Type::RequestParameters
 
       # @!attribute account_id
-      #   The Increase identifier for the account that will send the transfer.
+      #   The Increase identifier for the account that will send the ACH Prenotification.
       #
       #   @return [String]
       required :account_id, String
@@ -33,19 +33,19 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
       optional :addendum, String
 
       # @!attribute company_descriptive_date
-      #   The description of the date of the transfer.
+      #   The description of the date of the ACH Prenotification.
       #
       #   @return [String, nil]
       optional :company_descriptive_date, String
 
       # @!attribute company_discretionary_data
-      #   The data you choose to associate with the transfer.
+      #   The data you choose to associate with the ACH Prenotification.
       #
       #   @return [String, nil]
       optional :company_discretionary_data, String
 
       # @!attribute company_entry_description
-      #   The description of the transfer you wish to be shown to the recipient.
+      #   The description you wish to be shown to the recipient.
       #
       #   @return [String, nil]
       optional :company_entry_description, String
@@ -64,21 +64,21 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
                enum: -> { Increase::ACHPrenotificationCreateParams::CreditDebitIndicator }
 
       # @!attribute effective_date
-      #   The transfer effective date in
+      #   The ACH Prenotification effective date in
       #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
       #
       #   @return [Date, nil]
       optional :effective_date, Date
 
       # @!attribute individual_id
-      #   Your identifier for the transfer recipient.
+      #   Your identifier for the recipient.
       #
       #   @return [String, nil]
       optional :individual_id, String
 
       # @!attribute individual_name
-      #   The name of the transfer recipient. This value is information and not verified
-      #   by the recipient's bank.
+      #   The name of therecipient. This value is informational and not verified by the
+      #   recipient's bank.
       #
       #   @return [String, nil]
       optional :individual_name, String
@@ -94,29 +94,29 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::ACHPrenotificationCreateParams} for more details.
       #
-      #   @param account_id [String] The Increase identifier for the account that will send the transfer.
+      #   @param account_id [String] The Increase identifier for the account that will send the ACH Prenotification.
       #
       #   @param account_number [String] The account number for the destination account.
       #
       #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
       #
       #   @param addendum [String] Additional information that will be sent to the recipient.
       #
-      #   @param company_descriptive_date [String] The description of the date of the transfer.
+      #   @param company_descriptive_date [String] The description of the date of the ACH Prenotification.
       #
-      #   @param company_discretionary_data [String] The data you choose to associate with the transfer.
+      #   @param company_discretionary_data [String] The data you choose to associate with the ACH Prenotification.
       #
-      #   @param company_entry_description [String] The description of the transfer you wish to be shown to the recipient.
+      #   @param company_entry_description [String] The description you wish to be shown to the recipient.
       #
       #   @param company_name [String] The name by which the recipient knows you.
       #
       #   @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit.
       #
-      #   @param effective_date [Date] The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601
+      #   @param effective_date [Date] The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wi
       #
-      #   @param individual_id [String] Your identifier for the transfer recipient.
+      #   @param individual_id [String] Your identifier for the recipient.
       #
-      #   @param individual_name [String] The name of the transfer recipient. This value is information and not verified b
+      #   @param individual_name [String] The name of therecipient. This value is informational and not verified by the re
       #
       #   @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the ACH Prenotification.
       #

lib/increase/models/card_validation.rb

@@ -23,6 +23,12 @@ class CardValidation < Increase::Internal::Type::BaseModel
       #   @return [String]
       required :account_id, String
 
+      # @!attribute card_token_id
+      #   The ID of the Card Token that was used to validate the card.
+      #
+      #   @return [String]
+      required :card_token_id, String
+
       # @!attribute cardholder_first_name
       #   The cardholder's first name.
       #
@@ -133,7 +139,7 @@ class CardValidation < Increase::Internal::Type::BaseModel
       #   @return [Symbol, Increase::Models::CardValidation::Type]
       required :type, enum: -> { Increase::CardValidation::Type }
 
-      # @!method initialize(id:, acceptance:, account_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, status:, submission:, type:)
+      # @!method initialize(id:, acceptance:, account_id:, card_token_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, status:, submission:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardValidation} for more details.
       #
@@ -146,6 +152,8 @@ class CardValidation < Increase::Internal::Type::BaseModel
       #
       #   @param account_id [String] The identifier of the Account from which to send the validation.
       #
+      #   @param card_token_id [String] The ID of the Card Token that was used to validate the card.
+      #
       #   @param cardholder_first_name [String, nil] The cardholder's first name.
       #
       #   @param cardholder_last_name [String, nil] The cardholder's last name.

lib/increase/models/check_transfer.rb

@@ -42,6 +42,12 @@ class CheckTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :approved_inbound_check_deposit_id, String, nil?: true
 
+      # @!attribute balance_check
+      #   How the account's available balance should be checked.
+      #
+      #   @return [Symbol, Increase::Models::CheckTransfer::BalanceCheck, nil]
+      required :balance_check, enum: -> { Increase::CheckTransfer::BalanceCheck }, nil?: true
+
       # @!attribute cancellation
       #   If your account requires approvals for transfers and the transfer was not
       #   approved, this will contain details of the cancellation.
@@ -158,7 +164,7 @@ class CheckTransfer < Increase::Internal::Type::BaseModel
       #   @return [Symbol, Increase::Models::CheckTransfer::Type]
       required :type, enum: -> { Increase::CheckTransfer::Type }
 
-      # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:)
+      # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, balance_check:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CheckTransfer} for more details.
       #
@@ -177,6 +183,8 @@ class CheckTransfer < Increase::Internal::Type::BaseModel
       #
       #   @param approved_inbound_check_deposit_id [String, nil] If the Check Transfer was successfully deposited, this will contain the identifi
       #
+      #   @param balance_check [Symbol, Increase::Models::CheckTransfer::BalanceCheck, nil] How the account's available balance should be checked.
+      #
       #   @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
       #
       #   @param check_number [String] The check number printed on the check.
@@ -239,6 +247,22 @@ class Approval < Increase::Internal::Type::BaseModel
         #   @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
       end
 
+      # How the account's available balance should be checked.
+      #
+      # @see Increase::Models::CheckTransfer#balance_check
+      module BalanceCheck
+        extend Increase::Internal::Type::Enum
+
+        # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
+        FULL = :full
+
+        # No balance check will performed; a zero-dollar Pending Transaction will be created.
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Increase::Models::CheckTransfer#cancellation
       class Cancellation < Increase::Internal::Type::BaseModel
         # @!attribute canceled_at

lib/increase/models/export.rb

@@ -94,6 +94,9 @@ module Category
         # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
         ACCOUNT_STATEMENT_OFX = :account_statement_ofx
 
+        # Export a BAI2 file of transactions and balances for a given date and optional Account.
+        ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
+
         # Export a CSV of all transactions for a given time range.
         TRANSACTION_CSV = :transaction_csv