lithic 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_review
     class AccountHolderSimulateEnrollmentReviewParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#simulate_enrollment_review
     class AccountHolderSimulateEnrollmentReviewResponse < Lithic::BaseModel
       # @!attribute [r] token
       #   Globally unique identifier for the account holder.
@@ -372,6 +373,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual#address
         class Address < Lithic::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
@@ -433,6 +435,7 @@ module Lithic
         end
       end
 
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#control_person
       class ControlPerson < Lithic::BaseModel
         # @!attribute [r] address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -521,6 +524,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson#address
         class Address < Lithic::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
@@ -584,6 +588,8 @@ module Lithic
 
       # 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
 
@@ -597,6 +603,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#individual
       class Individual < Lithic::BaseModel
         # @!attribute [r] address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -676,6 +683,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual#address
         class Address < Lithic::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).
@@ -743,6 +751,8 @@ 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
 
@@ -803,6 +813,8 @@ 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
 
@@ -816,6 +828,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#verification_application
       class VerificationApplication < Lithic::BaseModel
         # @!attribute created
         #   Timestamp of when the application was created.
@@ -862,6 +875,8 @@ module Lithic
         #
         #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
         #   `ADVANCED` workflow.
+        #
+        # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication#status
         module Status
           extend Lithic::Enum
 

data/lib/lithic/models/account_holder_update_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#update
     class AccountHolderUpdateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_holder_update_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#update
     module AccountHolderUpdateResponse
       extend Lithic::Union
 
@@ -380,6 +381,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::BeneficialOwnerIndividual#address
           class Address < Lithic::BaseModel
             # @!attribute address1
             #   Valid deliverable address (no PO boxes).
@@ -441,6 +443,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#control_person
         class ControlPerson < Lithic::BaseModel
           # @!attribute [r] address
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -529,6 +532,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ControlPerson#address
           class Address < Lithic::BaseModel
             # @!attribute address1
             #   Valid deliverable address (no PO boxes).
@@ -592,6 +596,8 @@ module Lithic
 
         # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
         #   holder is not KYC-Exempt.
+        #
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#exemption_type
         module ExemptionType
           extend Lithic::Enum
 
@@ -605,6 +611,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#individual
         class Individual < Lithic::BaseModel
           # @!attribute [r] address
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -684,6 +691,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Individual#address
           class Address < Lithic::BaseModel
             # @!attribute address1
             #   Valid deliverable address (no PO boxes).
@@ -751,6 +759,8 @@ module Lithic
         #
         #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
         #   `ADVANCED` workflow.
+        #
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#status
         module Status
           extend Lithic::Enum
 
@@ -811,6 +821,8 @@ module Lithic
         #   "beneficial_owner_individuals", "beneficial_owner_entities",
         #
         #   "nature_of_business", and "website_url" attributes will be present.
+        #
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#user_type
         module UserType
           extend Lithic::Enum
 
@@ -824,6 +836,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#verification_application
         class VerificationApplication < Lithic::BaseModel
           # @!attribute created
           #   Timestamp of when the application was created.
@@ -874,6 +887,8 @@ module Lithic
           #
           #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
           #   `ADVANCED` workflow.
+          #
+          # @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::VerificationApplication#status
           module Status
             extend Lithic::Enum
 
@@ -1036,6 +1051,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AccountHolderUpdateResponse::PatchResponse#address
         class Address < Lithic::BaseModel
           # @!attribute address1
           #   Valid deliverable address (no PO boxes).

data/lib/lithic/models/account_holder_upload_document_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AccountHolders#upload_document
     class AccountHolderUploadDocumentParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#list
     class AccountListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_retrieve_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#retrieve
     class AccountRetrieveParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_retrieve_spend_limits_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#retrieve_spend_limits
     class AccountRetrieveSpendLimitsParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/account_spend_limits.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#retrieve_spend_limits
     class AccountSpendLimits < Lithic::BaseModel
       # @!attribute available_spend_limit
       #
@@ -35,6 +36,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::AccountSpendLimits#available_spend_limit
       class AvailableSpendLimit < Lithic::BaseModel
         # @!attribute [r] daily
         #   The available spend limit (in cents) relative to the daily limit configured on
@@ -79,6 +81,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::AccountSpendLimits#spend_limit
       class SpendLimit < Lithic::BaseModel
         # @!attribute [r] daily
         #   The configured daily spend limit (in cents) on the Account.
@@ -120,6 +123,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::AccountSpendLimits#spend_velocity
       class SpendVelocity < Lithic::BaseModel
         # @!attribute [r] daily
         #   Current daily spend velocity (in cents) on the Account. Present if daily spend

data/lib/lithic/models/account_update_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Accounts#update
     class AccountUpdateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/aggregate_balance.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AggregateBalances#list
     class AggregateBalance < Lithic::BaseModel
       # @!attribute available_amount
       #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)
@@ -100,6 +101,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # Type of financial account
+      #
+      # @see Lithic::Models::AggregateBalance#financial_account_type
       module FinancialAccountType
         extend Lithic::Enum
 

data/lib/lithic/models/aggregate_balance_list_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::AggregateBalances#list
     class AggregateBalanceListParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/api_status.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Client#api_status
     class APIStatus < Lithic::BaseModel
       # @!attribute [r] message
       #

