lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/lib/lithic/models/external_bank_account_update_response.rb

@@ -150,28 +150,59 @@ module Lithic
       optional :verification_failed_reason, String
 
       # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil)
-      #   @param token [String]
-      #   @param country [String]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param last_four [String]
-      #   @param owner [String]
-      #   @param owner_type [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::OwnerType]
-      #   @param routing_number [String]
-      #   @param state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::State]
-      #   @param type [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::Type]
-      #   @param verification_attempts [Integer]
-      #   @param verification_method [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationMethod]
-      #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState]
-      #   @param account_token [String]
-      #   @param address [Lithic::Models::ExternalBankAccountAddress]
-      #   @param company_id [String]
-      #   @param dob [Date]
-      #   @param doing_business_as [String]
-      #   @param financial_account_token [String]
-      #   @param name [String]
-      #   @param user_defined_id [String]
-      #   @param verification_failed_reason [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::ExternalBankAccountUpdateResponse} for more details.
+      #
+      #   @param token [String] A globally unique identifier for this record of an external bank account associa
+      #   ...
+      #
+      #   @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a
+      #   ...
+      #
+      #   @param created [Time] An ISO 8601 string representing when this funding source was added to the Lithic
+      #   ...
+      #
+      #   @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      #   @param last_four [String] The last 4 digits of the bank account. Derived by Lithic from the account number
+      #   ...
+      #
+      #   @param owner [String] Legal Name of the business or individual who owns the external account. This wil
+      #   ...
+      #
+      #   @param owner_type [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::OwnerType] Owner Type
+      #
+      #   @param routing_number [String] Routing Number
+      #
+      #   @param state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::State] Account State
+      #
+      #   @param type [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::Type] Account Type
+      #
+      #   @param verification_attempts [Integer] The number of attempts at verification
+      #
+      #   @param verification_method [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationMethod] Verification Method
+      #
+      #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState] Verification State
+      #
+      #   @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
+      #   ...
+      #
+      #   @param address [Lithic::Models::ExternalBankAccountAddress] Address
+      #
+      #   @param company_id [String] Optional field that helps identify bank accounts in receipts
+      #
+      #   @param dob [Date] Date of Birth of the Individual that owns the external bank account
+      #
+      #   @param doing_business_as [String] Doing Business As
+      #
+      #   @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
+      #
+      #   @param name [String] The nickname for this External Bank Account
+      #
+      #   @param user_defined_id [String] User Defined ID
+      #
+      #   @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC
+      #   ...
 
       # Owner Type
       #

data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb

@@ -152,28 +152,60 @@ module Lithic
         optional :verification_failed_reason, String
 
         # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil)
-        #   @param token [String]
-        #   @param country [String]
-        #   @param created [Time]
-        #   @param currency [String]
-        #   @param last_four [String]
-        #   @param owner [String]
-        #   @param owner_type [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::OwnerType]
-        #   @param routing_number [String]
-        #   @param state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::State]
-        #   @param type [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::Type]
-        #   @param verification_attempts [Integer]
-        #   @param verification_method [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod]
-        #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState]
-        #   @param account_token [String]
-        #   @param address [Lithic::Models::ExternalBankAccountAddress]
-        #   @param company_id [String]
-        #   @param dob [Date]
-        #   @param doing_business_as [String]
-        #   @param financial_account_token [String]
-        #   @param name [String]
-        #   @param user_defined_id [String]
-        #   @param verification_failed_reason [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse} for more
+        #   details.
+        #
+        #   @param token [String] A globally unique identifier for this record of an external bank account associa
+        #   ...
+        #
+        #   @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a
+        #   ...
+        #
+        #   @param created [Time] An ISO 8601 string representing when this funding source was added to the Lithic
+        #   ...
+        #
+        #   @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code
+        #
+        #   @param last_four [String] The last 4 digits of the bank account. Derived by Lithic from the account number
+        #   ...
+        #
+        #   @param owner [String] Legal Name of the business or individual who owns the external account. This wil
+        #   ...
+        #
+        #   @param owner_type [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::OwnerType] Owner Type
+        #
+        #   @param routing_number [String] Routing Number
+        #
+        #   @param state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::State] Account State
+        #
+        #   @param type [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::Type] Account Type
+        #
+        #   @param verification_attempts [Integer] The number of attempts at verification
+        #
+        #   @param verification_method [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod] Verification Method
+        #
+        #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState] Verification State
+        #
+        #   @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
+        #   ...
+        #
+        #   @param address [Lithic::Models::ExternalBankAccountAddress] Address
+        #
+        #   @param company_id [String] Optional field that helps identify bank accounts in receipts
+        #
+        #   @param dob [Date] Date of Birth of the Individual that owns the external bank account
+        #
+        #   @param doing_business_as [String] Doing Business As
+        #
+        #   @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
+        #
+        #   @param name [String] The nickname for this External Bank Account
+        #
+        #   @param user_defined_id [String] User Defined ID
+        #
+        #   @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC
+        #   ...
 
         # Owner Type
         #

