RubyGems - increase - Versions diffs - 1.270.0 → 1.273.0 - Mend

increase 1.270.0 → 1.273.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +183 -0
data/README.md +1 -1
data/lib/increase/internal/util.rb +1 -2
data/lib/increase/models/entity.rb +194 -100
data/lib/increase/models/entity_create_params.rb +185 -99
data/lib/increase/models/entity_update_params.rb +52 -36
data/lib/increase/version.rb +1 -1
data/rbi/increase/models/entity.rbi +283 -127
data/rbi/increase/models/entity_create_params.rbi +299 -113
data/rbi/increase/models/entity_update_params.rbi +70 -42
data/sig/increase/models/entity.rbs +160 -89
data/sig/increase/models/entity_create_params.rbs +145 -60
data/sig/increase/models/entity_update_params.rbs +40 -22
metadata +2 -2

data/lib/increase/models/entity_create_params.rb CHANGED Viewed

@@ -154,18 +154,19 @@ module Increase
         required :beneficial_owners,
                  -> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::Corporation::BeneficialOwner] }
+        # @!attribute legal_identifier
+        #   The legal identifier of the corporation. This is usually the Employer
+        #   Identification Number (EIN).
+        #
+        #   @return [Increase::Models::EntityCreateParams::Corporation::LegalIdentifier]
+        required :legal_identifier, -> { Increase::EntityCreateParams::Corporation::LegalIdentifier }
         # @!attribute name
         #   The legal name of the corporation.
         #
         #   @return [String]
         required :name, String
-        # @!attribute tax_identifier
-        #   The Employer Identification Number (EIN) for the corporation.
-        #
-        #   @return [String]
-        required :tax_identifier, String
         # @!attribute beneficial_ownership_exemption_reason
         #   If the entity is exempt from the requirement to submit beneficial owners,
         #   provide the justification. If a reason is provided, you do not need to submit a
@@ -204,7 +205,7 @@ module Increase
         #   @return [String, nil]
         optional :website, String
-        # @!method initialize(address:, beneficial_owners:, name:, tax_identifier:, beneficial_ownership_exemption_reason: nil, email: nil, incorporation_state: nil, industry_code: nil, website: nil)
+        # @!method initialize(address:, beneficial_owners:, legal_identifier:, name:, beneficial_ownership_exemption_reason: nil, email: nil, incorporation_state: nil, industry_code: nil, website: nil)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::EntityCreateParams::Corporation} for more details.
         #
@@ -215,9 +216,9 @@ module Increase
         #
         #   @param beneficial_owners [Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>] The identifying details of each person who owns 25% or more of the business and
         #
-        #   @param name [String] The legal name of the corporation.
+        #   @param legal_identifier [Increase::Models::EntityCreateParams::Corporation::LegalIdentifier] The legal identifier of the corporation. This is usually the Employer Identifica
         #
-        #   @param tax_identifier [String] The Employer Identification Number (EIN) for the corporation.
+        #   @param name [String] The legal name of the corporation.
         #
         #   @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason] If the entity is exempt from the requirement to submit beneficial owners, provid
         #
@@ -232,52 +233,60 @@ module Increase
         # @see Increase::Models::EntityCreateParams::Corporation#address
         class Address < Increase::Internal::Type::BaseModel
           # @!attribute city
-          #   The city of the address.
+          #   The city, district, town, or village of the address.
           #
           #   @return [String]
           required :city, String
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @return [String]
+          required :country, String
           # @!attribute line1
           #   The first line of the address. This is usually the street number and street.
           #
           #   @return [String]
           required :line1, String
-          # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          # @!attribute line2
+          #   The second line of the address. This might be the floor or room number.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :line2, String
-          # @!attribute zip
-          #   The ZIP code of the address.
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address. Required in certain countries.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          optional :state, String
-          # @!attribute line2
-          #   The second line of the address. This might be the floor or room number.
+          # @!attribute zip
+          #   The ZIP or postal code of the address. Required in certain countries.
           #
           #   @return [String, nil]
-          optional :line2, String
+          optional :zip, String
-          # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+          # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::EntityCreateParams::Corporation::Address} for more details.
           #
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String] The city, district, town, or village of the address.
+          #
+          #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param line2 [String] The second line of the address. This might be the floor or room number.
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param line2 [String] The second line of the address. This might be the floor or room number.
+          #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
         class BeneficialOwner < Increase::Internal::Type::BaseModel
@@ -656,6 +665,51 @@ module Increase
           end
         end
