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

data/lib/lithic/resources/book_transfers.rb

@@ -6,31 +6,21 @@ module Lithic
       # Book transfer funds between two financial accounts or between a financial
       #   account and card
       #
-      # @param params [Lithic::Models::BookTransferCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
-      #     This should always be a positive value.
-      #
-      #   @option params [Symbol, Lithic::Models::BookTransferCreateParams::Category] :category Category of the book transfer
-      #
-      #   @option params [String] :from_financial_account_token Globally unique identifier for the financial account or card that will send the
-      #     funds. Accepted type dependent on the program's use case.
-      #
-      #   @option params [String] :subtype The program specific subtype code for the specified category/type.
-      #
-      #   @option params [String] :to_financial_account_token Globally unique identifier for the financial account or card that will receive
-      #     the funds. Accepted type dependent on the program's use case.
-      #
-      #   @option params [Symbol, Lithic::Models::BookTransferCreateParams::Type] :type Type of book_transfer
-      #
-      #   @option params [String] :token Customer-provided token that will serve as an idempotency token. This token will
-      #     become the transaction token.
-      #
-      #   @option params [String] :memo Optional descriptor for the transfer.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, memo: nil, request_options: {})
+      #
+      # @param amount [Integer]
+      # @param category [Symbol, Lithic::Models::BookTransferCreateParams::Category]
+      # @param from_financial_account_token [String]
+      # @param subtype [String]
+      # @param to_financial_account_token [String]
+      # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type]
+      # @param token [String]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]
+      #
+      # @see Lithic::Models::BookTransferCreateParams
       def create(params)
         parsed, options = Lithic::Models::BookTransferCreateParams.dump_request(params)
         @client.request(
@@ -44,13 +34,14 @@ module Lithic
 
       # Get book transfer by token
       #
-      # @param book_transfer_token [String] Id of the book transfer to retrieve
+      # @overload retrieve(book_transfer_token, request_options: {})
       #
-      # @param params [Lithic::Models::BookTransferRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param book_transfer_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]
+      #
+      # @see Lithic::Models::BookTransferRetrieveParams
       def retrieve(book_transfer_token, params = {})
         @client.request(
           method: :get,
@@ -62,38 +53,24 @@ module Lithic
 
       # List book transfers
       #
-      # @param params [Lithic::Models::BookTransferListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_token
-      #
-      #   @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 [String] :business_account_token
-      #
-      #   @option params [Symbol, Lithic::Models::BookTransferListParams::Category] :category Book Transfer category to be returned.
-      #
-      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @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.
-      #
-      #   @option params [String] :financial_account_token Globally unique identifier for the financial account or card that will send the
-      #     funds. Accepted type dependent on the program's use case.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
-      #
-      #   @option params [Symbol, Lithic::Models::BookTransferListParams::Result] :result Book transfer 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::BookTransferListParams::Status] :status Book transfer status to be returned.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @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 business_account_token [String]
+      # @param category [Symbol, Lithic::Models::BookTransferListParams::Category]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param financial_account_token [String]
+      # @param page_size [Integer]
+      # @param result [Symbol, Lithic::Models::BookTransferListParams::Result]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::BookTransferListParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::BookTransferResponse>]
+      #
+      # @see Lithic::Models::BookTransferListParams
       def list(params = {})
         parsed, options = Lithic::Models::BookTransferListParams.dump_request(params)
         @client.request(
@@ -108,15 +85,15 @@ module Lithic
 
       # Reverse a book transfer
       #
-      # @param book_transfer_token [String] Id of the book transfer to retrieve
-      #
-      # @param params [Lithic::Models::BookTransferReverseParams, Hash{Symbol=>Object}] .
+      # @overload reverse(book_transfer_token, memo: nil, request_options: {})
       #
-      #   @option params [String] :memo Optional descriptor for the reversal.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param book_transfer_token [String]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]
+      #
+      # @see Lithic::Models::BookTransferReverseParams
       def reverse(book_transfer_token, params = {})
         parsed, options = Lithic::Models::BookTransferReverseParams.dump_request(params)
         @client.request(
@@ -128,6 +105,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/card_programs.rb

@@ -5,13 +5,14 @@ module Lithic
     class CardPrograms
       # Get card program.
       #
-      # @param card_program_token [String] Globally unique identifier for the card program.
+      # @overload retrieve(card_program_token, request_options: {})
       #
-      # @param params [Lithic::Models::CardProgramRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param card_program_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::CardProgram]
+      #
+      # @see Lithic::Models::CardProgramRetrieveParams
       def retrieve(card_program_token, params = {})
         @client.request(
           method: :get,
@@ -23,19 +24,16 @@ module Lithic
 
       # List card programs.
       #
-      # @param params [Lithic::Models::CardProgramListParams, Hash{Symbol=>Object}] .
-      #
-      #   @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.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
+      # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      #   @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
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::CardProgram>]
+      #
+      # @see Lithic::Models::CardProgramListParams
       def list(params = {})
         parsed, options = Lithic::Models::CardProgramListParams.dump_request(params)
         @client.request(
@@ -48,6 +46,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/cards/aggregate_balances.rb

@@ -6,15 +6,15 @@ module Lithic
       class AggregateBalances
         # Get the aggregated card balance across all end-user accounts.
         #
-        # @param params [Lithic::Models::Cards::AggregateBalanceListParams, Hash{Symbol=>Object}] .
+        # @overload list(account_token: nil, business_account_token: nil, request_options: {})
         #
-        #   @option params [String] :account_token Cardholder to retrieve aggregate balances for.
-        #
-        #   @option params [String] :business_account_token Business to retrieve aggregate balances for.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param account_token [String]
+        # @param business_account_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::SinglePage<Lithic::Models::Cards::AggregateBalanceListResponse>]
+        #
+        # @see Lithic::Models::Cards::AggregateBalanceListParams
         def list(params = {})
           parsed, options = Lithic::Models::Cards::AggregateBalanceListParams.dump_request(params)
           @client.request(
@@ -27,6 +27,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -6,19 +6,16 @@ module Lithic
       class Balances
         # Get the balances for a given card.
         #
-        # @param card_token [String]
-        #
-        # @param params [Lithic::Models::Cards::BalanceListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Time] :balance_date UTC date of the balance to retrieve. Defaults to latest available balance
-        #
-        #   @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
+        # @overload list(card_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param card_token [String]
+        # @param balance_date [Time]
+        # @param last_transaction_event_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::SinglePage<Lithic::Models::Cards::BalanceListResponse>]
+        #
+        # @see Lithic::Models::Cards::BalanceListParams
         def list(card_token, params = {})
           parsed, options = Lithic::Models::Cards::BalanceListParams.dump_request(params)
           @client.request(
@@ -31,6 +28,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

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

@@ -6,15 +6,15 @@ module Lithic
       class FinancialTransactions
         # Get the card financial transaction for the provided token.
         #
-        # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
+        # @overload retrieve(financial_transaction_token, card_token:, request_options: {})
         #
-        # @param params [Lithic::Models::Cards::FinancialTransactionRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :card_token
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param financial_transaction_token [String]
+        # @param card_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialTransaction]
+        #
+        # @see Lithic::Models::Cards::FinancialTransactionRetrieveParams
         def retrieve(financial_transaction_token, params)
           parsed, options = Lithic::Models::Cards::FinancialTransactionRetrieveParams.dump_request(params)
           card_token =
@@ -31,31 +31,21 @@ module Lithic
 
         # List the financial transactions for a given card.
         #
-        # @param card_token [String]
-        #
-        # @param params [Lithic::Models::Cards::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::Cards::FinancialTransactionListParams::Category] :category Financial Transaction category to be returned.
+        # @overload list(card_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.
-        #
-        #   @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.
-        #
-        #   @option params [Symbol, Lithic::Models::Cards::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::Cards::FinancialTransactionListParams::Status] :status Financial Transaction status to be returned.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param card_token [String]
+        # @param begin_ [Time]
+        # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
+        # @param end_ [Time]
+        # @param ending_before [String]
+        # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
+        # @param starting_after [String]
+        # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::SinglePage<Lithic::Models::FinancialTransaction>]
+        #
+        # @see Lithic::Models::Cards::FinancialTransactionListParams
         def list(card_token, params = {})
           parsed, options = Lithic::Models::Cards::FinancialTransactionListParams.dump_request(params)
           @client.request(
@@ -68,6 +58,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client