lithic 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.8

data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi

@@ -17,8 +17,7 @@ module Lithic
       sig { params(account_token: String).void }
       attr_writer :account_token
 
-      # Only present when user_type == "BUSINESS". List of all entities with >25%
-      #   ownership in the company.
+      # Deprecated.
       sig { returns(T.nilable(T::Array[Lithic::Models::KYBBusinessEntity])) }
       attr_reader :beneficial_owner_entities
 
@@ -30,8 +29,11 @@ module Lithic
       end
       attr_writer :beneficial_owner_entities
 
-      # Only present when user_type == "BUSINESS". List of all individuals with >25%
-      #   ownership in the company.
+      # Only present when user_type == "BUSINESS". List of all direct and indirect
+      # individuals with 25% or more ownership in the company. If no individual owns 25%
+      # of the company, please identify the largest shareholder in this field. See
+      # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      # (Section I) for more background on individuals that should be included.
       sig do
         returns(
           T.nilable(
@@ -44,10 +46,10 @@ module Lithic
       sig do
         params(
           beneficial_owner_individuals: T::Array[
-          T.any(
-            Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual,
-            Lithic::Internal::AnyHash
-          )
+            T.any(
+              Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual,
+              Lithic::Internal::AnyHash
+            )
           ]
         )
           .void
@@ -55,8 +57,8 @@ module Lithic
       attr_writer :beneficial_owner_individuals
 
       # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
-      #   users of businesses. Pass the account_token of the enrolled business associated
-      #   with the AUTHORIZED_USER in this field.
+      # users of businesses. Pass the account_token of the enrolled business associated
+      # with the AUTHORIZED_USER in this field.
       sig { returns(T.nilable(String)) }
       attr_reader :business_account_token
 
@@ -64,7 +66,7 @@ module Lithic
       attr_writer :business_account_token
 
       # Only present when user_type == "BUSINESS". Information about the business for
-      #   which the account is being opened and KYB is being run.
+      # which the account is being opened and KYB is being run.
       sig { returns(T.nilable(Lithic::Models::KYBBusinessEntity)) }
       attr_reader :business_entity
 
@@ -73,15 +75,15 @@ module Lithic
 
       # Only present when user_type == "BUSINESS".
       #
-      #   An individual with significant responsibility for managing the legal entity
-      #   (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
-      #   Officer,
+      # An individual with significant responsibility for managing the legal entity
+      # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+      # Officer,
       #
-      #   Managing Member, General Partner, President, Vice President, or Treasurer). This
-      #   can be an executive, or someone who will have program-wide access
+      # Managing Member, General Partner, President, Vice President, or Treasurer). This
+      # can be an executive, or someone who will have program-wide access
       #
-      #   to the cards that Lithic will provide. In some cases, this individual could also
-      #   be a beneficial owner listed above.
+      # to the cards that Lithic will provide. In some cases, this individual could also
+      # be a beneficial owner listed above.
       sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson)) }
       attr_reader :control_person
 
@@ -104,9 +106,9 @@ module Lithic
       attr_writer :created
 
       # < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
-      #   individual.phone_number when user_type == "INDIVIDUAL".
+      # individual.phone_number when user_type == "INDIVIDUAL".
       #
-      #   > Primary email of Account Holder.
+      # > Primary email of Account Holder.
       sig { returns(T.nilable(String)) }
       attr_reader :email
 
@@ -114,7 +116,7 @@ module Lithic
       attr_writer :email
 
       # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
-      #   holder is not KYC-Exempt.
+      # holder is not KYC-Exempt.
       sig do
         returns(
           T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType::TaggedSymbol)
@@ -131,7 +133,7 @@ module Lithic
       attr_writer :exemption_type
 
       # Customer-provided token that indicates a relationship with an object outside of
-      #   the Lithic ecosystem.
+      # the Lithic ecosystem.
       sig { returns(T.nilable(String)) }
       attr_reader :external_id
 
@@ -139,7 +141,7 @@ module Lithic
       attr_writer :external_id
 
       # Only present when user_type == "INDIVIDUAL". Information about the individual
