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

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

@@ -6,31 +6,30 @@ module Lithic
       class Balances
         # Get the balances for a given financial account.
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
+        # @overload list(financial_account_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
         #
-        # @param params [Lithic::Models::FinancialAccounts::BalanceListParams, Hash{Symbol=>Object}] .
+        # @param financial_account_token [String]
+        # @param balance_date [Time]
+        # @param last_transaction_event_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [Time] :balance_date UTC date of the balance to retrieve. Defaults to latest available balance
+        # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccounts::BalanceListResponse>]
         #
-        #   @option params [String] :last_transaction_event_token Balance after a given financial event occured. For example, passing the
-        #     event_token of a $5 CARD_CLEARING financial event will return a balance
-        #     decreased by $5
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [Lithic::SinglePage<Lithic::Models::FinancialAccounts::BalanceListResponse>]
+        # @see Lithic::Models::FinancialAccounts::BalanceListParams
         def list(financial_account_token, params = {})
           parsed, options = Lithic::Models::FinancialAccounts::BalanceListParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["v1/financial_accounts/%1$s/balances", financial_account_token],
             query: parsed,
-            page: Lithic::SinglePage,
+            page: Lithic::Internal::SinglePage,
             model: Lithic::Models::FinancialAccounts::BalanceListResponse,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -6,13 +6,14 @@ module Lithic
       class CreditConfiguration
         # Get an Account's credit configuration
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
+        # @overload retrieve(financial_account_token, request_options: {})
         #
-        # @param params [Lithic::Models::FinancialAccounts::CreditConfigurationRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param financial_account_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]
+        #
+        # @see Lithic::Models::FinancialAccounts::CreditConfigurationRetrieveParams
         def retrieve(financial_account_token, params = {})
           @client.request(
             method: :get,
@@ -24,21 +25,18 @@ module Lithic
 
         # Update an account's credit configuration
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
-        #
-        # @param params [Lithic::Models::FinancialAccounts::CreditConfigurationUpdateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Integer] :credit_limit
-        #
-        #   @option params [String] :credit_product_token Globally unique identifier for the credit product
+        # @overload update(financial_account_token, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {})
         #
-        #   @option params [String] :external_bank_account_token
-        #
-        #   @option params [String] :tier Tier to assign to a financial account
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param financial_account_token [String]
+        # @param credit_limit [Integer]
+        # @param credit_product_token [String]
+        # @param external_bank_account_token [String]
+        # @param tier [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]
+        #
+        # @see Lithic::Models::FinancialAccounts::CreditConfigurationUpdateParams
         def update(financial_account_token, params = {})
           parsed, options = Lithic::Models::FinancialAccounts::CreditConfigurationUpdateParams.dump_request(params)
           @client.request(
@@ -50,6 +48,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -6,15 +6,15 @@ module Lithic
       class FinancialTransactions
         # Get the financial transaction for the provided token.
         #
-        # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
+        # @overload retrieve(financial_transaction_token, financial_account_token:, request_options: {})
         #
-        # @param params [Lithic::Models::FinancialAccounts::FinancialTransactionRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :financial_account_token Globally unique identifier for financial account.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param financial_transaction_token [String]
+        # @param financial_account_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialTransaction]
+        #
+        # @see Lithic::Models::FinancialAccounts::FinancialTransactionRetrieveParams
         def retrieve(financial_transaction_token, params)
           parsed, options =
             Lithic::Models::FinancialAccounts::FinancialTransactionRetrieveParams.dump_request(params)
@@ -36,43 +36,35 @@ module Lithic
 
         # List the financial transactions for a given financial account.
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
-        #
-        # @param params [Lithic::Models::FinancialAccounts::FinancialTransactionListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
-        #     will be included. UTC time zone.
-        #
-        #   @option params [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category] :category Financial Transaction category to be returned.
+        # @overload list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
         #
-        #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
-        #     will be included. UTC time zone.
+        # @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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-        #     Used to retrieve the previous page of results before this item.
+        # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]
         #
-        #   @option params [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result] :result Financial Transaction result to be returned.
-        #
-        #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-        #     begin. Used to retrieve the next page of results after this item.
-        #
-        #   @option params [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status] :status Financial Transaction status to be returned.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [Lithic::SinglePage<Lithic::Models::FinancialTransaction>]
+        # @see Lithic::Models::FinancialAccounts::FinancialTransactionListParams
         def list(financial_account_token, params = {})
           parsed, options = Lithic::Models::FinancialAccounts::FinancialTransactionListParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["v1/financial_accounts/%1$s/financial_transactions", financial_account_token],
             query: parsed,
-            page: Lithic::SinglePage,
+            page: Lithic::Internal::SinglePage,
             model: Lithic::Models::FinancialTransaction,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -6,15 +6,15 @@ module Lithic
       class LoanTapes
         # Get a specific loan tape for a given financial account.
         #
-        # @param loan_tape_token [String] Globally unique identifier for loan tape.
+        # @overload retrieve(loan_tape_token, financial_account_token:, request_options: {})
         #
-        # @param params [Lithic::Models::FinancialAccounts::LoanTapeRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :financial_account_token Globally unique identifier for financial account.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param loan_tape_token [String]
+        # @param financial_account_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::LoanTape]
+        #
+        # @see Lithic::Models::FinancialAccounts::LoanTapeRetrieveParams
         def retrieve(loan_tape_token, params)
           parsed, options = Lithic::Models::FinancialAccounts::LoanTapeRetrieveParams.dump_request(params)
           financial_account_token =
@@ -31,39 +31,33 @@ module Lithic
 
         # List the loan tapes for a given financial account.
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
-        #
-        # @param params [Lithic::Models::FinancialAccounts::LoanTapeListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Date] :begin_ Date string in RFC 3339 format. Only entries created after the specified date
-        #     will be included.
+        # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        #   @option params [Date] :end_ Date string in RFC 3339 format. Only entries created before the specified date
-        #     will be included.
+        # @param financial_account_token [String]
+        # @param begin_ [Date]
+        # @param end_ [Date]
+        # @param ending_before [String]
+        # @param page_size [Integer]
+        # @param starting_after [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-        #     Used to retrieve the previous page of results before this item.
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::LoanTape>]
         #
-        #   @option params [Integer] :page_size Page size (for pagination).
-        #
-        #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-        #     begin. Used to retrieve the next page of results after this item.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [Lithic::CursorPage<Lithic::Models::FinancialAccounts::LoanTape>]
+        # @see Lithic::Models::FinancialAccounts::LoanTapeListParams
         def list(financial_account_token, params = {})
           parsed, options = Lithic::Models::FinancialAccounts::LoanTapeListParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["v1/financial_accounts/%1$s/loan_tapes", financial_account_token],
             query: parsed,
-            page: Lithic::CursorPage,
+            page: Lithic::Internal::CursorPage,
             model: Lithic::Models::FinancialAccounts::LoanTape,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -7,24 +7,18 @@ module Lithic
         class LineItems
           # List the line items for a given statement within a given financial account.
           #
-          # @param statement_token [String] Path param: Globally unique identifier for statements.
+          # @overload list(statement_token, financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
           #
-          # @param params [Lithic::Models::FinancialAccounts::Statements::LineItemListParams, Hash{Symbol=>Object}] .
+          # @param statement_token [String]
+          # @param financial_account_token [String]
+          # @param ending_before [String]
+          # @param page_size [Integer]
+          # @param starting_after [String]
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          #   @option params [String] :financial_account_token Path param: Globally unique identifier for financial account.
+          # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]
           #
-          #   @option params [String] :ending_before Query param: A cursor representing an item's token before which a page of
-          #     results should end. Used to retrieve the previous page of results before this
-          #     item.
-          #
-          #   @option params [Integer] :page_size Query param: Page size (for pagination).
-          #
-          #   @option params [String] :starting_after Query param: A cursor representing an item's token after which a page of results
-          #     should begin. Used to retrieve the next page of results after this item.
-          #
-          #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-          #
-          # @return [Lithic::CursorPage<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]
+          # @see Lithic::Models::FinancialAccounts::Statements::LineItemListParams
           def list(statement_token, params)
             parsed, options = Lithic::Models::FinancialAccounts::Statements::LineItemListParams.dump_request(params)
             financial_account_token =
@@ -39,12 +33,14 @@ module Lithic
                 statement_token
               ],
               query: parsed,
