lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.16

data/lib/lithic/models/kyb.rb

@@ -4,9 +4,10 @@ module Lithic
   module Models
     class KYB < Lithic::Internal::Type::BaseModel
       # @!attribute beneficial_owner_individuals
-      #   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
+      #   You must submit a list of all direct and indirect individuals with 25% or more
+      #   ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+      #   no individual owns 25% of the company you do not need to send beneficial owner
+      #   information. 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.
       #
@@ -55,29 +56,23 @@ module Lithic
       #   @return [Symbol, Lithic::Models::KYB::Workflow]
       required :workflow, enum: -> { Lithic::Models::KYB::Workflow }
 
-      # @!attribute [r] beneficial_owner_entities
+      # @!attribute beneficial_owner_entities
+      #   @deprecated
+      #
       #   Deprecated.
       #
       #   @return [Array<Lithic::Models::KYB::BeneficialOwnerEntity>, nil]
       optional :beneficial_owner_entities,
                -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::KYB::BeneficialOwnerEntity] }
 
-      # @!parse
-      #   # @return [Array<Lithic::Models::KYB::BeneficialOwnerEntity>]
-      #   attr_writer :beneficial_owner_entities
-
-      # @!attribute [r] external_id
+      # @!attribute external_id
       #   A user provided id that can be used to link an account holder with an external
       #   system
       #
       #   @return [String, nil]
       optional :external_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :external_id
-
-      # @!attribute [r] kyb_passed_timestamp
+      # @!attribute kyb_passed_timestamp
       #   An RFC 3339 timestamp indicating when precomputed KYC was completed on the
       #   business with a pass result.
       #
@@ -86,49 +81,23 @@ module Lithic
       #   @return [String, nil]
       optional :kyb_passed_timestamp, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :kyb_passed_timestamp
-
-      # @!attribute [r] website_url
+      # @!attribute website_url
       #   Company website URL.
       #
       #   @return [String, nil]
       optional :website_url, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :website_url
-
-      # @!parse
-      #   # @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>]
-      #   # @param business_entity [Lithic::Models::KYB::BusinessEntity]
-      #   # @param control_person [Lithic::Models::KYB::ControlPerson]
-      #   # @param nature_of_business [String]
-      #   # @param tos_timestamp [String]
-      #   # @param workflow [Symbol, Lithic::Models::KYB::Workflow]
-      #   # @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>]
-      #   # @param external_id [String]
-      #   # @param kyb_passed_timestamp [String]
-      #   # @param website_url [String]
-      #   #
-      #   def initialize(
-      #     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,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(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)
+      #   @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>]
+      #   @param business_entity [Lithic::Models::KYB::BusinessEntity]
+      #   @param control_person [Lithic::Models::KYB::ControlPerson]
+      #   @param nature_of_business [String]
+      #   @param tos_timestamp [String]
+      #   @param workflow [Symbol, Lithic::Models::KYB::Workflow]
+      #   @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>]
+      #   @param external_id [String]
+      #   @param kyb_passed_timestamp [String]
+      #   @param website_url [String]
 
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute address
@@ -172,30 +141,22 @@ module Lithic
         #   @return [String]
         required :last_name, String
 
-        # @!attribute [r] phone_number
+        # @!attribute phone_number
         #   Individual's phone number, entered in E.164 format.
         #
         #   @return [String, nil]
         optional :phone_number, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :phone_number
-
-        # @!parse
-        #   # Individuals associated with a KYB application. Phone number is optional.
-        #   #
-        #   # @param address [Lithic::Models::Address]
-        #   # @param dob [String]
-        #   # @param email [String]
-        #   # @param first_name [String]
-        #   # @param government_id [String]
-        #   # @param last_name [String]
-        #   # @param phone_number [String]
-        #   #
-        #   def initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        #   Individuals associated with a KYB application. Phone number is optional.
+        #
+        #   @param address [Lithic::Models::Address]
+        #   @param dob [String]
+        #   @param email [String]
+        #   @param first_name [String]
+        #   @param government_id [String]
+        #   @param last_name [String]
+        #   @param phone_number [String]
       end
 
       # @see Lithic::Models::KYB#business_entity
@@ -228,51 +189,29 @@ module Lithic
         #   @return [Array<String>]
         required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
 
-        # @!attribute [r] dba_business_name
+        # @!attribute dba_business_name
         #   Any name that the business operates under that is not its legal business name
         #   (if applicable).
         #
         #   @return [String, nil]
         optional :dba_business_name, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :dba_business_name
-
-        # @!attribute [r] parent_company
+        # @!attribute parent_company
         #   Parent company name (if applicable).
         #
         #   @return [String, nil]
         optional :parent_company, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :parent_company
