lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/lithic/resources/external_payments.rb

@@ -36,7 +36,8 @@ module Lithic
       #
       # @overload retrieve(external_payment_token, request_options: {})
       #
-      # @param external_payment_token [String]
+      # @param external_payment_token [String] Globally unique identifier for the external payment
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
@@ -51,20 +52,38 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::ExternalPaymentListParams} for more details.
+      #
       # List external payments
       #
       # @overload list(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]
+      # @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}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalPayment>]
@@ -86,9 +105,12 @@ module Lithic
       #
       # @overload cancel(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      # @param external_payment_token [String]
+      # @param external_payment_token [String] Globally unique identifier for the external payment
+      #
       # @param effective_date [Date]
+      #
       # @param memo [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
@@ -109,9 +131,12 @@ module Lithic
       #
       # @overload release(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      # @param external_payment_token [String]
+      # @param external_payment_token [String] Globally unique identifier for the external payment
+      #
       # @param effective_date [Date]
+      #
       # @param memo [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
@@ -132,9 +157,12 @@ module Lithic
       #
       # @overload reverse(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      # @param external_payment_token [String]
+      # @param external_payment_token [String] Globally unique identifier for the external payment
+      #
       # @param effective_date [Date]
+      #
       # @param memo [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
@@ -155,10 +183,14 @@ module Lithic
       #
       # @overload settle(external_payment_token, effective_date:, memo: nil, progress_to: nil, request_options: {})
       #
-      # @param external_payment_token [String]
+      # @param external_payment_token [String] Globally unique identifier for the external payment
+      #
       # @param effective_date [Date]
+      #
       # @param memo [String]
+      #
       # @param progress_to [Symbol, Lithic::Models::ExternalPaymentSettleParams::ProgressTo]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]

data/lib/lithic/resources/financial_accounts/balances.rb

@@ -4,13 +4,19 @@ module Lithic
   module Resources
     class FinancialAccounts
       class Balances
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::BalanceListParams} for more details.
+        #
         # Get the balances for a given financial account.
         #
         # @overload list(financial_account_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
         #
-        # @param financial_account_token [String]
-        # @param balance_date [Time]
-        # @param last_transaction_event_token [String]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @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}, nil]
         #
         # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccounts::BalanceListResponse>]

data/lib/lithic/resources/financial_accounts/credit_configuration.rb

@@ -8,7 +8,8 @@ module Lithic
         #
         # @overload retrieve(financial_account_token, request_options: {})
         #
-        # @param financial_account_token [String]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]
@@ -27,11 +28,16 @@ module Lithic
         #
         # @overload update(financial_account_token, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {})
         #
-        # @param financial_account_token [String]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         # @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}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]

data/lib/lithic/resources/financial_accounts/financial_transactions.rb

@@ -8,8 +8,10 @@ module Lithic
         #
         # @overload retrieve(financial_transaction_token, financial_account_token:, request_options: {})
         #
-        # @param financial_transaction_token [String]
-        # @param financial_account_token [String]
+        # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialTransaction]
@@ -34,18 +36,34 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::FinancialTransactionListParams} for more
+        # details.
+        #
         # List the financial transactions for a given financial account.
         #
         # @overload list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
         #
-        # @param financial_account_token [String]
-        # @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]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @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}, nil]
         #
         # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]

data/lib/lithic/resources/financial_accounts/loan_tapes.rb

@@ -8,8 +8,10 @@ module Lithic
         #
         # @overload retrieve(loan_tape_token, financial_account_token:, request_options: {})
         #
-        # @param loan_tape_token [String]
-        # @param financial_account_token [String]
+        # @param loan_tape_token [String] Globally unique identifier for loan tape.
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::LoanTape]
@@ -29,16 +31,29 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::LoanTapeListParams} for more details.
+        #
         # List the loan tapes for a given financial account.
         #
         # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        # @param financial_account_token [String]