+        # @see Increase::Models::EntityCreateParams::Corporation#legal_identifier
+        class LegalIdentifier < Increase::Internal::Type::BaseModel
+          # @!attribute value
+          #   The legal identifier.
+          #
+          #   @return [String]
+          required :value, String
+          # @!attribute category
+          #   The category of the legal identifier. If not provided, the default is
+          #   `us_employer_identification_number`.
+          #
+          #   @return [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category, nil]
+          optional :category, enum: -> { Increase::EntityCreateParams::Corporation::LegalIdentifier::Category }
+          # @!method initialize(value:, category: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityCreateParams::Corporation::LegalIdentifier} for more
+          #   details.
+          #
+          #   The legal identifier of the corporation. This is usually the Employer
+          #   Identification Number (EIN).
+          #
+          #   @param value [String] The legal identifier.
+          #
+          #   @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier. If not provided, the default is `us_employ
+          # The category of the legal identifier. If not provided, the default is
+          # `us_employer_identification_number`.
+          #
+          # @see Increase::Models::EntityCreateParams::Corporation::LegalIdentifier#category
+          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.
+            US_EMPLOYER_IDENTIFICATION_NUMBER = :us_employer_identification_number
+            # A legal identifier issued by a foreign government, like a tax identification number or registration number.
+            OTHER = :other
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
         # If the entity is exempt from the requirement to submit beneficial owners,
         # provide the justification. If a reason is provided, you do not need to submit a
         # list of beneficial owners.
@@ -891,37 +945,43 @@ module Increase
           # @see Increase::Models::EntityCreateParams::Joint::Individual#address
           class Address < Increase::Internal::Type::BaseModel
             # @!attribute city
-            #   The city of the address.
+            #   The city, district, town, or village of the address.
             #
             #   @return [String]
             required :city, String
+            # @!attribute country
+            #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            #
+            #   @return [String]
+            required :country, String
             # @!attribute line1
             #   The first line of the address. This is usually the street number and street.
             #
             #   @return [String]
             required :line1, String
-            # @!attribute state
-            #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-            #   the address.
+            # @!attribute line2
+            #   The second line of the address. This might be the floor or room number.
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            optional :line2, String
-            # @!attribute zip
-            #   The ZIP code of the address.
+            # @!attribute state
+            #   The two-letter United States Postal Service (USPS) abbreviation for the US
+            #   state, province, or region of the address. Required in certain countries.
             #
-            #   @return [String]
-            required :zip, String
+            #   @return [String, nil]
+            optional :state, String
-            # @!attribute line2
-            #   The second line of the address. This might be the floor or room number.
+            # @!attribute zip
+            #   The ZIP or postal code of the address. Required in certain countries.
             #
             #   @return [String, nil]
-            optional :line2, String
+            optional :zip, String
-            # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+            # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
             #   Some parameter documentations has been truncated, see
             #   {Increase::Models::EntityCreateParams::Joint::Individual::Address} for more
             #   details.
@@ -929,15 +989,17 @@ module Increase
             #   The individual's physical address. Mail receiving locations like PO Boxes and
             #   PMB's are disallowed.
             #
-            #   @param city [String] The city of the address.
+            #   @param city [String] The city, district, town, or village of the address.
+            #
+            #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             #
             #   @param line1 [String] The first line of the address. This is usually the street number and street.
             #
-            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+            #   @param line2 [String] The second line of the address. This might be the floor or room number.
             #
-            #   @param zip [String] The ZIP code of the address.
+            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
             #
-            #   @param line2 [String] The second line of the address. This might be the floor or room number.
+            #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
           end
           # @see Increase::Models::EntityCreateParams::Joint::Individual#identification
@@ -1209,52 +1271,60 @@ module Increase
         # @see Increase::Models::EntityCreateParams::NaturalPerson#address
         class Address < Increase::Internal::Type::BaseModel
           # @!attribute city
-          #   The city of the address.
+          #   The city, district, town, or village of the address.
           #
           #   @return [String]
           required :city, String
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @return [String]
+          required :country, String
           # @!attribute line1
           #   The first line of the address. This is usually the street number and street.
           #
           #   @return [String]
           required :line1, String
-          # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          # @!attribute line2
+          #   The second line of the address. This might be the floor or room number.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :line2, String
-          # @!attribute zip
-          #   The ZIP code of the address.
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address. Required in certain countries.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          optional :state, String
-          # @!attribute line2
-          #   The second line of the address. This might be the floor or room number.
+          # @!attribute zip
+          #   The ZIP or postal code of the address. Required in certain countries.
           #
           #   @return [String, nil]
-          optional :line2, String
+          optional :zip, String
-          # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+          # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::EntityCreateParams::NaturalPerson::Address} for more details.
           #
           #   The individual's physical address. Mail receiving locations like PO Boxes and
           #   PMB's are disallowed.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String] The city, district, town, or village of the address.
