release: 1.167.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.166.1"
+  ".": "1.167.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 230
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-acaa7510acabd57dfdde78063277cef0c611dd42abd998e5f1f851c4655e8fd0.yml
-openapi_spec_hash: d0684f4b10e09e2585ad70360531501c
-config_hash: ff2eb5f192b4de36611b37b27961c2d8
+configured_endpoints: 231
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-2304a782c25d2a6b9586de2f6e2b536b5abbf62735f9c18ed0551607f134b714.yml
+openapi_spec_hash: 67d6de7181215abe88dcc3da557a1e0d
+config_hash: 5a0bf28bf735edf93f36c6c808711847

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.167.0 (2025-12-18)
+
+Full Changelog: [v1.166.1...v1.167.0](https://github.com/Increase/increase-ruby/compare/v1.166.1...v1.167.0)
+
+### Features
+
+* **api:** api update ([8083993](https://github.com/Increase/increase-ruby/commit/80839936c4b528bb4c1070c5382196cba2206ad3))
+
 ## 1.166.1 (2025-12-18)
 
 Full Changelog: [v1.166.0...v1.166.1](https://github.com/Increase/increase-ruby/compare/v1.166.0...v1.166.1)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.166.1)
+    increase (1.167.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.166.1"
+gem "increase", "~> 1.167.0"
 ```
 
 <!-- x-release-please-end -->

lib/increase.rb

@@ -314,6 +314,7 @@
 require_relative "increase/models/simulations/digital_wallet_token_request_create_params"
 require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
 require_relative "increase/models/simulations/document_create_params"
+require_relative "increase/models/simulations/export_create_params"
 require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
 require_relative "increase/models/simulations/inbound_check_deposit_create_params"
 require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
@@ -417,6 +418,7 @@
 require_relative "increase/resources/simulations/check_transfers"
 require_relative "increase/resources/simulations/digital_wallet_token_requests"
 require_relative "increase/resources/simulations/documents"
+require_relative "increase/resources/simulations/exports"
 require_relative "increase/resources/simulations/inbound_ach_transfers"
 require_relative "increase/resources/simulations/inbound_check_deposits"
 require_relative "increase/resources/simulations/inbound_fednow_transfers"

lib/increase/models/export.rb

@@ -62,10 +62,10 @@ class Export < Increase::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see {Increase::Models::Export}
       #   for more details.
       #
-      #   Exports are batch summaries of your Increase data. You can make them from the
-      #   API or dashboard. Since they can take a while, they are generated
-      #   asynchronously. We send a webhook when they are ready. For more information,
-      #   please read our
+      #   Exports are generated files. Some exports can contain a lot of data, like a CSV
+      #   of your transactions. Others can be a single document, like a tax form. Since
+      #   they can take a while, they are generated asynchronously. We send a webhook when
+      #   they are ready. For more information, please read our
       #   [Exports documentation](https://increase.com/documentation/exports).
       #
       #   @param id [String] The Export identifier.

lib/increase/models/export_create_params.rb

@@ -27,6 +27,13 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel
       #   @return [Increase::Models::ExportCreateParams::AccountStatementOfx, nil]
       optional :account_statement_ofx, -> { Increase::ExportCreateParams::AccountStatementOfx }
 
+      # @!attribute account_verification_letter
+      #   Options for the created export. Required if `category` is equal to
+      #   `account_verification_letter`.
+      #
+      #   @return [Increase::Models::ExportCreateParams::AccountVerificationLetter, nil]
+      optional :account_verification_letter, -> { Increase::ExportCreateParams::AccountVerificationLetter }
+
       # @!attribute balance_csv
       #   Options for the created export. Required if `category` is equal to
       #   `balance_csv`.
@@ -48,6 +55,13 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel
       #   @return [Increase::Models::ExportCreateParams::EntityCsv, nil]
       optional :entity_csv, -> { Increase::ExportCreateParams::EntityCsv }
 
+      # @!attribute funding_instructions
+      #   Options for the created export. Required if `category` is equal to
+      #   `funding_instructions`.
+      #
+      #   @return [Increase::Models::ExportCreateParams::FundingInstructions, nil]
+      optional :funding_instructions, -> { Increase::ExportCreateParams::FundingInstructions }
+
       # @!attribute transaction_csv
       #   Options for the created export. Required if `category` is equal to
       #   `transaction_csv`.
@@ -61,7 +75,7 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel
       #   @return [Increase::Models::ExportCreateParams::VendorCsv, nil]
       optional :vendor_csv, -> { Increase::ExportCreateParams::VendorCsv }
 
-      # @!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: {})
+      # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::ExportCreateParams} for more details.
       #
@@ -71,13 +85,17 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel
       #
       #   @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
       #
+      #   @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
+      #
       #   @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
       #
       #   @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
       #   `bookkeeping\_
       #
       #   @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
       #
+      #   @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
+      #
       #   @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
       #   `transaction\_
       #
@@ -110,6 +128,12 @@ module Category
         # Export a CSV of vendors added to the third-party risk management dashboard.
         VENDOR_CSV = :vendor_csv
 
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+
+        # A PDF of funding instructions.
+        FUNDING_INSTRUCTIONS = :funding_instructions
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end
@@ -220,6 +244,28 @@ class CreatedAt < Increase::Internal::Type::BaseModel
         end
       end
 
+      class AccountVerificationLetter < Increase::Internal::Type::BaseModel
+        # @!attribute account_number_id
+        #   The Account Number to create a letter for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute balance_date
+        #   The date of the balance to include in the letter. Defaults to the current date.
+        #
+        #   @return [Date, nil]
+        optional :balance_date, Date
+
+        # @!method initialize(account_number_id:, balance_date: nil)
+        #   Options for the created export. Required if `category` is equal to
+        #   `account_verification_letter`.
+        #
+        #   @param account_number_id [String] The Account Number to create a letter for.
+        #
+        #   @param balance_date [Date] The date of the balance to include in the letter. Defaults to the current date.
+      end
+
       class BalanceCsv < Increase::Internal::Type::BaseModel
         # @!attribute account_id
         #   Filter exported Transactions to the specified Account.
@@ -414,6 +460,20 @@ module In
         end
       end
 
+      class FundingInstructions < Increase::Internal::Type::BaseModel
+        # @!attribute account_number_id
+        #   The Account Number to create funding instructions for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!method initialize(account_number_id:)
+        #   Options for the created export. Required if `category` is equal to
+        #   `funding_instructions`.
+        #
+        #   @param account_number_id [String] The Account Number to create funding instructions for.
+      end
+
       class TransactionCsv < Increase::Internal::Type::BaseModel
         # @!attribute account_id
         #   Filter exported Transactions to the specified Account.

lib/increase/models/simulations/export_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::Exports#create
+      class ExportCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The identifier of the Account the tax document is for.
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!method initialize(account_id:, request_options: {})
+        #   @param account_id [String] The identifier of the Account the tax document is for.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

lib/increase/resources/exports.rb

@@ -8,21 +8,25 @@ class Exports
       #
       # Create an Export
       #
-      # @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: {})
+      # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: 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 account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
+      #
       # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
       #
       # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
       # `bookkeeping\_
       #
       # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
       #
+      # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
+      #
       # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
       # `transaction\_
       #

lib/increase/resources/simulations.rb

@@ -93,6 +93,9 @@ class Simulations
       # @return [Increase::Resources::Simulations::Documents]
       attr_reader :documents
 
+      # @return [Increase::Resources::Simulations::Exports]
+      attr_reader :exports
+
       # @return [Increase::Resources::Simulations::CardTokens]
       attr_reader :card_tokens
 
@@ -136,6 +139,7 @@ def initialize(client:)
         @programs = Increase::Resources::Simulations::Programs.new(client: client)
         @account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
         @documents = Increase::Resources::Simulations::Documents.new(client: client)
+        @exports = Increase::Resources::Simulations::Exports.new(client: client)
         @card_tokens = Increase::Resources::Simulations::CardTokens.new(client: client)
       end
     end

lib/increase/resources/simulations/exports.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class Exports
+        # Simulates a tax form export being generated.
+        #
+        # @overload create(account_id:, request_options: {})
+        #
+        # @param account_id [String] The identifier of the Account the tax document is for.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Export]
+        #
+        # @see Increase::Models::Simulations::ExportCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::ExportCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/exports",
+            body: parsed,
+            model: Increase::Export,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

lib/increase/version.rb

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

rbi/increase/models/export.rbi

@@ -44,10 +44,10 @@ module Increase
       sig { returns(Increase::Export::Type::TaggedSymbol) }
       attr_accessor :type
 
-      # Exports are batch summaries of your Increase data. You can make them from the
-      # API or dashboard. Since they can take a while, they are generated
-      # asynchronously. We send a webhook when they are ready. For more information,
-      # please read our
+      # Exports are generated files. Some exports can contain a lot of data, like a CSV
+      # of your transactions. Others can be a single document, like a tax form. Since
+      # they can take a while, they are generated asynchronously. We send a webhook when
+      # they are ready. For more information, please read our
       # [Exports documentation](https://increase.com/documentation/exports).
       sig do
         params(