modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/resources/external_accounts.rb

@@ -5,45 +5,26 @@ module ModernTreasury
     class ExternalAccounts
       # create external account
       #
-      # @param params [ModernTreasury::Models::ExternalAccountCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :counterparty_id
-      #
-      #   @option params [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>] :account_details
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountType] :account_type Can be `checking`, `savings` or `other`.
-      #
-      #   @option params [Array<ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail>] :contact_details
-      #
-      #   @option params [ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount] :ledger_account Specifies a ledger account object that will be created with the external
-      #     account. The resulting ledger account is linked to the external account for
-      #     auto-ledgering Payment objects. See
-      #     https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-      #     for more details.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [String, nil] :name A nickname for the external account. This is only for internal usage and won't
-      #     affect any payments
-      #
-      #   @option params [ModernTreasury::Models::ExternalAccountCreateParams::PartyAddress] :party_address Required if receiving wire payments.
-      #
-      #   @option params [String] :party_identifier
-      #
-      #   @option params [String] :party_name If this value isn't provided, it will be inherited from the counterparty's name.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::PartyType, nil] :party_type Either `individual` or `business`.
-      #
-      #   @option params [String] :plaid_processor_token If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
-      #     you can pass the processor token in this field.
-      #
-      #   @option params [Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>] :routing_details
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(counterparty_id:, account_details: nil, account_type: nil, contact_details: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil, request_options: {})
+      #
+      # @param counterparty_id [String, nil]
+      # @param account_details [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>]
+      # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
+      # @param contact_details [Array<ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail>]
+      # @param ledger_account [ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String, nil]
+      # @param party_address [ModernTreasury::Models::ExternalAccountCreateParams::PartyAddress]
+      # @param party_identifier [String]
+      # @param party_name [String]
+      # @param party_type [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::PartyType, nil]
+      # @param plaid_processor_token [String]
+      # @param routing_details [Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExternalAccount]
       #
+      # @see ModernTreasury::Models::ExternalAccountCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::ExternalAccountCreateParams.dump_request(params)
         @client.request(
@@ -57,18 +38,18 @@ module ModernTreasury
 
       # show external account
       #
-      # @param id [String] external account id
-      #
-      # @param params [ModernTreasury::Models::ExternalAccountRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExternalAccount]
       #
+      # @see ModernTreasury::Models::ExternalAccountRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/external_accounts/%0s", id],
+          path: ["api/external_accounts/%1$s", id],
           model: ModernTreasury::Models::ExternalAccount,
           options: params[:request_options]
         )
@@ -76,35 +57,26 @@ module ModernTreasury
 
       # update external account
       #
-      # @param id [String] external account id
-      #
-      # @param params [ModernTreasury::Models::ExternalAccountUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountType] :account_type Can be `checking`, `savings` or `other`.
-      #
-      #   @option params [String, nil] :counterparty_id
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
-      #
-      #   @option params [String, nil] :name A nickname for the external account. This is only for internal usage and won't
-      #     affect any payments
+      # @overload update(id, account_type: nil, counterparty_id: nil, metadata: nil, name: nil, party_address: nil, party_name: nil, party_type: nil, request_options: {})
       #
-      #   @option params [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress] :party_address
-      #
-      #   @option params [String] :party_name If this value isn't provided, it will be inherited from the counterparty's name.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil] :party_type Either `individual` or `business`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
+      # @param counterparty_id [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String, nil]
+      # @param party_address [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress]
+      # @param party_name [String]
+      # @param party_type [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExternalAccount]
       #
+      # @see ModernTreasury::Models::ExternalAccountUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::ExternalAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/external_accounts/%0s", id],
+          path: ["api/external_accounts/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::ExternalAccount,
           options: options
@@ -113,31 +85,25 @@ module ModernTreasury
 
       # list external accounts
       #
-      # @param params [ModernTreasury::Models::ExternalAccountListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :counterparty_id
+      # @overload list(after_cursor: nil, counterparty_id: nil, metadata: nil, party_name: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      # @param after_cursor [String, nil]
+      # @param counterparty_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param party_name [String]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :party_name Searches the ExternalAccount's party_name AND the Counterparty's party_name
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::ExternalAccount>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ExternalAccount>]
       #
+      # @see ModernTreasury::Models::ExternalAccountListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ExternalAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/external_accounts",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::ExternalAccount,
           options: options
         )
@@ -145,18 +111,18 @@ module ModernTreasury
 
       # delete external account
       #
-      # @param id [String] external account id
+      # @overload delete(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::ExternalAccountDeleteParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::ExternalAccountDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/external_accounts/%0s", id],
+          path: ["api/external_accounts/%1$s", id],
           model: NilClass,
           options: params[:request_options]
         )
@@ -164,21 +130,20 @@ module ModernTreasury
 
       # complete verification of external account
       #
-      # @param id [String] external account id
-      #
-      # @param params [ModernTreasury::Models::ExternalAccountCompleteVerificationParams, Hash{Symbol=>Object}] .
+      # @overload complete_verification(id, amounts: nil, request_options: {})
       #
-      #   @option params [Array<Integer>] :amounts
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param amounts [Array<Integer>]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExternalAccount]
       #
+      # @see ModernTreasury::Models::ExternalAccountCompleteVerificationParams
       def complete_verification(id, params = {})
         parsed, options = ModernTreasury::Models::ExternalAccountCompleteVerificationParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["api/external_accounts/%0s/complete_verification", id],
+          path: ["api/external_accounts/%1$s/complete_verification", id],
           body: parsed,
           model: ModernTreasury::Models::ExternalAccount,
           options: options
@@ -187,41 +152,33 @@ module ModernTreasury
 
       # verify external account
       #
-      # @param id [String] external account id
-      #
-      # @param params [ModernTreasury::Models::ExternalAccountVerifyParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :originating_account_id The ID of the internal account where the micro-deposits originate from. Both
-      #     credit and debit capabilities must be enabled.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType] :payment_type Can be `ach`, `eft`, or `rtp`.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Defaults to the currency of the originating account.
+      # @overload verify(id, originating_account_id:, payment_type:, currency: nil, fallback_type: nil, priority: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType] :fallback_type A payment type to fallback to if the original type is not valid for the
-      #     receiving account. Currently, this only supports falling back from RTP to ACH
-      #     (payment_type=rtp and fallback_type=ach)
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority] :priority Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
-      #     transfer. This will apply to both `payment_type` and `fallback_type`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param originating_account_id [String]
+      # @param payment_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType]
+      # @param currency [Symbol, ModernTreasury::Models::Currency]
+      # @param fallback_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType]
+      # @param priority [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt]
       #
+      # @see ModernTreasury::Models::ExternalAccountVerifyParams
       def verify(id, params)
         parsed, options = ModernTreasury::Models::ExternalAccountVerifyParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["api/external_accounts/%0s/verify", id],
+          path: ["api/external_accounts/%1$s/verify", id],
           body: parsed,
           model: ModernTreasury::Models::ExternalAccountVerifyResponse,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/foreign_exchange_quotes.rb

@@ -5,26 +5,19 @@ module ModernTreasury
     class ForeignExchangeQuotes
       # create foreign_exchange_quote
       #
-      # @param params [ModernTreasury::Models::ForeignExchangeQuoteCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(internal_account_id:, target_currency:, base_amount: nil, base_currency: nil, effective_at: nil, target_amount: nil, request_options: {})
       #
-      #   @option params [String] :internal_account_id The ID for the `InternalAccount` this quote is associated with.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency] :target_currency Currency to convert the `base_currency` to, often called the "buy" currency.
-      #
-      #   @option params [Integer] :base_amount Amount in the lowest denomination of the `base_currency` to convert, often
-      #     called the "sell" amount.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency] :base_currency Currency to convert, often called the "sell" currency.
-      #
-      #   @option params [Time] :effective_at The timestamp until when the quoted rate is valid.
-      #
-      #   @option params [Integer] :target_amount Amount in the lowest denomination of the `target_currency`, often called the
-      #     "buy" amount.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param internal_account_id [String]
+      # @param target_currency [Symbol, ModernTreasury::Models::Currency]
+      # @param base_amount [Integer]
+      # @param base_currency [Symbol, ModernTreasury::Models::Currency]
+      # @param effective_at [Time]
+      # @param target_amount [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ForeignExchangeQuote]
       #
+      # @see ModernTreasury::Models::ForeignExchangeQuoteCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::ForeignExchangeQuoteCreateParams.dump_request(params)
         @client.request(
@@ -38,18 +31,18 @@ module ModernTreasury
 
       # get foreign_exchange_quote
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::ForeignExchangeQuoteRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ForeignExchangeQuote]
       #
+      # @see ModernTreasury::Models::ForeignExchangeQuoteRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/foreign_exchange_quotes/%0s", id],
+          path: ["api/foreign_exchange_quotes/%1$s", id],
           model: ModernTreasury::Models::ForeignExchangeQuote,
           options: params[:request_options]
         )
@@ -57,46 +50,37 @@ module ModernTreasury
 
       # list foreign_exchange_quotes
       #
-      # @param params [ModernTreasury::Models::ForeignExchangeQuoteListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :base_currency Currency to convert, often called the "sell" currency.
+      # @overload list(after_cursor: nil, base_currency: nil, effective_at_end: nil, effective_at_start: nil, expires_at: nil, internal_account_id: nil, metadata: nil, per_page: nil, target_currency: nil, request_options: {})
       #