+          #
+          #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param line2 [String] The second line of the address. This might be the floor or room number.
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param line2 [String] The second line of the address. This might be the floor or room number.
+          #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
         # @see Increase::Models::EntityCreateParams::NaturalPerson#identification
@@ -1840,37 +1910,43 @@ module Increase
             # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address
             class Address < Increase::Internal::Type::BaseModel
               # @!attribute city
-              #   The city of the address.
+              #   The city, district, town, or village of the address.
               #
               #   @return [String]
               required :city, String
+              # @!attribute country
+              #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              #
+              #   @return [String]
+              required :country, String
               # @!attribute line1
               #   The first line of the address. This is usually the street number and street.
               #
               #   @return [String]
               required :line1, String
-              # @!attribute state
-              #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-              #   the address.
+              # @!attribute line2
+              #   The second line of the address. This might be the floor or room number.
               #
-              #   @return [String]
-              required :state, String
+              #   @return [String, nil]
+              optional :line2, String
-              # @!attribute zip
-              #   The ZIP code of the address.
+              # @!attribute state
+              #   The two-letter United States Postal Service (USPS) abbreviation for the US
+              #   state, province, or region of the address. Required in certain countries.
               #
-              #   @return [String]
-              required :zip, String
+              #   @return [String, nil]
+              optional :state, String
-              # @!attribute line2
-              #   The second line of the address. This might be the floor or room number.
+              # @!attribute zip
+              #   The ZIP or postal code of the address. Required in certain countries.
               #
               #   @return [String, nil]
-              optional :line2, String
+              optional :zip, String
-              # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+              # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
               #   Some parameter documentations has been truncated, see
               #   {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address} for
               #   more details.
@@ -1878,15 +1954,17 @@ module Increase
               #   The individual's physical address. Mail receiving locations like PO Boxes and
               #   PMB's are disallowed.
               #
-              #   @param city [String] The city of the address.
+              #   @param city [String] The city, district, town, or village of the address.
+              #
+              #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               #
               #   @param line1 [String] The first line of the address. This is usually the street number and street.
               #
-              #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+              #   @param line2 [String] The second line of the address. This might be the floor or room number.
               #
-              #   @param zip [String] The ZIP code of the address.
+              #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
               #
-              #   @param line2 [String] The second line of the address. This might be the floor or room number.
+              #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
             end
             # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#identification
@@ -2159,37 +2237,43 @@ module Increase
           # @see Increase::Models::EntityCreateParams::Trust::Grantor#address
           class Address < Increase::Internal::Type::BaseModel
             # @!attribute city
-            #   The city of the address.
+            #   The city, district, town, or village of the address.
             #
             #   @return [String]
             required :city, String
+            # @!attribute country
+            #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            #
+            #   @return [String]
+            required :country, String
             # @!attribute line1
             #   The first line of the address. This is usually the street number and street.
             #
             #   @return [String]
             required :line1, String
-            # @!attribute state
-            #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-            #   the address.
+            # @!attribute line2
+            #   The second line of the address. This might be the floor or room number.
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            optional :line2, String
-            # @!attribute zip
-            #   The ZIP code of the address.
+            # @!attribute state
+            #   The two-letter United States Postal Service (USPS) abbreviation for the US
+            #   state, province, or region of the address. Required in certain countries.
             #
-            #   @return [String]
-            required :zip, String
+            #   @return [String, nil]
+            optional :state, String
-            # @!attribute line2
-            #   The second line of the address. This might be the floor or room number.
+            # @!attribute zip
+            #   The ZIP or postal code of the address. Required in certain countries.
             #
             #   @return [String, nil]
-            optional :line2, String
+            optional :zip, String
-            # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+            # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
             #   Some parameter documentations has been truncated, see
             #   {Increase::Models::EntityCreateParams::Trust::Grantor::Address} for more
             #   details.
@@ -2197,15 +2281,17 @@ module Increase
             #   The individual's physical address. Mail receiving locations like PO Boxes and
             #   PMB's are disallowed.
             #
-            #   @param city [String] The city of the address.
+            #   @param city [String] The city, district, town, or village of the address.
+            #
+            #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             #
             #   @param line1 [String] The first line of the address. This is usually the street number and street.
             #
-            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+            #   @param line2 [String] The second line of the address. This might be the floor or room number.
             #
-            #   @param zip [String] The ZIP code of the address.
+            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
             #
-            #   @param line2 [String] The second line of the address. This might be the floor or room number.
+            #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
           end
           # @see Increase::Models::EntityCreateParams::Trust::Grantor#identification