lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7

data/rbi/lib/lithic/models/kyb.rbi

@@ -3,28 +3,16 @@
 module Lithic
   module Models
     class KYB < Lithic::Internal::Type::BaseModel
-      # List of all entities with >25% ownership in the company. If no entity or
-      #   individual owns >25% of the company, and the largest shareholder is an entity,
-      #   please identify them 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. If no business owner is an entity, pass in an
-      #   empty list. However, either this parameter or `beneficial_owner_individuals`
-      #   must be populated. on entities that should be included.
-      sig { returns(T::Array[Lithic::Models::KYB::BeneficialOwnerEntity]) }
-      attr_accessor :beneficial_owner_entities
-
-      # List of all direct and indirect individuals with >25% ownership in the company.
-      #   If no entity or individual owns >25% of the company, and the largest shareholder
-      #   is an individual, please identify them 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. If no
-      #   individual is an entity, pass in an empty list. However, either this parameter
-      #   or `beneficial_owner_entities` must be populated.
+      # 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::Array[Lithic::Models::KYB::BeneficialOwnerIndividual]) }
       attr_accessor :beneficial_owner_individuals
 
       # Information for business for which the account is being opened and KYB is being
-      #   run.
+      # run.
       sig { returns(Lithic::Models::KYB::BusinessEntity) }
       attr_reader :business_entity
 
@@ -32,13 +20,13 @@ module Lithic
       attr_writer :business_entity
 
       # 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. See
-      #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
-      #   (Section II) for more background.
+      # (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. See
+      # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      # (Section II) for more background.
       sig { returns(Lithic::Models::KYB::ControlPerson) }
       attr_reader :control_person
 
@@ -46,13 +34,13 @@ module Lithic
       attr_writer :control_person
 
       # Short description of the company's line of business (i.e., what does the company
-      #   do?).
+      # do?).
       sig { returns(String) }
       attr_accessor :nature_of_business
 
       # An RFC 3339 timestamp indicating when the account holder accepted the applicable
-      #   legal agreements (e.g., cardholder terms) as agreed upon during API customer's
-      #   implementation with Lithic.
+      # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+      # implementation with Lithic.
       sig { returns(String) }
       attr_accessor :tos_timestamp
 
@@ -60,8 +48,20 @@ module Lithic
       sig { returns(Lithic::Models::KYB::Workflow::OrSymbol) }
       attr_accessor :workflow
 
+      # Deprecated.
+      sig { returns(T.nilable(T::Array[Lithic::Models::KYB::BeneficialOwnerEntity])) }
+      attr_reader :beneficial_owner_entities
+
+      sig do
+        params(
+          beneficial_owner_entities: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerEntity, Lithic::Internal::AnyHash)]
+        )
+          .void
+      end
+      attr_writer :beneficial_owner_entities
+
       # A user provided id that can be used to link an account holder with an external
-      #   system
+      # system
       sig { returns(T.nilable(String)) }
       attr_reader :external_id
 
@@ -69,9 +69,9 @@ module Lithic
       attr_writer :external_id
 
       # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
-      #   business with a pass result.
+      # business with a pass result.
       #
-      #   This field is required only if workflow type is `KYB_BYO`.
+      # This field is required only if workflow type is `KYB_BYO`.
       sig { returns(T.nilable(String)) }
       attr_reader :kyb_passed_timestamp
 
@@ -87,13 +87,13 @@ module Lithic
 
       sig do
         params(
-          beneficial_owner_entities: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerEntity, Lithic::Internal::AnyHash)],
           beneficial_owner_individuals: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerIndividual, Lithic::Internal::AnyHash)],
           business_entity: T.any(Lithic::Models::KYB::BusinessEntity, Lithic::Internal::AnyHash),
           control_person: T.any(Lithic::Models::KYB::ControlPerson, Lithic::Internal::AnyHash),
           nature_of_business: String,
           tos_timestamp: String,
           workflow: Lithic::Models::KYB::Workflow::OrSymbol,
+          beneficial_owner_entities: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerEntity, Lithic::Internal::AnyHash)],
           external_id: String,
           kyb_passed_timestamp: String,
           website_url: String
