increase 1.270.0 → 1.273.0

data/lib/increase/models/entity.rb

@@ -208,25 +208,25 @@ module Increase
         #   @return [String, nil]
         required :industry_code, String, nil?: true
 
+        # @!attribute legal_identifier
+        #   The legal identifier of the corporation.
+        #
+        #   @return [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
+        required :legal_identifier, -> { Increase::Entity::Corporation::LegalIdentifier }, nil?: true
+
         # @!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, nil]
-        required :tax_identifier, String, nil?: true
-
         # @!attribute website
         #   The website of the corporation.
         #
         #   @return [String, nil]
         required :website, String, nil?: true
 
-        # @!method initialize(address:, beneficial_owners:, email:, incorporation_state:, industry_code:, name:, tax_identifier:, website:)
+        # @!method initialize(address:, beneficial_owners:, email:, incorporation_state:, industry_code:, legal_identifier:, name:, website:)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::Entity::Corporation} for more details.
         #
@@ -243,19 +243,25 @@ module Increase
         #
         #   @param industry_code [String, nil] The numeric North American Industry Classification System (NAICS) code submitted
         #
-        #   @param name [String] The legal name of the corporation.
+        #   @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil] The legal identifier of the corporation.
         #
-        #   @param tax_identifier [String, nil] The Employer Identification Number (EIN) for the corporation.
+        #   @param name [String] The legal name of the corporation.
         #
         #   @param website [String, nil] The website of the corporation.
 
         # @see Increase::Models::Entity::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, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @return [String]
-          required :city, String
+          required :country, String
 
           # @!attribute line1
           #   The first line of the address.
@@ -270,33 +276,35 @@ module Increase
           required :line2, String, nil?: true
 
           # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          required :state, String, nil?: true
 
           # @!attribute zip
-          #   The ZIP code of the address.
+          #   The ZIP or postal code of the address.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          required :zip, String, nil?: true
 
-          # @!method initialize(city:, line1:, line2:, state:, zip:)
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Entity::Corporation::Address} for more details.
           #
           #   The corporation's address.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String, nil] 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.
           #
           #   @param line2 [String, nil] The second line of the address.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param zip [String, nil] The ZIP or postal code of the address.
         end
 
         class BeneficialOwner < Increase::Internal::Type::BaseModel
@@ -501,6 +509,44 @@ module Increase
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see Increase::Models::Entity::Corporation#legal_identifier
+        class LegalIdentifier < Increase::Internal::Type::BaseModel
+          # @!attribute category
+          #   The category of the legal identifier.
+          #
+          #   @return [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category]
+          required :category, enum: -> { Increase::Entity::Corporation::LegalIdentifier::Category }
+
+          # @!attribute value
+          #   The identifier of the legal identifier.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(category:, value:)
+          #   The legal identifier of the corporation.
+          #
+          #   @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category] The category of the legal identifier.
+          #
+          #   @param value [String] The identifier of the legal identifier.
+
+          # The category of the legal identifier.
+          #
+          # @see Increase::Models::Entity::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
 
       # @see Increase::Models::Entity#government_authority
@@ -561,10 +607,16 @@ module Increase
         # @see Increase::Models::Entity::GovernmentAuthority#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, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @return [String]
-          required :city, String
+          required :country, String
 
           # @!attribute line1
           #   The first line of the address.
@@ -579,33 +631,35 @@ module Increase
           required :line2, String, nil?: true
 
           # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          required :state, String, nil?: true
 
           # @!attribute zip
-          #   The ZIP code of the address.
+          #   The ZIP or postal code of the address.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          required :zip, String, nil?: true
 
-          # @!method initialize(city:, line1:, line2:, state:, zip:)
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Entity::GovernmentAuthority::Address} for more details.
           #
           #   The government authority's address.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String, nil] 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.
           #
           #   @param line2 [String, nil] The second line of the address.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param zip [String, nil] The ZIP or postal code of the address.
         end
 
         class AuthorizedPerson < Increase::Internal::Type::BaseModel
@@ -708,10 +762,16 @@ module Increase
           # @see Increase::Models::Entity::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, nil]
+            required :city, String, nil?: true
+
+            # @!attribute country
+            #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             #
             #   @return [String]
-            required :city, String
+            required :country, String
 
             # @!attribute line1
             #   The first line of the address.
@@ -726,33 +786,35 @@ module Increase
             required :line2, String, nil?: true
 
             # @!attribute state
-            #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-            #   the address.
+            #   The two-letter United States Postal Service (USPS) abbreviation for the US
+            #   state, province, or region of the address.
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            required :state, String, nil?: true
 
             # @!attribute zip
-            #   The ZIP code of the address.
+            #   The ZIP or postal code of the address.
             #
-            #   @return [String]
-            required :zip, String
+            #   @return [String, nil]
+            required :zip, String, nil?: true
 
-            # @!method initialize(city:, line1:, line2:, state:, zip:)
+            # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
             #   Some parameter documentations has been truncated, see
             #   {Increase::Models::Entity::Joint::Individual::Address} for more details.
             #
             #   The person's address.
             #
-            #   @param city [String] The city of the address.
+            #   @param city [String, nil] 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.
             #
             #   @param line2 [String, nil] The second line of the address.
             #