-      #   @option params [Date] :effective_at_end An inclusive upper bound for searching effective_at
+      # @param after_cursor [String, nil]
+      # @param base_currency [String]
+      # @param effective_at_end [Date]
+      # @param effective_at_start [Date]
+      # @param expires_at [Time]
+      # @param internal_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param target_currency [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Date] :effective_at_start An inclusive lower bound for searching effective_at
-      #
-      #   @option params [Time] :expires_at The timestamp until which the quote must be booked by.
-      #
-      #   @option params [String] :internal_account_id The ID for the `InternalAccount` this quote is associated with.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [String] :target_currency Currency to convert the `base_currency` to, often called the "buy" currency.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::ForeignExchangeQuote>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ForeignExchangeQuote>]
       #
+      # @see ModernTreasury::Models::ForeignExchangeQuoteListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ForeignExchangeQuoteListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/foreign_exchange_quotes",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::ForeignExchangeQuote,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/incoming_payment_details.rb

@@ -5,18 +5,18 @@ module ModernTreasury
     class IncomingPaymentDetails
       # Get an existing Incoming Payment Detail.
       #
-      # @param id [String] The unique identifier of the incoming payment detail.
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::IncomingPaymentDetailRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::IncomingPaymentDetail]
       #
+      # @see ModernTreasury::Models::IncomingPaymentDetailRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/incoming_payment_details/%0s", id],
+          path: ["api/incoming_payment_details/%1$s", id],
           model: ModernTreasury::Models::IncomingPaymentDetail,
           options: params[:request_options]
         )
@@ -24,22 +24,20 @@ module ModernTreasury
 
       # Update an existing Incoming Payment Detail.
       #
-      # @param id [String] The unique identifier of the incoming payment detail.
-      #
-      # @param params [ModernTreasury::Models::IncomingPaymentDetailUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
+      # @overload update(id, metadata: nil, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::IncomingPaymentDetail]
       #
+      # @see ModernTreasury::Models::IncomingPaymentDetailUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::IncomingPaymentDetailUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/incoming_payment_details/%0s", id],
+          path: ["api/incoming_payment_details/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::IncomingPaymentDetail,
           options: options
@@ -48,44 +46,29 @@ module ModernTreasury
 
       # Get a list of Incoming Payment Details.
       #
-      # @param params [ModernTreasury::Models::IncomingPaymentDetailListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Date] :as_of_date_end Filters incoming payment details with an as_of_date starting on or before the
-      #     specified date (YYYY-MM-DD).
-      #
-      #   @option params [Date] :as_of_date_start Filters incoming payment details with an as_of_date starting on or after the
-      #     specified date (YYYY-MM-DD).
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction One of `credit` or `debit`.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status] :status The current status of the incoming payment order. One of `pending`, `completed`,
-      #     or `returned`.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type] :type One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #     `wire`.
+      # @overload list(after_cursor: nil, as_of_date_end: nil, as_of_date_start: nil, direction: nil, metadata: nil, per_page: nil, status: nil, type: nil, virtual_account_id: nil, request_options: {})
       #
-      #   @option params [String] :virtual_account_id If the incoming payment detail is in a virtual account, the ID of the Virtual
-      #     Account.
+      # @param after_cursor [String, nil]
+      # @param as_of_date_end [Date]
+      # @param as_of_date_start [Date]
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param status [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status]
+      # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type]
+      # @param virtual_account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::IncomingPaymentDetail>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::IncomingPaymentDetail>]
       #
+      # @see ModernTreasury::Models::IncomingPaymentDetailListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::IncomingPaymentDetailListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/incoming_payment_details",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::IncomingPaymentDetail,
           options: options
         )
@@ -93,30 +76,22 @@ module ModernTreasury
 
       # Simulate Incoming Payment Detail
       #
-      # @param params [ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
-      #
-      #   @option params [Date, nil] :as_of_date Defaults to today.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency, nil] :currency Defaults to the currency of the originating account.
-      #
-      #   @option params [String, nil] :description Defaults to a random description.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction] :direction One of `credit`, `debit`.
+      # @overload create_async(amount: nil, as_of_date: nil, currency: nil, data: nil, description: nil, direction: nil, internal_account_id: nil, type: nil, virtual_account_id: nil, request_options: {})
       #
-      #   @option params [String] :internal_account_id The ID of one of your internal accounts.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type] :type One of `ach`, `wire`, `check`.
-      #
-      #   @option params [String, nil] :virtual_account_id An optional parameter to associate the incoming payment detail to a virtual
-      #     account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param as_of_date [Date, nil]
+      # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      # @param data [Object, nil]
+      # @param description [String, nil]
+      # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction]
+      # @param internal_account_id [String]
+      # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type]
+      # @param virtual_account_id [String, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AsyncResponse]
       #
+      # @see ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams
       def create_async(params = {})
         parsed, options = ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams.dump_request(params)
         @client.request(
@@ -128,8 +103,9 @@ module ModernTreasury
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end