@@ -101,119 +101,39 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
-        beneficial_owner_entities:,
         beneficial_owner_individuals:,
         business_entity:,
         control_person:,
         nature_of_business:,
         tos_timestamp:,
         workflow:,
+        beneficial_owner_entities: nil,
         external_id: nil,
         kyb_passed_timestamp: nil,
         website_url: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
             {
-              beneficial_owner_entities: T::Array[Lithic::Models::KYB::BeneficialOwnerEntity],
               beneficial_owner_individuals: T::Array[Lithic::Models::KYB::BeneficialOwnerIndividual],
               business_entity: Lithic::Models::KYB::BusinessEntity,
               control_person: Lithic::Models::KYB::ControlPerson,
               nature_of_business: String,
               tos_timestamp: String,
               workflow: Lithic::Models::KYB::Workflow::OrSymbol,
+              beneficial_owner_entities: T::Array[Lithic::Models::KYB::BeneficialOwnerEntity],
               external_id: String,
               kyb_passed_timestamp: String,
               website_url: String
             }
           )
       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.
-        sig { returns(Lithic::Models::Address) }
-        attr_reader :address
-
-        sig { params(address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash)).void }
-        attr_writer :address
-
-        # Government-issued identification number. US Federal Employer Identification
-        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
-        #   without hyphens.
-        sig { returns(String) }
-        attr_accessor :government_id
-
-        # Legal (formal) business name.
-        sig { returns(String) }
-        attr_accessor :legal_business_name
-
-        # One or more of the business's phone number(s), entered as a list in E.164
-        #   format.
-        sig { returns(T::Array[String]) }
-        attr_accessor :phone_numbers
-
-        # Any name that the business operates under that is not its legal business name
-        #   (if applicable).
-        sig { returns(T.nilable(String)) }
-        attr_reader :dba_business_name
-
-        sig { params(dba_business_name: String).void }
-        attr_writer :dba_business_name
-
-        # Parent company name (if applicable).
-        sig { returns(T.nilable(String)) }
-        attr_reader :parent_company
-
-        sig { params(parent_company: String).void }
-        attr_writer :parent_company
-
-        sig do
-          params(
-            address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
-            government_id: String,
-            legal_business_name: String,
-            phone_numbers: T::Array[String],
-            dba_business_name: String,
-            parent_company: String
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(
-          address:,
-          government_id:,
-          legal_business_name:,
-          phone_numbers:,
-          dba_business_name: nil,
-          parent_company: nil
-        )
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                address: Lithic::Models::Address,
-                government_id: String,
-                legal_business_name: String,
-                phone_numbers: T::Array[String],
-                dba_business_name: String,
-                parent_company: String
-              }
-            )
-        end
-        def to_hash
-        end
-      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 { returns(Lithic::Models::Address) }
         attr_reader :address
 
@@ -225,7 +145,7 @@ module Lithic
         attr_accessor :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(String) }
         attr_accessor :email
 
@@ -234,9 +154,9 @@ module Lithic
         attr_accessor :first_name
 
         # Government-issued identification number (required for identity verification and
-        #   compliance with banking regulations). Social Security Numbers (SSN) and
-        #   Individual Taxpayer Identification Numbers (ITIN) are currently supported,
-        #   entered as full nine-digits, with or without hyphens
+        # compliance with banking regulations). Social Security Numbers (SSN) and
+        # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+        # entered as full nine-digits, with or without hyphens
         sig { returns(String) }
         attr_accessor :government_id
 
@@ -264,8 +184,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
-        end
+        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
 
         sig do
           override
@@ -281,13 +200,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
 
@@ -295,8 +213,8 @@ module Lithic
         attr_writer :address
 
         # 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
 
@@ -305,12 +223,12 @@ 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
 
         # Any name that the business operates under that is not its legal business name
-        #   (if applicable).
+        # (if applicable).
         sig { returns(T.nilable(String)) }
         attr_reader :dba_business_name
 
@@ -325,7 +243,7 @@ module Lithic
         attr_writer :parent_company
 
         # Information for business for which the account is being opened and KYB is being
-        #   run.
+        # run.
         sig do
           params(
             address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -344,9 +262,7 @@ module Lithic
           phone_numbers:,
           dba_business_name: nil,
           parent_company: nil
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -360,13 +276,12 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; 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(Lithic::Models::Address) }
         attr_reader :address
 