-      #   for which the account is being opened and KYC is being run.
+      # for which the account is being opened and KYC is being run.
       sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual)) }
       attr_reader :individual
 
@@ -155,7 +157,7 @@ module Lithic
       attr_writer :individual
 
       # Only present when user_type == "BUSINESS". User-submitted description of the
-      #   business.
+      # business.
       sig { returns(T.nilable(String)) }
       attr_reader :nature_of_business
 
@@ -163,9 +165,9 @@ module Lithic
       attr_writer :nature_of_business
 
       # < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
-      #   individual.phone_number when user_type == "INDIVIDUAL".
+      # individual.phone_number when user_type == "INDIVIDUAL".
       #
-      #   > Primary phone of Account Holder, entered in E.164 format.
+      # > Primary phone of Account Holder, entered in E.164 format.
       sig { returns(T.nilable(String)) }
       attr_reader :phone_number
 
@@ -173,7 +175,7 @@ module Lithic
       attr_writer :phone_number
 
       # Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
-      #   required for the account holder to be approved.
+      # required for the account holder to be approved.
       sig { returns(T.nilable(T::Array[Lithic::Models::RequiredDocument])) }
       attr_reader :required_documents
 
@@ -185,10 +187,10 @@ module Lithic
 
       # <Deprecated. Use verification_application.status instead>
       #
-      #   KYC and KYB evaluation states.
+      # KYC and KYB evaluation states.
       #
-      #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-      #   `ADVANCED` workflow.
+      # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+      # `ADVANCED` workflow.
       sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status::TaggedSymbol)) }
       attr_reader :status
 
@@ -196,7 +198,7 @@ module Lithic
       attr_writer :status
 
       # <Deprecated. Use verification_application.status_reasons> Reason for the
-      #   evaluation status.
+      # evaluation status.
       sig do
         returns(
           T.nilable(
@@ -215,12 +217,11 @@ module Lithic
       attr_writer :status_reasons
 
       # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
-      #   attribute will be present.
+      # attribute will be present.
       #
-      #   If the type is "BUSINESS" then the "business_entity", "control_person",
-      #   "beneficial_owner_individuals", "beneficial_owner_entities",
-      #
-      #   "nature_of_business", and "website_url" attributes will be present.
+      # If the type is "BUSINESS" then the "business_entity", "control_person",
+      # "beneficial_owner_individuals", "nature_of_business", and "website_url"
+      # attributes will be present.
       sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::UserType::TaggedSymbol)) }
       attr_reader :user_type
 
@@ -255,10 +256,10 @@ module Lithic
           account_token: String,
           beneficial_owner_entities: T::Array[T.any(Lithic::Models::KYBBusinessEntity, Lithic::Internal::AnyHash)],
           beneficial_owner_individuals: T::Array[
-          T.any(
-            Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual,
-            Lithic::Internal::AnyHash
-          )
+            T.any(
+              Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual,
+              Lithic::Internal::AnyHash
+            )
           ],
           business_account_token: String,
           business_entity: T.any(Lithic::Models::KYBBusinessEntity, Lithic::Internal::AnyHash),
@@ -309,9 +310,7 @@ module Lithic
         user_type: nil,
         verification_application: nil,
         website_url: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -339,12 +338,11 @@ module Lithic
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # 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 currently supported.
         sig do
           returns(
             T.nilable(
@@ -373,7 +371,7 @@ module Lithic
         attr_writer :dob
 
         # Individual's email address. If utilizing Lithic for chargeback processing, this
-        #   customer email address may be used to communicate dispute status and resolution.
+        # customer email address may be used to communicate dispute status and resolution.
         sig { returns(T.nilable(String)) }
         attr_reader :email
 
@@ -432,8 +430,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
         class Address < Lithic::Internal::Type::BaseModel
           # Valid deliverable address (no PO boxes).
@@ -445,17 +442,17 @@ module Lithic
           attr_accessor :city
 
           # Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          # 3166-1 alpha-3 three-character format.
           sig { returns(String) }
           attr_accessor :country
 
           # Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # five-digit ZIP or nine-digit ZIP+4.
           sig { returns(String) }
           attr_accessor :postal_code
 
           # Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # uppercase ISO 3166-2 two-character format.
           sig { returns(String) }
           attr_accessor :state
 
@@ -467,7 +464,7 @@ module Lithic
           attr_writer :address2
 
           # 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 currently supported.
           sig do
             params(
               address1: String,
@@ -479,8 +476,7 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil)
-          end
+          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
 
           sig do
             override
@@ -495,14 +491,13 @@ module Lithic
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
       end
 
       class ControlPerson < Lithic::Internal::Type::BaseModel
         # 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 currently supported.
         sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address)) }
         attr_reader :address
 
@@ -525,7 +520,7 @@ module Lithic
         attr_writer :dob
 
         # Individual's email address. If utilizing Lithic for chargeback processing, this
-        #   customer email address may be used to communicate dispute status and resolution.
+        # customer email address may be used to communicate dispute status and resolution.
         sig { returns(T.nilable(String)) }
         attr_reader :email
 
@@ -555,15 +550,15 @@ module Lithic
 
         # Only present when user_type == "BUSINESS".
         #
-        #   An individual with significant responsibility for managing the legal entity
-        #   (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
-        #   Officer,
+        # An individual with significant responsibility for managing the legal entity
+        # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+        # Officer,
         #
-        #   Managing Member, General Partner, President, Vice President, or Treasurer). This
-        #   can be an executive, or someone who will have program-wide access
+        # Managing Member, General Partner, President, Vice President, or Treasurer). This
+        # can be an executive, or someone who will have program-wide access
         #
-        #   to the cards that Lithic will provide. In some cases, this individual could also
-        #   be a beneficial owner listed above.
+        # to the cards that Lithic will provide. In some cases, this individual could also
+        # be a beneficial owner listed above.
         sig do
           params(
             address: T.any(
@@ -595,8 +590,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
         class Address < Lithic::Internal::Type::BaseModel
           # Valid deliverable address (no PO boxes).
@@ -608,17 +602,17 @@ module Lithic
           attr_accessor :city
 
           # Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          # 3166-1 alpha-3 three-character format.
           sig { returns(String) }
           attr_accessor :country
 
           # Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # five-digit ZIP or nine-digit ZIP+4.
           sig { returns(String) }
           attr_accessor :postal_code
 
           # Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # uppercase ISO 3166-2 two-character format.
           sig { returns(String) }
           attr_accessor :state
 
@@ -630,7 +624,7 @@ module Lithic
           attr_writer :address2
 
           # 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 currently supported.
           sig do
             params(
               address1: String,
@@ -642,8 +636,7 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil)
-          end
+          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
 
           sig do
             override
@@ -658,13 +651,12 @@ module Lithic
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
       end
 
       # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
-      #   holder is not KYC-Exempt.
+      # holder is not KYC-Exempt.
       module ExemptionType
         extend Lithic::Internal::Type::Enum
 
@@ -696,13 +688,12 @@ module Lithic
               T::Array[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType::TaggedSymbol]
             )
         end
-        def self.values
-        end
+        def self.values; end
       end
 
       class Individual < Lithic::Internal::Type::BaseModel
         # 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 currently supported.
         sig { returns(T.nilable(Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address)) }
         attr_reader :address
 
@@ -725,7 +716,7 @@ module Lithic
         attr_writer :dob
 
         # Individual's email address. If utilizing Lithic for chargeback processing, this
-        #   customer email address may be used to communicate dispute status and resolution.
+        # customer email address may be used to communicate dispute status and resolution.
         sig { returns(T.nilable(String)) }
         attr_reader :email
 
@@ -754,7 +745,7 @@ module Lithic
         attr_writer :phone_number
 
         # Only present when user_type == "INDIVIDUAL". Information about the individual
-        #   for which the account is being opened and KYC is being run.
+        # for which the account is being opened and KYC is being run.
         sig do
           params(
             address: T.any(
@@ -786,8 +777,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
         class Address < Lithic::Internal::Type::BaseModel
           # Valid deliverable address (no PO boxes).
@@ -799,17 +789,17 @@ module Lithic
           attr_accessor :city
 
           # Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          # 3166-1 alpha-3 three-character format.
           sig { returns(String) }
           attr_accessor :country
 
           # Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # five-digit ZIP or nine-digit ZIP+4.
           sig { returns(String) }
           attr_accessor :postal_code
 
           # Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # uppercase ISO 3166-2 two-character format.
           sig { returns(String) }
           attr_accessor :state
 
@@ -821,7 +811,7 @@ module Lithic
           attr_writer :address2
 
           # 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 currently supported.
           sig do
             params(
               address1: String,
@@ -833,8 +823,7 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil)
-          end
+          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
 
           sig do
             override
@@ -849,17 +838,16 @@ module Lithic
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
       end
 
       # <Deprecated. Use verification_application.status instead>
       #
-      #   KYC and KYB evaluation states.
+      # KYC and KYB evaluation states.
       #
-      #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-      #   `ADVANCED` workflow.
+      # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+      # `ADVANCED` workflow.
       module Status
         extend Lithic::Internal::Type::Enum
 
@@ -887,8 +875,7 @@ module Lithic
           override
             .returns(T::Array[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status::TaggedSymbol])
         end
-        def self.values
-        end
+        def self.values; end
       end
 
       # Status Reasons for KYC/KYB enrollment states
@@ -1033,17 +1020,15 @@ module Lithic
               T::Array[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason::TaggedSymbol]
             )
         end
-        def self.values
-        end
+        def self.values; end
       end
 
       # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
-      #   attribute will be present.
-      #
-      #   If the type is "BUSINESS" then the "business_entity", "control_person",
-      #   "beneficial_owner_individuals", "beneficial_owner_entities",
+      # attribute will be present.
       #
-      #   "nature_of_business", and "website_url" attributes will be present.
+      # If the type is "BUSINESS" then the "business_entity", "control_person",
+      # "beneficial_owner_individuals", "nature_of_business", and "website_url"
+      # attributes will be present.
       module UserType
         extend Lithic::Internal::Type::Enum
 
@@ -1067,8 +1052,7 @@ module Lithic
           override
             .returns(T::Array[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::UserType::TaggedSymbol])
         end
-        def self.values
-        end
+        def self.values; end
       end
 
       class VerificationApplication < Lithic::Internal::Type::BaseModel
@@ -1078,8 +1062,8 @@ module Lithic
 
         # KYC and KYB evaluation states.
         #
-        #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-        #   `ADVANCED` workflow.
+        # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+        # `ADVANCED` workflow.
         sig do
           returns(
             Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status::TaggedSymbol
@@ -1091,7 +1075,7 @@ module Lithic
         sig do
           returns(
             T::Array[
-            Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
+              Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
             ]
           )
         end
@@ -1107,14 +1091,13 @@ module Lithic
             created: Time,
             status: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status::OrSymbol,
             status_reasons: T::Array[
-            Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::OrSymbol
+              Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::OrSymbol
             ],
             updated: Time
           )
             .returns(T.attached_class)
         end
-        def self.new(created:, status:, status_reasons:, updated:)
-        end
+        def self.new(created:, status:, status_reasons:, updated:); end
 
         sig do
           override
@@ -1123,19 +1106,18 @@ module Lithic
                 created: Time,
                 status: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status::TaggedSymbol,
                 status_reasons: T::Array[
-                Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
+                  Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
                 ],
                 updated: Time
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
         # KYC and KYB evaluation states.
         #
-        #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-        #   `ADVANCED` workflow.
+        # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+        # `ADVANCED` workflow.
         module Status
           extend Lithic::Internal::Type::Enum
 
@@ -1177,12 +1159,11 @@ module Lithic
             override
               .returns(
                 T::Array[
-                Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status::TaggedSymbol
+                  Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status::TaggedSymbol
                 ]
               )
           end
-          def self.values
-          end
+          def self.values; end
         end
 
         # Status Reasons for KYC/KYB enrollment states
@@ -1327,12 +1308,11 @@ module Lithic
             override
               .returns(
                 T::Array[
-                Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
+                  Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason::TaggedSymbol
                 ]
               )
           end
-          def self.values
-          end
+          def self.values; end
         end
       end
     end