increase 1.310.0 → 1.311.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e031a8bed8aeb92b372e9816281d01326f065909cbf1e23a68e69ca36ac5fa0
-  data.tar.gz: 91cf4a53fdc6387257509c15fae9fd43962a31686e397c830bbb097360207339
+  metadata.gz: d88e22054de9abb4f3e4ec5e103aa335cf5027a0c18826a179f8f3e54e5a15fc
+  data.tar.gz: 579d5a494d5143ad22f19d988c58da191616828f8cd62069791389d372022c06
 SHA512:
-  metadata.gz: 67248dbedfb8072d0c678732b5860ecc01b0d70cba2388a4e47db5ee351406b7903a7d83ff578d237a6b6a8dd255328dd7d91543f5b68802981253ab10f56313
-  data.tar.gz: 73b424d4b9901b6a39fcd7f6518a68934715e12eb61af17a69138e68b021995ed1dd29835a05250c0b3d069a8ca836c8e9983726d162661dc7b8fde1b6f67e3d
+  metadata.gz: f1e23de84c1251950b81915630f1dd57f7e38b6a51386842653064b77aa9195c98b5d0febbd8966db91eb9981d45051143cadcf1ed13ae6cbdd5603731b0be25
+  data.tar.gz: b823934d66708454849aba102b908c56e9ba2bee242342530ad789d663e1e22accb2771cb6875b4b53bd28d358ca39310fc275fac5f1c5e73e8c72962ded11b9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.311.0 (2026-04-29)
+
+Full Changelog: [v1.310.0...v1.311.0](https://github.com/Increase/increase-ruby/compare/v1.310.0...v1.311.0)
+
+### Features
+
+* **api:** api update ([e4afbd9](https://github.com/Increase/increase-ruby/commit/e4afbd9cc83a679c7e00fc163d0bac940f1768df))
+
 ## 1.310.0 (2026-04-28)
 
 Full Changelog: [v1.309.0...v1.310.0](https://github.com/Increase/increase-ruby/compare/v1.309.0...v1.310.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.310.0"
+gem "increase", "~> 1.311.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/beneficial_owner_create_params.rb

@@ -171,7 +171,9 @@ module Increase
 
           # @!attribute number
           #   An identification number that can be used to verify the individual's identity,
-          #   such as a social security number.
+          #   such as a social security number. For Social Security Numbers and Individual
+          #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          #   separators.
           #
           #   @return [String]
           required :number, String

data/lib/increase/models/beneficial_owner_update_params.rb

@@ -126,7 +126,9 @@ module Increase
 
         # @!attribute number
         #   An identification number that can be used to verify the individual's identity,
-        #   such as a social security number.
+        #   such as a social security number. For Social Security Numbers and Individual
+        #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+        #   separators.
         #
         #   @return [String]
         required :number, String

data/lib/increase/models/entity.rb

@@ -547,7 +547,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER = :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.

data/lib/increase/models/entity_create_params.rb

@@ -450,7 +450,9 @@ module Increase
 
               # @!attribute number
               #   An identification number that can be used to verify the individual's identity,
-              #   such as a social security number.
+              #   such as a social security number. For Social Security Numbers and Individual
+              #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              #   separators.
               #
               #   @return [String]
               required :number, String
@@ -668,7 +670,8 @@ module Increase
         # @see Increase::Models::EntityCreateParams::Corporation#legal_identifier
         class LegalIdentifier < Increase::Internal::Type::BaseModel
           # @!attribute value
-          #   The legal identifier.
+          #   The legal identifier. For US Employer Identification Numbers, submit nine digits
+          #   with no dashes or other separators.
           #
           #   @return [String]
           required :value, String
@@ -688,7 +691,7 @@ module Increase
           #   The legal identifier of the corporation. This is usually the Employer
           #   Identification Number (EIN).
           #
-          #   @param value [String] The legal identifier.
+          #   @param value [String] The legal identifier. For US Employer Identification Numbers, submit nine digits
           #
           #   @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier. If not provided, the default is `us_employ
 
@@ -699,7 +702,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER = :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.
@@ -763,7 +766,8 @@ module Increase
         required :name, String
 
         # @!attribute tax_identifier
-        #   The Employer Identification Number (EIN) for the government authority.
+        #   The Employer Identification Number (EIN) for the government authority. Submit
+        #   nine digits with no dashes or other separators.
         #
         #   @return [String]
         required :tax_identifier, String
@@ -789,7 +793,7 @@ module Increase
         #
         #   @param name [String] The legal name of the government authority.
         #
-        #   @param tax_identifier [String] The Employer Identification Number (EIN) for the government authority.
+        #   @param tax_identifier [String] The Employer Identification Number (EIN) for the government authority. Submit ni
         #
         #   @param website [String] The website of the government authority.
 
@@ -1014,7 +1018,9 @@ module Increase
 
             # @!attribute number
             #   An identification number that can be used to verify the individual's identity,
-            #   such as a social security number.
+            #   such as a social security number. For Social Security Numbers and Individual
+            #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            #   separators.
             #
             #   @return [String]
             required :number, String
@@ -1339,7 +1345,9 @@ module Increase
 
           # @!attribute number
           #   An identification number that can be used to verify the individual's identity,
-          #   such as a social security number.
+          #   such as a social security number. For Social Security Numbers and Individual
+          #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          #   separators.
           #
           #   @return [String]
           required :number, String
@@ -1720,8 +1728,8 @@ module Increase
         optional :grantor, -> { Increase::EntityCreateParams::Trust::Grantor }
 
         # @!attribute tax_identifier
-        #   The Employer Identification Number (EIN) for the trust. Required if `category`
-        #   is equal to `irrevocable`.
+        #   The Employer Identification Number (EIN) for the trust. Submit nine digits with
+        #   no dashes or other separators. Required if `category` is equal to `irrevocable`.
         #
         #   @return [String, nil]
         optional :tax_identifier, String
@@ -1747,7 +1755,7 @@ module Increase
         #
         #   @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] The grantor of the trust. Required if `category` is equal to `revocable`.
         #
-        #   @param tax_identifier [String] The Employer Identification Number (EIN) for the trust. Required if `category` i
+        #   @param tax_identifier [String] The Employer Identification Number (EIN) for the trust. Submit nine digits with
 
         # @see Increase::Models::EntityCreateParams::Trust#address
         class Address < Increase::Internal::Type::BaseModel
@@ -1981,7 +1989,9 @@ module Increase
 
               # @!attribute number
               #   An identification number that can be used to verify the individual's identity,
-              #   such as a social security number.
+              #   such as a social security number. For Social Security Numbers and Individual
+              #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              #   separators.
               #
               #   @return [String]
               required :number, String
@@ -2306,7 +2316,9 @@ module Increase
 
             # @!attribute number
             #   An identification number that can be used to verify the individual's identity,
-            #   such as a social security number.
+            #   such as a social security number. For Social Security Numbers and Individual
+            #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            #   separators.
             #
             #   @return [String]
             required :number, String

data/lib/increase/models/entity_update_params.rb

@@ -221,7 +221,8 @@ module Increase
         # @see Increase::Models::EntityUpdateParams::Corporation#legal_identifier
         class LegalIdentifier < Increase::Internal::Type::BaseModel
           # @!attribute value
-          #   The identifier of the legal identifier.
+          #   The identifier of the legal identifier. For US Employer Identification Numbers,
+          #   submit nine digits with no dashes or other separators.
           #
           #   @return [String]
           required :value, String
@@ -233,10 +234,14 @@ module Increase
           optional :category, enum: -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category }
 
           # @!method initialize(value:, category: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier} for more
+          #   details.
+          #
           #   The legal identifier of the corporation. This is usually the Employer
           #   Identification Number (EIN).
           #
-          #   @param value [String] The identifier of the legal identifier.
+          #   @param value [String] The identifier of the legal identifier. For US Employer Identification Numbers,
           #
           #   @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
 
@@ -246,7 +251,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER = :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.
@@ -451,7 +456,9 @@ module Increase
 
           # @!attribute number
           #   An identification number that can be used to verify the individual's identity,
-          #   such as a social security number.
+          #   such as a social security number. For Social Security Numbers and Individual
+          #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          #   separators.
           #
           #   @return [String]
           required :number, String

data/lib/increase/version.rb

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

data/rbi/increase/models/beneficial_owner_create_params.rbi

@@ -296,7 +296,9 @@ module Increase
           attr_accessor :method_
 
           # An identification number that can be used to verify the individual's identity,
-          # such as a social security number.
+          # such as a social security number. For Social Security Numbers and Individual
+          # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          # separators.
           sig { returns(String) }
           attr_accessor :number
 
@@ -375,7 +377,9 @@ module Increase
             # A method that can be used to verify the individual's identity.
             method_:,
             # An identification number that can be used to verify the individual's identity,
-            # such as a social security number.
+            # such as a social security number. For Social Security Numbers and Individual
+            # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            # separators.
             number:,
             # Information about the United States driver's license used for identification.
             # Required if `method` is equal to `drivers_license`.

data/rbi/increase/models/beneficial_owner_update_params.rbi

@@ -215,7 +215,9 @@ module Increase
         attr_accessor :method_
 
         # An identification number that can be used to verify the individual's identity,
-        # such as a social security number.
+        # such as a social security number. For Social Security Numbers and Individual
+        # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+        # separators.
         sig { returns(String) }
         attr_accessor :number
 
@@ -294,7 +296,9 @@ module Increase
           # A method that can be used to verify the individual's identity.
           method_:,
           # An identification number that can be used to verify the individual's identity,
-          # such as a social security number.
+          # such as a social security number. For Social Security Numbers and Individual
+          # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          # separators.
           number:,
           # Information about the United States driver's license used for identification.
           # Required if `method` is equal to `drivers_license`.

data/rbi/increase/models/entity.rbi

@@ -925,7 +925,7 @@ module Increase
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER =
               T.let(
                 :us_employer_identification_number,

data/rbi/increase/models/entity_create_params.rbi

@@ -837,7 +837,9 @@ module Increase
               attr_accessor :method_
 
               # An identification number that can be used to verify the individual's identity,
-              # such as a social security number.
+              # such as a social security number. For Social Security Numbers and Individual
+              # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              # separators.
               sig { returns(String) }
               attr_accessor :number
 
@@ -916,7 +918,9 @@ module Increase
                 # A method that can be used to verify the individual's identity.
                 method_:,
                 # An identification number that can be used to verify the individual's identity,
-                # such as a social security number.
+                # such as a social security number. For Social Security Numbers and Individual
+                # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+                # separators.
                 number:,
                 # Information about the United States driver's license used for identification.
                 # Required if `method` is equal to `drivers_license`.
@@ -1250,7 +1254,8 @@ module Increase
               )
             end
 
-          # The legal identifier.
+          # The legal identifier. For US Employer Identification Numbers, submit nine digits
+          # with no dashes or other separators.
           sig { returns(String) }
           attr_accessor :value
 
@@ -1283,7 +1288,8 @@ module Increase
             ).returns(T.attached_class)
           end
           def self.new(
-            # The legal identifier.
+            # The legal identifier. For US Employer Identification Numbers, submit nine digits
+            # with no dashes or other separators.
             value:,
             # The category of the legal identifier. If not provided, the default is
             # `us_employer_identification_number`.
@@ -1317,7 +1323,7 @@ module Increase
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER =
               T.let(
                 :us_employer_identification_number,
@@ -1444,7 +1450,8 @@ module Increase
         sig { returns(String) }
         attr_accessor :name
 
-        # The Employer Identification Number (EIN) for the government authority.
+        # The Employer Identification Number (EIN) for the government authority. Submit
+        # nine digits with no dashes or other separators.
         sig { returns(String) }
         attr_accessor :tax_identifier
 
@@ -1482,7 +1489,8 @@ module Increase
           category:,
           # The legal name of the government authority.
           name:,
-          # The Employer Identification Number (EIN) for the government authority.
+          # The Employer Identification Number (EIN) for the government authority. Submit
+          # nine digits with no dashes or other separators.
           tax_identifier:,
           # The website of the government authority.
           website: nil
@@ -1910,7 +1918,9 @@ module Increase
             attr_accessor :method_
 
             # An identification number that can be used to verify the individual's identity,
-            # such as a social security number.
+            # such as a social security number. For Social Security Numbers and Individual
+            # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            # separators.
             sig { returns(String) }
             attr_accessor :number
 
@@ -1989,7 +1999,9 @@ module Increase
               # A method that can be used to verify the individual's identity.
               method_:,
               # An identification number that can be used to verify the individual's identity,
-              # such as a social security number.
+              # such as a social security number. For Social Security Numbers and Individual
+              # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              # separators.
               number:,
               # Information about the United States driver's license used for identification.
               # Required if `method` is equal to `drivers_license`.
@@ -2485,7 +2497,9 @@ module Increase
           attr_accessor :method_
 
           # An identification number that can be used to verify the individual's identity,
-          # such as a social security number.
+          # such as a social security number. For Social Security Numbers and Individual
+          # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          # separators.
           sig { returns(String) }
           attr_accessor :number
 
@@ -2564,7 +2578,9 @@ module Increase
             # A method that can be used to verify the individual's identity.
             method_:,
             # An identification number that can be used to verify the individual's identity,
-            # such as a social security number.
+            # such as a social security number. For Social Security Numbers and Individual
+            # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            # separators.
             number:,
             # Information about the United States driver's license used for identification.
             # Required if `method` is equal to `drivers_license`.
@@ -3186,8 +3202,8 @@ module Increase
         end
         attr_writer :grantor
 
-        # The Employer Identification Number (EIN) for the trust. Required if `category`
-        # is equal to `irrevocable`.
+        # The Employer Identification Number (EIN) for the trust. Submit nine digits with
+        # no dashes or other separators. Required if `category` is equal to `irrevocable`.
         sig { returns(T.nilable(String)) }
         attr_reader :tax_identifier
 
@@ -3228,8 +3244,8 @@ module Increase
           formation_state: nil,
           # The grantor of the trust. Required if `category` is equal to `revocable`.
           grantor: nil,
-          # The Employer Identification Number (EIN) for the trust. Required if `category`
-          # is equal to `irrevocable`.
+          # The Employer Identification Number (EIN) for the trust. Submit nine digits with
+          # no dashes or other separators. Required if `category` is equal to `irrevocable`.
           tax_identifier: nil
         )
         end
@@ -3672,7 +3688,9 @@ module Increase
               attr_accessor :method_
 
               # An identification number that can be used to verify the individual's identity,
-              # such as a social security number.
+              # such as a social security number. For Social Security Numbers and Individual
+              # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              # separators.
               sig { returns(String) }
               attr_accessor :number
 
@@ -3751,7 +3769,9 @@ module Increase
                 # A method that can be used to verify the individual's identity.
                 method_:,
                 # An identification number that can be used to verify the individual's identity,
-                # such as a social security number.
+                # such as a social security number. For Social Security Numbers and Individual
+                # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+                # separators.
                 number:,
                 # Information about the United States driver's license used for identification.
                 # Required if `method` is equal to `drivers_license`.
@@ -4246,7 +4266,9 @@ module Increase
             attr_accessor :method_
 
             # An identification number that can be used to verify the individual's identity,
-            # such as a social security number.
+            # such as a social security number. For Social Security Numbers and Individual
+            # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            # separators.
             sig { returns(String) }
             attr_accessor :number
 
@@ -4325,7 +4347,9 @@ module Increase
               # A method that can be used to verify the individual's identity.
               method_:,
               # An identification number that can be used to verify the individual's identity,
-              # such as a social security number.
+              # such as a social security number. For Social Security Numbers and Individual
+              # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+              # separators.
               number:,
               # Information about the United States driver's license used for identification.
               # Required if `method` is equal to `drivers_license`.

data/rbi/increase/models/entity_update_params.rbi

@@ -412,7 +412,8 @@ module Increase
               )
             end
 
-          # The identifier of the legal identifier.
+          # The identifier of the legal identifier. For US Employer Identification Numbers,
+          # submit nine digits with no dashes or other separators.
           sig { returns(String) }
           attr_accessor :value
 
@@ -444,7 +445,8 @@ module Increase
             ).returns(T.attached_class)
           end
           def self.new(
-            # The identifier of the legal identifier.
+            # The identifier of the legal identifier. For US Employer Identification Numbers,
+            # submit nine digits with no dashes or other separators.
             value:,
             # The category of the legal identifier.
             category: nil
@@ -476,7 +478,7 @@ module Increase
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER =
               T.let(
                 :us_employer_identification_number,
@@ -852,7 +854,9 @@ module Increase
           attr_accessor :method_
 
           # An identification number that can be used to verify the individual's identity,
-          # such as a social security number.
+          # such as a social security number. For Social Security Numbers and Individual
+          # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          # separators.
           sig { returns(String) }
           attr_accessor :number
 
@@ -931,7 +935,9 @@ module Increase
             # A method that can be used to verify the individual's identity.
             method_:,
             # An identification number that can be used to verify the individual's identity,
-            # such as a social security number.
+            # such as a social security number. For Social Security Numbers and Individual
+            # Taxpayer Identification Numbers, submit nine digits with no dashes or other
+            # separators.
             number:,
             # Information about the United States driver's license used for identification.
             # Required if `method` is equal to `drivers_license`.

data/sig/increase/models/entity.rbs

@@ -395,7 +395,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER: :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.

data/sig/increase/models/entity_create_params.rbs

@@ -585,7 +585,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER: :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.

data/sig/increase/models/entity_update_params.rbs

@@ -227,7 +227,7 @@ module Increase
           module Category
             extend Increase::Internal::Type::Enum
 
-            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
+            # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.
             US_EMPLOYER_IDENTIFICATION_NUMBER: :us_employer_identification_number
 
             # A legal identifier issued by a foreign government, like a tax identification number or registration number.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.310.0
+  version: 1.311.0
 platform: ruby
 authors:
 - Increase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-28 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi