modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/resources/foreign_exchange_quotes.rb

@@ -3,28 +3,37 @@
 module ModernTreasury
   module Resources
     class ForeignExchangeQuotes
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ForeignExchangeQuoteCreateParams} for more details.
+      #
       # create foreign_exchange_quote
       #
       # @overload create(internal_account_id:, target_currency:, base_amount: nil, base_currency: nil, effective_at: nil, target_amount: 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 internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
+      #
+      # @param target_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      # @param base_amount [Integer] Amount in the lowest denomination of the `base_currency` to convert, often calle
+      #
+      # @param base_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert, often called the "sell" currency.
+      #
+      # @param effective_at [Time] The timestamp until when the quoted rate is valid.
+      #
+      # @param target_amount [Integer] Amount in the lowest denomination of the `target_currency`, often called the "bu
+      #
       # @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)
+        parsed, options = ModernTreasury::ForeignExchangeQuoteCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/foreign_exchange_quotes",
           body: parsed,
-          model: ModernTreasury::Models::ForeignExchangeQuote,
+          model: ModernTreasury::ForeignExchangeQuote,
           options: options
         )
       end
@@ -33,7 +42,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ForeignExchangeQuote]
@@ -43,37 +53,49 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/foreign_exchange_quotes/%1$s", id],
-          model: ModernTreasury::Models::ForeignExchangeQuote,
+          model: ModernTreasury::ForeignExchangeQuote,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ForeignExchangeQuoteListParams} for more details.
+      #
       # list foreign_exchange_quotes
       #
       # @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: {})
       #
       # @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 base_currency [String] Currency to convert, often called the "sell" currency.
+      #
+      # @param effective_at_end [Date] An inclusive upper bound for searching effective_at
+      #
+      # @param effective_at_start [Date] An inclusive lower bound for searching effective_at
+      #
+      # @param expires_at [Time] The timestamp until which the quote must be booked by.
+      #
+      # @param internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
-      # @param target_currency [String]
+      #
+      # @param target_currency [String] Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ForeignExchangeQuote>]
       #
       # @see ModernTreasury::Models::ForeignExchangeQuoteListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ForeignExchangeQuoteListParams.dump_request(params)
+        parsed, options = ModernTreasury::ForeignExchangeQuoteListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/foreign_exchange_quotes",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::ForeignExchangeQuote,
+          model: ModernTreasury::ForeignExchangeQuote,
           options: options
         )
       end

data/lib/modern_treasury/resources/incoming_payment_details.rb

@@ -7,7 +7,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The unique identifier of the incoming payment detail.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::IncomingPaymentDetail]
@@ -17,88 +18,118 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/incoming_payment_details/%1$s", id],
-          model: ModernTreasury::Models::IncomingPaymentDetail,
+          model: ModernTreasury::IncomingPaymentDetail,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::IncomingPaymentDetailUpdateParams} for more details.
+      #
       # Update an existing Incoming Payment Detail.
       #
       # @overload update(id, metadata: nil, request_options: {})
       #
-      # @param id [String]
-      # @param metadata [Hash{Symbol=>String}]
+      # @param id [String] The unique identifier of the incoming payment detail.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #
       # @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)
+        parsed, options = ModernTreasury::IncomingPaymentDetailUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/incoming_payment_details/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::IncomingPaymentDetail,
+          model: ModernTreasury::IncomingPaymentDetail,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::IncomingPaymentDetailListParams} for more details.
+      #
       # Get a list of Incoming Payment Details.
       #
       # @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: {})
       #
       # @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 as_of_date_end [Date] Filters incoming payment details with an as_of_date starting on or before the sp
+      #
+      # @param as_of_date_start [Date] Filters incoming payment details with an as_of_date starting on or after the spe
+      #
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit` or `debit`.
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
-      # @param status [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status]
-      # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type]
-      # @param virtual_account_id [String]
+      #
+      # @param status [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status] The current status of the incoming payment order. One of `pending`, `completed`,
+      #
+      # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type] One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or `w
+      #
+      # @param virtual_account_id [String] If the incoming payment detail is in a virtual account, the ID of the Virtual Ac
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::IncomingPaymentDetail>]
       #
       # @see ModernTreasury::Models::IncomingPaymentDetailListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::IncomingPaymentDetailListParams.dump_request(params)