-
-        # @!parse
-        #   # Information for business for which the account is being opened and KYB is being
-        #   # run.
-        #   #
-        #   # @param address [Lithic::Models::Address]
-        #   # @param government_id [String]
-        #   # @param legal_business_name [String]
-        #   # @param phone_numbers [Array<String>]
-        #   # @param dba_business_name [String]
-        #   # @param parent_company [String]
-        #   #
-        #   def initialize(
-        #     address:,
-        #     government_id:,
-        #     legal_business_name:,
-        #     phone_numbers:,
-        #     dba_business_name: nil,
-        #     parent_company: nil,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
+        #   Information for business for which the account is being opened and KYB is being
+        #   run.
+        #
+        #   @param address [Lithic::Models::Address]
+        #   @param government_id [String]
+        #   @param legal_business_name [String]
+        #   @param phone_numbers [Array<String>]
+        #   @param dba_business_name [String]
+        #   @param parent_company [String]
       end
 
       # @see Lithic::Models::KYB#control_person
@@ -318,37 +257,29 @@ module Lithic
         #   @return [String]
         required :last_name, String
 
-        # @!attribute [r] phone_number
+        # @!attribute phone_number
         #   Individual's phone number, entered in E.164 format.
         #
         #   @return [String, nil]
         optional :phone_number, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :phone_number
-
-        # @!parse
-        #   # 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.
-        #   #
-        #   # @param address [Lithic::Models::Address]
-        #   # @param dob [String]
-        #   # @param email [String]
-        #   # @param first_name [String]
-        #   # @param government_id [String]
-        #   # @param last_name [String]
-        #   # @param phone_number [String]
-        #   #
-        #   def initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        #   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.
+        #
+        #   @param address [Lithic::Models::Address]
+        #   @param dob [String]
+        #   @param email [String]
+        #   @param first_name [String]
+        #   @param government_id [String]
+        #   @param last_name [String]
+        #   @param phone_number [String]
       end
 
       # Specifies the type of KYB workflow to run.
@@ -360,11 +291,8 @@ module Lithic
         KYB_BASIC = :KYB_BASIC
         KYB_BYO = :KYB_BYO
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
@@ -396,48 +324,26 @@ module Lithic
         #   @return [Array<String>]
         required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
 
-        # @!attribute [r] dba_business_name
+        # @!attribute dba_business_name
         #   Any name that the business operates under that is not its legal business name
         #   (if applicable).
         #
         #   @return [String, nil]
         optional :dba_business_name, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :dba_business_name
-
-        # @!attribute [r] parent_company
+        # @!attribute parent_company
         #   Parent company name (if applicable).
         #
         #   @return [String, nil]
         optional :parent_company, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :parent_company
-
-        # @!parse
-        #   # @param address [Lithic::Models::Address]
-        #   # @param government_id [String]
-        #   # @param legal_business_name [String]
-        #   # @param phone_numbers [Array<String>]
-        #   # @param dba_business_name [String]
-        #   # @param parent_company [String]
-        #   #
-        #   def initialize(
-        #     address:,
-        #     government_id:,
-        #     legal_business_name:,
-        #     phone_numbers:,
-        #     dba_business_name: nil,
-        #     parent_company: nil,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
+        #   @param address [Lithic::Models::Address]
+        #   @param government_id [String]
+        #   @param legal_business_name [String]
+        #   @param phone_numbers [Array<String>]
+        #   @param dba_business_name [String]
+        #   @param parent_company [String]
       end
     end
   end

data/lib/lithic/models/kyb_business_entity.rb

@@ -31,48 +31,26 @@ module Lithic
       #   @return [Array<String>]
       required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
 
-      # @!attribute [r] dba_business_name
+      # @!attribute dba_business_name
       #   Any name that the business operates under that is not its legal business name
       #   (if applicable).
       #
       #   @return [String, nil]
       optional :dba_business_name, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :dba_business_name
-
-      # @!attribute [r] parent_company
+      # @!attribute parent_company
       #   Parent company name (if applicable).
       #
       #   @return [String, nil]
       optional :parent_company, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :parent_company
-
-      # @!parse
-      #   # @param address [Lithic::Models::KYBBusinessEntity::Address]
-      #   # @param government_id [String]
-      #   # @param legal_business_name [String]
-      #   # @param phone_numbers [Array<String>]
-      #   # @param dba_business_name [String]
-      #   # @param parent_company [String]
-      #   #
-      #   def initialize(
-      #     address:,
-      #     government_id:,
-      #     legal_business_name:,
-      #     phone_numbers:,
-      #     dba_business_name: nil,
-      #     parent_company: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
+      #   @param address [Lithic::Models::KYBBusinessEntity::Address]
+      #   @param government_id [String]
+      #   @param legal_business_name [String]
+      #   @param phone_numbers [Array<String>]
+      #   @param dba_business_name [String]
+      #   @param parent_company [String]
 
       # @see Lithic::Models::KYBBusinessEntity#address
       class Address < Lithic::Internal::Type::BaseModel
@@ -109,30 +87,22 @@ module Lithic
         #   @return [String]
         required :state, String
 
-        # @!attribute [r] address2
+        # @!attribute address2
         #   Unit or apartment number (if applicable).
         #
         #   @return [String, nil]
         optional :address2, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :address2
