modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/resources/foreign_exchange_quotes.rb

@@ -5,25 +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(
@@ -37,17 +31,18 @@ module ModernTreasury
 
       # get foreign_exchange_quote
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::ForeignExchangeQuoteRetrieveParams, 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::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]
         )
@@ -55,43 +50,36 @@ module ModernTreasury
 
       # list foreign_exchange_quotes
       #
-      # @param params [ModernTreasury::Models::ForeignExchangeQuoteListParams, Hash{Symbol=>Object}] .
+      # @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 [String, nil] :after_cursor
+      # @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 [String] :base_currency Currency to convert, often called the "sell" currency.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ForeignExchangeQuote>]
       #
-      #   @option params [Date] :effective_at_end An inclusive upper bound for searching effective_at
-      #
-      #   @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>]
+      # @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
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/incoming_payment_details.rb

@@ -5,17 +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]
         )
@@ -23,21 +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}] .
+      # @overload update(id, metadata: nil, request_options: {})
       #
-      #   @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 [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
@@ -46,43 +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`.
+      # @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 [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type] :type One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #     `wire`.
+      # @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 [String] :virtual_account_id If the incoming payment detail is in a virtual account, the ID of the Virtual
-      #     Account.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::IncomingPaymentDetail>]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::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
         )
@@ -90,29 +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(
@@ -124,6 +103,8 @@ module ModernTreasury
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/internal_accounts/balance_reports.rb

@@ -6,28 +6,24 @@ module ModernTreasury
       class BalanceReports
         # create balance reports
         #
-        # @param internal_account_id [String]
-        #
-        # @param params [ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Date] :as_of_date The date of the balance report in local time.
-        #
-        #   @option params [String] :as_of_time The time (24-hour clock) of the balance report in local time.
-        #
-        #   @option params [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType] :balance_report_type The specific type of balance report. One of `intraday`, `previous_day`,
-        #     `real_time`, or `other`.
-        #
-        #   @option params [Array<ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance>] :balances An array of `Balance` objects.
+        # @overload create(internal_account_id, as_of_date:, as_of_time:, balance_report_type:, balances:, request_options: {})
         #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param internal_account_id [String]
+        # @param as_of_date [Date]
+        # @param as_of_time [String]
+        # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType]
+        # @param balances [Array<ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance>]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [ModernTreasury::Models::InternalAccounts::BalanceReport]
+        #
+        # @see ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams
         def create(internal_account_id, params)
           parsed, options =
             ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["api/internal_accounts/%0s/balance_reports", internal_account_id],
+            path: ["api/internal_accounts/%1$s/balance_reports", internal_account_id],
             body: parsed,
             model: ModernTreasury::Models::InternalAccounts::BalanceReport,
             options: options
@@ -36,16 +32,15 @@ module ModernTreasury
 
         # Get a single balance report for a given internal account.
         #
-        # @param id [String] Either the unique identifier of the balance report or latest for the latest
-        #   balance report.
-        #
-        # @param params [ModernTreasury::Models::InternalAccounts::BalanceReportRetrieveParams, Hash{Symbol=>Object}] .
+        # @overload retrieve(id, internal_account_id:, request_options: {})
         #
-        #   @option params [String] :internal_account_id
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param id [String]
+        # @param internal_account_id [String]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [ModernTreasury::Models::InternalAccounts::BalanceReport]
+        #
+        # @see ModernTreasury::Models::InternalAccounts::BalanceReportRetrieveParams
         def retrieve(id, params)
           parsed, options =
             ModernTreasury::Models::InternalAccounts::BalanceReportRetrieveParams.dump_request(params)
@@ -55,7 +50,7 @@ module ModernTreasury
             end
           @client.request(
             method: :get,
-            path: ["api/internal_accounts/%0s/balance_reports/%1s", internal_account_id, id],
+            path: ["api/internal_accounts/%1$s/balance_reports/%2$s", internal_account_id, id],
             model: ModernTreasury::Models::InternalAccounts::BalanceReport,
             options: options
           )
@@ -63,29 +58,25 @@ module ModernTreasury
 
         # Get all balance reports for a given internal account.
         #
-        # @param internal_account_id [String]
-        #
-        # @param params [ModernTreasury::Models::InternalAccounts::BalanceReportListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String, nil] :after_cursor
+        # @overload list(internal_account_id, after_cursor: nil, as_of_date: nil, balance_report_type: nil, per_page: nil, request_options: {})
         #
-        #   @option params [Date] :as_of_date The date of the balance report in local time.
-        #
-        #   @option params [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType] :balance_report_type The specific type of balance report. One of `intraday`, `previous_day`,
-        #     `real_time`, or `other`.
-        #
-        #   @option params [Integer] :per_page
+        # @param internal_account_id [String]
+        # @param after_cursor [String, nil]
+        # @param as_of_date [Date]
+        # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType]
+        # @param per_page [Integer]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::InternalAccounts::BalanceReport>]
         #
-        # @return [ModernTreasury::Page<ModernTreasury::Models::InternalAccounts::BalanceReport>]
+        # @see ModernTreasury::Models::InternalAccounts::BalanceReportListParams
         def list(internal_account_id, params = {})
           parsed, options = ModernTreasury::Models::InternalAccounts::BalanceReportListParams.dump_request(params)
           @client.request(
             method: :get,
-            path: ["api/internal_accounts/%0s/balance_reports", internal_account_id],
+            path: ["api/internal_accounts/%1$s/balance_reports", internal_account_id],
             query: parsed,
-            page: ModernTreasury::Page,
+            page: ModernTreasury::Internal::Page,
             model: ModernTreasury::Models::InternalAccounts::BalanceReport,
             options: options
           )
@@ -93,16 +84,15 @@ module ModernTreasury
 
         # Deletes a given balance report.
         #
-        # @param id [String] Either the unique identifier of the balance report or latest for the latest
-        #   balance report.
+        # @overload delete(id, internal_account_id:, request_options: {})
         #
-        # @param params [ModernTreasury::Models::InternalAccounts::BalanceReportDeleteParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :internal_account_id
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param id [String]
+        # @param internal_account_id [String]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see ModernTreasury::Models::InternalAccounts::BalanceReportDeleteParams
         def delete(id, params)
           parsed, options =
             ModernTreasury::Models::InternalAccounts::BalanceReportDeleteParams.dump_request(params)
@@ -112,12 +102,14 @@ module ModernTreasury
             end
           @client.request(
             method: :delete,
-            path: ["api/internal_accounts/%0s/balance_reports/%1s", internal_account_id, id],
+            path: ["api/internal_accounts/%1$s/balance_reports/%2$s", internal_account_id, id],
             model: NilClass,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [ModernTreasury::Client]
         def initialize(client:)
           @client = client

data/lib/modern_treasury/resources/internal_accounts.rb

@@ -8,31 +8,22 @@ module ModernTreasury
 
       # create internal account
       #
-      # @param params [ModernTreasury::Models::InternalAccountCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :connection_id The identifier of the financial institution the account belongs to.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] :currency Either "USD" or "CAD". Internal accounts created at Increase only supports
-      #     "USD".
-      #
-      #   @option params [String] :name The nickname of the account.
-      #
-      #   @option params [String] :party_name The legal name of the entity which owns the account.
-      #
-      #   @option params [String] :counterparty_id The Counterparty associated to this account.
-      #
-      #   @option params [String] :legal_entity_id The LegalEntity associated to this account.
-      #
-      #   @option params [String] :parent_account_id The parent internal account of this new account.
-      #
-      #   @option params [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress] :party_address The address associated with the owner or null.
-      #
-      #   @option params [Hash{Symbol=>String}] :vendor_attributes A hash of vendor specific attributes that will be used when creating the account
-      #     at the vendor specified by the given connection.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(connection_id:, currency:, name:, party_name:, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {})
+      #
+      # @param connection_id [String]
+      # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency]
+      # @param name [String]
+      # @param party_name [String]
+      # @param counterparty_id [String]
+      # @param legal_entity_id [String]
+      # @param parent_account_id [String]
+      # @param party_address [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress]
+      # @param vendor_attributes [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::InternalAccount]
+      #
+      # @see ModernTreasury::Models::InternalAccountCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::InternalAccountCreateParams.dump_request(params)
         @client.request(
@@ -46,17 +37,18 @@ module ModernTreasury
 
       # get internal account
       #
-      # @param id [String] Unique identifier for the account.
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::InternalAccountRetrieveParams, 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::InternalAccount]
+      #
+      # @see ModernTreasury::Models::InternalAccountRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/internal_accounts/%0s", id],
+          path: ["api/internal_accounts/%1$s", id],
           model: ModernTreasury::Models::InternalAccount,
           options: params[:request_options]
         )
@@ -64,29 +56,24 @@ module ModernTreasury
 
       # update internal account
       #
-      # @param id [String] Unique identifier for the account.
-      #
-      # @param params [ModernTreasury::Models::InternalAccountUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
       #
-      #   @option params [String] :counterparty_id The Counterparty associated to this account.
-      #
-      #   @option params [String] :ledger_account_id The Ledger Account associated to this account.
-      #
-      #   @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] :name The nickname for the internal account.
-      #
-      #   @option params [String] :parent_account_id The parent internal account for this account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param counterparty_id [String]
+      # @param ledger_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String]
+      # @param parent_account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::InternalAccount]
+      #
+      # @see ModernTreasury::Models::InternalAccountUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::InternalAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/internal_accounts/%0s", id],
+          path: ["api/internal_accounts/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::InternalAccount,
           options: options
@@ -95,41 +82,35 @@ module ModernTreasury
 
       # list internal accounts
       #
-      # @param params [ModernTreasury::Models::InternalAccountListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
+      # @overload list(after_cursor: nil, counterparty_id: nil, currency: nil, legal_entity_id: nil, metadata: nil, payment_direction: nil, payment_type: nil, per_page: nil, request_options: {})
       #
-      #   @option params [String] :counterparty_id Only return internal accounts associated with this counterparty.
+      # @param after_cursor [String, nil]
+      # @param counterparty_id [String]
+      # @param currency [Symbol, ModernTreasury::Models::Currency]
+      # @param legal_entity_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param payment_direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param payment_type [Symbol, ModernTreasury::Models::InternalAccountListParams::PaymentType]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Only return internal accounts with this currency.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::InternalAccount>]
       #
-      #   @option params [String] :legal_entity_id Only return internal accounts associated with this legal entity.
-      #
-      #   @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 [Symbol, ModernTreasury::Models::TransactionDirection] :payment_direction Only return internal accounts that can originate payments with this direction.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::InternalAccountListParams::PaymentType] :payment_type Only return internal accounts that can make this type of payment.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::InternalAccount>]
+      # @see ModernTreasury::Models::InternalAccountListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::InternalAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/internal_accounts",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::InternalAccount,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client