@@ -378,7 +293,7 @@ module Lithic
         attr_accessor :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(String) }
         attr_accessor :email
 
@@ -387,9 +302,9 @@ module Lithic
         attr_accessor :first_name
 
         # Government-issued identification number (required for identity verification and
-        #   compliance with banking regulations). Social Security Numbers (SSN) and
-        #   Individual Taxpayer Identification Numbers (ITIN) are currently supported,
-        #   entered as full nine-digits, with or without hyphens
+        # compliance with banking regulations). Social Security Numbers (SSN) and
+        # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+        # entered as full nine-digits, with or without hyphens
         sig { returns(String) }
         attr_accessor :government_id
 
@@ -405,13 +320,13 @@ module Lithic
         attr_writer :phone_number
 
         # 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. See
-        #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
-        #   (Section II) for more background.
+        # (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. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section II) for more background.
         sig do
           params(
             address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
@@ -424,8 +339,7 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
-        end
+        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
 
         sig do
           override
@@ -441,8 +355,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
 
       # Specifies the type of KYB workflow to run.
@@ -456,8 +369,81 @@ module Lithic
         KYB_BYO = T.let(:KYB_BYO, Lithic::Models::KYB::Workflow::TaggedSymbol)
 
         sig { override.returns(T::Array[Lithic::Models::KYB::Workflow::TaggedSymbol]) }
-        def self.values
+        def self.values; end
+      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.
+        sig { returns(Lithic::Models::Address) }
+        attr_reader :address
+
+        sig { params(address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash)).void }
+        attr_writer :address
+
+        # Government-issued identification number. US Federal Employer Identification
+        # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        # without hyphens.
+        sig { returns(String) }
+        attr_accessor :government_id
+
+        # Legal (formal) business name.
+        sig { returns(String) }
+        attr_accessor :legal_business_name
+
+        # One or more of the business's phone number(s), entered as a list in E.164
+        # format.
+        sig { returns(T::Array[String]) }
+        attr_accessor :phone_numbers
+
+        # Any name that the business operates under that is not its legal business name
+        # (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :dba_business_name
+
+        sig { params(dba_business_name: String).void }
+        attr_writer :dba_business_name
+
+        # Parent company name (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :parent_company
+
+        sig { params(parent_company: String).void }
+        attr_writer :parent_company
+
+        sig do
+          params(
+            address: T.any(Lithic::Models::Address, Lithic::Internal::AnyHash),
+            government_id: String,
+            legal_business_name: String,
+            phone_numbers: T::Array[String],
+            dba_business_name: String,
+            parent_company: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          address:,
+          government_id:,
+          legal_business_name:,
+          phone_numbers:,
+          dba_business_name: nil,
+          parent_company: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                address: Lithic::Models::Address,
+                government_id: String,
+                legal_business_name: String,
+                phone_numbers: T::Array[String],
+                dba_business_name: String,
+                parent_company: String
+              }
+            )
         end
+        def to_hash; end
       end
     end
   end

data/rbi/lib/lithic/models/kyb_business_entity.rbi

@@ -4,7 +4,7 @@ module Lithic
   module Models
     class KYBBusinessEntity < 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::KYBBusinessEntity::Address) }
       attr_reader :address
 
@@ -12,8 +12,8 @@ module Lithic
       attr_writer :address
 
       # 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
 
@@ -22,12 +22,12 @@ 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
 
       # Any name that the business operates under that is not its legal business name
-      #   (if applicable).
+      # (if applicable).
       sig { returns(T.nilable(String)) }
       attr_reader :dba_business_name
 
@@ -59,9 +59,7 @@ module Lithic
         phone_numbers:,
         dba_business_name: nil,
         parent_company: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -75,8 +73,7 @@ module Lithic
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
       class Address < Lithic::Internal::Type::BaseModel
         # Valid deliverable address (no PO boxes).
@@ -88,17 +85,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
 
@@ -110,7 +107,7 @@ module Lithic
         attr_writer :address2
 
         # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable.
+        # acceptable; APO/FPO are acceptable.
         sig do
           params(
             address1: String,
@@ -122,8 +119,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
@@ -138,8 +134,7 @@ module Lithic
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
     end
   end