increase 1.270.0 → 1.273.0

data/rbi/increase/models/entity_create_params.rbi

@@ -306,14 +306,25 @@ module Increase
         end
         attr_accessor :beneficial_owners
 
+        # The legal identifier of the corporation. This is usually the Employer
+        # Identification Number (EIN).
+        sig do
+          returns(Increase::EntityCreateParams::Corporation::LegalIdentifier)
+        end
+        attr_reader :legal_identifier
+
+        sig do
+          params(
+            legal_identifier:
+              Increase::EntityCreateParams::Corporation::LegalIdentifier::OrHash
+          ).void
+        end
+        attr_writer :legal_identifier
+
         # The legal name of the corporation.
         sig { returns(String) }
         attr_accessor :name
 
-        # The Employer Identification Number (EIN) for the corporation.
-        sig { returns(String) }
-        attr_accessor :tax_identifier
-
         # 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.
@@ -376,8 +387,9 @@ module Increase
               T::Array[
                 Increase::EntityCreateParams::Corporation::BeneficialOwner::OrHash
               ],
+            legal_identifier:
+              Increase::EntityCreateParams::Corporation::LegalIdentifier::OrHash,
             name: String,
-            tax_identifier: String,
             beneficial_ownership_exemption_reason:
               Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol,
             email: String,
@@ -394,10 +406,11 @@ module Increase
           # one control person, like the CEO, CFO, or other executive. You can submit
           # between 1 and 5 people to this list.
           beneficial_owners:,
+          # The legal identifier of the corporation. This is usually the Employer
+          # Identification Number (EIN).
+          legal_identifier:,
           # The legal name of the corporation.
           name:,
-          # The Employer Identification Number (EIN) for the corporation.
-          tax_identifier:,
           # 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.
@@ -426,8 +439,9 @@ module Increase
                 T::Array[
                   Increase::EntityCreateParams::Corporation::BeneficialOwner
                 ],
+              legal_identifier:
+                Increase::EntityCreateParams::Corporation::LegalIdentifier,
               name: String,
-              tax_identifier: String,
               beneficial_ownership_exemption_reason:
                 Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol,
               email: String,
@@ -449,22 +463,17 @@ module Increase
               )
             end
 
-          # The city of the address.
+          # The city, district, town, or village of the address.
           sig { returns(String) }
           attr_accessor :city
 
-          # The first line of the address. This is usually the street number and street.
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           sig { returns(String) }
-          attr_accessor :line1
-
-          # The two-letter United States Postal Service (USPS) abbreviation for the state of
-          # the address.
-          sig { returns(String) }
-          attr_accessor :state
+          attr_accessor :country
 
-          # The ZIP code of the address.
+          # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
-          attr_accessor :zip
+          attr_accessor :line1
 
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
@@ -473,29 +482,47 @@ module Increase
           sig { params(line2: String).void }
           attr_writer :line2
 
+          # The two-letter United States Postal Service (USPS) abbreviation for the US
+          # state, province, or region of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # The ZIP or postal code of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :zip
+
+          sig { params(zip: String).void }
+          attr_writer :zip
+
           # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           # are disallowed.
           sig do
             params(
               city: String,
+              country: String,
               line1: String,
+              line2: String,
               state: String,
-              zip: String,
-              line2: String
+              zip: String
             ).returns(T.attached_class)
           end
           def self.new(
-            # The city of the address.
+            # The city, district, town, or village of the address.
             city:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
-            state:,
-            # The ZIP code of the address.
-            zip:,
             # The second line of the address. This might be the floor or room number.
-            line2: nil
+            line2: nil,
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            state: nil,
+            # The ZIP or postal code of the address. Required in certain countries.
+            zip: nil
           )
           end
 
@@ -503,10 +530,11 @@ module Increase
             override.returns(
               {
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               }
             )
           end
@@ -1213,6 +1241,108 @@ module Increase
           end
         end
 
