lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4

data/lib/lithic/models/financial_accounts/loan_tape.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::LoanTapes#retrieve
       class LoanTape < Lithic::BaseModel
         # @!attribute token
         #   Globally unique identifier for a loan tape
@@ -193,6 +194,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#account_standing
         class AccountStanding < Lithic::BaseModel
           # @!attribute consecutive_full_payments_made
           #   Number of consecutive full payments made
@@ -269,6 +271,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding#financial_account_state
           class FinancialAccountState < Lithic::BaseModel
             # @!attribute status
             #   Status of the financial account
@@ -296,6 +299,8 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
 
             # Status of the financial account
+            #
+            # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState#status
             module Status
               extend Lithic::Enum
 
@@ -312,6 +317,8 @@ module Lithic
             end
 
             # Reason for the financial account status change
+            #
+            # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState#status_change_reason
             module StatusChangeReason
               extend Lithic::Enum
 
@@ -329,6 +336,7 @@ module Lithic
             end
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding#period_state
           module PeriodState
             extend Lithic::Enum
 
@@ -344,6 +352,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#balances
         class Balances < Lithic::BaseModel
           # @!attribute due
           #   Amount due for the prior billing cycle. Any amounts not fully paid off on this
@@ -384,6 +393,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#due
           class Due < Lithic::BaseModel
             # @!attribute fees
             #
@@ -413,6 +423,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#next_statement_due
           class NextStatementDue < Lithic::BaseModel
             # @!attribute fees
             #
@@ -443,6 +454,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#past_due
           class PastDue < Lithic::BaseModel
             # @!attribute fees
             #
@@ -471,6 +483,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#past_statements_due
           class PastStatementsDue < Lithic::BaseModel
             # @!attribute fees
             #
@@ -500,6 +513,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#day_totals
         class DayTotals < Lithic::BaseModel
           # @!attribute balance_transfers
           #   Opening balance transferred from previous account in cents
@@ -558,6 +572,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#interest_details
         class InterestDetails < Lithic::BaseModel
           # @!attribute actual_interest_charged
           #
@@ -621,6 +636,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#daily_balance_amounts
           class DailyBalanceAmounts < Lithic::BaseModel
             # @!attribute balance_transfers
             #
@@ -647,6 +663,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#effective_apr
           class EffectiveApr < Lithic::BaseModel
             # @!attribute balance_transfers
             #
@@ -673,6 +690,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#interest_calculation_method
           module InterestCalculationMethod
             extend Lithic::Enum
 
@@ -686,6 +704,7 @@ module Lithic
             #   def self.values; end
           end
 
+          # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#interest_for_period
           class InterestForPeriod < Lithic::BaseModel
             # @!attribute balance_transfers
             #
@@ -713,6 +732,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#minimum_payment_balance
         class MinimumPaymentBalance < Lithic::BaseModel
           # @!attribute amount
           #
@@ -733,6 +753,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#payment_allocation
         class PaymentAllocation < Lithic::BaseModel
           # @!attribute fees
           #
@@ -759,6 +780,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#period_totals
         class PeriodTotals < Lithic::BaseModel
           # @!attribute balance_transfers
           #   Opening balance transferred from previous account in cents
@@ -817,6 +839,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance
         class PreviousStatementBalance < Lithic::BaseModel
           # @!attribute amount
           #
@@ -837,6 +860,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#ytd_totals
         class YtdTotals < Lithic::BaseModel
           # @!attribute balance_transfers
           #   Opening balance transferred from previous account in cents

data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb

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

data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::LoanTapes#retrieve
       class LoanTapeRetrieveParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/financial_accounts/statement.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::Statements#retrieve
       class Statement < Lithic::BaseModel
         # @!attribute token
         #   Globally unique identifier for a statement
@@ -187,6 +188,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::FinancialAccounts::Statement#account_standing
         class AccountStanding < Lithic::BaseModel
           # @!attribute consecutive_full_payments_made
           #   Number of consecutive full payments made
@@ -263,6 +265,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding#financial_account_state
           class FinancialAccountState < Lithic::BaseModel
             # @!attribute status
             #   Status of the financial account
@@ -290,6 +293,8 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
 
             # Status of the financial account
+            #
+            # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState#status
             module Status
               extend Lithic::Enum
 
@@ -306,6 +311,8 @@ module Lithic
             end
 
             # Reason for the financial account status change
+            #
+            # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState#status_change_reason
             module StatusChangeReason
               extend Lithic::Enum
 
@@ -323,6 +330,7 @@ module Lithic
             end
           end
 
+          # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding#period_state
           module PeriodState
             extend Lithic::Enum
 
@@ -338,6 +346,7 @@ module Lithic
           end
         end
 
+        # @see Lithic::Models::FinancialAccounts::Statement#amount_due
         class AmountDue < Lithic::BaseModel
           # @!attribute amount
           #   Payment due at the end of the billing period in cents. Negative amount indicates
@@ -363,6 +372,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::Statement#period_totals
         class PeriodTotals < Lithic::BaseModel
           # @!attribute balance_transfers
           #   Opening balance transferred from previous account in cents
