lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.5

data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb

@@ -2,10 +2,11 @@
 
 module Lithic
   module Models
-    class AccountHolderSimulateEnrollmentDocumentReviewParams < Lithic::BaseModel
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_document_review
+    class AccountHolderSimulateEnrollmentDocumentReviewParams < Lithic::Internal::Type::BaseModel
       # @!parse
-      #   extend Lithic::Type::RequestParameters::Converter
-      include Lithic::RequestParameters
+      #   extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
 
       # @!attribute document_upload_token
       #   The account holder document upload which to perform the simulation upon.
@@ -23,7 +24,7 @@ module Lithic
       #   A list of status reasons associated with a KYB account holder in PENDING_REVIEW
       #
       #   @return [Array<String>, nil]
-      optional :accepted_entity_status_reasons, Lithic::ArrayOf[String]
+      optional :accepted_entity_status_reasons, Lithic::Internal::Type::ArrayOf[String]
 
       # @!parse
       #   # @return [Array<String>]
@@ -59,11 +60,11 @@ module Lithic
       #     super
       #   end
 
-      # def initialize: (Hash | Lithic::BaseModel) -> void
+      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
       # An account holder document's upload status for use within the simulation.
       module Status
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         UPLOADED = :UPLOADED
         ACCEPTED = :ACCEPTED
@@ -80,7 +81,7 @@ module Lithic
       # Status reason that will be associated with the simulated account holder status.
       #   Only required for a `REJECTED` status or `PARTIAL_APPROVAL` status.
       module StatusReason
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         DOCUMENT_MISSING_REQUIRED_DATA = :DOCUMENT_MISSING_REQUIRED_DATA
         DOCUMENT_UPLOAD_TOO_BLURRY = :DOCUMENT_UPLOAD_TOO_BLURRY

data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb

@@ -2,10 +2,11 @@
 
 module Lithic
   module Models
-    class AccountHolderSimulateEnrollmentReviewParams < Lithic::BaseModel
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_review
+    class AccountHolderSimulateEnrollmentReviewParams < Lithic::Internal::Type::BaseModel
       # @!parse
-      #   extend Lithic::Type::RequestParameters::Converter
-      include Lithic::RequestParameters
+      #   extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
 
       # @!attribute [r] account_holder_token
       #   The account holder which to perform the simulation upon.
@@ -33,7 +34,7 @@ module Lithic
       #
       #   @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>, nil]
       optional :status_reasons,
-               -> { Lithic::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason] }
+               -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason] }
 
       # @!parse
       #   # @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>]
@@ -47,11 +48,11 @@ module Lithic
       #   #
       #   def initialize(account_holder_token: nil, status: nil, status_reasons: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | Lithic::BaseModel) -> void
+      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
       # An account holder's status for use within the simulation.
       module Status
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         ACCEPTED = :ACCEPTED
         REJECTED = :REJECTED
@@ -64,7 +65,7 @@ module Lithic
       end
 
       module StatusReason
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE = :PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE
         PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE =

data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb

@@ -2,7 +2,8 @@
 
 module Lithic
   module Models
-    class AccountHolderSimulateEnrollmentReviewResponse < Lithic::BaseModel
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_review
+    class AccountHolderSimulateEnrollmentReviewResponse < Lithic::Internal::Type::BaseModel
       # @!attribute [r] token
       #   Globally unique identifier for the account holder.
       #
@@ -28,7 +29,8 @@ module Lithic
       #     ownership in the company.
       #
       #   @return [Array<Lithic::Models::KYBBusinessEntity>, nil]
-      optional :beneficial_owner_entities, -> { Lithic::ArrayOf[Lithic::Models::KYBBusinessEntity] }
+      optional :beneficial_owner_entities,
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::KYBBusinessEntity] }
 
       # @!parse
       #   # @return [Array<Lithic::Models::KYBBusinessEntity>]
@@ -40,7 +42,7 @@ module Lithic
       #
       #   @return [Array<Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual>, nil]
       optional :beneficial_owner_individuals,
-               -> { Lithic::ArrayOf[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual] }
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual] }
 
       # @!parse
       #   # @return [Array<Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual>]
