diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 4bce58a11..507912c50 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.41.0" + ".": "1.42.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 0b576c5e5..be347cd13 100644 --- a/.stats.yml +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 605028cca..64f801cdc 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/Gemfile.lock b/Gemfile.lock index d1dc55d00..1e766006d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - increase (1.41.0) + increase (1.42.0) connection_pool GEM diff --git a/README.md b/README.md index eb1089eea..4ce996584 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "increase", "~> 1.41.0" +gem "increase", "~> 1.42.0" ``` diff --git a/lib/increase/models/ach_prenotification.rb b/lib/increase/models/ach_prenotification.rb index a43adda48..feb5677bc 100644 --- a/lib/increase/models/ach_prenotification.rb +++ b/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] 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] + end + # The lifecycle status of the ACH Prenotification. # # @see Increase::Models::ACHPrenotification#status diff --git a/lib/increase/models/ach_prenotification_create_params.rb b/lib/increase/models/ach_prenotification_create_params.rb index 19be932f1..cd636d6de 100644 --- a/lib/increase/models/ach_prenotification_create_params.rb +++ b/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,7 +94,7 @@ 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. # @@ -102,21 +102,21 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel # # @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. # diff --git a/lib/increase/models/card_validation.rb b/lib/increase/models/card_validation.rb index 0b738c636..1d8385412 100644 --- a/lib/increase/models/card_validation.rb +++ b/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. diff --git a/lib/increase/models/check_transfer.rb b/lib/increase/models/check_transfer.rb index 634ba10ba..65e15d73f 100644 --- a/lib/increase/models/check_transfer.rb +++ b/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] + end + # @see Increase::Models::CheckTransfer#cancellation class Cancellation < Increase::Internal::Type::BaseModel # @!attribute canceled_at diff --git a/lib/increase/models/export.rb b/lib/increase/models/export.rb index ebfa9953a..e55e7dbfc 100644 --- a/lib/increase/models/export.rb +++ b/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 diff --git a/lib/increase/models/export_create_params.rb b/lib/increase/models/export_create_params.rb index c22eb48bc..333b1b4ff 100644 --- a/lib/increase/models/export_create_params.rb +++ b/lib/increase/models/export_create_params.rb @@ -13,6 +13,13 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ExportCreateParams::Category] required :category, enum: -> { Increase::ExportCreateParams::Category } + # @!attribute account_statement_bai2 + # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + # + # @return [Increase::Models::ExportCreateParams::AccountStatementBai2, nil] + optional :account_statement_bai2, -> { Increase::ExportCreateParams::AccountStatementBai2 } + # @!attribute account_statement_ofx # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. @@ -54,12 +61,14 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel # @return [Object, nil] optional :vendor_csv, Increase::Internal::Type::Unknown - # @!method initialize(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) + # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Increase::Models::ExportCreateParams} for more details. # # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create. # + # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat + # # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat # # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv` @@ -83,6 +92,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 @@ -102,6 +114,35 @@ module Category # @return [Array] end + class AccountStatementBai2 < Increase::Internal::Type::BaseModel + # @!attribute account_id + # The Account to create a BAI2 report for. If not provided, all open accounts will + # be included. + # + # @return [String, nil] + optional :account_id, String + + # @!attribute effective_date + # The date to create a BAI2 report for. If not provided, the current date will be + # used. The timezone is UTC. If the current date is used, the report will include + # intraday balances, otherwise it will include end-of-day balances for the + # provided date. + # + # @return [Date, nil] + optional :effective_date, Date + + # @!method initialize(account_id: nil, effective_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportCreateParams::AccountStatementBai2} for more details. + # + # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + # + # @param account_id [String] The Account to create a BAI2 report for. If not provided, all open accounts will + # + # @param effective_date [Date] The date to create a BAI2 report for. If not provided, the current date will be + end + class AccountStatementOfx < Increase::Internal::Type::BaseModel # @!attribute account_id # The Account to create a statement for. diff --git a/lib/increase/models/export_list_params.rb b/lib/increase/models/export_list_params.rb index 6ab95fcef..1021db5ff 100644 --- a/lib/increase/models/export_list_params.rb +++ b/lib/increase/models/export_list_params.rb @@ -85,6 +85,9 @@ module In # 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 diff --git a/lib/increase/models/intrafi_account_enrollment.rb b/lib/increase/models/intrafi_account_enrollment.rb index 66c7b0569..446f80f0f 100644 --- a/lib/increase/models/intrafi_account_enrollment.rb +++ b/lib/increase/models/intrafi_account_enrollment.rb @@ -23,6 +23,12 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel # @return [Time] required :created_at, Time + # @!attribute email_address + # The contact email for the account owner, to be shared with IntraFi. + # + # @return [String, nil] + required :email_address, String, nil?: true + # @!attribute idempotency_key # The idempotency key you chose for this object. This value is unique across # Increase and is used to ensure that a request is only processed once. Learn more @@ -52,7 +58,7 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] required :type, enum: -> { Increase::IntrafiAccountEnrollment::Type } - # @!method initialize(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:) + # @!method initialize(id:, account_id:, created_at:, email_address:, idempotency_key:, intrafi_id:, status:, type:) # Some parameter documentations has been truncated, see # {Increase::Models::IntrafiAccountEnrollment} for more details. # @@ -70,6 +76,8 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel # # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th # + # @param email_address [String, nil] The contact email for the account owner, to be shared with IntraFi. + # # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre # # @param intrafi_id [String] The identifier of the account in IntraFi's system. This identifier will be print diff --git a/lib/increase/resources/ach_prenotifications.rb b/lib/increase/resources/ach_prenotifications.rb index 65c22614e..be5b3b585 100644 --- a/lib/increase/resources/ach_prenotifications.rb +++ b/lib/increase/resources/ach_prenotifications.rb @@ -10,7 +10,7 @@ class ACHPrenotifications # # @overload create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) # - # @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. # @@ -18,21 +18,21 @@ class ACHPrenotifications # # @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. # diff --git a/lib/increase/resources/exports.rb b/lib/increase/resources/exports.rb index 8360173fd..dbf48d38f 100644 --- a/lib/increase/resources/exports.rb +++ b/lib/increase/resources/exports.rb @@ -8,10 +8,12 @@ class Exports # # Create an Export # - # @overload create(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) + # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) # # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create. # + # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat + # # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat # # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv` diff --git a/lib/increase/version.rb b/lib/increase/version.rb index b4631c60f..4118250a9 100644 --- a/lib/increase/version.rb +++ b/lib/increase/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Increase - VERSION = "1.41.0" + VERSION = "1.42.0" end diff --git a/rbi/increase/models/ach_prenotification.rbi b/rbi/increase/models/ach_prenotification.rbi index ad6cf20c6..eea737f5c 100644 --- a/rbi/increase/models/ach_prenotification.rbi +++ b/rbi/increase/models/ach_prenotification.rbi @@ -12,6 +12,10 @@ module Increase sig { returns(String) } attr_accessor :id + # The account that sent the ACH Prenotification. + sig { returns(T.nilable(String)) } + attr_accessor :account_id + # The destination account number. sig { returns(String) } attr_accessor :account_number @@ -61,6 +65,15 @@ module Increase sig { returns(T.nilable(String)) } attr_accessor :idempotency_key + # Your identifier for the recipient. + sig { returns(T.nilable(String)) } + attr_accessor :individual_id + + # The name of the recipient. This value is informational and not verified by the + # recipient's bank. + sig { returns(T.nilable(String)) } + attr_accessor :individual_name + # If the receiving bank notifies that future transfers should use different # details, this will contain those details. sig do @@ -88,6 +101,16 @@ module Increase sig { returns(String) } attr_accessor :routing_number + # The Standard Entry Class (SEC) code to use for the ACH Prenotification. + sig do + returns( + T.nilable( + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ) + ) + end + attr_accessor :standard_entry_class_code + # The lifecycle status of the ACH Prenotification. sig { returns(Increase::ACHPrenotification::Status::TaggedSymbol) } attr_accessor :status @@ -102,6 +125,7 @@ module Increase sig do params( id: String, + account_id: T.nilable(String), account_number: String, addendum: T.nilable(String), company_descriptive_date: T.nilable(String), @@ -115,6 +139,8 @@ module Increase ), effective_date: T.nilable(Time), idempotency_key: T.nilable(String), + individual_id: T.nilable(String), + individual_name: T.nilable(String), notifications_of_change: T::Array[ Increase::ACHPrenotification::NotificationsOfChange::OrHash @@ -124,6 +150,10 @@ module Increase Increase::ACHPrenotification::PrenotificationReturn::OrHash ), routing_number: String, + standard_entry_class_code: + T.nilable( + Increase::ACHPrenotification::StandardEntryClassCode::OrSymbol + ), status: Increase::ACHPrenotification::Status::OrSymbol, type: Increase::ACHPrenotification::Type::OrSymbol ).returns(T.attached_class) @@ -131,6 +161,8 @@ module Increase def self.new( # The ACH Prenotification's identifier. id:, + # The account that sent the ACH Prenotification. + account_id:, # The destination account number. account_number:, # Additional information for the recipient. @@ -154,6 +186,11 @@ module Increase # Increase and is used to ensure that a request is only processed once. Learn more # about [idempotency](https://increase.com/documentation/idempotency-keys). idempotency_key:, + # Your identifier for the recipient. + individual_id:, + # The name of the recipient. This value is informational and not verified by the + # recipient's bank. + individual_name:, # If the receiving bank notifies that future transfers should use different # details, this will contain those details. notifications_of_change:, @@ -161,6 +198,8 @@ module Increase prenotification_return:, # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # The Standard Entry Class (SEC) code to use for the ACH Prenotification. + standard_entry_class_code:, # The lifecycle status of the ACH Prenotification. status:, # A constant representing the object's type. For this resource it will always be @@ -173,6 +212,7 @@ module Increase override.returns( { id: String, + account_id: T.nilable(String), account_number: String, addendum: T.nilable(String), company_descriptive_date: T.nilable(String), @@ -186,11 +226,17 @@ module Increase ), effective_date: T.nilable(Time), idempotency_key: T.nilable(String), + individual_id: T.nilable(String), + individual_name: T.nilable(String), notifications_of_change: T::Array[Increase::ACHPrenotification::NotificationsOfChange], prenotification_return: T.nilable(Increase::ACHPrenotification::PrenotificationReturn), routing_number: String, + standard_entry_class_code: + T.nilable( + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ), status: Increase::ACHPrenotification::Status::TaggedSymbol, type: Increase::ACHPrenotification::Type::TaggedSymbol } @@ -1027,6 +1073,55 @@ module Increase end end + # The Standard Entry Class (SEC) code to use for the ACH Prenotification. + module StandardEntryClassCode + extend Increase::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Increase::ACHPrenotification::StandardEntryClassCode) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + # Corporate Credit and Debit (CCD). + CORPORATE_CREDIT_OR_DEBIT = + T.let( + :corporate_credit_or_debit, + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ) + + # Corporate Trade Exchange (CTX). + CORPORATE_TRADE_EXCHANGE = + T.let( + :corporate_trade_exchange, + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ) + + # Prearranged Payments and Deposits (PPD). + PREARRANGED_PAYMENTS_AND_DEPOSIT = + T.let( + :prearranged_payments_and_deposit, + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ) + + # Internet Initiated (WEB). + INTERNET_INITIATED = + T.let( + :internet_initiated, + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol + ] + ) + end + def self.values + end + end + # The lifecycle status of the ACH Prenotification. module Status extend Increase::Internal::Type::Enum diff --git a/rbi/increase/models/ach_prenotification_create_params.rbi b/rbi/increase/models/ach_prenotification_create_params.rbi index efee750ca..6b7ebdbc1 100644 --- a/rbi/increase/models/ach_prenotification_create_params.rbi +++ b/rbi/increase/models/ach_prenotification_create_params.rbi @@ -14,7 +14,7 @@ module Increase ) end - # The Increase identifier for the account that will send the transfer. + # The Increase identifier for the account that will send the ACH Prenotification. sig { returns(String) } attr_accessor :account_id @@ -34,21 +34,21 @@ module Increase sig { params(addendum: String).void } attr_writer :addendum - # The description of the date of the transfer. + # The description of the date of the ACH Prenotification. sig { returns(T.nilable(String)) } attr_reader :company_descriptive_date sig { params(company_descriptive_date: String).void } attr_writer :company_descriptive_date - # The data you choose to associate with the transfer. + # The data you choose to associate with the ACH Prenotification. sig { returns(T.nilable(String)) } attr_reader :company_discretionary_data sig { params(company_discretionary_data: String).void } attr_writer :company_discretionary_data - # The description of the transfer you wish to be shown to the recipient. + # The description you wish to be shown to the recipient. sig { returns(T.nilable(String)) } attr_reader :company_entry_description @@ -80,7 +80,7 @@ module Increase end attr_writer :credit_debit_indicator - # The transfer effective date in + # The ACH Prenotification effective date in # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. sig { returns(T.nilable(Date)) } attr_reader :effective_date @@ -88,15 +88,15 @@ module Increase sig { params(effective_date: Date).void } attr_writer :effective_date - # Your identifier for the transfer recipient. + # Your identifier for the recipient. sig { returns(T.nilable(String)) } attr_reader :individual_id sig { params(individual_id: String).void } attr_writer :individual_id - # 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. sig { returns(T.nilable(String)) } attr_reader :individual_name @@ -142,7 +142,7 @@ module Increase ).returns(T.attached_class) end def self.new( - # The Increase identifier for the account that will send the transfer. + # The Increase identifier for the account that will send the ACH Prenotification. account_id:, # The account number for the destination account. account_number:, @@ -151,23 +151,23 @@ module Increase routing_number:, # Additional information that will be sent to the recipient. addendum: nil, - # The description of the date of the transfer. + # The description of the date of the ACH Prenotification. company_descriptive_date: nil, - # The data you choose to associate with the transfer. + # The data you choose to associate with the ACH Prenotification. company_discretionary_data: nil, - # The description of the transfer you wish to be shown to the recipient. + # The description you wish to be shown to the recipient. company_entry_description: nil, # The name by which the recipient knows you. company_name: nil, # Whether the Prenotification is for a future debit or credit. credit_debit_indicator: nil, - # The transfer effective date in + # The ACH Prenotification effective date in # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. effective_date: nil, - # Your identifier for the transfer recipient. + # Your identifier for the recipient. individual_id: nil, - # 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. individual_name: nil, # The Standard Entry Class (SEC) code to use for the ACH Prenotification. standard_entry_class_code: nil, diff --git a/rbi/increase/models/card_validation.rbi b/rbi/increase/models/card_validation.rbi index b75a44316..474a76e58 100644 --- a/rbi/increase/models/card_validation.rbi +++ b/rbi/increase/models/card_validation.rbi @@ -28,6 +28,10 @@ module Increase sig { returns(String) } attr_accessor :account_id + # The ID of the Card Token that was used to validate the card. + sig { returns(String) } + attr_accessor :card_token_id + # The cardholder's first name. sig { returns(T.nilable(String)) } attr_accessor :cardholder_first_name @@ -132,6 +136,7 @@ module Increase id: String, acceptance: T.nilable(Increase::CardValidation::Acceptance::OrHash), account_id: String, + card_token_id: String, cardholder_first_name: T.nilable(String), cardholder_last_name: T.nilable(String), cardholder_middle_name: T.nilable(String), @@ -159,6 +164,8 @@ module Increase acceptance:, # The identifier of the Account from which to send the validation. account_id:, + # The ID of the Card Token that was used to validate the card. + card_token_id:, # The cardholder's first name. cardholder_first_name:, # The cardholder's last name. @@ -210,6 +217,7 @@ module Increase id: String, acceptance: T.nilable(Increase::CardValidation::Acceptance), account_id: String, + card_token_id: String, cardholder_first_name: T.nilable(String), cardholder_last_name: T.nilable(String), cardholder_middle_name: T.nilable(String), diff --git a/rbi/increase/models/check_transfer.rbi b/rbi/increase/models/check_transfer.rbi index f0bb3e704..b6cf11342 100644 --- a/rbi/increase/models/check_transfer.rbi +++ b/rbi/increase/models/check_transfer.rbi @@ -41,6 +41,12 @@ module Increase sig { returns(T.nilable(String)) } attr_accessor :approved_inbound_check_deposit_id + # How the account's available balance should be checked. + sig do + returns(T.nilable(Increase::CheckTransfer::BalanceCheck::TaggedSymbol)) + end + attr_accessor :balance_check + # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { returns(T.nilable(Increase::CheckTransfer::Cancellation)) } @@ -184,6 +190,8 @@ module Increase amount: Integer, approval: T.nilable(Increase::CheckTransfer::Approval::OrHash), approved_inbound_check_deposit_id: T.nilable(String), + balance_check: + T.nilable(Increase::CheckTransfer::BalanceCheck::OrSymbol), cancellation: T.nilable(Increase::CheckTransfer::Cancellation::OrHash), check_number: String, @@ -222,6 +230,8 @@ module Increase # If the Check Transfer was successfully deposited, this will contain the # identifier of the Inbound Check Deposit object with details of the deposit. approved_inbound_check_deposit_id:, + # How the account's available balance should be checked. + balance_check:, # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. cancellation:, @@ -282,6 +292,8 @@ module Increase amount: Integer, approval: T.nilable(Increase::CheckTransfer::Approval), approved_inbound_check_deposit_id: T.nilable(String), + balance_check: + T.nilable(Increase::CheckTransfer::BalanceCheck::TaggedSymbol), cancellation: T.nilable(Increase::CheckTransfer::Cancellation), check_number: String, created_at: Time, @@ -352,6 +364,29 @@ module Increase end end + # How the account's available balance should be checked. + module BalanceCheck + extend Increase::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Increase::CheckTransfer::BalanceCheck) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + # 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 = T.let(:full, Increase::CheckTransfer::BalanceCheck::TaggedSymbol) + + # No balance check will performed; a zero-dollar Pending Transaction will be created. + NONE = T.let(:none, Increase::CheckTransfer::BalanceCheck::TaggedSymbol) + + sig do + override.returns( + T::Array[Increase::CheckTransfer::BalanceCheck::TaggedSymbol] + ) + end + def self.values + end + end + class Cancellation < Increase::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/increase/models/export.rbi b/rbi/increase/models/export.rbi index a370c91f5..fbea5147c 100644 --- a/rbi/increase/models/export.rbi +++ b/rbi/increase/models/export.rbi @@ -120,6 +120,13 @@ module Increase Increase::Export::Category::TaggedSymbol ) + # Export a BAI2 file of transactions and balances for a given date and optional Account. + ACCOUNT_STATEMENT_BAI2 = + T.let( + :account_statement_bai2, + Increase::Export::Category::TaggedSymbol + ) + # Export a CSV of all transactions for a given time range. TRANSACTION_CSV = T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol) diff --git a/rbi/increase/models/export_create_params.rbi b/rbi/increase/models/export_create_params.rbi index 51f4b9066..80ad6dfc4 100644 --- a/rbi/increase/models/export_create_params.rbi +++ b/rbi/increase/models/export_create_params.rbi @@ -15,6 +15,21 @@ module Increase sig { returns(Increase::ExportCreateParams::Category::OrSymbol) } attr_accessor :category + # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + sig do + returns(T.nilable(Increase::ExportCreateParams::AccountStatementBai2)) + end + attr_reader :account_statement_bai2 + + sig do + params( + account_statement_bai2: + Increase::ExportCreateParams::AccountStatementBai2::OrHash + ).void + end + attr_writer :account_statement_bai2 + # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. sig do @@ -90,6 +105,8 @@ module Increase sig do params( category: Increase::ExportCreateParams::Category::OrSymbol, + account_statement_bai2: + Increase::ExportCreateParams::AccountStatementBai2::OrHash, account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx::OrHash, balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash, @@ -105,6 +122,9 @@ module Increase # The type of Export to create. category:, # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + account_statement_bai2: nil, + # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. account_statement_ofx: nil, # Options for the created export. Required if `category` is equal to @@ -128,6 +148,8 @@ module Increase override.returns( { category: Increase::ExportCreateParams::Category::OrSymbol, + account_statement_bai2: + Increase::ExportCreateParams::AccountStatementBai2, account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx, balance_csv: Increase::ExportCreateParams::BalanceCsv, @@ -158,6 +180,13 @@ module Increase Increase::ExportCreateParams::Category::TaggedSymbol ) + # Export a BAI2 file of transactions and balances for a given date and optional Account. + ACCOUNT_STATEMENT_BAI2 = + T.let( + :account_statement_bai2, + Increase::ExportCreateParams::Category::TaggedSymbol + ) + # Export a CSV of all transactions for a given time range. TRANSACTION_CSV = T.let( @@ -202,6 +231,57 @@ module Increase end end + class AccountStatementBai2 < Increase::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Increase::ExportCreateParams::AccountStatementBai2, + Increase::Internal::AnyHash + ) + end + + # The Account to create a BAI2 report for. If not provided, all open accounts will + # be included. + sig { returns(T.nilable(String)) } + attr_reader :account_id + + sig { params(account_id: String).void } + attr_writer :account_id + + # The date to create a BAI2 report for. If not provided, the current date will be + # used. The timezone is UTC. If the current date is used, the report will include + # intraday balances, otherwise it will include end-of-day balances for the + # provided date. + sig { returns(T.nilable(Date)) } + attr_reader :effective_date + + sig { params(effective_date: Date).void } + attr_writer :effective_date + + # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + sig do + params(account_id: String, effective_date: Date).returns( + T.attached_class + ) + end + def self.new( + # The Account to create a BAI2 report for. If not provided, all open accounts will + # be included. + account_id: nil, + # The date to create a BAI2 report for. If not provided, the current date will be + # used. The timezone is UTC. If the current date is used, the report will include + # intraday balances, otherwise it will include end-of-day balances for the + # provided date. + effective_date: nil + ) + end + + sig { override.returns({ account_id: String, effective_date: Date }) } + def to_hash + end + end + class AccountStatementOfx < Increase::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/increase/models/export_list_params.rbi b/rbi/increase/models/export_list_params.rbi index 2dae97f77..bb1492e59 100644 --- a/rbi/increase/models/export_list_params.rbi +++ b/rbi/increase/models/export_list_params.rbi @@ -170,6 +170,13 @@ module Increase Increase::ExportListParams::Category::In::TaggedSymbol ) + # Export a BAI2 file of transactions and balances for a given date and optional Account. + ACCOUNT_STATEMENT_BAI2 = + T.let( + :account_statement_bai2, + Increase::ExportListParams::Category::In::TaggedSymbol + ) + # Export a CSV of all transactions for a given time range. TRANSACTION_CSV = T.let( diff --git a/rbi/increase/models/intrafi_account_enrollment.rbi b/rbi/increase/models/intrafi_account_enrollment.rbi index 131b9b468..742f16214 100644 --- a/rbi/increase/models/intrafi_account_enrollment.rbi +++ b/rbi/increase/models/intrafi_account_enrollment.rbi @@ -21,6 +21,10 @@ module Increase sig { returns(Time) } attr_accessor :created_at + # The contact email for the account owner, to be shared with IntraFi. + sig { returns(T.nilable(String)) } + attr_accessor :email_address + # The idempotency key you chose for this object. This value is unique across # Increase and is used to ensure that a request is only processed once. Learn more # about [idempotency](https://increase.com/documentation/idempotency-keys). @@ -54,6 +58,7 @@ module Increase id: String, account_id: String, created_at: Time, + email_address: T.nilable(String), idempotency_key: T.nilable(String), intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status::OrSymbol, @@ -68,6 +73,8 @@ module Increase # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which # the enrollment was created. created_at:, + # The contact email for the account owner, to be shared with IntraFi. + email_address:, # The idempotency key you chose for this object. This value is unique across # Increase and is used to ensure that a request is only processed once. Learn more # about [idempotency](https://increase.com/documentation/idempotency-keys). @@ -90,6 +97,7 @@ module Increase id: String, account_id: String, created_at: Time, + email_address: T.nilable(String), idempotency_key: T.nilable(String), intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status::TaggedSymbol, diff --git a/rbi/increase/resources/ach_prenotifications.rbi b/rbi/increase/resources/ach_prenotifications.rbi index 5e3a7d41a..915593e0c 100644 --- a/rbi/increase/resources/ach_prenotifications.rbi +++ b/rbi/increase/resources/ach_prenotifications.rbi @@ -25,7 +25,7 @@ module Increase ).returns(Increase::ACHPrenotification) end def create( - # The Increase identifier for the account that will send the transfer. + # The Increase identifier for the account that will send the ACH Prenotification. account_id:, # The account number for the destination account. account_number:, @@ -34,23 +34,23 @@ module Increase routing_number:, # Additional information that will be sent to the recipient. addendum: nil, - # The description of the date of the transfer. + # The description of the date of the ACH Prenotification. company_descriptive_date: nil, - # The data you choose to associate with the transfer. + # The data you choose to associate with the ACH Prenotification. company_discretionary_data: nil, - # The description of the transfer you wish to be shown to the recipient. + # The description you wish to be shown to the recipient. company_entry_description: nil, # The name by which the recipient knows you. company_name: nil, # Whether the Prenotification is for a future debit or credit. credit_debit_indicator: nil, - # The transfer effective date in + # The ACH Prenotification effective date in # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. effective_date: nil, - # Your identifier for the transfer recipient. + # Your identifier for the recipient. individual_id: nil, - # 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. individual_name: nil, # The Standard Entry Class (SEC) code to use for the ACH Prenotification. standard_entry_class_code: nil, diff --git a/rbi/increase/resources/exports.rbi b/rbi/increase/resources/exports.rbi index 97c40fc12..ba5bc8d13 100644 --- a/rbi/increase/resources/exports.rbi +++ b/rbi/increase/resources/exports.rbi @@ -7,6 +7,8 @@ module Increase sig do params( category: Increase::ExportCreateParams::Category::OrSymbol, + account_statement_bai2: + Increase::ExportCreateParams::AccountStatementBai2::OrHash, account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx::OrHash, balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash, @@ -22,6 +24,9 @@ module Increase # The type of Export to create. category:, # Options for the created export. Required if `category` is equal to + # `account_statement_bai2`. + account_statement_bai2: nil, + # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. account_statement_ofx: nil, # Options for the created export. Required if `category` is equal to diff --git a/sig/increase/models/ach_prenotification.rbs b/sig/increase/models/ach_prenotification.rbs index 36c958bf6..fa845b5b3 100644 --- a/sig/increase/models/ach_prenotification.rbs +++ b/sig/increase/models/ach_prenotification.rbs @@ -3,6 +3,7 @@ module Increase type ach_prenotification = { id: String, + account_id: String?, account_number: String, addendum: String?, company_descriptive_date: String?, @@ -13,9 +14,12 @@ module Increase credit_debit_indicator: Increase::Models::ACHPrenotification::credit_debit_indicator?, effective_date: Time?, idempotency_key: String?, + individual_id: String?, + individual_name: String?, notifications_of_change: ::Array[Increase::ACHPrenotification::NotificationsOfChange], prenotification_return: Increase::ACHPrenotification::PrenotificationReturn?, routing_number: String, + standard_entry_class_code: Increase::Models::ACHPrenotification::standard_entry_class_code?, status: Increase::Models::ACHPrenotification::status, type: Increase::Models::ACHPrenotification::type_ } @@ -23,6 +27,8 @@ module Increase class ACHPrenotification < Increase::Internal::Type::BaseModel attr_accessor id: String + attr_accessor account_id: String? + attr_accessor account_number: String attr_accessor addendum: String? @@ -43,18 +49,25 @@ module Increase attr_accessor idempotency_key: String? + attr_accessor individual_id: String? + + attr_accessor individual_name: String? + attr_accessor notifications_of_change: ::Array[Increase::ACHPrenotification::NotificationsOfChange] attr_accessor prenotification_return: Increase::ACHPrenotification::PrenotificationReturn? attr_accessor routing_number: String + attr_accessor standard_entry_class_code: Increase::Models::ACHPrenotification::standard_entry_class_code? + attr_accessor status: Increase::Models::ACHPrenotification::status attr_accessor type: Increase::Models::ACHPrenotification::type_ def initialize: ( id: String, + account_id: String?, account_number: String, addendum: String?, company_descriptive_date: String?, @@ -65,15 +78,19 @@ module Increase credit_debit_indicator: Increase::Models::ACHPrenotification::credit_debit_indicator?, effective_date: Time?, idempotency_key: String?, + individual_id: String?, + individual_name: String?, notifications_of_change: ::Array[Increase::ACHPrenotification::NotificationsOfChange], prenotification_return: Increase::ACHPrenotification::PrenotificationReturn?, routing_number: String, + standard_entry_class_code: Increase::Models::ACHPrenotification::standard_entry_class_code?, status: Increase::Models::ACHPrenotification::status, type: Increase::Models::ACHPrenotification::type_ ) -> void def to_hash: -> { id: String, + account_id: String?, account_number: String, addendum: String?, company_descriptive_date: String?, @@ -84,9 +101,12 @@ module Increase credit_debit_indicator: Increase::Models::ACHPrenotification::credit_debit_indicator?, effective_date: Time?, idempotency_key: String?, + individual_id: String?, + individual_name: String?, notifications_of_change: ::Array[Increase::ACHPrenotification::NotificationsOfChange], prenotification_return: Increase::ACHPrenotification::PrenotificationReturn?, routing_number: String, + standard_entry_class_code: Increase::Models::ACHPrenotification::standard_entry_class_code?, status: Increase::Models::ACHPrenotification::status, type: Increase::Models::ACHPrenotification::type_ } @@ -526,6 +546,30 @@ module Increase end end + type standard_entry_class_code = + :corporate_credit_or_debit + | :corporate_trade_exchange + | :prearranged_payments_and_deposit + | :internet_initiated + + 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 + + def self?.values: -> ::Array[Increase::Models::ACHPrenotification::standard_entry_class_code] + end + type status = :pending_submitting | :requires_attention | :returned | :submitted diff --git a/sig/increase/models/card_validation.rbs b/sig/increase/models/card_validation.rbs index cebbb1197..f7030740b 100644 --- a/sig/increase/models/card_validation.rbs +++ b/sig/increase/models/card_validation.rbs @@ -5,6 +5,7 @@ module Increase id: String, acceptance: Increase::CardValidation::Acceptance?, account_id: String, + card_token_id: String, cardholder_first_name: String?, cardholder_last_name: String?, cardholder_middle_name: String?, @@ -31,6 +32,8 @@ module Increase attr_accessor account_id: String + attr_accessor card_token_id: String + attr_accessor cardholder_first_name: String? attr_accessor cardholder_last_name: String? @@ -69,6 +72,7 @@ module Increase id: String, acceptance: Increase::CardValidation::Acceptance?, account_id: String, + card_token_id: String, cardholder_first_name: String?, cardholder_last_name: String?, cardholder_middle_name: String?, @@ -92,6 +96,7 @@ module Increase id: String, acceptance: Increase::CardValidation::Acceptance?, account_id: String, + card_token_id: String, cardholder_first_name: String?, cardholder_last_name: String?, cardholder_middle_name: String?, diff --git a/sig/increase/models/check_transfer.rbs b/sig/increase/models/check_transfer.rbs index 25fe77f3d..fcfdc2feb 100644 --- a/sig/increase/models/check_transfer.rbs +++ b/sig/increase/models/check_transfer.rbs @@ -8,6 +8,7 @@ module Increase amount: Integer, approval: Increase::CheckTransfer::Approval?, approved_inbound_check_deposit_id: String?, + balance_check: Increase::Models::CheckTransfer::balance_check?, cancellation: Increase::CheckTransfer::Cancellation?, check_number: String, created_at: Time, @@ -40,6 +41,8 @@ module Increase attr_accessor approved_inbound_check_deposit_id: String? + attr_accessor balance_check: Increase::Models::CheckTransfer::balance_check? + attr_accessor cancellation: Increase::CheckTransfer::Cancellation? attr_accessor check_number: String @@ -81,6 +84,7 @@ module Increase amount: Integer, approval: Increase::CheckTransfer::Approval?, approved_inbound_check_deposit_id: String?, + balance_check: Increase::Models::CheckTransfer::balance_check?, cancellation: Increase::CheckTransfer::Cancellation?, check_number: String, created_at: Time, @@ -107,6 +111,7 @@ module Increase amount: Integer, approval: Increase::CheckTransfer::Approval?, approved_inbound_check_deposit_id: String?, + balance_check: Increase::Models::CheckTransfer::balance_check?, cancellation: Increase::CheckTransfer::Cancellation?, check_number: String, created_at: Time, @@ -138,6 +143,20 @@ module Increase def to_hash: -> { approved_at: Time, approved_by: String? } end + type balance_check = :full | :none + + 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 + + def self?.values: -> ::Array[Increase::Models::CheckTransfer::balance_check] + end + type cancellation = { canceled_at: Time, canceled_by: String? } class Cancellation < Increase::Internal::Type::BaseModel diff --git a/sig/increase/models/export.rbs b/sig/increase/models/export.rbs index c3d3b8469..d786ccd4b 100644 --- a/sig/increase/models/export.rbs +++ b/sig/increase/models/export.rbs @@ -53,6 +53,7 @@ module Increase type category = :account_statement_ofx + | :account_statement_bai2 | :transaction_csv | :balance_csv | :bookkeeping_account_balance_csv @@ -66,6 +67,9 @@ module Increase # 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 diff --git a/sig/increase/models/export_create_params.rbs b/sig/increase/models/export_create_params.rbs index 5eda104fa..323a7ff20 100644 --- a/sig/increase/models/export_create_params.rbs +++ b/sig/increase/models/export_create_params.rbs @@ -3,6 +3,7 @@ module Increase type export_create_params = { category: Increase::Models::ExportCreateParams::category, + :account_statement_bai2 => Increase::ExportCreateParams::AccountStatementBai2, account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx, balance_csv: Increase::ExportCreateParams::BalanceCsv, bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv, @@ -18,6 +19,12 @@ module Increase attr_accessor category: Increase::Models::ExportCreateParams::category + attr_reader account_statement_bai2: Increase::ExportCreateParams::AccountStatementBai2? + + def account_statement_bai2=: ( + Increase::ExportCreateParams::AccountStatementBai2 + ) -> Increase::ExportCreateParams::AccountStatementBai2 + attr_reader account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx? def account_statement_ofx=: ( @@ -54,6 +61,7 @@ module Increase def initialize: ( category: Increase::Models::ExportCreateParams::category, + ?account_statement_bai2: Increase::ExportCreateParams::AccountStatementBai2, ?account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx, ?balance_csv: Increase::ExportCreateParams::BalanceCsv, ?bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv, @@ -65,6 +73,7 @@ module Increase def to_hash: -> { category: Increase::Models::ExportCreateParams::category, + :account_statement_bai2 => Increase::ExportCreateParams::AccountStatementBai2, account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx, balance_csv: Increase::ExportCreateParams::BalanceCsv, bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv, @@ -76,6 +85,7 @@ module Increase type category = :account_statement_ofx + | :account_statement_bai2 | :transaction_csv | :balance_csv | :bookkeeping_account_balance_csv @@ -88,6 +98,9 @@ module Increase # 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 @@ -106,6 +119,22 @@ module Increase def self?.values: -> ::Array[Increase::Models::ExportCreateParams::category] end + type account_statement_bai2 = { account_id: String, effective_date: Date } + + class AccountStatementBai2 < Increase::Internal::Type::BaseModel + attr_reader account_id: String? + + def account_id=: (String) -> String + + attr_reader effective_date: Date? + + def effective_date=: (Date) -> Date + + def initialize: (?account_id: String, ?effective_date: Date) -> void + + def to_hash: -> { account_id: String, effective_date: Date } + end + type account_statement_ofx = { account_id: String, diff --git a/sig/increase/models/export_list_params.rbs b/sig/increase/models/export_list_params.rbs index 90d12dca7..51424f272 100644 --- a/sig/increase/models/export_list_params.rbs +++ b/sig/increase/models/export_list_params.rbs @@ -85,6 +85,7 @@ module Increase type in_ = :account_statement_ofx + | :account_statement_bai2 | :transaction_csv | :balance_csv | :bookkeeping_account_balance_csv @@ -98,6 +99,9 @@ module Increase # 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 diff --git a/sig/increase/models/intrafi_account_enrollment.rbs b/sig/increase/models/intrafi_account_enrollment.rbs index 64b6c6492..0f0337e36 100644 --- a/sig/increase/models/intrafi_account_enrollment.rbs +++ b/sig/increase/models/intrafi_account_enrollment.rbs @@ -5,6 +5,7 @@ module Increase id: String, account_id: String, created_at: Time, + email_address: String?, idempotency_key: String?, intrafi_id: String, status: Increase::Models::IntrafiAccountEnrollment::status, @@ -18,6 +19,8 @@ module Increase attr_accessor created_at: Time + attr_accessor email_address: String? + attr_accessor idempotency_key: String? attr_accessor intrafi_id: String @@ -30,6 +33,7 @@ module Increase id: String, account_id: String, created_at: Time, + email_address: String?, idempotency_key: String?, intrafi_id: String, status: Increase::Models::IntrafiAccountEnrollment::status, @@ -40,6 +44,7 @@ module Increase id: String, account_id: String, created_at: Time, + email_address: String?, idempotency_key: String?, intrafi_id: String, status: Increase::Models::IntrafiAccountEnrollment::status, diff --git a/sig/increase/resources/exports.rbs b/sig/increase/resources/exports.rbs index 552d81e13..d3c9f2b23 100644 --- a/sig/increase/resources/exports.rbs +++ b/sig/increase/resources/exports.rbs @@ -3,6 +3,7 @@ module Increase class Exports def create: ( category: Increase::Models::ExportCreateParams::category, + ?account_statement_bai2: Increase::ExportCreateParams::AccountStatementBai2, ?account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx, ?balance_csv: Increase::ExportCreateParams::BalanceCsv, ?bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv, diff --git a/test/increase/resources/ach_prenotifications_test.rb b/test/increase/resources/ach_prenotifications_test.rb index 549828cc5..7d3d12359 100644 --- a/test/increase/resources/ach_prenotifications_test.rb +++ b/test/increase/resources/ach_prenotifications_test.rb @@ -18,6 +18,7 @@ def test_create_required_params assert_pattern do response => { id: String, + account_id: String | nil, account_number: String, addendum: String | nil, company_descriptive_date: String | nil, @@ -28,9 +29,12 @@ def test_create_required_params credit_debit_indicator: Increase::ACHPrenotification::CreditDebitIndicator | nil, effective_date: Time | nil, idempotency_key: String | nil, + individual_id: String | nil, + individual_name: String | nil, notifications_of_change: ^(Increase::Internal::Type::ArrayOf[Increase::ACHPrenotification::NotificationsOfChange]), prenotification_return: Increase::ACHPrenotification::PrenotificationReturn | nil, routing_number: String, + standard_entry_class_code: Increase::ACHPrenotification::StandardEntryClassCode | nil, status: Increase::ACHPrenotification::Status, type: Increase::ACHPrenotification::Type } @@ -47,6 +51,7 @@ def test_retrieve assert_pattern do response => { id: String, + account_id: String | nil, account_number: String, addendum: String | nil, company_descriptive_date: String | nil, @@ -57,9 +62,12 @@ def test_retrieve credit_debit_indicator: Increase::ACHPrenotification::CreditDebitIndicator | nil, effective_date: Time | nil, idempotency_key: String | nil, + individual_id: String | nil, + individual_name: String | nil, notifications_of_change: ^(Increase::Internal::Type::ArrayOf[Increase::ACHPrenotification::NotificationsOfChange]), prenotification_return: Increase::ACHPrenotification::PrenotificationReturn | nil, routing_number: String, + standard_entry_class_code: Increase::ACHPrenotification::StandardEntryClassCode | nil, status: Increase::ACHPrenotification::Status, type: Increase::ACHPrenotification::Type } @@ -83,6 +91,7 @@ def test_list assert_pattern do row => { id: String, + account_id: String | nil, account_number: String, addendum: String | nil, company_descriptive_date: String | nil, @@ -93,9 +102,12 @@ def test_list credit_debit_indicator: Increase::ACHPrenotification::CreditDebitIndicator | nil, effective_date: Time | nil, idempotency_key: String | nil, + individual_id: String | nil, + individual_name: String | nil, notifications_of_change: ^(Increase::Internal::Type::ArrayOf[Increase::ACHPrenotification::NotificationsOfChange]), prenotification_return: Increase::ACHPrenotification::PrenotificationReturn | nil, routing_number: String, + standard_entry_class_code: Increase::ACHPrenotification::StandardEntryClassCode | nil, status: Increase::ACHPrenotification::Status, type: Increase::ACHPrenotification::Type } diff --git a/test/increase/resources/card_validations_test.rb b/test/increase/resources/card_validations_test.rb index 5c4bd4856..ce524af3f 100644 --- a/test/increase/resources/card_validations_test.rb +++ b/test/increase/resources/card_validations_test.rb @@ -24,6 +24,7 @@ def test_create_required_params id: String, acceptance: Increase::CardValidation::Acceptance | nil, account_id: String, + card_token_id: String, cardholder_first_name: String | nil, cardholder_last_name: String | nil, cardholder_middle_name: String | nil, @@ -57,6 +58,7 @@ def test_retrieve id: String, acceptance: Increase::CardValidation::Acceptance | nil, account_id: String, + card_token_id: String, cardholder_first_name: String | nil, cardholder_last_name: String | nil, cardholder_middle_name: String | nil, @@ -97,6 +99,7 @@ def test_list id: String, acceptance: Increase::CardValidation::Acceptance | nil, account_id: String, + card_token_id: String, cardholder_first_name: String | nil, cardholder_last_name: String | nil, cardholder_middle_name: String | nil, diff --git a/test/increase/resources/check_transfers_test.rb b/test/increase/resources/check_transfers_test.rb index 3e8776e7f..38d50ba6b 100644 --- a/test/increase/resources/check_transfers_test.rb +++ b/test/increase/resources/check_transfers_test.rb @@ -24,6 +24,7 @@ def test_create_required_params amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, @@ -60,6 +61,7 @@ def test_retrieve amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, @@ -103,6 +105,7 @@ def test_list amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, @@ -139,6 +142,7 @@ def test_approve amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, @@ -175,6 +179,7 @@ def test_cancel amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, @@ -211,6 +216,7 @@ def test_stop_payment amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time, diff --git a/test/increase/resources/intrafi_account_enrollments_test.rb b/test/increase/resources/intrafi_account_enrollments_test.rb index 784f9d99f..dcb1b6771 100644 --- a/test/increase/resources/intrafi_account_enrollments_test.rb +++ b/test/increase/resources/intrafi_account_enrollments_test.rb @@ -19,6 +19,7 @@ def test_create_required_params id: String, account_id: String, created_at: Time, + email_address: String | nil, idempotency_key: String | nil, intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status, @@ -39,6 +40,7 @@ def test_retrieve id: String, account_id: String, created_at: Time, + email_address: String | nil, idempotency_key: String | nil, intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status, @@ -66,6 +68,7 @@ def test_list id: String, account_id: String, created_at: Time, + email_address: String | nil, idempotency_key: String | nil, intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status, @@ -86,6 +89,7 @@ def test_unenroll id: String, account_id: String, created_at: Time, + email_address: String | nil, idempotency_key: String | nil, intrafi_id: String, status: Increase::IntrafiAccountEnrollment::Status, diff --git a/test/increase/resources/simulations/check_transfers_test.rb b/test/increase/resources/simulations/check_transfers_test.rb index fbd15e842..e157f8f12 100644 --- a/test/increase/resources/simulations/check_transfers_test.rb +++ b/test/increase/resources/simulations/check_transfers_test.rb @@ -18,6 +18,7 @@ def test_mail amount: Integer, approval: Increase::CheckTransfer::Approval | nil, approved_inbound_check_deposit_id: String | nil, + balance_check: Increase::CheckTransfer::BalanceCheck | nil, cancellation: Increase::CheckTransfer::Cancellation | nil, check_number: String, created_at: Time,