-              page: Lithic::CursorPage,
+              page: Lithic::Internal::CursorPage,
               model: Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data,
               options: options
             )
           end
 
+          # @api private
+          #
           # @param client [Lithic::Client]
           def initialize(client:)
             @client = client

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

@@ -9,15 +9,15 @@ module Lithic
 
         # Get a specific statement for a given financial account.
         #
-        # @param statement_token [String] Globally unique identifier for statements.
+        # @overload retrieve(statement_token, financial_account_token:, request_options: {})
         #
-        # @param params [Lithic::Models::FinancialAccounts::StatementRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :financial_account_token Globally unique identifier for financial account.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param statement_token [String]
+        # @param financial_account_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialAccounts::Statement]
+        #
+        # @see Lithic::Models::FinancialAccounts::StatementRetrieveParams
         def retrieve(statement_token, params)
           parsed, options = Lithic::Models::FinancialAccounts::StatementRetrieveParams.dump_request(params)
           financial_account_token =
@@ -34,41 +34,34 @@ module Lithic
 
         # List the statements for a given financial account.
         #
-        # @param financial_account_token [String] Globally unique identifier for financial account.
-        #
-        # @param params [Lithic::Models::FinancialAccounts::StatementListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Date] :begin_ Date string in RFC 3339 format. Only entries created after the specified date
-        #     will be included.
+        # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        #   @option params [Date] :end_ Date string in RFC 3339 format. Only entries created before the specified date
-        #     will be included.
+        # @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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [String] :ending_before A cursor representing an item's token before which a page of results should end.
-        #     Used to retrieve the previous page of results before this item.
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statement>]
         #
