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

data/lib/lithic/resources/events.rb

@@ -8,13 +8,14 @@ module Lithic
 
       # Get an event.
       #
-      # @param event_token [String]
-      #
-      # @param params [Lithic::Models::EventRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(event_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param event_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Event]
+      #
+      # @see Lithic::Models::EventRetrieveParams
       def retrieve(event_token, params = {})
         @client.request(
           method: :get,
@@ -26,36 +27,27 @@ module Lithic
 
       # List all events.
       #
-      # @param params [Lithic::Models::EventListParams, 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 [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 [Array<Symbol, Lithic::Models::EventListParams::EventType>] :event_types Event types to filter events by.
-      #
-      #   @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.
+      # @overload list(begin_: nil, end_: nil, ending_before: nil, event_types: nil, page_size: nil, starting_after: nil, with_content: nil, request_options: {})
       #
-      #   @option params [Boolean] :with_content Whether to include the event payload content in the response.
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param with_content [Boolean]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::Event>]
       #
-      # @return [Lithic::CursorPage<Lithic::Models::Event>]
+      # @see Lithic::Models::EventListParams
       def list(params = {})
         parsed, options = Lithic::Models::EventListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/events",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::Event,
           options: options
         )
@@ -63,41 +55,34 @@ module Lithic
 
       # List all the message attempts for a given event.
       #
-      # @param event_token [String]
-      #
-      # @param params [Lithic::Models::EventListAttemptsParams, 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 [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.
+      # @overload list_attempts(event_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
       #
-      #   @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 [Symbol, Lithic::Models::EventListAttemptsParams::Status] :status
+      # @param event_token [String]
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::EventListAttemptsParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::MessageAttempt>]
       #
-      # @return [Lithic::CursorPage<Lithic::Models::MessageAttempt>]
+      # @see Lithic::Models::EventListAttemptsParams
       def list_attempts(event_token, params = {})
         parsed, options = Lithic::Models::EventListAttemptsParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v1/events/%1$s/attempts", event_token],
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::MessageAttempt,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/external_bank_accounts/micro_deposits.rb

@@ -6,15 +6,15 @@ module Lithic
       class MicroDeposits
         # Verify the external bank account by providing the micro deposit amounts.
         #
-        # @param external_bank_account_token [String]
-        #
-        # @param params [Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<Integer>] :micro_deposits
+        # @overload create(external_bank_account_token, micro_deposits:, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param external_bank_account_token [String]
+        # @param micro_deposits [Array<Integer>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse]
+        #
+        # @see Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams
         def create(external_bank_account_token, params)
           parsed, options = Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams.dump_request(params)
           @client.request(
@@ -26,6 +26,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/external_bank_accounts.rb

@@ -8,51 +8,31 @@ module Lithic
 
       # Creates an external bank account within a program or Lithic account.
       #
-      # @param params [Lithic::Models::ExternalBankAccountCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_number Account Number
-      #
-      #   @option params [String] :country The country that the bank account is located in using ISO 3166-1. We will only
-      #     accept USA bank accounts e.g., USA
-      #
-      #   @option params [String] :currency currency of the external account 3-character alphabetic ISO 4217 code
-      #
-      #   @option params [String] :financial_account_token The financial account token of the operating account to fund the micro deposits
-      #
-      #   @option params [String] :owner Legal Name of the business or individual who owns the external account. This
-      #     will appear in statements
-      #
-      #   @option params [Symbol, Lithic::Models::OwnerType] :owner_type Owner Type
-      #
-      #   @option params [String] :routing_number Routing Number
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type] :type Account Type
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod] :verification_method Verification Method
-      #
-      #   @option params [String] :processor_token
-      #
-      #   @option params [String] :account_token Indicates which Lithic account the external account is associated with. For
-      #     external accounts that are associated with the program, account_token field
-      #     returned will be null
-      #
-      #   @option params [Lithic::Models::ExternalBankAccountAddress] :address Address
-      #
-      #   @option params [String] :company_id Optional field that helps identify bank accounts in receipts
-      #
-      #   @option params [Date] :dob Date of Birth of the Individual that owns the external bank account
-      #
-      #   @option params [String] :doing_business_as Doing Business As
-      #
-      #   @option params [String] :name The nickname for this External Bank Account
-      #
-      #   @option params [String] :user_defined_id User Defined ID
-      #
-      #   @option params [Boolean] :verification_enforcement
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(account_number:, country:, currency:, financial_account_token:, owner:, owner_type:, routing_number:, type:, verification_method:, processor_token:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, user_defined_id: nil, verification_enforcement: nil, request_options: {})
+      #
+      # @param account_number [String]
+      # @param country [String]
+      # @param currency [String]
+      # @param financial_account_token [String]
+      # @param owner [String]
+      # @param owner_type [Symbol, Lithic::Models::OwnerType]
+      # @param routing_number [String]
+      # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type]
+      # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod]
+      # @param processor_token [String]
+      # @param account_token [String]
+      # @param address [Lithic::Models::ExternalBankAccountAddress]
+      # @param company_id [String]
+      # @param dob [Date]
+      # @param doing_business_as [String]
+      # @param name [String]
+      # @param user_defined_id [String]
+      # @param verification_enforcement [Boolean]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountCreateResponse]
+      #
+      # @see Lithic::Models::ExternalBankAccountCreateParams
       def create(params)
         parsed, options = Lithic::Models::ExternalBankAccountCreateParams.dump_request(params)
         @client.request(
@@ -66,13 +46,14 @@ module Lithic
 
       # Get the external bank account by token.
       #
-      # @param external_bank_account_token [String]
-      #
-      # @param params [Lithic::Models::ExternalBankAccountRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(external_bank_account_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_bank_account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountRetrieveResponse]
+      #
+      # @see Lithic::Models::ExternalBankAccountRetrieveParams
       def retrieve(external_bank_account_token, params = {})
         @client.request(
           method: :get,
@@ -84,32 +65,23 @@ module Lithic
 
       # Update the external bank account by token.
       #
-      # @param external_bank_account_token [String]
-      #
-      # @param params [Lithic::Models::ExternalBankAccountUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::Models::ExternalBankAccountAddress] :address Address
-      #
-      #   @option params [String] :company_id Optional field that helps identify bank accounts in receipts
+      # @overload update(external_bank_account_token, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, owner: nil, owner_type: nil, type: nil, user_defined_id: nil, request_options: {})
       #
-      #   @option params [Date] :dob Date of Birth of the Individual that owns the external bank account
-      #
-      #   @option params [String] :doing_business_as Doing Business As
-      #
-      #   @option params [String] :name The nickname for this External Bank Account
-      #
-      #   @option params [String] :owner Legal Name of the business or individual who owns the external account. This
-      #     will appear in statements
-      #
-      #   @option params [Symbol, Lithic::Models::OwnerType] :owner_type Owner Type
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type] :type
-      #
-      #   @option params [String] :user_defined_id User Defined ID
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_bank_account_token [String]
+      # @param address [Lithic::Models::ExternalBankAccountAddress]
+      # @param company_id [String]
+      # @param dob [Date]
+      # @param doing_business_as [String]
+      # @param name [String]
+      # @param owner [String]
+      # @param owner_type [Symbol, Lithic::Models::OwnerType]
+      # @param type [Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type]
+      # @param user_defined_id [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountUpdateResponse]
+      #
+      # @see Lithic::Models::ExternalBankAccountUpdateParams
       def update(external_bank_account_token, params = {})
         parsed, options = Lithic::Models::ExternalBankAccountUpdateParams.dump_request(params)
         @client.request(
@@ -123,38 +95,29 @@ module Lithic
 
       # List all the external bank accounts for the provided search criteria.
       #
-      # @param params [Lithic::Models::ExternalBankAccountListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_token
-      #
-      #   @option params [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::AccountType>] :account_types
-      #
-      #   @option params [Array<String>] :countries
-      #
-      #   @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 [Array<Symbol, Lithic::Models::OwnerType>] :owner_types
+      # @overload list(account_token: nil, account_types: nil, countries: nil, ending_before: nil, owner_types: nil, page_size: nil, starting_after: nil, states: nil, verification_states: nil, request_options: {})
       #
-      #   @option params [Integer] :page_size Page size (for pagination).
+      # @param account_token [String]
+      # @param account_types [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::AccountType>]
+      # @param countries [Array<String>]
+      # @param ending_before [String]
+      # @param owner_types [Array<Symbol, Lithic::Models::OwnerType>]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::State>]
+      # @param verification_states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::VerificationState>]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @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.
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalBankAccountListResponse>]
       #
-      #   @option params [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::State>] :states
-      #
-      #   @option params [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::VerificationState>] :verification_states
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Lithic::CursorPage<Lithic::Models::ExternalBankAccountListResponse>]
+      # @see Lithic::Models::ExternalBankAccountListParams
       def list(params = {})
         parsed, options = Lithic::Models::ExternalBankAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/external_bank_accounts",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::ExternalBankAccountListResponse,
           options: options
         )