-
-        # @!parse
-        #   # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   # acceptable; APO/FPO are acceptable.
-        #   #
-        #   # @param address1 [String]
-        #   # @param city [String]
-        #   # @param country [String]
-        #   # @param postal_code [String]
-        #   # @param state [String]
-        #   # @param address2 [String]
-        #   #
-        #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+        #   Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable.
+        #
+        #   @param address1 [String]
+        #   @param city [String]
+        #   @param country [String]
+        #   @param postal_code [String]
+        #   @param state [String]
+        #   @param address2 [String]
       end
     end
   end

data/lib/lithic/models/kyc.rb

@@ -24,18 +24,14 @@ module Lithic
       #   @return [Symbol, Lithic::Models::KYC::Workflow]
       required :workflow, enum: -> { Lithic::Models::KYC::Workflow }
 
-      # @!attribute [r] external_id
+      # @!attribute external_id
       #   A user provided id that can be used to link an account holder with an external
       #   system
       #
       #   @return [String, nil]
       optional :external_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :external_id
-
-      # @!attribute [r] kyc_passed_timestamp
+      # @!attribute kyc_passed_timestamp
       #   An RFC 3339 timestamp indicating when precomputed KYC was completed on the
       #   individual with a pass result.
       #
@@ -44,20 +40,12 @@ module Lithic
       #   @return [String, nil]
       optional :kyc_passed_timestamp, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :kyc_passed_timestamp
-
-      # @!parse
-      #   # @param individual [Lithic::Models::KYC::Individual]
-      #   # @param tos_timestamp [String]
-      #   # @param workflow [Symbol, Lithic::Models::KYC::Workflow]
-      #   # @param external_id [String]
-      #   # @param kyc_passed_timestamp [String]
-      #   #
-      #   def initialize(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil, **) = super
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil)
+      #   @param individual [Lithic::Models::KYC::Individual]
+      #   @param tos_timestamp [String]
+      #   @param workflow [Symbol, Lithic::Models::KYC::Workflow]
+      #   @param external_id [String]
+      #   @param kyc_passed_timestamp [String]
 
       # @see Lithic::Models::KYC#individual
       class Individual < Lithic::Internal::Type::BaseModel
@@ -108,21 +96,17 @@ module Lithic
         #   @return [String]
         required :phone_number, String
 
-        # @!parse
-        #   # Information on individual for whom the account is being opened and KYC is being
-        #   # run.
-        #   #
-        #   # @param address [Lithic::Models::Address]
-        #   # @param dob [String]
-        #   # @param email [String]
-        #   # @param first_name [String]
-        #   # @param government_id [String]
-        #   # @param last_name [String]
-        #   # @param phone_number [String]
-        #   #
-        #   def initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:)
+        #   Information on individual for whom the account is being opened and KYC is being
+        #   run.
+        #
+        #   @param address [Lithic::Models::Address]
+        #   @param dob [String]
+        #   @param email [String]
+        #   @param first_name [String]
+        #   @param government_id [String]
+        #   @param last_name [String]
+        #   @param phone_number [String]
       end
 
       # Specifies the type of KYC workflow to run.
@@ -134,11 +118,8 @@ module Lithic
         KYC_BASIC = :KYC_BASIC
         KYC_BYO = :KYC_BYO
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/lithic/models/kyc_exempt.rb

@@ -46,7 +46,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::KYCExempt::Workflow]
       required :workflow, enum: -> { Lithic::Models::KYCExempt::Workflow }
 
-      # @!attribute [r] business_account_token
+      # @!attribute business_account_token
       #   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.
@@ -54,48 +54,23 @@ module Lithic
       #   @return [String, nil]
       optional :business_account_token, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :business_account_token
-
-      # @!attribute [r] external_id
+      # @!attribute external_id
       #   A user provided id that can be used to link an account holder with an external
       #   system
       #
       #   @return [String, nil]
       optional :external_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :external_id
-
-      # @!parse
-      #   # @param address [Lithic::Models::Address]
-      #   # @param email [String]
-      #   # @param first_name [String]
-      #   # @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
-      #   # @param last_name [String]
-      #   # @param phone_number [String]
-      #   # @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow]
-      #   # @param business_account_token [String]
-      #   # @param external_id [String]
-      #   #
-      #   def initialize(
-      #     address:,
-      #     email:,
-      #     first_name:,
-      #     kyc_exemption_type:,
-      #     last_name:,
-      #     phone_number:,
-      #     workflow:,
-      #     business_account_token: nil,
-      #     external_id: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, workflow:, business_account_token: nil, external_id: nil)
+      #   @param address [Lithic::Models::Address]
+      #   @param email [String]
+      #   @param first_name [String]
+      #   @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
+      #   @param last_name [String]
+      #   @param phone_number [String]
+      #   @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow]
+      #   @param business_account_token [String]
+      #   @param external_id [String]
 
       # Specifies the type of KYC Exempt user
       #
@@ -106,11 +81,8 @@ module Lithic
         AUTHORIZED_USER = :AUTHORIZED_USER
         PREPAID_CARD_USER = :PREPAID_CARD_USER
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # Specifies the workflow type. This must be 'KYC_EXEMPT'
@@ -121,11 +93,8 @@ module Lithic
 
         KYC_EXEMPT = :KYC_EXEMPT
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end