modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/modern_treasury/resources/expected_payments.rb

@@ -5,65 +5,32 @@ module ModernTreasury
     class ExpectedPayments
       # create expected payment
       #
-      # @param params [ModernTreasury::Models::ExpectedPaymentCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer, nil] :amount_lower_bound The lowest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
-      #
-      #   @option params [Integer, nil] :amount_upper_bound The highest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
-      #
-      #   @option params [String, nil] :counterparty_id The ID of the counterparty you expect for this payment.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency, nil] :currency Must conform to ISO 4217. Defaults to the currency of the internal account.
-      #
-      #   @option params [Date, nil] :date_lower_bound The earliest date the payment may come in. Format: yyyy-mm-dd
-      #
-      #   @option params [Date, nil] :date_upper_bound The latest date the payment may come in. Format: yyyy-mm-dd
-      #
-      #   @option params [String, nil] :description An optional description for internal use.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil] :direction One of credit or debit. When you are receiving money, use credit. When you are
-      #     being charged, use debit.
-      #
-      #   @option params [String, nil] :internal_account_id The ID of the Internal Account for the expected payment.
-      #
-      #   @option params [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction] :ledger_transaction Specifies a ledger transaction object that will be created with the expected
-      #     payment. If the ledger transaction cannot be created, then the expected payment
-      #     creation will fail. The resulting ledger transaction will mirror the status of
-      #     the expected payment.
-      #
-      #   @option params [String] :ledger_transaction_id Either ledger_transaction or ledger_transaction_id can be provided. Only a
-      #     pending ledger transaction can be attached upon expected payment creation. Once
-      #     the expected payment is created, the status of the ledger transaction tracks the
-      #     expected payment automatically.
-      #
-      #   @option params [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>] :line_items
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Object, nil] :reconciliation_filters The reconciliation filters you have for this payment.
-      #
-      #   @option params [Object, nil] :reconciliation_groups The reconciliation groups you have for this payment.
-      #
-      #   @option params [Array<ModernTreasury::Models::ReconciliationRule>, nil] :reconciliation_rule_variables An array of reconciliation rule variables for this payment.
-      #
-      #   @option params [String, nil] :remittance_information For `ach`, this field will be passed through on an addenda record. For `wire`
-      #     payments the field will be passed through as the "Originator to Beneficiary
-      #     Information", also known as OBI or Fedwire tag 6000.
-      #
-      #   @option params [String, nil] :statement_descriptor The statement description you expect to see on the transaction. For ACH
-      #     payments, this will be the full line item passed from the bank. For wire
-      #     payments, this will be the OBI field on the wire. For check payments, this will
-      #     be the memo field.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-      #     sepa, signet, wire.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
+      #
+      # @param amount_lower_bound [Integer, nil]
+      # @param amount_upper_bound [Integer, nil]
+      # @param counterparty_id [String, nil]
+      # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      # @param date_lower_bound [Date, nil]
+      # @param date_upper_bound [Date, nil]
+      # @param description [String, nil]
+      # @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil]
+      # @param internal_account_id [String, nil]
+      # @param ledger_transaction [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction]
+      # @param ledger_transaction_id [String]
+      # @param line_items [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param reconciliation_filters [Object, nil]
+      # @param reconciliation_groups [Object, nil]
+      # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
+      # @param remittance_information [String, nil]
+      # @param statement_descriptor [String, nil]
+      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExpectedPayment]
+      #
+      # @see ModernTreasury::Models::ExpectedPaymentCreateParams
       def create(params = {})
         parsed, options = ModernTreasury::Models::ExpectedPaymentCreateParams.dump_request(params)
         @client.request(
@@ -77,17 +44,18 @@ module ModernTreasury
 
       # get expected payment
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::ExpectedPaymentRetrieveParams, 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::ExpectedPayment]
+      #
+      # @see ModernTreasury::Models::ExpectedPaymentRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/expected_payments/%0s", id],
+          path: ["api/expected_payments/%1$s", id],
           model: ModernTreasury::Models::ExpectedPayment,
           options: params[:request_options]
         )
