From 356b373ee000da480050236864e5a9bc4cdc113a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 21:28:35 +0000 Subject: [PATCH 1/2] feat(api): api update --- .stats.yml | 4 ++-- .../models/ach_transfer_create_params.rb | 6 +++++- lib/increase/models/document_create_params.rb | 19 +++++++++++++------ lib/increase/models/entity_create_params.rb | 14 +++++++------- lib/increase/resources/documents.rb | 7 +++++-- .../models/ach_transfer_create_params.rbi | 6 ++++++ .../models/document_create_params.rbi | 18 ++++++++++++------ rbi/increase/models/entity_create_params.rbi | 18 +++++++++--------- rbi/increase/resources/documents.rbi | 6 ++++-- rbi/increase/resources/entities.rbi | 2 +- 10 files changed, 64 insertions(+), 36 deletions(-) diff --git a/.stats.yml b/.stats.yml index 76d80ce71..a123afd0f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 216 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-a3db5141ad8a06aca3ec4fbc0a4414af61ffea1bbd6470b4a9ad13f8b24ed9eb.yml -openapi_spec_hash: 1192108447914f9233f6e0933dd36033 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-4951789bd74367647a7109ac527206883115628aac13b8131b0bc046ead9cc5c.yml +openapi_spec_hash: 924a557a551c40624e4fe4703dec71cc config_hash: 632b628b59d8f0b717153b3d8133f6cb diff --git a/lib/increase/models/ach_transfer_create_params.rb b/lib/increase/models/ach_transfer_create_params.rb index ff3933710..1fe8602ea 100644 --- a/lib/increase/models/ach_transfer_create_params.rb +++ b/lib/increase/models/ach_transfer_create_params.rb @@ -195,6 +195,7 @@ class Addenda < Increase::Internal::Type::BaseModel # @!attribute freeform # Unstructured `payment_related_information` passed through with the transfer. + # Required if and only if `category` is `freeform`. # # @return [Increase::Models::ACHTransferCreateParams::Addenda::Freeform, nil] optional :freeform, -> { Increase::ACHTransferCreateParams::Addenda::Freeform } @@ -202,6 +203,7 @@ class Addenda < Increase::Internal::Type::BaseModel # @!attribute payment_order_remittance_advice # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. + # Required if and only if `category` is `payment_order_remittance_advice`. # # @return [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice, nil] optional :payment_order_remittance_advice, @@ -216,7 +218,7 @@ class Addenda < Increase::Internal::Type::BaseModel # # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] The type of addenda to pass with the transfer. # - # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer. + # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer. Req # # @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] Structured ASC X12 820 remittance advice records. Please reach out to [support@i @@ -254,6 +256,7 @@ class Freeform < Increase::Internal::Type::BaseModel # {Increase::Models::ACHTransferCreateParams::Addenda::Freeform} for more details. # # Unstructured `payment_related_information` passed through with the transfer. + # Required if and only if `category` is `freeform`. # # @param entries [Array] Each entry represents an addendum sent with the transfer. In general, you should @@ -281,6 +284,7 @@ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel # @!method initialize(invoices:) # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. + # Required if and only if `category` is `payment_order_remittance_advice`. # # @param invoices [Array] ASC X12 RMR records for this specific transfer. diff --git a/lib/increase/models/document_create_params.rb b/lib/increase/models/document_create_params.rb index e240184ab..6cf5c68bd 100644 --- a/lib/increase/models/document_create_params.rb +++ b/lib/increase/models/document_create_params.rb @@ -14,23 +14,28 @@ class DocumentCreateParams < Increase::Internal::Type::BaseModel required :category, enum: -> { Increase::DocumentCreateParams::Category } # @!attribute account_verification_letter - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. # # @return [Increase::Models::DocumentCreateParams::AccountVerificationLetter, nil] optional :account_verification_letter, -> { Increase::DocumentCreateParams::AccountVerificationLetter } # @!attribute funding_instructions - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. # # @return [Increase::Models::DocumentCreateParams::FundingInstructions, nil] optional :funding_instructions, -> { Increase::DocumentCreateParams::FundingInstructions } # @!method initialize(category:, account_verification_letter: nil, funding_instructions: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::DocumentCreateParams} for more details. + # # @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create. # - # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. + # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. Required if and only if `category` is `account_v # - # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. + # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. Required if and only if `category` is `funding_instruction # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] @@ -62,7 +67,8 @@ class AccountVerificationLetter < Increase::Internal::Type::BaseModel optional :balance_date, Date # @!method initialize(account_number_id:, balance_date: nil) - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. # # @param account_number_id [String] The Account Number the bank letter should be generated for. # @@ -77,7 +83,8 @@ class FundingInstructions < Increase::Internal::Type::BaseModel required :account_number_id, String # @!method initialize(account_number_id:) - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. # # @param account_number_id [String] The Account Number the funding instructions should be generated for. end diff --git a/lib/increase/models/entity_create_params.rb b/lib/increase/models/entity_create_params.rb index 7c005c7a8..79f1bf308 100644 --- a/lib/increase/models/entity_create_params.rb +++ b/lib/increase/models/entity_create_params.rb @@ -28,7 +28,7 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel # @!attribute government_authority # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. # # @return [Increase::Models::EntityCreateParams::GovernmentAuthority, nil] optional :government_authority, -> { Increase::EntityCreateParams::GovernmentAuthority } @@ -693,7 +693,7 @@ class GovernmentAuthority < Increase::Internal::Type::BaseModel # {Increase::Models::EntityCreateParams::GovernmentAuthority} for more details. # # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. # # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's # @@ -1642,8 +1642,8 @@ class Trustee < Increase::Internal::Type::BaseModel required :structure, enum: -> { Increase::EntityCreateParams::Trust::Trustee::Structure } # @!attribute individual - # Details of the individual trustee. Required when the trustee `structure` is - # equal to `individual`. + # Details of the individual trustee. Within the trustee object, this is required + # if `structure` is equal to `individual`. # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual, nil] optional :individual, -> { Increase::EntityCreateParams::Trust::Trustee::Individual } @@ -1654,7 +1654,7 @@ class Trustee < Increase::Internal::Type::BaseModel # # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] The structure of the trustee. # - # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] Details of the individual trustee. Required when the trustee `structure` is equa + # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] Details of the individual trustee. Within the trustee object, this is required i # The structure of the trustee. # @@ -1710,8 +1710,8 @@ class Individual < Increase::Internal::Type::BaseModel # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual} for more # details. # - # Details of the individual trustee. Required when the trustee `structure` is - # equal to `individual`. + # Details of the individual trustee. Within the trustee object, this is required + # if `structure` is equal to `individual`. # # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM # diff --git a/lib/increase/resources/documents.rb b/lib/increase/resources/documents.rb index 3b132afe4..7085de4f4 100644 --- a/lib/increase/resources/documents.rb +++ b/lib/increase/resources/documents.rb @@ -3,15 +3,18 @@ module Increase module Resources class Documents + # Some parameter documentations has been truncated, see + # {Increase::Models::DocumentCreateParams} for more details. + # # Create a Document # # @overload create(category:, account_verification_letter: nil, funding_instructions: nil, request_options: {}) # # @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create. # - # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. + # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. Required if and only if `category` is `account_v # - # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. + # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. Required if and only if `category` is `funding_instruction # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/increase/models/ach_transfer_create_params.rbi b/rbi/increase/models/ach_transfer_create_params.rbi index 18cfabf93..d691d37b5 100644 --- a/rbi/increase/models/ach_transfer_create_params.rbi +++ b/rbi/increase/models/ach_transfer_create_params.rbi @@ -345,6 +345,7 @@ module Increase attr_accessor :category # Unstructured `payment_related_information` passed through with the transfer. + # Required if and only if `category` is `freeform`. sig do returns( T.nilable(Increase::ACHTransferCreateParams::Addenda::Freeform) @@ -362,6 +363,7 @@ module Increase # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. + # Required if and only if `category` is `payment_order_remittance_advice`. sig do returns( T.nilable( @@ -395,9 +397,11 @@ module Increase # The type of addenda to pass with the transfer. category:, # Unstructured `payment_related_information` passed through with the transfer. + # Required if and only if `category` is `freeform`. freeform: nil, # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. + # Required if and only if `category` is `payment_order_remittance_advice`. payment_order_remittance_advice: nil ) end @@ -478,6 +482,7 @@ module Increase attr_accessor :entries # Unstructured `payment_related_information` passed through with the transfer. + # Required if and only if `category` is `freeform`. sig do params( entries: @@ -560,6 +565,7 @@ module Increase # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. + # Required if and only if `category` is `payment_order_remittance_advice`. sig do params( invoices: diff --git a/rbi/increase/models/document_create_params.rbi b/rbi/increase/models/document_create_params.rbi index 3f65a49ef..47e254d2c 100644 --- a/rbi/increase/models/document_create_params.rbi +++ b/rbi/increase/models/document_create_params.rbi @@ -15,7 +15,8 @@ module Increase sig { returns(Increase::DocumentCreateParams::Category::OrSymbol) } attr_accessor :category - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. sig do returns( T.nilable(Increase::DocumentCreateParams::AccountVerificationLetter) @@ -31,7 +32,8 @@ module Increase end attr_writer :account_verification_letter - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. sig do returns(T.nilable(Increase::DocumentCreateParams::FundingInstructions)) end @@ -58,9 +60,11 @@ module Increase def self.new( # The type of document to create. category:, - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. account_verification_letter: nil, - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. funding_instructions: nil, request_options: {} ) @@ -134,7 +138,8 @@ module Increase sig { params(balance_date: Date).void } attr_writer :balance_date - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. sig do params(account_number_id: String, balance_date: Date).returns( T.attached_class @@ -168,7 +173,8 @@ module Increase sig { returns(String) } attr_accessor :account_number_id - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. sig { params(account_number_id: String).returns(T.attached_class) } def self.new( # The Account Number the funding instructions should be generated for. diff --git a/rbi/increase/models/entity_create_params.rbi b/rbi/increase/models/entity_create_params.rbi index bb8254060..05721dc50 100644 --- a/rbi/increase/models/entity_create_params.rbi +++ b/rbi/increase/models/entity_create_params.rbi @@ -35,7 +35,7 @@ module Increase attr_writer :description # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. sig do returns(T.nilable(Increase::EntityCreateParams::GovernmentAuthority)) end @@ -140,7 +140,7 @@ module Increase # The description you choose to give the entity. description: nil, # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. government_authority: nil, # Details of the joint entity to create. Required if `structure` is equal to # `joint`. @@ -1263,7 +1263,7 @@ module Increase attr_writer :website # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. sig do params( address: @@ -3005,8 +3005,8 @@ module Increase end attr_accessor :structure - # Details of the individual trustee. Required when the trustee `structure` is - # equal to `individual`. + # Details of the individual trustee. Within the trustee object, this is required + # if `structure` is equal to `individual`. sig do returns( T.nilable( @@ -3035,8 +3035,8 @@ module Increase def self.new( # The structure of the trustee. structure:, - # Details of the individual trustee. Required when the trustee `structure` is - # equal to `individual`. + # Details of the individual trustee. Within the trustee object, this is required + # if `structure` is equal to `individual`. individual: nil ) end @@ -3145,8 +3145,8 @@ module Increase sig { params(confirmed_no_us_tax_id: T::Boolean).void } attr_writer :confirmed_no_us_tax_id - # Details of the individual trustee. Required when the trustee `structure` is - # equal to `individual`. + # Details of the individual trustee. Within the trustee object, this is required + # if `structure` is equal to `individual`. sig do params( address: diff --git a/rbi/increase/resources/documents.rbi b/rbi/increase/resources/documents.rbi index 2ea3892cf..3fe022546 100644 --- a/rbi/increase/resources/documents.rbi +++ b/rbi/increase/resources/documents.rbi @@ -17,9 +17,11 @@ module Increase def create( # The type of document to create. category:, - # An account verification letter. + # An account verification letter. Required if and only if `category` is + # `account_verification_letter`. account_verification_letter: nil, - # Funding instructions. + # Funding instructions. Required if and only if `category` is + # `funding_instructions`. funding_instructions: nil, request_options: {} ) diff --git a/rbi/increase/resources/entities.rbi b/rbi/increase/resources/entities.rbi index 27f5caf93..93adc03d7 100644 --- a/rbi/increase/resources/entities.rbi +++ b/rbi/increase/resources/entities.rbi @@ -32,7 +32,7 @@ module Increase # The description you choose to give the entity. description: nil, # Details of the Government Authority entity to create. Required if `structure` is - # equal to `Government Authority`. + # equal to `government_authority`. government_authority: nil, # Details of the joint entity to create. Required if `structure` is equal to # `joint`. From 0ebba70c220bd22a4a820be22e4af011618797b5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 21:28:53 +0000 Subject: [PATCH 2/2] release: 1.62.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/increase/version.rb | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 68804e4da..ccd8ea8be 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.61.0" + ".": "1.62.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 0cd942a61..deec5b885 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 1.62.0 (2025-08-29) + +Full Changelog: [v1.61.0...v1.62.0](https://github.com/Increase/increase-ruby/compare/v1.61.0...v1.62.0) + +### Features + +* **api:** api update ([356b373](https://github.com/Increase/increase-ruby/commit/356b373ee000da480050236864e5a9bc4cdc113a)) + ## 1.61.0 (2025-08-29) Full Changelog: [v1.60.0...v1.61.0](https://github.com/Increase/increase-ruby/compare/v1.60.0...v1.61.0) diff --git a/Gemfile.lock b/Gemfile.lock index 5ef789c56..8db68e60d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - increase (1.61.0) + increase (1.62.0) connection_pool GEM diff --git a/README.md b/README.md index 3d19c058f..5912eeb33 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.61.0" +gem "increase", "~> 1.62.0" ``` diff --git a/lib/increase/version.rb b/lib/increase/version.rb index 22ea4e663..7eaf9b80b 100644 --- a/lib/increase/version.rb +++ b/lib/increase/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Increase - VERSION = "1.61.0" + VERSION = "1.62.0" end