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

data/lib/modern_treasury/resources/ledger_account_categories.rb

@@ -5,30 +5,21 @@ module ModernTreasury
     class LedgerAccountCategories
       # Create a ledger account category.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :currency The currency of the ledger account category.
-      #
-      #   @option params [String] :ledger_id The id of the ledger that this account category belongs to.
-      #
-      #   @option params [String] :name The name of the ledger account category.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :normal_balance The normal balance of the ledger account category.
-      #
-      #   @option params [Integer, nil] :currency_exponent The currency exponent of the ledger account category.
-      #
-      #   @option params [String, nil] :description The description of the ledger account category.
-      #
-      #   @option params [Array<String>] :ledger_account_category_ids The array of ledger account category ids that this ledger account category
-      #     should be a child of.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, metadata: nil, request_options: {})
+      #
+      # @param currency [String]
+      # @param ledger_id [String]
+      # @param name [String]
+      # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param currency_exponent [Integer, nil]
+      # @param description [String, nil]
+      # @param ledger_account_category_ids [Array<String>]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountCategory]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerAccountCategoryCreateParams.dump_request(params)
         @client.request(
@@ -42,23 +33,20 @@ module ModernTreasury
 
       # Get the details on a single ledger account category.
       #
-      # @param id [String] id
+      # @overload retrieve(id, balances: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances] :balances For example, if you want the balances as of a particular time (ISO8601), the
-      #     encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-      #     The balances as of a time are inclusive of entries with that exact time.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param balances [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountCategory]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryRetrieveParams
       def retrieve(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountCategoryRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["api/ledger_account_categories/%0s", id],
+          path: ["api/ledger_account_categories/%1$s", id],
           query: parsed,
           model: ModernTreasury::Models::LedgerAccountCategory,
           options: options
@@ -67,26 +55,22 @@ module ModernTreasury
 
       # Update the details of a ledger account category.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :description The description of the ledger account category.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      # @overload update(id, description: nil, metadata: nil, name: nil, request_options: {})
       #
-      #   @option params [String] :name The name of the ledger account category.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param description [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountCategory]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountCategoryUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_account_categories/%0s", id],
+          path: ["api/ledger_account_categories/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerAccountCategory,
           options: options
@@ -95,45 +79,30 @@ module ModernTreasury
 
       # Get a list of ledger account categories.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Array<String>] :id If you have specific IDs to retrieve in bulk, you can pass them as query
-      #     parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances] :balances For example, if you want the balances as of a particular time (ISO8601), the
-      #     encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-      #     The balances as of a time are inclusive of entries with that exact time.
+      # @overload list(id: nil, after_cursor: nil, balances: nil, currency: nil, ledger_account_id: nil, ledger_id: nil, metadata: nil, name: nil, parent_ledger_account_category_id: nil, per_page: nil, request_options: {})
       #
-      #   @option params [String] :currency
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param balances [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances]
+      # @param currency [String]
+      # @param ledger_account_id [String]
+      # @param ledger_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String]
+      # @param parent_ledger_account_category_id [String]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :ledger_account_id Query categories which contain a ledger account directly or through child
-      #     categories.
-      #
-      #   @option params [String] :ledger_id
-      #
-      #   @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 [String] :name
-      #
-      #   @option params [String] :parent_ledger_account_category_id Query categories that are nested underneath a parent category
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerAccountCategory>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountCategory>]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountCategoryListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_account_categories",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerAccountCategory,
           options: options
         )
@@ -141,18 +110,18 @@ module ModernTreasury
 
       # Delete a ledger account category.
       #
-      # @param id [String] id
+      # @overload delete(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryDeleteParams, 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::LedgerAccountCategory]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/ledger_account_categories/%0s", id],
+          path: ["api/ledger_account_categories/%1$s", id],
           model: ModernTreasury::Models::LedgerAccountCategory,
           options: params[:request_options]
         )
@@ -160,24 +129,25 @@ module ModernTreasury
 
       # Add a ledger account to a ledger account category.
       #
-      # @param ledger_account_id [String] ledger_account_id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryAddLedgerAccountParams, Hash{Symbol=>Object}] .
+      # @overload add_ledger_account(ledger_account_id, id:, request_options: {})
       #
-      #   @option params [String] :id id
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param ledger_account_id [String]
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryAddLedgerAccountParams
       def add_ledger_account(ledger_account_id, params)
-        parsed, options = ModernTreasury::Models::LedgerAccountCategoryAddLedgerAccountParams.dump_request(params)
-        id = parsed.fetch(:id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        parsed, options =
+          ModernTreasury::Models::LedgerAccountCategoryAddLedgerAccountParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :put,
-          path: ["api/ledger_account_categories/%0s/ledger_accounts/%1s", id, ledger_account_id],
+          path: ["api/ledger_account_categories/%1$s/ledger_accounts/%2$s", id, ledger_account_id],
           model: NilClass,
           options: options
         )
@@ -185,24 +155,25 @@ module ModernTreasury
 
       # Add a ledger account category to a ledger account category.
       #
-      # @param sub_category_id [String] sub_category_id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :id id
+      # @overload add_nested_category(sub_category_id, id:, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param sub_category_id [String]
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams
       def add_nested_category(sub_category_id, params)
-        parsed, options = ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams.dump_request(params)
-        id = parsed.fetch(:id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        parsed, options =
+          ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :put,
-          path: ["api/ledger_account_categories/%0s/ledger_account_categories/%1s", id, sub_category_id],
+          path: ["api/ledger_account_categories/%1$s/ledger_account_categories/%2$s", id, sub_category_id],
           model: NilClass,
           options: options
         )
@@ -210,24 +181,25 @@ module ModernTreasury
 
       # Remove a ledger account from a ledger account category.
       #
-      # @param ledger_account_id [String] ledger_account_id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryRemoveLedgerAccountParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :id id
+      # @overload remove_ledger_account(ledger_account_id, id:, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param ledger_account_id [String]
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryRemoveLedgerAccountParams
       def remove_ledger_account(ledger_account_id, params)
-        parsed, options = ModernTreasury::Models::LedgerAccountCategoryRemoveLedgerAccountParams.dump_request(params)
-        id = parsed.fetch(:id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        parsed, options =
+          ModernTreasury::Models::LedgerAccountCategoryRemoveLedgerAccountParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :delete,
-          path: ["api/ledger_account_categories/%0s/ledger_accounts/%1s", id, ledger_account_id],
+          path: ["api/ledger_account_categories/%1$s/ledger_accounts/%2$s", id, ledger_account_id],
           model: NilClass,
           options: options
         )
@@ -235,31 +207,33 @@ module ModernTreasury
 
       # Delete a ledger account category from a ledger account category.
       #
-      # @param sub_category_id [String] sub_category_id
+      # @overload remove_nested_category(sub_category_id, id:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :id id
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param sub_category_id [String]
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams
       def remove_nested_category(sub_category_id, params)