+        parsed, options = ModernTreasury::IncomingPaymentDetailListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/incoming_payment_details",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::IncomingPaymentDetail,
+          model: ModernTreasury::IncomingPaymentDetail,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams} for more
+      # details.
+      #
       # Simulate Incoming Payment Detail
       #
       # @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: {})
       #
-      # @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 amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      # @param as_of_date [Date, nil] Defaults to today.
+      #
+      # @param currency [Symbol, ModernTreasury::Models::Currency, nil] Defaults to the currency of the originating account.
+      #
+      # @param data [Object, nil] An object passed through to the simulated IPD that could reflect what a vendor w
+      #
+      # @param description [String, nil] Defaults to a random description.
+      #
+      # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction] One of `credit`, `debit`.
+      #
+      # @param internal_account_id [String] The ID of one of your internal accounts.
+      #
+      # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type] One of `ach`, `wire`, `check`.
+      #
+      # @param virtual_account_id [String, nil] An optional parameter to associate the incoming payment detail to a virtual acco
+      #
       # @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)
+        parsed, options = ModernTreasury::IncomingPaymentDetailCreateAsyncParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/simulations/incoming_payment_details/create_async",
           body: parsed,
-          model: ModernTreasury::Models::AsyncResponse,
+          model: ModernTreasury::AsyncResponse,
           options: options
         )
       end

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

@@ -4,46 +4,59 @@ module ModernTreasury
   module Resources
     class InternalAccounts
       class BalanceReports
+        # Some parameter documentations has been truncated, see
+        # {ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams} for more
+        # details.
+        #
         # create balance reports
         #
         # @overload create(internal_account_id, as_of_date:, as_of_time:, balance_report_type:, balances:, 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 as_of_date [Date] The date of the balance report in local time.
+        #
+        # @param as_of_time [String] The time (24-hour clock) of the balance report in local time.
+        #
+        # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType] The specific type of balance report. One of `intraday`, `previous_day`, `real_ti
+        #
+        # @param balances [Array<ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance>] An array of `Balance` objects.
+        #
         # @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)
+          parsed, options = ModernTreasury::InternalAccounts::BalanceReportCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["api/internal_accounts/%1$s/balance_reports", internal_account_id],
             body: parsed,
-            model: ModernTreasury::Models::InternalAccounts::BalanceReport,
+            model: ModernTreasury::InternalAccounts::BalanceReport,
             options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {ModernTreasury::Models::InternalAccounts::BalanceReportRetrieveParams} for more
+        # details.
+        #
         # Get a single balance report for a given internal account.
         #
         # @overload retrieve(id, internal_account_id:, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] Either the unique identifier of the balance report or latest for the latest bala
+        #
         # @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)