data/lib/lithic/models/external_payment_list_params.rb

@@ -72,16 +72,34 @@ module Lithic
       optional :status, enum: -> { Lithic::Models::ExternalPaymentListParams::Status }
 
       # @!method initialize(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
-      #   @param begin_ [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::ExternalPaymentListParams} for more details.
+      #
+      #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #   ...
+      #
       #   @param business_account_token [String]
-      #   @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category]
-      #   @param end_ [Time]
-      #   @param ending_before [String]
-      #   @param financial_account_token [String]
-      #   @param page_size [Integer]
-      #   @param result [Symbol, Lithic::Models::ExternalPaymentListParams::Result]
-      #   @param starting_after [String]
-      #   @param status [Symbol, Lithic::Models::ExternalPaymentListParams::Status]
+      #
+      #   @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category] External Payment category to be returned.
+      #
+      #   @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      #   ...
+      #
+      #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      #   ...
+      #
+      #   @param financial_account_token [String] Globally unique identifier for the financial account or card that will send the
+      #   ...
+      #
+      #   @param page_size [Integer] Page size (for pagination).
+      #
+      #   @param result [Symbol, Lithic::Models::ExternalPaymentListParams::Result] External Payment result to be returned.
+      #
+      #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      #   ...
+      #
+      #   @param status [Symbol, Lithic::Models::ExternalPaymentListParams::Status] Book transfer status to be returned.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # External Payment category to be returned.

data/lib/lithic/models/financial_account.rb

@@ -69,18 +69,29 @@ module Lithic
       optional :substatus, enum: -> { Lithic::Models::FinancialAccount::Substatus }, nil?: true
 
       # @!method initialize(token:, account_token:, created:, credit_configuration:, is_for_benefit_of:, nickname:, status:, type:, updated:, account_number: nil, routing_number: nil, substatus: nil)
-      #   @param token [String]
+      #   @param token [String] Globally unique identifier for the account
+      #
       #   @param account_token [String, nil]
+      #
       #   @param created [Time]
+      #
       #   @param credit_configuration [Lithic::Models::FinancialAccount::CreditConfiguration, nil]
-      #   @param is_for_benefit_of [Boolean]
+      #
+      #   @param is_for_benefit_of [Boolean] Whether financial account is for the benefit of another entity
+      #
       #   @param nickname [String, nil]
-      #   @param status [Symbol, Lithic::Models::FinancialAccount::Status]
+      #
+      #   @param status [Symbol, Lithic::Models::FinancialAccount::Status] Status of the financial account
+      #
       #   @param type [Symbol, Lithic::Models::FinancialAccount::Type]
+      #
       #   @param updated [Time]
+      #
       #   @param account_number [String, nil]
+      #
       #   @param routing_number [String, nil]
-      #   @param substatus [Symbol, Lithic::Models::FinancialAccount::Substatus, nil]
+      #
+      #   @param substatus [Symbol, Lithic::Models::FinancialAccount::Substatus, nil] Substatus for the financial account
 
       # @see Lithic::Models::FinancialAccount#credit_configuration
       class CreditConfiguration < Lithic::Internal::Type::BaseModel
@@ -128,13 +139,19 @@ module Lithic
         required :tier, String, nil?: true
 
         # @!method initialize(charged_off_reason:, credit_limit:, credit_product_token:, external_bank_account_token:, financial_account_state:, is_spend_blocked:, tier:)
-        #   @param charged_off_reason [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::ChargedOffReason, nil]
+        #   @param charged_off_reason [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::ChargedOffReason, nil] Reason for the financial account being marked as Charged Off
+        #
         #   @param credit_limit [Integer, nil]
-        #   @param credit_product_token [String, nil]
+        #
+        #   @param credit_product_token [String, nil] Globally unique identifier for the credit product
+        #
         #   @param external_bank_account_token [String, nil]
-        #   @param financial_account_state [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::FinancialAccountState, nil]
+        #
+        #   @param financial_account_state [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::FinancialAccountState, nil] State of the financial account
+        #
         #   @param is_spend_blocked [Boolean]
-        #   @param tier [String, nil]
+        #
+        #   @param tier [String, nil] Tier assigned to the financial account
 
         # Reason for the financial account being marked as Charged Off
         #

data/lib/lithic/models/financial_account_list_params.rb

@@ -26,9 +26,12 @@ module Lithic
       optional :type, enum: -> { Lithic::Models::FinancialAccountListParams::Type }
 
       # @!method initialize(account_token: nil, business_account_token: nil, type: nil, request_options: {})
-      #   @param account_token [String]
-      #   @param business_account_token [String]
-      #   @param type [Symbol, Lithic::Models::FinancialAccountListParams::Type]
+      #   @param account_token [String] List financial accounts for a given account_token or business_account_token
+      #
+      #   @param business_account_token [String] List financial accounts for a given business_account_token
+      #
+      #   @param type [Symbol, Lithic::Models::FinancialAccountListParams::Type] List financial accounts of a given type
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # List financial accounts of a given type