data/lib/lithic/models/auth_rules/auth_rule.rb

@@ -121,6 +121,8 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
         # Indicates whether the Auth Rule is ACTIVE or INACTIVE
+        #
+        # @see Lithic::Models::AuthRules::AuthRule#state
         module State
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/auth_rule_condition.rb

@@ -90,6 +90,8 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
         # The operation to apply to the attribute
+        #
+        # @see Lithic::Models::AuthRules::AuthRuleCondition#operation
         module Operation
           extend Lithic::Enum
 
@@ -108,6 +110,8 @@ module Lithic
         end
 
         # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+        #
+        # @see Lithic::Models::AuthRules::AuthRuleCondition#value
         module Value
           extend Lithic::Union
 

data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb

@@ -4,6 +4,7 @@ module Lithic
   module Models
     module AuthRules
       module V2
+        # @see Lithic::Resources::AuthRules::V2::Backtests#create
         class BacktestCreateParams < Lithic::BaseModel
           # @!parse
           #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb

@@ -4,6 +4,7 @@ module Lithic
   module Models
     module AuthRules
       module V2
+        # @see Lithic::Resources::AuthRules::V2::Backtests#create
         class BacktestCreateResponse < Lithic::BaseModel
           # @!attribute [r] backtest_token
           #   Auth Rule Backtest Token

data/lib/lithic/models/auth_rules/v2/backtest_results.rb

@@ -4,6 +4,7 @@ module Lithic
   module Models
     module AuthRules
       module V2
+        # @see Lithic::Resources::AuthRules::V2::Backtests#retrieve
         class BacktestResults < Lithic::BaseModel
           # @!attribute backtest_token
           #   Auth Rule Backtest Token
@@ -31,6 +32,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::AuthRules::V2::BacktestResults#results
           class Results < Lithic::BaseModel
             # @!attribute current_version
             #
@@ -54,6 +56,7 @@ module Lithic
 
             # def initialize: (Hash | Lithic::BaseModel) -> void
 
+            # @see Lithic::Models::AuthRules::V2::BacktestResults::Results#current_version
             class CurrentVersion < Lithic::BaseModel
               # @!attribute [r] approved
               #   The total number of historical transactions approved by this rule during the
@@ -155,6 +158,7 @@ module Lithic
               end
             end
 
+            # @see Lithic::Models::AuthRules::V2::BacktestResults::Results#draft_version
             class DraftVersion < Lithic::BaseModel
               # @!attribute [r] approved
               #   The total number of historical transactions approved by this rule during the
@@ -257,6 +261,7 @@ module Lithic
             end
           end
 
+          # @see Lithic::Models::AuthRules::V2::BacktestResults#simulation_parameters
           class SimulationParameters < Lithic::BaseModel
             # @!attribute [r] auth_rule_token
             #   Auth Rule Token

data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb

@@ -4,6 +4,7 @@ module Lithic
   module Models
     module AuthRules
       module V2
+        # @see Lithic::Resources::AuthRules::V2::Backtests#retrieve
         class BacktestRetrieveParams < Lithic::BaseModel
           # @!parse
           #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_apply_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#apply
       class V2ApplyParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_apply_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#apply
       class V2ApplyResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -96,6 +97,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2ApplyResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -121,6 +123,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -134,6 +138,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2ApplyResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -159,6 +164,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -173,6 +180,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2ApplyResponse#state
         module State
           extend Lithic::Enum
 
@@ -187,6 +196,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2ApplyResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/v2_create_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#create
       class V2CreateParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_create_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#create
       class V2CreateResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -96,6 +97,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2CreateResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -122,6 +124,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2CreateResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -135,6 +139,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2CreateResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -160,6 +165,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2CreateResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -174,6 +181,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2CreateResponse#state
         module State
           extend Lithic::Enum
 
@@ -188,6 +197,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2CreateResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/v2_delete_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#delete
       class V2DeleteParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_draft_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#draft
       class V2DraftParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/auth_rules/v2_draft_response.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#draft
       class V2DraftResponse < Lithic::BaseModel
         # @!attribute token
         #   Auth Rule Token
@@ -96,6 +97,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::AuthRules::V2DraftResponse#current_version
         class CurrentVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -121,6 +123,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2DraftResponse::CurrentVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -134,6 +138,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::AuthRules::V2DraftResponse#draft_version
         class DraftVersion < Lithic::BaseModel
           # @!attribute parameters
           #   Parameters for the Auth Rule
@@ -159,6 +164,8 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
           # Parameters for the Auth Rule
+          #
+          # @see Lithic::Models::AuthRules::V2DraftResponse::DraftVersion#parameters
           module Parameters
             extend Lithic::Union
 
@@ -173,6 +180,8 @@ module Lithic
         end
 
         # The state of the Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2DraftResponse#state
         module State
           extend Lithic::Enum
 
@@ -187,6 +196,8 @@ module Lithic
         end
 
         # The type of Auth Rule
+        #
+        # @see Lithic::Models::AuthRules::V2DraftResponse#type
         module Type
           extend Lithic::Enum
 

data/lib/lithic/models/auth_rules/v2_list_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module AuthRules
+      # @see Lithic::Resources::AuthRules::V2#list
       class V2ListParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter