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

data/lib/modern_treasury/resources/ledger_account_balance_monitors.rb

@@ -5,20 +5,17 @@ module ModernTreasury
     class LedgerAccountBalanceMonitors
       # Create a ledger account balance monitor.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(alert_condition:, ledger_account_id:, description: nil, metadata: nil, request_options: {})
       #
-      #   @option params [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition] :alert_condition Describes the condition that must be satisfied for the monitor to be triggered.
-      #
-      #   @option params [String] :ledger_account_id The ledger account associated with this balance monitor.
-      #
-      #   @option params [String] :description An optional, free-form description for internal use.
-      #
-      #   @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
+      # @param alert_condition [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition]
+      # @param ledger_account_id [String]
+      # @param description [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      #
+      # @see ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams.dump_request(params)
         @client.request(
@@ -32,17 +29,18 @@ module ModernTreasury
 
       # Get details on a single ledger account balance monitor.
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountBalanceMonitorRetrieveParams, 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::LedgerAccountBalanceMonitor]
+      #
+      # @see ModernTreasury::Models::LedgerAccountBalanceMonitorRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledger_account_balance_monitors/%0s", id],
+          path: ["api/ledger_account_balance_monitors/%1$s", id],
           model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
           options: params[:request_options]
         )
@@ -50,23 +48,21 @@ module ModernTreasury
 
       # Update a ledger account balance monitor.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :description An optional, free-form description for internal use.
+      # @overload update(id, description: nil, metadata: nil, request_options: {})
       #
-      #   @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
+      # @param id [String]
+      # @param description [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      #
+      # @see ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_account_balance_monitors/%0s", id],
+          path: ["api/ledger_account_balance_monitors/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
           options: options
@@ -75,31 +71,25 @@ module ModernTreasury
 
       # Get a list of ledger account balance monitors.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountBalanceMonitorListParams, 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 [String] :ledger_account_id Query the balance monitors for a single ledger account.
+      # @overload list(id: nil, after_cursor: nil, ledger_account_id: nil, metadata: 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 id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param ledger_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Integer] :per_page
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountBalanceMonitor>]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerAccountBalanceMonitor>]
+      # @see ModernTreasury::Models::LedgerAccountBalanceMonitorListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountBalanceMonitorListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_account_balance_monitors",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
           options: options
         )
@@ -107,22 +97,25 @@ module ModernTreasury
 
       # Delete a ledger account balance monitor.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountBalanceMonitorDeleteParams, 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 [ModernTreasury::Models::LedgerAccountBalanceMonitor]
+      #
+      # @see ModernTreasury::Models::LedgerAccountBalanceMonitorDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/ledger_account_balance_monitors/%0s", id],
+          path: ["api/ledger_account_balance_monitors/%1$s", id],
           model: ModernTreasury::Models::LedgerAccountBalanceMonitor,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/ledger_account_categories.rb

@@ -5,29 +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(
@@ -41,22 +33,20 @@ module ModernTreasury
 
       # Get the details on a single ledger account category.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, balances: nil, request_options: {})
       #
-      #   @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
@@ -65,25 +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
@@ -92,44 +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.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountCategory>]
       #
-      #   @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>]
+      # @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
         )
@@ -137,17 +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]
         )
@@ -155,15 +129,15 @@ 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)
@@ -173,7 +147,7 @@ module ModernTreasury
           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
         )
@@ -181,15 +155,15 @@ module ModernTreasury
 
       # Add a ledger account category to a ledger account category.
       #
-      # @param sub_category_id [String] sub_category_id
+      # @overload add_nested_category(sub_category_id, id:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams, 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::LedgerAccountCategoryAddNestedCategoryParams
       def add_nested_category(sub_category_id, params)
         parsed, options =
           ModernTreasury::Models::LedgerAccountCategoryAddNestedCategoryParams.dump_request(params)
@@ -199,7 +173,7 @@ module ModernTreasury
           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
         )
@@ -207,15 +181,15 @@ 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)
@@ -225,7 +199,7 @@ module ModernTreasury
           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
         )
@@ -233,15 +207,15 @@ module ModernTreasury
 
       # Delete a ledger account category from a ledger account category.
       #
-      # @param sub_category_id [String] sub_category_id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :id id
+      # @overload remove_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::LedgerAccountCategoryRemoveNestedCategoryParams
       def remove_nested_category(sub_category_id, params)
         parsed, options =
           ModernTreasury::Models::LedgerAccountCategoryRemoveNestedCategoryParams.dump_request(params)
@@ -251,12 +225,14 @@ module ModernTreasury
           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
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

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)
           @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,28 +29,29 @@ 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)
           @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
 
+        # @api private
+        #
         # @param client [ModernTreasury::Client]
         def initialize(client:)
           @client = client