-        # @param begin_ [Date]
-        # @param end_ [Date]
-        # @param ending_before [String]
-        # @param page_size [Integer]
-        # @param starting_after [String]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
+        # ...
+        #
+        # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
+        # ...
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        # ...
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::LoanTape>]

data/lib/lithic/resources/financial_accounts/statements/line_items.rb

@@ -5,15 +5,26 @@ module Lithic
     class FinancialAccounts
       class Statements
         class LineItems
+          # Some parameter documentations has been truncated, see
+          # {Lithic::Models::FinancialAccounts::Statements::LineItemListParams} for more
+          # details.
+          #
           # List the line items for a given statement within a given financial account.
           #
           # @overload list(statement_token, financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
           #
-          # @param statement_token [String]
-          # @param financial_account_token [String]
-          # @param ending_before [String]
-          # @param page_size [Integer]
-          # @param starting_after [String]
+          # @param statement_token [String] Path param: Globally unique identifier for statements.
+          #
+          # @param financial_account_token [String] Path param: Globally unique identifier for financial account.
+          #
+          # @param ending_before [String] Query param: A cursor representing an item's token before which a page of result
+          # ...
+          #
+          # @param page_size [Integer] Query param: Page size (for pagination).
+          #
+          # @param starting_after [String] Query param: A cursor representing an item's token after which a page of results
+          # ...
+          #
           # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]

data/lib/lithic/resources/financial_accounts/statements.rb

@@ -11,8 +11,10 @@ module Lithic
         #
         # @overload retrieve(statement_token, financial_account_token:, request_options: {})
         #
-        # @param statement_token [String]
-        # @param financial_account_token [String]
+        # @param statement_token [String] Globally unique identifier for statements.
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::Statement]
@@ -32,17 +34,31 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
+        #
         # List the statements for a given financial account.
         #
         # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        # @param financial_account_token [String]
-        # @param begin_ [Date]
-        # @param end_ [Date]
-        # @param ending_before [String]
-        # @param include_initial_statements [Boolean]
-        # @param page_size [Integer]
-        # @param starting_after [String]
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
+        # ...
+        #
+        # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
+        # ...
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        # ...
+        #
+        # @param include_initial_statements [Boolean] Whether to include the initial statement. It is not included by default.
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statement>]

data/lib/lithic/resources/financial_accounts.rb

@@ -22,11 +22,16 @@ module Lithic
       #
       # @overload create(nickname:, type:, account_token: nil, is_for_benefit_of: nil, idempotency_key: nil, request_options: {})
       #
-      # @param nickname [String]
-      # @param type [Symbol, Lithic::Models::FinancialAccountCreateParams::Type]
-      # @param account_token [String]
-      # @param is_for_benefit_of [Boolean]
-      # @param idempotency_key [String]
+      # @param nickname [String] Body param:
+      #
+      # @param type [Symbol, Lithic::Models::FinancialAccountCreateParams::Type] Body param:
+      #
+      # @param account_token [String] Body param:
+      #
+      # @param is_for_benefit_of [Boolean] Body param:
+      #
+      # @param idempotency_key [String] Header param:
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]
@@ -91,9 +96,12 @@ module Lithic
       #
       # @overload list(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}, nil]
       #
       # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccount>]
@@ -115,9 +123,12 @@ module Lithic
       #
       # @overload update_status(financial_account_token, status:, substatus:, request_options: {})
       #
-      # @param financial_account_token [String]
-      # @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status]
-      # @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil]
+      # @param financial_account_token [String] Globally unique identifier for financial account.
+      #
+      # @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}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]

data/lib/lithic/resources/management_operations.rb

@@ -37,7 +37,8 @@ module Lithic
       #
       # @overload retrieve(management_operation_token, request_options: {})
       #
-      # @param management_operation_token [String]
+      # @param management_operation_token [String] Globally unique identifier for the management operation
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]
@@ -52,19 +53,36 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::ManagementOperationListParams} for more details.
+      #
       # List management operations
       #
       # @overload list(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
       #
