lithic 0.20.0 → 0.22.0

data/lib/lithic/models/account_holder_update_response.rb

@@ -223,7 +223,8 @@ module Lithic
         class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
           # @!attribute address
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @return [Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::BeneficialOwnerIndividual::Address, nil]
           optional :address,
@@ -292,51 +293,68 @@ module Lithic
             required :city, String
 
             # @!attribute country
-            #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-            #   3166-1 alpha-3 three-character format.
+            #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+            #   format. Supported countries depend on the onboarding workflow used for the
+            #   account holder.
             #
             #   @return [String]
             required :country, String
 
-            # @!attribute postal_code
-            #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-            #   five-digit ZIP or nine-digit ZIP+4.
+            # @!attribute address2
+            #   Unit or apartment number (if applicable).
             #
-            #   @return [String]
-            required :postal_code, String
+            #   @return [String, nil]
+            optional :address2, String
 
-            # @!attribute state
-            #   Valid state code. Only USA state codes are currently supported, entered in
-            #   uppercase ISO 3166-2 two-character format.
+            # @!attribute postal_code
+            #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+            #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+            #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+            #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+            #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+            #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            optional :postal_code, String, nil?: true
 
-            # @!attribute address2
-            #   Unit or apartment number (if applicable).
+            # @!attribute state
+            #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+            #   code for the country without the country prefix. For example, `CA` for
+            #   California. Optional unless the address is in one of the following countries,
+            #   where it is required:
+            #
+            #   - `USA`
+            #   - `CAN`
+            #   - `AUS`
+            #   - `CHN`
+            #   - `KOR`
+            #   - `MEX`
+            #   - `MYS`
+            #   - `NZL`
             #
             #   @return [String, nil]
-            optional :address2, String
+            optional :state, String, nil?: true
 
-            # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+            # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
             #   Some parameter documentations has been truncated, see
             #   {Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::BeneficialOwnerIndividual::Address}
             #   for more details.
             #
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @param address1 [String] Valid deliverable address (no PO boxes).
             #
             #   @param city [String] Name of city.
             #
-            #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+            #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
             #
-            #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+            #   @param address2 [String] Unit or apartment number (if applicable).
             #
-            #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+            #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
             #
-            #   @param address2 [String] Unit or apartment number (if applicable).
+            #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
           end
         end
 
@@ -344,7 +362,8 @@ module Lithic
         class ControlPerson < Lithic::Internal::Type::BaseModel
           # @!attribute address
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @return [Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ControlPerson::Address, nil]
           optional :address,
@@ -425,51 +444,68 @@ module Lithic
             required :city, String
 
             # @!attribute country
-            #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-            #   3166-1 alpha-3 three-character format.
+            #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+            #   format. Supported countries depend on the onboarding workflow used for the
+            #   account holder.
             #
             #   @return [String]
             required :country, String
 
-            # @!attribute postal_code
-            #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-            #   five-digit ZIP or nine-digit ZIP+4.
+            # @!attribute address2
+            #   Unit or apartment number (if applicable).
             #
-            #   @return [String]
-            required :postal_code, String
+            #   @return [String, nil]
+            optional :address2, String
 
-            # @!attribute state
-            #   Valid state code. Only USA state codes are currently supported, entered in
-            #   uppercase ISO 3166-2 two-character format.
+            # @!attribute postal_code
+            #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+            #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+            #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+            #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+            #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+            #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            optional :postal_code, String, nil?: true
 
-            # @!attribute address2
-            #   Unit or apartment number (if applicable).
+            # @!attribute state
+            #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+            #   code for the country without the country prefix. For example, `CA` for
+            #   California. Optional unless the address is in one of the following countries,
+            #   where it is required:
+            #
+            #   - `USA`
+            #   - `CAN`
+            #   - `AUS`
+            #   - `CHN`
+            #   - `KOR`
+            #   - `MEX`
+            #   - `MYS`
+            #   - `NZL`
             #
             #   @return [String, nil]
-            optional :address2, String
+            optional :state, String, nil?: true
 
-            # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+            # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
             #   Some parameter documentations has been truncated, see
             #   {Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ControlPerson::Address}
             #   for more details.
             #
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @param address1 [String] Valid deliverable address (no PO boxes).
             #
             #   @param city [String] Name of city.
             #
-            #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+            #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
             #
-            #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+            #   @param address2 [String] Unit or apartment number (if applicable).
             #
-            #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+            #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
             #
-            #   @param address2 [String] Unit or apartment number (if applicable).
+            #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
           end
         end
 
@@ -491,7 +527,8 @@ module Lithic
         class Individual < Lithic::Internal::Type::BaseModel
           # @!attribute address
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @return [Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Individual::Address, nil]
           optional :address,
@@ -563,51 +600,68 @@ module Lithic
             required :city, String
 
             # @!attribute country
-            #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-            #   3166-1 alpha-3 three-character format.
+            #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+            #   format. Supported countries depend on the onboarding workflow used for the
+            #   account holder.
             #
             #   @return [String]
             required :country, String
 
-            # @!attribute postal_code
-            #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-            #   five-digit ZIP or nine-digit ZIP+4.
+            # @!attribute address2
+            #   Unit or apartment number (if applicable).
             #
-            #   @return [String]
-            required :postal_code, String
+            #   @return [String, nil]
+            optional :address2, String
 
-            # @!attribute state
-            #   Valid state code. Only USA state codes are currently supported, entered in
-            #   uppercase ISO 3166-2 two-character format.
+            # @!attribute postal_code
+            #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+            #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+            #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+            #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+            #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+            #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
             #
-            #   @return [String]
-            required :state, String
+            #   @return [String, nil]
+            optional :postal_code, String, nil?: true
 
-            # @!attribute address2
-            #   Unit or apartment number (if applicable).
+            # @!attribute state
+            #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+            #   code for the country without the country prefix. For example, `CA` for
+            #   California. Optional unless the address is in one of the following countries,
+            #   where it is required:
+            #
+            #   - `USA`
+            #   - `CAN`
+            #   - `AUS`
+            #   - `CHN`
+            #   - `KOR`
+            #   - `MEX`
+            #   - `MYS`
+            #   - `NZL`
             #
             #   @return [String, nil]
-            optional :address2, String
+            optional :state, String, nil?: true
 
-            # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+            # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
             #   Some parameter documentations has been truncated, see
             #   {Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Individual::Address}
             #   for more details.
             #
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @param address1 [String] Valid deliverable address (no PO boxes).
             #
             #   @param city [String] Name of city.
             #
-            #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+            #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
             #
-            #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+            #   @param address2 [String] Unit or apartment number (if applicable).
             #
-            #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+            #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
             #
-            #   @param address2 [String] Unit or apartment number (if applicable).
+            #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
           end
         end
 
@@ -878,33 +932,49 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderUpdateResponse::PatchResponse::Address} for more
           #   details.
@@ -915,13 +985,13 @@ module Lithic
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end