data/lib/lithic/models/financial_account_update_status_params.rb

@@ -22,8 +22,10 @@ module Lithic
                nil?: true
 
       # @!method initialize(status:, substatus:, request_options: {})
-      #   @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status]
-      #   @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil]
+      #   @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status] Status of the financial account
+      #
+      #   @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil] Substatus for the financial account
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Status of the financial account

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

@@ -23,8 +23,13 @@ module Lithic
         optional :last_transaction_event_token, String
 
         # @!method initialize(balance_date: nil, last_transaction_event_token: nil, request_options: {})
-        #   @param balance_date [Time]
-        #   @param last_transaction_event_token [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialAccounts::BalanceListParams} for more details.
+        #
+        #   @param balance_date [Time] UTC date of the balance to retrieve. Defaults to latest available balance
+        #
+        #   @param last_transaction_event_token [String] Balance after a given financial event occured. ...
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -70,18 +70,34 @@ module Lithic
         required :updated, Time
 
         # @!method initialize(token:, available_amount:, created:, currency:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, type:, updated:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialAccounts::BalanceListResponse} for more details.
+        #
         #   Balance of a Financial Account
         #
-        #   @param token [String]
-        #   @param available_amount [Integer]
-        #   @param created [Time]
-        #   @param currency [String]
-        #   @param last_transaction_event_token [String]
-        #   @param last_transaction_token [String]
-        #   @param pending_amount [Integer]
-        #   @param total_amount [Integer]
-        #   @param type [Symbol, Lithic::Models::FinancialAccounts::BalanceListResponse::Type]
-        #   @param updated [Time]
+        #   @param token [String] Globally unique identifier for the financial account that holds this balance.
+        #
+        #   @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+        #
+        #   @param created [Time] Date and time for when the balance was first created.
+        #
+        #   @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
+        #
+        #   @param last_transaction_event_token [String] Globally unique identifier for the last financial transaction event that impacte
+        #   ...
+        #
+        #   @param last_transaction_token [String] Globally unique identifier for the last financial transaction that impacted this
+        #   ...
+        #
+        #   @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
+        #   ...
+        #
+        #   @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
+        #   ...
+        #
+        #   @param type [Symbol, Lithic::Models::FinancialAccounts::BalanceListResponse::Type] Type of financial account.
+        #
+        #   @param updated [Time] Date and time for when the balance was last updated.
 
         # Type of financial account.
         #

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

@@ -32,9 +32,13 @@ module Lithic
 
         # @!method initialize(credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {})
         #   @param credit_limit [Integer]
-        #   @param credit_product_token [String]
+        #
+        #   @param credit_product_token [String] Globally unique identifier for the credit product
+        #
         #   @param external_bank_account_token [String]
-        #   @param tier [String]
+        #
+        #   @param tier [String] Tier to assign to a financial account
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -54,14 +54,21 @@ module Lithic
         required :tier, String, nil?: true
 
         # @!method initialize(account_token:, charged_off_reason:, credit_limit:, credit_product_token:, external_bank_account_token:, financial_account_state:, is_spend_blocked:, tier:)
-        #   @param account_token [String]
-        #   @param charged_off_reason [Symbol, Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig::ChargedOffReason, nil]
+        #   @param account_token [String] Globally unique identifier for the account
+        #
+        #   @param charged_off_reason [Symbol, Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig::ChargedOffReason, nil] Reason for the financial account being marked as Charged Off
+        #
         #   @param credit_limit [Integer, nil]
-        #   @param credit_product_token [String, nil]
+        #
+        #   @param credit_product_token [String, nil] Globally unique identifier for the credit product
+        #
         #   @param external_bank_account_token [String, nil]
-        #   @param financial_account_state [Symbol, Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig::FinancialAccountState]
+        #
+        #   @param financial_account_state [Symbol, Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig::FinancialAccountState] State of the financial account
+        #
         #   @param is_spend_blocked [Boolean]
-        #   @param tier [String, nil]
+        #
+        #   @param tier [String, nil] Tier assigned to the financial account
 
         # Reason for the financial account being marked as Charged Off
         #

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

@@ -56,13 +56,28 @@ module Lithic
         optional :status, enum: -> { Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status }
 
         # @!method initialize(begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
-        #   @param begin_ [Time]
-        #   @param category [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category]
-        #   @param end_ [Time]
-        #   @param ending_before [String]
-        #   @param result [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result]
-        #   @param starting_after [String]
-        #   @param status [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialAccounts::FinancialTransactionListParams} for more
+        #   details.
+        #
+        #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        #   ...
+        #
+        #   @param category [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
+        #
+        #   @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        #   ...
+        #
+        #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        #   ...
+        #
+        #   @param result [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
+        #
+        #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        #   ...
+        #
+        #   @param status [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status] Financial Transaction status to be returned.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
         # Financial Transaction category to be returned.