@@ -176,7 +178,7 @@ module Lithic
       #     required for the account holder to be approved.
       #
       #   @return [Array<Lithic::Models::RequiredDocument>, nil]
-      optional :required_documents, -> { Lithic::ArrayOf[Lithic::Models::RequiredDocument] }
+      optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::RequiredDocument] }
 
       # @!parse
       #   # @return [Array<Lithic::Models::RequiredDocument>]
@@ -203,7 +205,7 @@ module Lithic
       #
       #   @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>, nil]
       optional :status_reasons,
-               -> { Lithic::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason] }
+               -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason] }
 
       # @!parse
       #   # @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>]
@@ -294,9 +296,9 @@ module Lithic
       #     super
       #   end
 
-      # def initialize: (Hash | Lithic::BaseModel) -> void
+      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
-      class BeneficialOwnerIndividual < Lithic::BaseModel
+      class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute [r] address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
         #     acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
@@ -370,9 +372,10 @@ module Lithic
         #   #
         #   def initialize(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil, **) = super
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
-        class Address < Lithic::BaseModel
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual#address
+        class Address < Lithic::Internal::Type::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
           #
@@ -429,11 +432,12 @@ module Lithic
           #   #
           #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
 
-          # def initialize: (Hash | Lithic::BaseModel) -> void
+          # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
         end
       end
 
-      class ControlPerson < Lithic::BaseModel
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#control_person
+      class ControlPerson < Lithic::Internal::Type::BaseModel
         # @!attribute [r] address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
         #     acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
@@ -519,9 +523,10 @@ module Lithic
         #   #
         #   def initialize(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil, **) = super
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
-        class Address < Lithic::BaseModel
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson#address
+        class Address < Lithic::Internal::Type::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
           #
@@ -578,14 +583,16 @@ module Lithic
           #   #
           #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
 
-          # def initialize: (Hash | Lithic::BaseModel) -> void
+          # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
         end
       end
 
       # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
       #   holder is not KYC-Exempt.
+      #
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#exemption_type
       module ExemptionType
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         AUTHORIZED_USER = :AUTHORIZED_USER
         PREPAID_CARD_USER = :PREPAID_CARD_USER
@@ -597,7 +604,8 @@ module Lithic
         #   def self.values; end
       end
 
-      class Individual < Lithic::BaseModel
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#individual
+      class Individual < Lithic::Internal::Type::BaseModel
         # @!attribute [r] address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
         #     acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
@@ -674,9 +682,10 @@ module Lithic
         #   #
         #   def initialize(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil, **) = super
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
-        class Address < Lithic::BaseModel
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual#address
+        class Address < Lithic::Internal::Type::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
           #
@@ -733,7 +742,7 @@ module Lithic
           #   #
           #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
 
-          # def initialize: (Hash | Lithic::BaseModel) -> void
+          # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
         end
       end
 
@@ -743,8 +752,10 @@ module Lithic
       #
       #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
       #   `ADVANCED` workflow.
+      #
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#status
       module Status
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         ACCEPTED = :ACCEPTED
         PENDING_DOCUMENT = :PENDING_DOCUMENT
@@ -760,7 +771,7 @@ module Lithic
 
       # Status Reasons for KYC/KYB enrollment states
       module StatusReason
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         ADDRESS_VERIFICATION_FAILURE = :ADDRESS_VERIFICATION_FAILURE
         AGE_THRESHOLD_FAILURE = :AGE_THRESHOLD_FAILURE
@@ -803,8 +814,10 @@ module Lithic
       #   "beneficial_owner_individuals", "beneficial_owner_entities",
       #
       #   "nature_of_business", and "website_url" attributes will be present.
+      #
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#user_type
       module UserType
-        extend Lithic::Enum
+        extend Lithic::Internal::Type::Enum
 
         BUSINESS = :BUSINESS
         INDIVIDUAL = :INDIVIDUAL
@@ -816,7 +829,8 @@ module Lithic
         #   def self.values; end
       end
 
-      class VerificationApplication < Lithic::BaseModel
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#verification_application
+      class VerificationApplication < Lithic::Internal::Type::BaseModel
         # @!attribute created
         #   Timestamp of when the application was created.
         #