-        parsed, options = ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams.dump_request(params)
-        id = parsed.fetch(:id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        parsed, options =
+          ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :delete,
-          path: ["api/ledger_account_categories/%0s/ledger_account_categories/%1s", id, sub_category_id],
+          path: ["api/ledger_account_categories/%1$s/ledger_account_categories/%2$s", id, sub_category_id],
           model: NilClass,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rb

@@ -6,22 +6,21 @@ module ModernTreasury
       class AccountEntries
         # Add ledger entries to a draft ledger account settlement.
         #
-        # @param id [String] id
+        # @overload update(id, ledger_entry_ids:, request_options: {})
         #
-        # @param params [ModernTreasury::Models::LedgerAccountSettlements::AccountEntryUpdateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<String>, nil] :ledger_entry_ids The ids of the ledger entries that are to be added or removed from the ledger
-        #     account settlement.
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param id [String]
+        # @param ledger_entry_ids [Array<String>, nil]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
         #
+        # @see ModernTreasury::Models::LedgerAccountSettlements::AccountEntryUpdateParams
         def update(id, params)
-          parsed, options = ModernTreasury::Models::LedgerAccountSettlements::AccountEntryUpdateParams.dump_request(params)
+          parsed, options =
+            ModernTreasury::Models::LedgerAccountSettlements::AccountEntryUpdateParams.dump_request(params)
           @client.request(
             method: :patch,
-            path: ["api/ledger_account_settlements/%0s/ledger_entries", id],
+            path: ["api/ledger_account_settlements/%1$s/ledger_entries", id],
             body: parsed,
             model: NilClass,
             options: options
@@ -30,30 +29,30 @@ module ModernTreasury
 
         # Remove ledger entries from a draft ledger account settlement.
         #
-        # @param id [String] id
-        #
-        # @param params [ModernTreasury::Models::LedgerAccountSettlements::AccountEntryDeleteParams, Hash{Symbol=>Object}] .
+        # @overload delete(id, ledger_entry_ids:, request_options: {})
         #
-        #   @option params [Array<Object>, nil] :ledger_entry_ids The ids of the ledger entries that are to be added or removed from the ledger
-        #     account settlement.
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param id [String]
+        # @param ledger_entry_ids [Array<String>, nil]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
         #
+        # @see ModernTreasury::Models::LedgerAccountSettlements::AccountEntryDeleteParams
         def delete(id, params)
-          parsed, options = ModernTreasury::Models::LedgerAccountSettlements::AccountEntryDeleteParams.dump_request(params)
+          parsed, options =
+            ModernTreasury::Models::LedgerAccountSettlements::AccountEntryDeleteParams.dump_request(params)
           @client.request(
             method: :delete,
-            path: ["api/ledger_account_settlements/%0s/ledger_entries", id],
+            path: ["api/ledger_account_settlements/%1$s/ledger_entries", id],
             body: parsed,
             model: NilClass,
             options: options
           )
         end
 
-        # @param client [ModernTreasury::Client]
+        # @api private
         #
+        # @param client [ModernTreasury::Client]
         def initialize(client:)
           @client = client
         end

data/lib/modern_treasury/resources/ledger_account_settlements.rb

@@ -8,37 +8,21 @@ module ModernTreasury
 
       # Create a ledger account settlement.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountSettlementCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :contra_ledger_account_id The id of the contra ledger account that sends to or receives funds from the
-      #     settled ledger account.
-      #
-      #   @option params [String] :settled_ledger_account_id The id of the settled ledger account whose ledger entries are queried against,
-      #     and its balance is reduced as a result.
-      #
-      #   @option params [Boolean, nil] :allow_either_direction If true, the settlement amount and settlement_entry_direction will bring the
-      #     settlement ledger account's balance closer to zero, even if the balance is
-      #     negative.
-      #
-      #   @option params [String, nil] :description The description of the ledger account settlement.
-      #
-      #   @option params [Time, nil] :effective_at_upper_bound The exclusive upper bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account settlement. The default value is the
-      #     created_at timestamp of the ledger account settlement.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Boolean, nil] :skip_settlement_ledger_transaction It is set to `false` by default. It should be set to `true` when migrating
-      #     existing settlements.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status, nil] :status The status of the ledger account settlement. It is set to `pending` by default.
-      #     To post a ledger account settlement at creation, use `posted`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(contra_ledger_account_id:, settled_ledger_account_id:, allow_either_direction: nil, description: nil, effective_at_upper_bound: nil, metadata: nil, skip_settlement_ledger_transaction: nil, status: nil, request_options: {})
+      #
+      # @param contra_ledger_account_id [String]
+      # @param settled_ledger_account_id [String]
+      # @param allow_either_direction [Boolean, nil]
+      # @param description [String, nil]
+      # @param effective_at_upper_bound [Time, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param skip_settlement_ledger_transaction [Boolean, nil]
+      # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountSettlement]
       #
+      # @see ModernTreasury::Models::LedgerAccountSettlementCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerAccountSettlementCreateParams.dump_request(params)
         @client.request(
@@ -52,18 +36,18 @@ module ModernTreasury
 
       # Get details on a single ledger account settlement.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountSettlementRetrieveParams, 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::LedgerAccountSettlement]
       #
+      # @see ModernTreasury::Models::LedgerAccountSettlementRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledger_account_settlements/%0s", id],
+          path: ["api/ledger_account_settlements/%1$s", id],
           model: ModernTreasury::Models::LedgerAccountSettlement,
           options: params[:request_options]
         )
@@ -71,27 +55,22 @@ module ModernTreasury
 
       # Update the details of a ledger account settlement.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountSettlementUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :description The description of the ledger account settlement.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      # @overload update(id, description: nil, metadata: nil, status: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status] :status To post a pending ledger account settlement, use `posted`. To archive a pending
-      #     ledger transaction, use `archived`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param description [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountSettlement]
       #
+      # @see ModernTreasury::Models::LedgerAccountSettlementUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountSettlementUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_account_settlements/%0s", id],
+          path: ["api/ledger_account_settlements/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerAccountSettlement,
           options: options
@@ -100,56 +79,42 @@ module ModernTreasury
 
       # Get a list of ledger account settlements.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountSettlementListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Array<String>] :id If you have specific IDs to retrieve in bulk, you can pass them as query
-      #     parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Hash{Symbol=>Time}] :created_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-      #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
-      #
-      #   @option params [String] :ledger_id
-      #
-      #   @option params [String] :ledger_transaction_id
-      #
-      #   @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.
+      # @overload list(id: nil, after_cursor: nil, created_at: nil, ledger_id: nil, ledger_transaction_id: nil, metadata: nil, per_page: nil, settled_ledger_account_id: nil, settlement_entry_direction: nil, updated_at: nil, request_options: {})
       #
-      #   @option params [Integer] :per_page
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param created_at [Hash{Symbol=>Time}]
+      # @param ledger_id [String]
+      # @param ledger_transaction_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param settled_ledger_account_id [String]
+      # @param settlement_entry_direction [String]
+      # @param updated_at [Hash{Symbol=>Time}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :settled_ledger_account_id
-      #
-      #   @option params [String] :settlement_entry_direction
-      #
-      #   @option params [Hash{Symbol=>Time}] :updated_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-      #     updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerAccountSettlement>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountSettlement>]
       #
+      # @see ModernTreasury::Models::LedgerAccountSettlementListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountSettlementListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_account_settlements",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerAccountSettlement,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
-        @account_entries = ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries.new(client: client)
+        @account_entries =
+          ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries.new(client: client)
       end
     end
   end