@@ -95,63 +63,36 @@ module ModernTreasury
 
       # update expected payment
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::ExpectedPaymentUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer, nil] :amount_lower_bound The lowest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
-      #
-      #   @option params [Integer, nil] :amount_upper_bound The highest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
-      #
-      #   @option params [String, nil] :counterparty_id The ID of the counterparty you expect for this payment.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::Currency, nil] :currency Must conform to ISO 4217. Defaults to the currency of the internal account.
-      #
-      #   @option params [Date, nil] :date_lower_bound The earliest date the payment may come in. Format: yyyy-mm-dd
-      #
-      #   @option params [Date, nil] :date_upper_bound The latest date the payment may come in. Format: yyyy-mm-dd
-      #
-      #   @option params [String, nil] :description An optional description for internal use.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil] :direction One of credit or debit. When you are receiving money, use credit. When you are
-      #     being charged, use debit.
-      #
-      #   @option params [String, nil] :internal_account_id The ID of the Internal Account for the expected payment.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Object, nil] :reconciliation_filters The reconciliation filters you have for this payment.
-      #
-      #   @option params [Object, nil] :reconciliation_groups The reconciliation groups you have for this payment.
-      #
-      #   @option params [Array<ModernTreasury::Models::ReconciliationRule>, nil] :reconciliation_rule_variables An array of reconciliation rule variables for this payment.
-      #
-      #   @option params [String, nil] :remittance_information For `ach`, this field will be passed through on an addenda record. For `wire`
-      #     payments the field will be passed through as the "Originator to Beneficiary
-      #     Information", also known as OBI or Fedwire tag 6000.
-      #
-      #   @option params [String, nil] :statement_descriptor The statement description you expect to see on the transaction. For ACH
-      #     payments, this will be the full line item passed from the bank. For wire
-      #     payments, this will be the OBI field on the wire. For check payments, this will
-      #     be the memo field.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status, nil] :status The Expected Payment's status can be updated from partially_reconciled to
-      #     reconciled.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-      #     sepa, signet, wire.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload update(id, amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
+      #
+      # @param id [String]
+      # @param amount_lower_bound [Integer, nil]
+      # @param amount_upper_bound [Integer, nil]
+      # @param counterparty_id [String, nil]
+      # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      # @param date_lower_bound [Date, nil]
+      # @param date_upper_bound [Date, nil]
+      # @param description [String, nil]
+      # @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil]
+      # @param internal_account_id [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param reconciliation_filters [Object, nil]
+      # @param reconciliation_groups [Object, nil]
+      # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
+      # @param remittance_information [String, nil]
+      # @param statement_descriptor [String, nil]
+      # @param status [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status, nil]
+      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ExpectedPayment]
+      #
+      # @see ModernTreasury::Models::ExpectedPaymentUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::ExpectedPaymentUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/expected_payments/%0s", id],
+          path: ["api/expected_payments/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::ExpectedPayment,
           options: options
@@ -160,41 +101,30 @@ module ModernTreasury
 
       # list expected_payments
       #
-      # @param params [ModernTreasury::Models::ExpectedPaymentListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :counterparty_id Specify counterparty_id to see expected_payments for a specific account.
-      #
-      #   @option params [Time] :created_at_lower_bound Used to return expected payments created after some datetime
-      #
-      #   @option params [Time] :created_at_upper_bound Used to return expected payments created before some datetime
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction One of credit, debit
-      #
-      #   @option params [String] :internal_account_id Specify internal_account_id to see expected_payments for a specific account.
+      # @overload list(after_cursor: nil, counterparty_id: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, direction: nil, internal_account_id: nil, metadata: nil, per_page: nil, status: nil, type: 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 created_at_lower_bound [Time]
+      # @param created_at_upper_bound [Time]
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param internal_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param status [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status]
+      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ExpectedPayment>]
       #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status] :status One of unreconciled, reconciled, or archived.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type] :type One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
-      #     sepa, signet, wire
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::ExpectedPayment>]
+      # @see ModernTreasury::Models::ExpectedPaymentListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::ExpectedPaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/expected_payments",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::ExpectedPayment,
           options: options
         )
@@ -202,22 +132,25 @@ module ModernTreasury
 
       # delete expected payment
       #
-      # @param id [String] id
+      # @overload delete(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::ExpectedPaymentDeleteParams, 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::ExpectedPayment]
+      #
+      # @see ModernTreasury::Models::ExpectedPaymentDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/expected_payments/%0s", id],
+          path: ["api/expected_payments/%1$s", id],
           model: ModernTreasury::Models::ExpectedPayment,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/external_accounts.rb

@@ -5,44 +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(
@@ -56,17 +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]
         )
@@ -74,34 +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
@@ -110,30 +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
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ExternalAccount>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::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
         )
@@ -141,17 +111,18 @@ module ModernTreasury
 
       # delete external account
       #
-      # @param id [String] external account id
-      #
-      # @param params [ModernTreasury::Models::ExternalAccountDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(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 [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]
         )
@@ -159,20 +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
@@ -181,38 +152,32 @@ 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`.
+      # @overload verify(id, originating_account_id:, payment_type:, currency: nil, fallback_type: nil, priority: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Defaults to the currency of the originating account.
-      #
-      #   @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
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client