-        #   @option params [Boolean] :include_initial_statements Whether to include the initial statement. It is not included by default.
-        #
-        #   @option params [Integer] :page_size Page size (for pagination).
-        #
-        #   @option params [String] :starting_after A cursor representing an item's token after which a page of results should
-        #     begin. Used to retrieve the next page of results after this item.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [Lithic::CursorPage<Lithic::Models::FinancialAccounts::Statement>]
+        # @see Lithic::Models::FinancialAccounts::StatementListParams
         def list(financial_account_token, params = {})
           parsed, options = Lithic::Models::FinancialAccounts::StatementListParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["v1/financial_accounts/%1$s/statements", financial_account_token],
             query: parsed,
-            page: Lithic::CursorPage,
+            page: Lithic::Internal::CursorPage,
             model: Lithic::Models::FinancialAccounts::Statement,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/financial_accounts.rb

@@ -20,21 +20,18 @@ module Lithic
 
       # Create a new financial account
       #
-      # @param params [Lithic::Models::FinancialAccountCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(nickname:, type:, account_token: nil, is_for_benefit_of: nil, idempotency_key: nil, request_options: {})
       #
-      #   @option params [String] :nickname Body param:
-      #
-      #   @option params [Symbol, Lithic::Models::FinancialAccountCreateParams::Type] :type Body param:
-      #
-      #   @option params [String] :account_token Body param:
-      #
-      #   @option params [Boolean] :is_for_benefit_of Body param:
-      #
-      #   @option params [String] :idempotency_key Header param:
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, 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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]
+      #
+      # @see Lithic::Models::FinancialAccountCreateParams
       def create(params)
         parsed, options = Lithic::Models::FinancialAccountCreateParams.dump_request(params)
         header_params = [:"Idempotency-Key"]
@@ -50,13 +47,14 @@ module Lithic
 
       # Get a financial account
       #
-      # @param financial_account_token [String]
-      #
-      # @param params [Lithic::Models::FinancialAccountRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(financial_account_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param financial_account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]
+      #
+      # @see Lithic::Models::FinancialAccountRetrieveParams
       def retrieve(financial_account_token, params = {})
         @client.request(
           method: :get,
@@ -68,15 +66,15 @@ module Lithic
 
       # Update a financial account
       #
-      # @param financial_account_token [String]
-      #
-      # @param params [Lithic::Models::FinancialAccountUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(financial_account_token, nickname: nil, request_options: {})
       #
-      #   @option params [String] :nickname
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param financial_account_token [String]
+      # @param nickname [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]
+      #
+      # @see Lithic::Models::FinancialAccountUpdateParams
       def update(financial_account_token, params = {})
         parsed, options = Lithic::Models::FinancialAccountUpdateParams.dump_request(params)
         @client.request(
@@ -91,24 +89,23 @@ module Lithic
       # Retrieve information on your financial accounts including routing and account
       #   number.
       #
-      # @param params [Lithic::Models::FinancialAccountListParams, Hash{Symbol=>Object}] .
+      # @overload list(account_token: nil, business_account_token: nil, type: nil, request_options: {})
       #
-      #   @option params [String] :account_token List financial accounts for a given account_token or business_account_token
+      # @param account_token [String]
+      # @param business_account_token [String]
+      # @param type [Symbol, Lithic::Models::FinancialAccountListParams::Type]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :business_account_token List financial accounts for a given business_account_token
+      # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccount>]
       #
-      #   @option params [Symbol, Lithic::Models::FinancialAccountListParams::Type] :type List financial accounts of a given type
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Lithic::SinglePage<Lithic::Models::FinancialAccount>]
+      # @see Lithic::Models::FinancialAccountListParams
       def list(params = {})
         parsed, options = Lithic::Models::FinancialAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/financial_accounts",
           query: parsed,
-          page: Lithic::SinglePage,
+          page: Lithic::Internal::SinglePage,
           model: Lithic::Models::FinancialAccount,
           options: options
         )
@@ -116,17 +113,16 @@ module Lithic
 
       # Update financial account status
       #
-      # @param financial_account_token [String] Globally unique identifier for financial account.
-      #
-      # @param params [Lithic::Models::FinancialAccountUpdateStatusParams, Hash{Symbol=>Object}] .
+      # @overload update_status(financial_account_token, status:, status_change_reason:, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status] :status Status of the financial account
-      #
-      #   @option params [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::StatusChangeReason, nil] :status_change_reason Reason for the financial account status change
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param financial_account_token [String]
+      # @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status]
+      # @param status_change_reason [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::StatusChangeReason, nil]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::FinancialAccount]
+      #
+      # @see Lithic::Models::FinancialAccountUpdateStatusParams
       def update_status(financial_account_token, params)
         parsed, options = Lithic::Models::FinancialAccountUpdateStatusParams.dump_request(params)
         @client.request(
@@ -138,6 +134,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client