@@ -421,6 +431,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::Statement#statement_type
         module StatementType
           extend Lithic::Enum
 
@@ -435,6 +446,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::FinancialAccounts::Statement#ytd_totals
         class YtdTotals < Lithic::BaseModel
           # @!attribute balance_transfers
           #   Opening balance transferred from previous account in cents
@@ -493,6 +505,7 @@ module Lithic
           # def initialize: (Hash | Lithic::BaseModel) -> void
         end
 
+        # @see Lithic::Models::FinancialAccounts::Statement#interest_details
         class InterestDetails < Lithic::BaseModel
           # @!attribute actual_interest_charged
           #
@@ -557,6 +570,7 @@ module Lithic
 
           # def initialize: (Hash | Lithic::BaseModel) -> void
 
+          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#daily_balance_amounts
           class DailyBalanceAmounts < Lithic::BaseModel
             # @!attribute balance_transfers
             #
@@ -583,6 +597,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#effective_apr
           class EffectiveApr < Lithic::BaseModel
             # @!attribute balance_transfers
             #
@@ -609,6 +624,7 @@ module Lithic
             # def initialize: (Hash | Lithic::BaseModel) -> void
           end
 
+          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_calculation_method
           module InterestCalculationMethod
             extend Lithic::Enum
 
@@ -622,6 +638,7 @@ module Lithic
             #   def self.values; end
           end
 
+          # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_for_period
           class InterestForPeriod < Lithic::BaseModel
             # @!attribute balance_transfers
             #

data/lib/lithic/models/financial_accounts/statement_list_params.rb

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

data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb

@@ -3,6 +3,7 @@
 module Lithic
   module Models
     module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::Statements#retrieve
       class StatementRetrieveParams < Lithic::BaseModel
         # @!parse
         #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb

@@ -4,6 +4,7 @@ module Lithic
   module Models
     module FinancialAccounts
       module Statements
+        # @see Lithic::Resources::FinancialAccounts::Statements::LineItems#list
         class LineItemListParams < Lithic::BaseModel
           # @!parse
           #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb

@@ -139,6 +139,7 @@ module Lithic
 
             # def initialize: (Hash | Lithic::BaseModel) -> void
 
+            # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category
             module Category
               extend Lithic::Enum
 
@@ -161,6 +162,7 @@ module Lithic
               #   def self.values; end
             end
 
+            # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#event_type
             module EventType
               extend Lithic::Enum
 

data/lib/lithic/models/financial_transaction.rb

@@ -128,6 +128,8 @@ module Lithic
       #   - `INTERNAL` - Transaction for internal adjustment.
       #   - `TRANSFER` - Internal transfer of funds between financial accounts in your
       #     program.
+      #
+      # @see Lithic::Models::FinancialTransaction#category
       module Category
         extend Lithic::Enum
 
@@ -208,6 +210,8 @@ module Lithic
 
         # APPROVED financial events were successful while DECLINED financial events were
         #   declined by user, Lithic, or the network.
+        #
+        # @see Lithic::Models::FinancialTransaction::Event#result
         module Result
           extend Lithic::Enum
 
@@ -221,6 +225,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::FinancialTransaction::Event#type
         module Type
           extend Lithic::Enum
 
@@ -299,6 +304,8 @@ module Lithic
 
       # APPROVED transactions were successful while DECLINED transactions were declined
       #   by user, Lithic, or the network.
+      #
+      # @see Lithic::Models::FinancialTransaction#result
       module Result
         extend Lithic::Enum
 
@@ -321,6 +328,8 @@ module Lithic
       #   - `RETURNED` - The transaction has been returned.
       #   - `SETTLED` - The transaction is completed.
       #   - `VOIDED` - The transaction was voided. Card transaction only.
+      #
+      # @see Lithic::Models::FinancialTransaction#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/kyb.rb

@@ -274,6 +274,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::KYB#business_entity
       class BusinessEntity < Lithic::BaseModel
         # @!attribute address
         #   Business's physical address - PO boxes, UPS drops, and FedEx drops are not
@@ -350,6 +351,7 @@ module Lithic
         # def initialize: (Hash | Lithic::BaseModel) -> void
       end
 
+      # @see Lithic::Models::KYB#control_person
       class ControlPerson < Lithic::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -426,6 +428,8 @@ module Lithic
       end
 
       # Specifies the type of KYB workflow to run.
+      #
+      # @see Lithic::Models::KYB#workflow
       module Workflow
         extend Lithic::Enum
 

data/lib/lithic/models/kyb_business_entity.rb

@@ -74,6 +74,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::KYBBusinessEntity#address
       class Address < Lithic::BaseModel
         # @!attribute address1
         #   Valid deliverable address (no PO boxes).

data/lib/lithic/models/kyc.rb

@@ -59,6 +59,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::KYC#individual
       class Individual < Lithic::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -125,6 +126,8 @@ module Lithic
       end
 
       # Specifies the type of KYC workflow to run.
+      #
+      # @see Lithic::Models::KYC#workflow
       module Workflow
         extend Lithic::Enum
 

data/lib/lithic/models/kyc_exempt.rb

