increase 1.271.0 → 1.274.0

data/lib/increase/models/entity_create_params.rb

@@ -233,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
@@ -937,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.
@@ -975,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
@@ -1255,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
@@ -1886,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.
@@ -1924,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
@@ -2205,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.
@@ -2243,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

data/lib/increase/models/entity_update_params.rb

@@ -117,19 +117,20 @@ module Increase
         #   @return [String, nil]
         optional :industry_code, String
 
+        # @!attribute legal_identifier
+        #   The legal identifier of the corporation. This is usually the Employer
+        #   Identification Number (EIN).
+        #
+        #   @return [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier, nil]
+        optional :legal_identifier, -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier }
+
         # @!attribute name
         #   The legal name of the corporation.
         #
         #   @return [String, nil]
         optional :name, String
 
-        # @!attribute tax_identifier
-        #   The Employer Identification Number (EIN) for the corporation.
-        #
-        #   @return [String, nil]
-        optional :tax_identifier, String
-
-        # @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, name: nil, tax_identifier: nil)
+        # @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, legal_identifier: nil, name: nil)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::EntityUpdateParams::Corporation} for more details.
         #
@@ -144,59 +145,106 @@ module Increase
         #
         #   @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
         #
-        #   @param name [String] The legal name of the corporation.
+        #   @param legal_identifier [Increase::Models::EntityUpdateParams::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.
 
         # @see Increase::Models::EntityUpdateParams::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::EntityUpdateParams::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
+
+        # @see Increase::Models::EntityUpdateParams::Corporation#legal_identifier
+        class LegalIdentifier < Increase::Internal::Type::BaseModel
+          # @!attribute value
+          #   The identifier of the legal identifier.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!attribute category
+          #   The category of the legal identifier.
+          #
+          #   @return [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category, nil]
+          optional :category, enum: -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category }
+
+          # @!method initialize(value:, category: nil)
+          #   The legal identifier of the corporation. This is usually the Employer
+          #   Identification Number (EIN).
+          #
+          #   @param value [String] The identifier of the legal identifier.
+          #
+          #   @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
+
+          # The category of the legal identifier.
+          #
+          # @see Increase::Models::EntityUpdateParams::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
       end
 
@@ -306,52 +354,60 @@ module Increase
         # @see Increase::Models::EntityUpdateParams::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::EntityUpdateParams::NaturalPerson::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
       end
 

data/lib/increase/version.rb

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