+        class LegalIdentifier < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::EntityCreateParams::Corporation::LegalIdentifier,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The legal identifier.
+          sig { returns(String) }
+          attr_accessor :value
+
+          # The category of the legal identifier. If not provided, the default is
+          # `us_employer_identification_number`.
+          sig do
+            returns(
+              T.nilable(
+                Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::OrSymbol
+              )
+            )
+          end
+          attr_reader :category
+
+          sig do
+            params(
+              category:
+                Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::OrSymbol
+            ).void
+          end
+          attr_writer :category
+
+          # The legal identifier of the corporation. This is usually the Employer
+          # Identification Number (EIN).
+          sig do
+            params(
+              value: String,
+              category:
+                Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The legal identifier.
+            value:,
+            # The category of the legal identifier. If not provided, the default is
+            # `us_employer_identification_number`.
+            category: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                value: String,
+                category:
+                  Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The category of the legal identifier. If not provided, the default is
+          # `us_employer_identification_number`.
+          module Category
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::EntityCreateParams::Corporation::LegalIdentifier::Category
+                )
+              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.
+            US_EMPLOYER_IDENTIFICATION_NUMBER =
+              T.let(
+                :us_employer_identification_number,
+                Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
+              )
+
+            # A legal identifier issued by a foreign government, like a tax identification number or registration number.
+            OTHER =
+              T.let(
+                :other,
+                Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::EntityCreateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          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.
@@ -1683,22 +1813,17 @@ module Increase
                 )
               end
 
-            # The city of the address.
+            # The city, district, town, or village of the address.
             sig { returns(String) }
             attr_accessor :city
 
-            # The first line of the address. This is usually the street number and street.
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             sig { returns(String) }
-            attr_accessor :line1
-
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
-            sig { returns(String) }
-            attr_accessor :state
+            attr_accessor :country
 
-            # The ZIP code of the address.
+            # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
-            attr_accessor :zip
+            attr_accessor :line1
 
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
@@ -1707,29 +1832,47 @@ module Increase
             sig { params(line2: String).void }
             attr_writer :line2
 
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            sig { returns(T.nilable(String)) }
+            attr_reader :state
+
+            sig { params(state: String).void }
+            attr_writer :state
+
+            # The ZIP or postal code of the address. Required in certain countries.
+            sig { returns(T.nilable(String)) }
+            attr_reader :zip
+
+            sig { params(zip: String).void }
+            attr_writer :zip
+
             # The individual's physical address. Mail receiving locations like PO Boxes and
             # PMB's are disallowed.
             sig do
               params(
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               ).returns(T.attached_class)
             end
             def self.new(
-              # The city of the address.
+              # The city, district, town, or village of the address.
               city:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
-              # The two-letter United States Postal Service (USPS) abbreviation for the state of
-              # the address.
-              state:,
-              # The ZIP code of the address.
-              zip:,
               # The second line of the address. This might be the floor or room number.
-              line2: nil
+              line2: nil,
+              # The two-letter United States Postal Service (USPS) abbreviation for the US
+              # state, province, or region of the address. Required in certain countries.
+              state: nil,
+              # The ZIP or postal code of the address. Required in certain countries.
+              zip: nil
             )
             end
 
@@ -1737,10 +1880,11 @@ module Increase
               override.returns(
                 {
                   city: String,
+                  country: String,
                   line1: String,
+                  line2: String,
                   state: String,
-                  zip: String,
-                  line2: String
+                  zip: String
                 }
               )
             end
@@ -2244,22 +2388,17 @@ module Increase
               )
             end
 
-          # The city of the address.
+          # The city, district, town, or village of the address.
           sig { returns(String) }
           attr_accessor :city
 
-          # The first line of the address. This is usually the street number and street.
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           sig { returns(String) }
-          attr_accessor :line1
+          attr_accessor :country
 
-          # The two-letter United States Postal Service (USPS) abbreviation for the state of
-          # the address.
-          sig { returns(String) }
-          attr_accessor :state
-
-          # The ZIP code of the address.
+          # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
-          attr_accessor :zip
+          attr_accessor :line1
 
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
@@ -2268,29 +2407,47 @@ module Increase
           sig { params(line2: String).void }
           attr_writer :line2
 
+          # The two-letter United States Postal Service (USPS) abbreviation for the US
+          # state, province, or region of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # The ZIP or postal code of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :zip
+
+          sig { params(zip: String).void }
+          attr_writer :zip
+
           # The individual's physical address. Mail receiving locations like PO Boxes and
           # PMB's are disallowed.
           sig do
             params(
               city: String,
+              country: String,
               line1: String,
+              line2: String,
               state: String,
-              zip: String,
-              line2: String
+              zip: String
             ).returns(T.attached_class)
           end
           def self.new(
-            # The city of the address.
+            # The city, district, town, or village of the address.
             city:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
-            state:,
-            # The ZIP code of the address.
-            zip:,
             # The second line of the address. This might be the floor or room number.
-            line2: nil
+            line2: nil,
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            state: nil,
+            # The ZIP or postal code of the address. Required in certain countries.
+            zip: nil
           )
           end
 
@@ -2298,10 +2455,11 @@ module Increase
             override.returns(
               {
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               }
             )
           end