@@ -98,6 +98,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # Specifies the type of KYC Exempt user
+      #
+      # @see Lithic::Models::KYCExempt#kyc_exemption_type
       module KYCExemptionType
         extend Lithic::Enum
 
@@ -112,6 +114,8 @@ module Lithic
       end
 
       # Specifies the workflow type. This must be 'KYC_EXEMPT'
+      #
+      # @see Lithic::Models::KYCExempt#workflow
       module Workflow
         extend Lithic::Enum
 

data/lib/lithic/models/management_operation_create_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::ManagementOperations#create
     class ManagementOperationCreateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/management_operation_list_params.rb

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

data/lib/lithic/models/management_operation_retrieve_params.rb

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

data/lib/lithic/models/management_operation_reverse_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::ManagementOperations#reverse
     class ManagementOperationReverseParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter

data/lib/lithic/models/management_operation_transaction.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::ManagementOperations#create
     class ManagementOperationTransaction < Lithic::BaseModel
       # @!attribute token
       #
@@ -108,6 +109,7 @@ module Lithic
 
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
+      # @see Lithic::Models::ManagementOperationTransaction#category
       module Category
         extend Lithic::Enum
 
@@ -123,6 +125,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::ManagementOperationTransaction#direction
       module Direction
         extend Lithic::Enum
 
@@ -214,6 +217,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::ManagementOperationTransaction::Event#result
         module Result
           extend Lithic::Enum
 
@@ -227,6 +231,7 @@ module Lithic
           #   def self.values; end
         end
 
+        # @see Lithic::Models::ManagementOperationTransaction::Event#type
         module Type
           extend Lithic::Enum
 
@@ -254,6 +259,7 @@ module Lithic
         end
       end
 
+      # @see Lithic::Models::ManagementOperationTransaction#result
       module Result
         extend Lithic::Enum
 
@@ -267,6 +273,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::ManagementOperationTransaction#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/message_attempt.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Events#list_attempts
     class MessageAttempt < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier.
@@ -81,6 +82,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # The status of the event attempt.
+      #
+      # @see Lithic::Models::MessageAttempt#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/payment.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Payments#retrieve
     class Payment < Lithic::BaseModel
       # @!attribute token
       #   Globally unique identifier.
@@ -161,6 +162,8 @@ module Lithic
       # def initialize: (Hash | Lithic::BaseModel) -> void
 
       # Payment category
+      #
+      # @see Lithic::Models::Payment#category
       module Category
         extend Lithic::Enum
 
@@ -173,6 +176,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::Payment#direction
       module Direction
         extend Lithic::Enum
 
@@ -262,6 +266,8 @@ module Lithic
 
         # APPROVED financial events were successful while DECLINED financial events were
         #   declined by user, Lithic, or the network.
+        #
+        # @see Lithic::Models::Payment::Event#result
         module Result
           extend Lithic::Enum
 
@@ -295,6 +301,8 @@ module Lithic
         #     balance.
         #   - `ACH_RETURN_SETTLED` - ACH receipt return settled by the Receiving Depository
         #     Financial Institution.
+        #
+        # @see Lithic::Models::Payment::Event#type
         module Type
           extend Lithic::Enum
 
@@ -335,6 +343,7 @@ module Lithic
         end
       end
 
+      # @see Lithic::Models::Payment#method_
       module Method
         extend Lithic::Enum
 
@@ -348,6 +357,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::Payment#method_attributes
       class MethodAttributes < Lithic::BaseModel
         # @!attribute company_id
         #
@@ -391,6 +401,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::Payment::MethodAttributes#sec_code
         module SecCode
           extend Lithic::Enum
 
@@ -408,6 +419,8 @@ module Lithic
 
       # APPROVED payments were successful while DECLINED payments were declined by
       #   Lithic or returned.
+      #
+      # @see Lithic::Models::Payment#result
       module Result
         extend Lithic::Enum
 
@@ -421,6 +434,7 @@ module Lithic
         #   def self.values; end
       end
 
+      # @see Lithic::Models::Payment#source
       module Source
         extend Lithic::Enum
 
@@ -441,6 +455,8 @@ module Lithic
       #     (origination debit).
       #   - `RETURNED` - The payment has been returned.
       #   - `SETTLED` - The payment is completed.
+      #
+      # @see Lithic::Models::Payment#status
       module Status
         extend Lithic::Enum
 

data/lib/lithic/models/payment_create_params.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Payments#create
     class PaymentCreateParams < Lithic::BaseModel
       # @!parse
       #   extend Lithic::Type::RequestParameters::Converter
@@ -122,6 +123,7 @@ module Lithic
 
         # def initialize: (Hash | Lithic::BaseModel) -> void
 
+        # @see Lithic::Models::PaymentCreateParams::MethodAttributes#sec_code
         module SecCode
           extend Lithic::Enum
 

data/lib/lithic/models/payment_create_response.rb

@@ -2,6 +2,7 @@
 
 module Lithic
   module Models
+    # @see Lithic::Resources::Payments#create
     class PaymentCreateResponse < Lithic::Models::Payment
       # @!attribute [r] balance
       #   Balance