-      # @param begin_ [Time]
+      # @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::ManagementOperationListParams::Category]
-      # @param end_ [Time]
-      # @param ending_before [String]
-      # @param financial_account_token [String]
-      # @param page_size [Integer]
-      # @param starting_after [String]
-      # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status]
+      #
+      # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category] Management operation 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. Accepted type dependent on
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
+      # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status] Management operation status to be returned.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::ManagementOperationTransaction>]
@@ -86,9 +104,12 @@ module Lithic
       #
       # @overload reverse(management_operation_token, effective_date:, memo: nil, request_options: {})
       #
-      # @param management_operation_token [String]
+      # @param management_operation_token [String] Globally unique identifier for the management operation
+      #
       # @param effective_date [Date]
+      #
       # @param memo [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]

data/lib/lithic/resources/payments.rb

@@ -3,19 +3,32 @@
 module Lithic
   module Resources
     class Payments
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::PaymentCreateParams} for more details.
+      #
       # Initiates a payment between a financial account and an external bank account.
       #
       # @overload create(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, memo: nil, user_defined_id: nil, request_options: {})
       #
       # @param amount [Integer]
+      #
       # @param external_bank_account_token [String]
+      #
       # @param financial_account_token [String]
+      #
       # @param method_ [Symbol, Lithic::Models::PaymentCreateParams::Method]
+      #
       # @param method_attributes [Lithic::Models::PaymentCreateParams::MethodAttributes]
+      #
       # @param type [Symbol, Lithic::Models::PaymentCreateParams::Type]
-      # @param token [String]
+      #
+      # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      # ...
+      #
       # @param memo [String]
+      #
       # @param user_defined_id [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentCreateResponse]
@@ -51,21 +64,39 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::PaymentListParams} for more details.
+      #
       # List all the payments for the provided search criteria.
       #
       # @overload list(account_token: nil, 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 account_token [String]
-      # @param begin_ [Time]
+      #
+      # @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::PaymentListParams::Category]
-      # @param end_ [Time]
-      # @param ending_before [String]
+      #
+      # @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]
-      # @param page_size [Integer]
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
       # @param result [Symbol, Lithic::Models::PaymentListParams::Result]
-      # @param starting_after [String]
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param status [Symbol, Lithic::Models::PaymentListParams::Status]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::Payment>]
@@ -107,9 +138,13 @@ module Lithic
       # @overload simulate_action(payment_token, event_type:, decline_reason: nil, return_reason_code: nil, request_options: {})
       #
       # @param payment_token [String]
-      # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType]
-      # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason]
-      # @param return_reason_code [String]
+      #
+      # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] Event Type
+      #
+      # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason] Decline reason
+      #
+      # @param return_reason_code [String] Return Reason Code
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateActionResponse]
@@ -126,15 +161,24 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::PaymentSimulateReceiptParams} for more details.
+      #
       # Simulates a receipt of a Payment.
       #
       # @overload simulate_receipt(token:, amount:, financial_account_token:, receipt_type:, memo: nil, request_options: {})
       #
-      # @param token [String]
-      # @param amount [Integer]
-      # @param financial_account_token [String]
-      # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType]
-      # @param memo [String]
+      # @param token [String] Customer-generated payment token used to uniquely identify the simulated payment
+      # ...
+      #
+      # @param amount [Integer] Amount
+      #
+      # @param financial_account_token [String] Financial Account Token
+      #
+      # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType] Receipt Type
+      #
+      # @param memo [String] Memo
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReceiptResponse]
@@ -155,7 +199,8 @@ module Lithic
       #
       # @overload simulate_release(payment_token:, request_options: {})
       #
-      # @param payment_token [String]
+      # @param payment_token [String] Payment Token
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReleaseResponse]
@@ -176,8 +221,10 @@ module Lithic
       #
       # @overload simulate_return(payment_token:, return_reason_code: nil, request_options: {})
       #
-      # @param payment_token [String]
-      # @param return_reason_code [String]
+      # @param payment_token [String] Payment Token
+      #
+      # @param return_reason_code [String] Return Reason Code
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReturnResponse]