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

data/rbi/lib/lithic/models/account_holder.rbi

@@ -18,7 +18,7 @@ module Lithic
       sig { params(account_token: String).void }
       attr_writer :account_token
 
-      # Deprecated. Only present when user_type == "BUSINESS".
+      # Deprecated.
       sig { returns(T.nilable(T::Array[Lithic::Models::AccountHolder::BeneficialOwnerEntity])) }
       attr_reader :beneficial_owner_entities
 
@@ -30,8 +30,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 { returns(T.nilable(T::Array[Lithic::Models::AccountHolder::BeneficialOwnerIndividual])) }
       attr_reader :beneficial_owner_individuals
 
@@ -44,8 +47,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
 
@@ -53,7 +56,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::AccountHolder::BusinessEntity)) }
       attr_reader :business_entity
 
@@ -64,21 +67,23 @@ module Lithic
       attr_writer :business_entity
 
       # 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, 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.
+      # 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 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::AccountHolder::ControlPerson)) }
       attr_reader :control_person
 
-      sig { params(control_person: T.any(Lithic::Models::AccountHolder::ControlPerson, Lithic::Internal::AnyHash)).void }
+      sig do
+        params(control_person: T.any(Lithic::Models::AccountHolder::ControlPerson, Lithic::Internal::AnyHash)).void
+      end
       attr_writer :control_person
 
       # < 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
 
@@ -93,7 +98,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
 
@@ -101,7 +106,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::AccountHolder::Individual)) }
       attr_reader :individual
 
@@ -109,7 +114,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
 
@@ -117,9 +122,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
 
@@ -127,7 +132,7 @@ module Lithic
       attr_writer :phone_number
 
       # Only present for "KYB_BASIC" workflow. A list of documents required for the
-      #   account holder to be approved.
+      # account holder to be approved.
       sig { returns(T.nilable(T::Array[Lithic::Models::RequiredDocument])) }
       attr_reader :required_documents
 
@@ -139,11 +144,11 @@ module Lithic
 
       # <Deprecated. Use verification_application.status instead>
       #
-      #   KYC and KYB evaluation states.
+      # KYC and KYB evaluation states.
       #
-      #   Note:
+      # Note:
       #
-      #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+      # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
       sig { returns(T.nilable(Lithic::Models::AccountHolder::Status::TaggedSymbol)) }
       attr_reader :status
 
@@ -151,7 +156,7 @@ module Lithic
       attr_writer :status
 
       # <Deprecated. Use verification_application.status_reasons> Reason for the
-      #   evaluation status.
+      # evaluation status.
       sig { returns(T.nilable(T::Array[Lithic::Models::AccountHolder::StatusReason::TaggedSymbol])) }
       attr_reader :status_reasons
 
@@ -159,9 +164,9 @@ module Lithic
       attr_writer :status_reasons
 
       # 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",
-      #   "nature_of_business", and "website_url" attributes will be present.
+      # attribute 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::AccountHolder::UserType::TaggedSymbol)) }
       attr_reader :user_type
 
@@ -233,9 +238,7 @@ module Lithic
         user_type: nil,
         verification_application: nil,
         website_url: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -263,12 +266,11 @@ module Lithic
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
       class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
         # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable.
+        # acceptable; APO/FPO are acceptable.
         sig { returns(Lithic::Models::Address) }
         attr_reader :address
 
@@ -276,7 +278,7 @@ module Lithic
         attr_writer :address
 
         # Any name that the business operates under that is not its legal business name
-        #   (if applicable).
+        # (if applicable).
         sig { returns(String) }
         attr_accessor :dba_business_name
 
@@ -285,8 +287,8 @@ module Lithic
         attr_accessor :entity_token
 
         # Government-issued identification number. US Federal Employer Identification
-        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
-        #   without hyphens.
+        # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        # without hyphens.
         sig { returns(String) }
         attr_accessor :government_id
 
@@ -295,7 +297,7 @@ module Lithic
         attr_accessor :legal_business_name
 
         # One or more of the business's phone number(s), entered as a list in E.164
-        #   format.
+        # format.
         sig { returns(T::Array[String]) }
         attr_accessor :phone_numbers
 
@@ -326,9 +328,7 @@ module Lithic
           legal_business_name:,
           phone_numbers:,
           parent_company: nil
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -343,8 +343,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
@@ -380,8 +379,8 @@ module Lithic
         attr_accessor :phone_number
 
         # Information about an individual associated with an account holder. A subset of
-        #   the information provided via KYC. For example, we do not return the government
-        #   id.
+        # the information provided via KYC. For example, we do not return the government
+        # id.
         sig do
           params(
             address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -394,8 +393,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:)
-        end
+        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
 
         sig do
           override
@@ -411,13 +409,12 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       class BusinessEntity < Lithic::Internal::Type::BaseModel
         # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable.
+        # acceptable; APO/FPO are acceptable.
         sig { returns(Lithic::Models::Address) }
         attr_reader :address
 
@@ -425,7 +422,7 @@ module Lithic
         attr_writer :address
 
         # Any name that the business operates under that is not its legal business name