+          parsed, options = ModernTreasury::InternalAccounts::BalanceReportRetrieveParams.dump_request(params)
           internal_account_id =
             parsed.delete(:internal_account_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
@@ -51,51 +64,65 @@ module ModernTreasury
           @client.request(
             method: :get,
             path: ["api/internal_accounts/%1$s/balance_reports/%2$s", internal_account_id, id],
-            model: ModernTreasury::Models::InternalAccounts::BalanceReport,
+            model: ModernTreasury::InternalAccounts::BalanceReport,
             options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {ModernTreasury::Models::InternalAccounts::BalanceReportListParams} for more
+        # details.
+        #
         # Get all balance reports for a given internal account.
         #
         # @overload list(internal_account_id, after_cursor: nil, as_of_date: nil, balance_report_type: nil, per_page: nil, request_options: {})
         #
         # @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 as_of_date [Date] The date of the balance report in local time.
+        #
+        # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType] The specific type of balance report. One of `intraday`, `previous_day`, `real_ti
+        #
         # @param per_page [Integer]
+        #
         # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [ModernTreasury::Internal::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)
+          parsed, options = ModernTreasury::InternalAccounts::BalanceReportListParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["api/internal_accounts/%1$s/balance_reports", internal_account_id],
             query: parsed,
             page: ModernTreasury::Internal::Page,
-            model: ModernTreasury::Models::InternalAccounts::BalanceReport,
+            model: ModernTreasury::InternalAccounts::BalanceReport,
             options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {ModernTreasury::Models::InternalAccounts::BalanceReportDeleteParams} for more
+        # details.
+        #
         # Deletes a given balance report.
         #
         # @overload delete(id, internal_account_id:, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] Either the unique identifier of the balance report or latest for the latest bala
+        #
         # @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)
+          parsed, options = ModernTreasury::InternalAccounts::BalanceReportDeleteParams.dump_request(params)
           internal_account_id =
             parsed.delete(:internal_account_id) do
               raise ArgumentError.new("missing required path argument #{_1}")

data/lib/modern_treasury/resources/internal_accounts.rb

@@ -6,31 +6,45 @@ module ModernTreasury
       # @return [ModernTreasury::Resources::InternalAccounts::BalanceReports]
       attr_reader :balance_reports
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InternalAccountCreateParams} for more details.
+      #
       # create internal account
       #
-      # @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}]
+      # @overload create(connection_id:, currency:, name:, party_name:, account_type: nil, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {})
+      #
+      # @param connection_id [String] The identifier of the financial institution the account belongs to.
+      #
+      # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] Either "USD" or "CAD". Internal accounts created at Increase only supports "USD"
+      #
+      # @param name [String] The nickname of the account.
+      #
+      # @param party_name [String] The legal name of the entity which owns the account.
+      #
+      # @param account_type [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType] The account type, used to provision the appropriate account at the financial ins
+      #
+      # @param counterparty_id [String] The Counterparty associated to this account.
+      #
+      # @param legal_entity_id [String] The LegalEntity associated to this account.
+      #
+      # @param parent_account_id [String] The parent internal account of this new account.
+      #
+      # @param party_address [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress] The address associated with the owner or null.
+      #
+      # @param vendor_attributes [Hash{Symbol=>String}] A hash of vendor specific attributes that will be used when creating the account
+      #
       # @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)
+        parsed, options = ModernTreasury::InternalAccountCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/internal_accounts",
           body: parsed,
-          model: ModernTreasury::Models::InternalAccount,
+          model: ModernTreasury::InternalAccount,
           options: options
         )
       end
@@ -39,7 +53,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Unique identifier for the account.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::InternalAccount]
@@ -49,62 +64,82 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/internal_accounts/%1$s", id],
-          model: ModernTreasury::Models::InternalAccount,
+          model: ModernTreasury::InternalAccount,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InternalAccountUpdateParams} for more details.
+      #
       # update internal account
       #
       # @overload update(id, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: 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 id [String] Unique identifier for the account.
+      #
+      # @param counterparty_id [String] The Counterparty associated to this account.
+      #
+      # @param ledger_account_id [String] The Ledger Account associated to this account.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #
+      # @param name [String] The nickname for the internal account.
+      #
+      # @param parent_account_id [String] The parent internal account for this account.
+      #
       # @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)
+        parsed, options = ModernTreasury::InternalAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/internal_accounts/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::InternalAccount,
+          model: ModernTreasury::InternalAccount,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::InternalAccountListParams} for more details.
+      #
       # list internal accounts
       #
       # @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: {})
       #
       # @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 counterparty_id [String] Only return internal accounts associated with this counterparty.
+      #
+      # @param currency [Symbol, ModernTreasury::Models::Currency] Only return internal accounts with this currency.
+      #
+      # @param legal_entity_id [String] Only return internal accounts associated with this legal entity.
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      # @param payment_direction [Symbol, ModernTreasury::Models::TransactionDirection] Only return internal accounts that can originate payments with this direction.
+      #
+      # @param payment_type [Symbol, ModernTreasury::Models::InternalAccountListParams::PaymentType] Only return internal accounts that can make this type of payment.
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::InternalAccount>]
       #
       # @see ModernTreasury::Models::InternalAccountListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::InternalAccountListParams.dump_request(params)
+        parsed, options = ModernTreasury::InternalAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/internal_accounts",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::InternalAccount,
+          model: ModernTreasury::InternalAccount,
           options: options
         )
       end