@@ -838,7 +852,7 @@ module Lithic
         #
         #   @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason>]
         required :status_reasons,
-                 -> { Lithic::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason] }
+                 -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason] }
 
         # @!attribute updated
         #   Timestamp of when the application was last updated.
@@ -856,14 +870,16 @@ module Lithic
         #   #
         #   def initialize(created:, status:, status_reasons:, updated:, **) = super
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
         # KYC and KYB evaluation states.
         #
         #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
         #   `ADVANCED` workflow.
+        #
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication#status
         module Status
-          extend Lithic::Enum
+          extend Lithic::Internal::Type::Enum
 
           ACCEPTED = :ACCEPTED
           PENDING_DOCUMENT = :PENDING_DOCUMENT
@@ -879,7 +895,7 @@ module Lithic
 
         # Status Reasons for KYC/KYB enrollment states
         module StatusReason
-          extend Lithic::Enum
+          extend Lithic::Internal::Type::Enum
 
           ADDRESS_VERIFICATION_FAILURE = :ADDRESS_VERIFICATION_FAILURE
           AGE_THRESHOLD_FAILURE = :AGE_THRESHOLD_FAILURE

data/lib/lithic/models/account_holder_update_params.rb

@@ -2,10 +2,11 @@
 
 module Lithic
   module Models
-    class AccountHolderUpdateParams < Lithic::BaseModel
+    # @see Lithic::Resources::AccountHolders#update
+    class AccountHolderUpdateParams < Lithic::Internal::Type::BaseModel
       # @!parse
-      #   extend Lithic::Type::RequestParameters::Converter
-      include Lithic::RequestParameters
+      #   extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
 
       # @!attribute [r] beneficial_owner_entities
       #   List of all entities with >25% ownership in the company. If no entity or
@@ -18,7 +19,7 @@ module Lithic
       #
       #   @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>, nil]
       optional :beneficial_owner_entities,
-               -> { Lithic::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity] }
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity] }
 
       # @!parse
       #   # @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>]
@@ -35,7 +36,7 @@ module Lithic
       #
       #   @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>, nil]
       optional :beneficial_owner_individuals,
-               -> { Lithic::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual] }
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual] }
 
       # @!parse
       #   # @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>]
@@ -227,9 +228,9 @@ module Lithic
       #     super
       #   end
 
-      # def initialize: (Hash | Lithic::BaseModel) -> void
+      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
-      class BeneficialOwnerEntity < Lithic::BaseModel
+      class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
         #   Globally unique identifier for an entity.
         #
@@ -295,7 +296,7 @@ module Lithic
         #     format.
         #
         #   @return [Array<String>, nil]
-        optional :phone_numbers, Lithic::ArrayOf[String]
+        optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
 
         # @!parse
         #   # @return [Array<String>]
@@ -323,10 +324,10 @@ module Lithic
         #     super
         #   end
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
       end
 
-      class BeneficialOwnerIndividual < Lithic::BaseModel
+      class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
         #   Globally unique identifier for an entity.
         #
@@ -436,10 +437,10 @@ module Lithic
         #     super
         #   end
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
       end
 
-      class BusinessEntity < Lithic::BaseModel
+      class BusinessEntity < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
         #   Globally unique identifier for an entity.
         #
@@ -505,7 +506,7 @@ module Lithic
         #     format.
         #
         #   @return [Array<String>, nil]
-        optional :phone_numbers, Lithic::ArrayOf[String]
+        optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
 
         # @!parse
         #   # @return [Array<String>]
@@ -536,10 +537,10 @@ module Lithic
         #     super
         #   end
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
       end
 
-      class ControlPerson < Lithic::BaseModel
+      class ControlPerson < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
         #   Globally unique identifier for an entity.
         #
@@ -656,10 +657,10 @@ module Lithic
         #     super
         #   end
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
       end
 
-      class Individual < Lithic::BaseModel
+      class Individual < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
         #   Globally unique identifier for an entity.
         #
@@ -770,7 +771,7 @@ module Lithic
         #     super
         #   end
 
-        # def initialize: (Hash | Lithic::BaseModel) -> void
+        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
       end
     end
   end