-            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+            #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
             #
-            #   @param zip [String] The ZIP code of the address.
+            #   @param zip [String, nil] The ZIP or postal code of the address.
           end
 
           # @see Increase::Models::Entity::Joint::Individual#identification
@@ -851,10 +913,16 @@ module Increase
         # @see Increase::Models::Entity::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, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @return [String]
-          required :city, String
+          required :country, String
 
           # @!attribute line1
           #   The first line of the address.
@@ -869,33 +937,35 @@ module Increase
           required :line2, String, nil?: true
 
           # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          required :state, String, nil?: true
 
           # @!attribute zip
-          #   The ZIP code of the address.
+          #   The ZIP or postal code of the address.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          required :zip, String, nil?: true
 
-          # @!method initialize(city:, line1:, line2:, state:, zip:)
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Entity::NaturalPerson::Address} for more details.
           #
           #   The person's address.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String, nil] 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.
           #
           #   @param line2 [String, nil] The second line of the address.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param zip [String, nil] The ZIP or postal code of the address.
         end
 
         # @see Increase::Models::Entity::NaturalPerson#identification
@@ -1199,10 +1269,16 @@ module Increase
         # @see Increase::Models::Entity::Trust#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, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
           #   @return [String]
-          required :city, String
+          required :country, String
 
           # @!attribute line1
           #   The first line of the address.
@@ -1217,33 +1293,35 @@ module Increase
           required :line2, String, nil?: true
 
           # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          required :state, String, nil?: true
 
           # @!attribute zip
-          #   The ZIP code of the address.
+          #   The ZIP or postal code of the address.
           #
-          #   @return [String]
-          required :zip, String
+          #   @return [String, nil]
+          required :zip, String, nil?: true
 
-          # @!method initialize(city:, line1:, line2:, state:, zip:)
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Entity::Trust::Address} for more details.
           #
           #   The trust's address.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String, nil] 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.
           #
           #   @param line2 [String, nil] The second line of the address.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param zip [String, nil] The ZIP or postal code of the address.
         end
 
         # Whether the trust is `revocable` or `irrevocable`.
@@ -1302,10 +1380,16 @@ module Increase
           # @see Increase::Models::Entity::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, nil]
+            required :city, String, nil?: true
+
+            # @!attribute country
+            #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             #
             #   @return [String]
-            required :city, String
+            required :country, String
 
             # @!attribute line1
             #   The first line of the address.
@@ -1320,33 +1404,35 @@ module Increase
             required :line2, String, nil?: true
 
             # @!attribute state
-            #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-            #   the address.
+            #   The two-letter United States Postal Service (USPS) abbreviation for the US
+            #   state, province, or region of the address.
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            required :state, String, nil?: true
 
             # @!attribute zip
-            #   The ZIP code of the address.
+            #   The ZIP or postal code of the address.
             #
-            #   @return [String]
-            required :zip, String
+            #   @return [String, nil]
+            required :zip, String, nil?: true
 
-            # @!method initialize(city:, line1:, line2:, state:, zip:)
+            # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
             #   Some parameter documentations has been truncated, see
             #   {Increase::Models::Entity::Trust::Grantor::Address} for more details.
             #
             #   The person's address.
             #
-            #   @param city [String] The city of the address.
+            #   @param city [String, nil] 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.
             #
             #   @param line2 [String, nil] The second line of the address.
             #
-            #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+            #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
             #
-            #   @param zip [String] The ZIP code of the address.
+            #   @param zip [String, nil] The ZIP or postal code of the address.
           end
 
           # @see Increase::Models::Entity::Trust::Grantor#identification
@@ -1466,10 +1552,16 @@ module Increase
             # @see Increase::Models::Entity::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, nil]
+              required :city, String, nil?: true
+
+              # @!attribute country
+              #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               #
               #   @return [String]
-              required :city, String
+              required :country, String
 
               # @!attribute line1
               #   The first line of the address.
@@ -1484,34 +1576,36 @@ module Increase
               required :line2, String, nil?: true
 
               # @!attribute state
-              #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-              #   the address.
+              #   The two-letter United States Postal Service (USPS) abbreviation for the US
+              #   state, province, or region of the address.
               #
-              #   @return [String]
-              required :state, String
+              #   @return [String, nil]
+              required :state, String, nil?: true
 
               # @!attribute zip
-              #   The ZIP code of the address.
+              #   The ZIP or postal code of the address.
               #
-              #   @return [String]
-              required :zip, String
+              #   @return [String, nil]
+              required :zip, String, nil?: true
 
-              # @!method initialize(city:, line1:, line2:, state:, zip:)
+              # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
               #   Some parameter documentations has been truncated, see
               #   {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more
               #   details.
               #
               #   The person's address.
               #
-              #   @param city [String] The city of the address.
+              #   @param city [String, nil] 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.
               #
               #   @param line2 [String, nil] The second line of the address.
               #
-              #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+              #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
               #
-              #   @param zip [String] The ZIP code of the address.
+              #   @param zip [String, nil] The ZIP or postal code of the address.
             end
 
             # @see Increase::Models::Entity::Trust::Trustee::Individual#identification