@@ -3417,22 +3575,17 @@ module Increase
                   )
                 end
 
-              # The city of the address.
+              # The city, district, town, or village of the address.
               sig { returns(String) }
               attr_accessor :city
 
-              # The first line of the address. This is usually the street number and street.
-              sig { returns(String) }
-              attr_accessor :line1
-
-              # The two-letter United States Postal Service (USPS) abbreviation for the state of
-              # the address.
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               sig { returns(String) }
-              attr_accessor :state
+              attr_accessor :country
 
-              # The ZIP code of the address.
+              # The first line of the address. This is usually the street number and street.
               sig { returns(String) }
-              attr_accessor :zip
+              attr_accessor :line1
 
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
@@ -3441,29 +3594,47 @@ module Increase
               sig { params(line2: String).void }
               attr_writer :line2
 
+              # The two-letter United States Postal Service (USPS) abbreviation for the US
+              # state, province, or region of the address. Required in certain countries.
+              sig { returns(T.nilable(String)) }
+              attr_reader :state
+
+              sig { params(state: String).void }
+              attr_writer :state
+
+              # The ZIP or postal code of the address. Required in certain countries.
+              sig { returns(T.nilable(String)) }
+              attr_reader :zip
+
+              sig { params(zip: String).void }
+              attr_writer :zip
+
               # The individual's physical address. Mail receiving locations like PO Boxes and
               # PMB's are disallowed.
               sig do
                 params(
                   city: String,
+                  country: String,
                   line1: String,
+                  line2: String,
                   state: String,
-                  zip: String,
-                  line2: String
+                  zip: String
                 ).returns(T.attached_class)
               end
               def self.new(
-                # The city of the address.
+                # The city, district, town, or village of the address.
                 city:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
-                # The two-letter United States Postal Service (USPS) abbreviation for the state of
-                # the address.
-                state:,
-                # The ZIP code of the address.
-                zip:,
                 # The second line of the address. This might be the floor or room number.
-                line2: nil
+                line2: nil,
+                # The two-letter United States Postal Service (USPS) abbreviation for the US
+                # state, province, or region of the address. Required in certain countries.
+                state: nil,
+                # The ZIP or postal code of the address. Required in certain countries.
+                zip: nil
               )
               end
 
@@ -3471,10 +3642,11 @@ module Increase
                 override.returns(
                   {
                     city: String,
+                    country: String,
                     line1: String,
+                    line2: String,
                     state: String,
-                    zip: String,
-                    line2: String
+                    zip: String
                   }
                 )
               end
@@ -3977,22 +4149,17 @@ module Increase
                 )
               end
 
-            # The city of the address.
+            # The city, district, town, or village of the address.
             sig { returns(String) }
             attr_accessor :city
 
-            # The first line of the address. This is usually the street number and street.
-            sig { returns(String) }
-            attr_accessor :line1
-
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             sig { returns(String) }
-            attr_accessor :state
+            attr_accessor :country
 
-            # The ZIP code of the address.
+            # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
-            attr_accessor :zip
+            attr_accessor :line1
 
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
@@ -4001,29 +4168,47 @@ module Increase
             sig { params(line2: String).void }
             attr_writer :line2
 
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            sig { returns(T.nilable(String)) }
+            attr_reader :state
+
+            sig { params(state: String).void }
+            attr_writer :state
+
+            # The ZIP or postal code of the address. Required in certain countries.
+            sig { returns(T.nilable(String)) }
+            attr_reader :zip
+
+            sig { params(zip: String).void }
+            attr_writer :zip
+
             # The individual's physical address. Mail receiving locations like PO Boxes and
             # PMB's are disallowed.
             sig do
               params(
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               ).returns(T.attached_class)
             end
             def self.new(
-              # The city of the address.
+              # The city, district, town, or village of the address.
               city:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
-              # The two-letter United States Postal Service (USPS) abbreviation for the state of
-              # the address.
-              state:,
-              # The ZIP code of the address.
-              zip:,
               # The second line of the address. This might be the floor or room number.
-              line2: nil
+              line2: nil,
+              # The two-letter United States Postal Service (USPS) abbreviation for the US
+              # state, province, or region of the address. Required in certain countries.
+              state: nil,
+              # The ZIP or postal code of the address. Required in certain countries.
+              zip: nil
             )
             end
 
@@ -4031,10 +4216,11 @@ module Increase
               override.returns(
                 {
                   city: String,
+                  country: String,
                   line1: String,
+                  line2: String,
                   state: String,
-                  zip: String,
-                  line2: String
+                  zip: String
                 }
               )
             end