-        #   (if applicable).
+        # (if applicable).
         sig { returns(String) }
         attr_accessor :dba_business_name
 
@@ -434,8 +431,8 @@ module Lithic
         attr_accessor :entity_token
 
         # Government-issued identification number. US Federal Employer Identification
-        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
-        #   without hyphens.
+        # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        # without hyphens.
         sig { returns(String) }
         attr_accessor :government_id
 
@@ -444,7 +441,7 @@ module Lithic
         attr_accessor :legal_business_name
 
         # One or more of the business's phone number(s), entered as a list in E.164
-        #   format.
+        # format.
         sig { returns(T::Array[String]) }
         attr_accessor :phone_numbers
 
@@ -456,7 +453,7 @@ module Lithic
         attr_writer :parent_company
 
         # 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 do
           params(
             address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -477,9 +474,7 @@ module Lithic
           legal_business_name:,
           phone_numbers:,
           parent_company: nil
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -494,8 +489,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       class ControlPerson < Lithic::Internal::Type::BaseModel
@@ -531,11 +525,11 @@ module Lithic
         attr_accessor :phone_number
 
         # 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, 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.
+        # 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 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(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -548,8 +542,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:)
-        end
+        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
 
         sig do
           override
@@ -565,8 +558,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       # The type of KYC exemption for a KYC-Exempt Account Holder.
@@ -581,8 +573,7 @@ module Lithic
         PREPAID_CARD_USER = T.let(:PREPAID_CARD_USER, Lithic::Models::AccountHolder::ExemptionType::TaggedSymbol)
 
         sig { override.returns(T::Array[Lithic::Models::AccountHolder::ExemptionType::TaggedSymbol]) }
-        def self.values
-        end
+        def self.values; end
       end
 
       class Individual < Lithic::Internal::Type::BaseModel
@@ -618,7 +609,7 @@ module Lithic
         attr_accessor :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(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -631,8 +622,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:)
-        end
+        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
 
         sig do
           override
@@ -648,17 +638,16 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       # <Deprecated. Use verification_application.status instead>
       #
-      #   KYC and KYB evaluation states.
+      # KYC and KYB evaluation states.
       #
-      #   Note:
+      # Note:
       #
-      #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+      # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
       module Status
         extend Lithic::Internal::Type::Enum
 
@@ -672,8 +661,7 @@ module Lithic
         REJECTED = T.let(:REJECTED, Lithic::Models::AccountHolder::Status::TaggedSymbol)
 
         sig { override.returns(T::Array[Lithic::Models::AccountHolder::Status::TaggedSymbol]) }
-        def self.values
-        end
+        def self.values; end
       end
 
       module StatusReason
@@ -707,14 +695,13 @@ module Lithic
           T.let(:WATCHLIST_ALERT_FAILURE, Lithic::Models::AccountHolder::StatusReason::TaggedSymbol)
 
         sig { override.returns(T::Array[Lithic::Models::AccountHolder::StatusReason::TaggedSymbol]) }
-        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",
-      #   "nature_of_business", and "website_url" attributes will be present.
+      # attribute 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
 
@@ -725,8 +712,7 @@ module Lithic
         INDIVIDUAL = T.let(:INDIVIDUAL, Lithic::Models::AccountHolder::UserType::TaggedSymbol)
 
         sig { override.returns(T::Array[Lithic::Models::AccountHolder::UserType::TaggedSymbol]) }
-        def self.values
-        end
+        def self.values; end
       end
 
       class VerificationApplication < Lithic::Internal::Type::BaseModel
@@ -739,9 +725,9 @@ module Lithic
 
         # KYC and KYB evaluation states.
         #
-        #   Note:
+        # Note:
         #
-        #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+        # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
         sig { returns(T.nilable(Lithic::Models::AccountHolder::VerificationApplication::Status::TaggedSymbol)) }
         attr_reader :status
 
@@ -781,8 +767,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(created: nil, status: nil, status_reasons: nil, updated: nil)
-        end
+        def self.new(created: nil, status: nil, status_reasons: nil, updated: nil); end
 
         sig do
           override
@@ -795,14 +780,13 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
         # KYC and KYB evaluation states.
         #
-        #   Note:
+        # Note:
         #
-        #   - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+        # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
         module Status
           extend Lithic::Internal::Type::Enum
 
@@ -821,8 +805,7 @@ module Lithic
           REJECTED = T.let(:REJECTED, Lithic::Models::AccountHolder::VerificationApplication::Status::TaggedSymbol)
 
           sig { override.returns(T::Array[Lithic::Models::AccountHolder::VerificationApplication::Status::TaggedSymbol]) }
-          def self.values
-          end
+          def self.values; end
         end
 
         module StatusReason
@@ -893,8 +876,7 @@ module Lithic
             override
               .returns(T::Array[Lithic::Models::AccountHolder::VerificationApplication::StatusReason::TaggedSymbol])
           end
-          def self.values
-          end
+          def self.values; end
         end
       end
     end