increase 1.61.0 → 1.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61f06f8d322ec0ac93a22a3a444de7cbc16fe7aeacb9c3c82dae74428bfe3d8
-  data.tar.gz: 220177203100129d7868c1f6ea867d8394667527861f9257666319b5f504c200
+  metadata.gz: 15b72439e813be126ada1f2b7beb01e41b0dcaca294c17b428d03b822b22a357
+  data.tar.gz: 8042dc70cb56867f1c738c33a99c922b3f51d914e9a96ed8b37b2c313c9bd957
 SHA512:
-  metadata.gz: cb215c7dde710ab0ba7cccf8f15adaed3caf7122ca7d20ede754ffe80c371209e461295802c630e97b96b5d90c93e3f780ca216d57a4b95ebc78ab6e0a7e255f
-  data.tar.gz: 7a6f318027edda9d8ea543720873692adec01ae3729253fb50a926ec12f2cd0137b5074340973314b806b300f33cdcfb7edb056e81d8f34916e12ac1f4b3d983
+  metadata.gz: d10f55ebe9343ad66de8f33ec8c6cd36cff42744a8bdef1b4eeb5055d881696bcb4b75b1f2603d1e124eb5b378de9e23348df21b57b1233e696f6cbfdc18ca54
+  data.tar.gz: 23023e9919b592b3d4b72b61b9b157ea81d0aa3b786054e96f577cca507cd27624307e4016f209786ef2416758743650369cf8ed16d66b48d2e39d47be838d5a

data/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)

data/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.61.0"
+gem "increase", "~> 1.62.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/ach_transfer_create_params.rb

@@ -195,6 +195,7 @@ module Increase
 
         # @!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 @@ module Increase
         # @!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 @@ module Increase
         #
         #   @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 @@ module Increase
           #   {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<Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer. In general, you should
 
@@ -281,6 +284,7 @@ module Increase
           # @!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<Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice>] ASC X12 RMR records for this specific transfer.
 

data/lib/increase/models/document_create_params.rb

@@ -14,23 +14,28 @@ module Increase
       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 @@ module Increase
         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 @@ module Increase
         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

data/lib/increase/models/entity_create_params.rb

@@ -28,7 +28,7 @@ module Increase
 
       # @!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 @@ module Increase
         #   {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 @@ module Increase
           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 @@ module Increase
           #
           #   @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 @@ module Increase
             #   {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
             #

data/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]
       #

data/lib/increase/version.rb

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

data/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:

data/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.

data/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:

data/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: {}
       )

data/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`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.61.0
+  version: 1.62.0
 platform: ruby
 authors:
 - Increase