@@ -162,15 +125,15 @@ module Lithic
 
       # Retry external bank account micro deposit verification.
       #
-      # @param external_bank_account_token [String]
+      # @overload retry_micro_deposits(external_bank_account_token, financial_account_token: nil, request_options: {})
       #
-      # @param params [Lithic::Models::ExternalBankAccountRetryMicroDepositsParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :financial_account_token
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_bank_account_token [String]
+      # @param financial_account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse]
+      #
+      # @see Lithic::Models::ExternalBankAccountRetryMicroDepositsParams
       def retry_micro_deposits(external_bank_account_token, params = {})
         parsed, options = Lithic::Models::ExternalBankAccountRetryMicroDepositsParams.dump_request(params)
         @client.request(
@@ -184,15 +147,15 @@ module Lithic
 
       # Retry external bank account prenote verification.
       #
-      # @param external_bank_account_token [String]
-      #
-      # @param params [Lithic::Models::ExternalBankAccountRetryPrenoteParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :financial_account_token
+      # @overload retry_prenote(external_bank_account_token, financial_account_token: nil, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_bank_account_token [String]
+      # @param financial_account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountRetryPrenoteResponse]
+      #
+      # @see Lithic::Models::ExternalBankAccountRetryPrenoteParams
       def retry_prenote(external_bank_account_token, params = {})
         parsed, options = Lithic::Models::ExternalBankAccountRetryPrenoteParams.dump_request(params)
         @client.request(
@@ -204,6 +167,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/external_payments.rb

@@ -5,29 +5,22 @@ module Lithic
     class ExternalPayments
       # Create external payment
       #
-      # @param params [Lithic::Models::ExternalPaymentCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentCreateParams::Category] :category
-      #
-      #   @option params [Date] :effective_date
-      #
-      #   @option params [String] :financial_account_token
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentCreateParams::PaymentType] :payment_type
-      #
-      #   @option params [String] :token
-      #
-      #   @option params [String] :memo
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo] :progress_to
-      #
-      #   @option params [String] :user_defined_id
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount:, category:, effective_date:, financial_account_token:, payment_type:, token: nil, memo: nil, progress_to: nil, user_defined_id: nil, request_options: {})
+      #
+      # @param amount [Integer]
+      # @param category [Symbol, Lithic::Models::ExternalPaymentCreateParams::Category]
+      # @param effective_date [Date]
+      # @param financial_account_token [String]
+      # @param payment_type [Symbol, Lithic::Models::ExternalPaymentCreateParams::PaymentType]
+      # @param token [String]
+      # @param memo [String]
+      # @param progress_to [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo]
+      # @param user_defined_id [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
+      #
+      # @see Lithic::Models::ExternalPaymentCreateParams
       def create(params)
         parsed, options = Lithic::Models::ExternalPaymentCreateParams.dump_request(params)
         @client.request(
@@ -41,13 +34,14 @@ module Lithic
 
       # Get external payment
       #
-      # @param external_payment_token [String] Globally unique identifier for the external payment
-      #
-      # @param params [Lithic::Models::ExternalPaymentRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(external_payment_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_payment_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
+      #
+      # @see Lithic::Models::ExternalPaymentRetrieveParams
       def retrieve(external_payment_token, params = {})
         @client.request(
           method: :get,
@@ -59,43 +53,30 @@ module Lithic
 
       # List external payments
       #
-      # @param params [Lithic::Models::ExternalPaymentListParams, 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 [String] :business_account_token
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentListParams::Category] :category External Payment 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).
+      # @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: {})
       #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentListParams::Result] :result External Payment result to be returned.
+      # @param begin_ [Time]
+      # @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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @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.
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalPayment>]
       #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentListParams::Status] :status Book transfer status to be returned.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Lithic::CursorPage<Lithic::Models::ExternalPayment>]
+      # @see Lithic::Models::ExternalPaymentListParams
       def list(params = {})
         parsed, options = Lithic::Models::ExternalPaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/external_payments",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::ExternalPayment,
           options: options
         )
@@ -103,17 +84,16 @@ module Lithic
 
       # Cancel external payment
       #
-      # @param external_payment_token [String] Globally unique identifier for the external payment
-      #
-      # @param params [Lithic::Models::ExternalPaymentCancelParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Date] :effective_date
-      #
-      #   @option params [String] :memo
+      # @overload cancel(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_payment_token [String]
+      # @param effective_date [Date]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
+      #
+      # @see Lithic::Models::ExternalPaymentCancelParams
       def cancel(external_payment_token, params)
         parsed, options = Lithic::Models::ExternalPaymentCancelParams.dump_request(params)
         @client.request(
@@ -127,17 +107,16 @@ module Lithic
 
       # Release external payment
       #
-      # @param external_payment_token [String] Globally unique identifier for the external payment
-      #
-      # @param params [Lithic::Models::ExternalPaymentReleaseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Date] :effective_date
+      # @overload release(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      #   @option params [String] :memo
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_payment_token [String]
+      # @param effective_date [Date]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
+      #
+      # @see Lithic::Models::ExternalPaymentReleaseParams
       def release(external_payment_token, params)
         parsed, options = Lithic::Models::ExternalPaymentReleaseParams.dump_request(params)
         @client.request(
@@ -151,17 +130,16 @@ module Lithic
 
       # Reverse external payment
       #
-      # @param external_payment_token [String] Globally unique identifier for the external payment
+      # @overload reverse(external_payment_token, effective_date:, memo: nil, request_options: {})
       #
-      # @param params [Lithic::Models::ExternalPaymentReverseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Date] :effective_date
-      #
-      #   @option params [String] :memo
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_payment_token [String]
+      # @param effective_date [Date]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalPayment]
+      #
+      # @see Lithic::Models::ExternalPaymentReverseParams
       def reverse(external_payment_token, params)
         parsed, options = Lithic::Models::ExternalPaymentReverseParams.dump_request(params)
         @client.request(
@@ -175,19 +153,17 @@ module Lithic
 
       # Settle external payment
       #
-      # @param external_payment_token [String] Globally unique identifier for the external payment
-      #
-      # @param params [Lithic::Models::ExternalPaymentSettleParams, Hash{Symbol=>Object}] .
+      # @overload settle(external_payment_token, effective_date:, memo: nil, progress_to: nil, request_options: {})
       #
-      #   @option params [Date] :effective_date
-      #
-      #   @option params [String] :memo
-      #
-      #   @option params [Symbol, Lithic::Models::ExternalPaymentSettleParams::ProgressTo] :progress_to
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param external_payment_token [String]
+      # @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]
+      #
+      # @see Lithic::Models::ExternalPaymentSettleParams
       def settle(external_payment_token, params)
         parsed, options = Lithic::Models::ExternalPaymentSettleParams.dump_request(params)
         @client.request(
@@ -199,6 +175,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client