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

data/lib/modern_treasury/resources/ledger_transactions/versions.rb

@@ -6,43 +6,34 @@ module ModernTreasury
       class Versions
         # Get a list of ledger transaction versions.
         #
-        # @param params [ModernTreasury::Models::LedgerTransactions::VersionListParams, Hash{Symbol=>Object}] .
+        # @overload list(after_cursor: nil, created_at: nil, ledger_account_statement_id: nil, ledger_transaction_id: nil, per_page: nil, version: nil, request_options: {})
         #
-        #   @option params [String, nil] :after_cursor
+        # @param after_cursor [String, nil]
+        # @param created_at [Hash{Symbol=>Time}]
+        # @param ledger_account_statement_id [String]
+        # @param ledger_transaction_id [String]
+        # @param per_page [Integer]
+        # @param version [Hash{Symbol=>Integer}]
+        # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @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 dates after Jan 1 2000 12:00 UTC, use
-        #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
-        #
-        #   @option params [String] :ledger_account_statement_id Get all ledger transaction versions that are included in the ledger account
-        #     statement.
-        #
-        #   @option params [String] :ledger_transaction_id Get all the ledger transaction versions corresponding to the ID of a ledger
-        #     transaction.
-        #
-        #   @option params [Integer] :per_page
-        #
-        #   @option params [Hash{Symbol=>Integer}] :version Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-        #     version. For example, for all versions after 2, use version%5Bgt%5D=2.
-        #
-        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion>]
+        # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion>]
         #
+        # @see ModernTreasury::Models::LedgerTransactions::VersionListParams
         def list(params = {})
           parsed, options = ModernTreasury::Models::LedgerTransactions::VersionListParams.dump_request(params)
           @client.request(
             method: :get,
             path: "api/ledger_transaction_versions",
             query: parsed,
-            page: ModernTreasury::Page,
+            page: ModernTreasury::Internal::Page,
             model: ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion,
             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_transactions.rb

@@ -8,38 +8,22 @@ module ModernTreasury
 
       # Create a ledger transaction.
       #
-      # @param params [ModernTreasury::Models::LedgerTransactionCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>] :ledger_entries An array of ledger entry objects.
-      #
-      #   @option params [String, nil] :description An optional description for internal use.
-      #
-      #   @option params [Time] :effective_at The timestamp (ISO8601 format) at which the ledger transaction happened for
-      #     reporting purposes.
-      #
-      #   @option params [Date] :effective_date The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-      #     purposes.
-      #
-      #   @option params [String] :external_id A unique string to represent the ledger transaction. Only one pending or posted
-      #     ledger transaction may have this ID in the ledger.
-      #
-      #   @option params [String] :ledgerable_id If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the id will be populated here, otherwise null.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType] :ledgerable_type If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the type will be populated here, otherwise null. This can be one of
-      #     payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      #     reversal.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status] :status To post a ledger transaction at creation, use `posted`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(ledger_entries:, description: nil, effective_at: nil, effective_date: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil, request_options: {})
+      #
+      # @param ledger_entries [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>]
+      # @param description [String, nil]
+      # @param effective_at [Time]
+      # @param effective_date [Date]
+      # @param external_id [String]
+      # @param ledgerable_id [String]
+      # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param status [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerTransaction]
       #
+      # @see ModernTreasury::Models::LedgerTransactionCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerTransactionCreateParams.dump_request(params)
         @client.request(
@@ -53,18 +37,18 @@ module ModernTreasury
 
       # Get details on a single ledger transaction.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerTransactionRetrieveParams, 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::LedgerTransaction]
       #
+      # @see ModernTreasury::Models::LedgerTransactionRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledger_transactions/%0s", id],
+          path: ["api/ledger_transactions/%1$s", id],
           model: ModernTreasury::Models::LedgerTransaction,
           options: params[:request_options]
         )
@@ -72,39 +56,26 @@ module ModernTreasury
 
       # Update the details of a ledger transaction.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerTransactionUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :description An optional description for internal use.
-      #
-      #   @option params [Time] :effective_at The timestamp (ISO8601 format) at which the ledger transaction happened for
-      #     reporting purposes.
+      # @overload update(id, description: nil, effective_at: nil, ledger_entries: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil, request_options: {})
       #
-      #   @option params [Array<ModernTreasury::Models::LedgerTransactionUpdateParams::LedgerEntry>] :ledger_entries An array of ledger entry objects.
-      #
-      #   @option params [String] :ledgerable_id If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the id will be populated here, otherwise null.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionUpdateParams::LedgerableType] :ledgerable_type If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the type will be populated here, otherwise null. This can be one of
-      #     payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      #     reversal.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionUpdateParams::Status] :status To post a ledger transaction at creation, use `posted`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param description [String, nil]
+      # @param effective_at [Time]
+      # @param ledger_entries [Array<ModernTreasury::Models::LedgerTransactionUpdateParams::LedgerEntry>]
+      # @param ledgerable_id [String]
+      # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionUpdateParams::LedgerableType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param status [Symbol, ModernTreasury::Models::LedgerTransactionUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerTransaction]
       #
+      # @see ModernTreasury::Models::LedgerTransactionUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerTransactionUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_transactions/%0s", id],
+          path: ["api/ledger_transactions/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerTransaction,
           options: options
@@ -113,70 +84,39 @@ module ModernTreasury
 
       # Get a list of ledger transactions.
       #
-      # @param params [ModernTreasury::Models::LedgerTransactionListParams, 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}] :effective_at Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
-      #     effective at. For example, for all transactions after Jan 1 2000, use
-      #     effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.
-      #
-      #   @option params [Hash{Symbol=>Time}] :effective_date Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by
-      #     effective date. For example, for all dates after Jan 1 2000, use
-      #     effective_date%5Bgt%5D=2000-01-01.
-      #
-      #   @option params [String] :external_id
-      #
-      #   @option params [String] :ledger_account_category_id
-      #
-      #   @option params [String] :ledger_account_id
-      #
-      #   @option params [String] :ledger_account_settlement_id
-      #
-      #   @option params [String] :ledger_id
-      #
-      #   @option params [String] :ledgerable_id
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionListParams::LedgerableType] :ledgerable_type
-      #
-      #   @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 [ModernTreasury::Models::LedgerTransactionListParams::OrderBy] :order_by Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
-      #     to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
-      #     by only one field at a time is supported.
-      #
-      #   @option params [String] :partially_posts_ledger_transaction_id
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [Hash{Symbol=>Time}] :posted_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-      #     posted_at%5Bgt%5D=2000-01-01T12:00:00Z.
-      #
-      #   @option params [String] :reverses_ledger_transaction_id
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionListParams::Status] :status
-      #
-      #   @option params [Hash{Symbol=>Time}] :updated_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     posted 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::LedgerTransaction>]
-      #
+      # @overload list(id: nil, after_cursor: nil, effective_at: nil, effective_date: nil, external_id: nil, ledger_account_category_id: nil, ledger_account_id: nil, ledger_account_settlement_id: nil, ledger_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, order_by: nil, partially_posts_ledger_transaction_id: nil, per_page: nil, posted_at: nil, reverses_ledger_transaction_id: nil, status: nil, updated_at: nil, request_options: {})
+      #
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param effective_at [Hash{Symbol=>Time}]
+      # @param effective_date [Hash{Symbol=>Time}]
+      # @param external_id [String]
+      # @param ledger_account_category_id [String]
+      # @param ledger_account_id [String]
+      # @param ledger_account_settlement_id [String]
+      # @param ledger_id [String]
+      # @param ledgerable_id [String]
+      # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionListParams::LedgerableType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param order_by [ModernTreasury::Models::LedgerTransactionListParams::OrderBy]
+      # @param partially_posts_ledger_transaction_id [String]
+      # @param per_page [Integer]
+      # @param posted_at [Hash{Symbol=>Time}]
+      # @param reverses_ledger_transaction_id [String]
+      # @param status [Symbol, ModernTreasury::Models::LedgerTransactionListParams::Status]
+      # @param updated_at [Hash{Symbol=>Time}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerTransaction>]
+      #
+      # @see ModernTreasury::Models::LedgerTransactionListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerTransactionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_transactions",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerTransaction,
           options: options
         )
@@ -184,32 +124,23 @@ module ModernTreasury
 
       # Create a ledger transaction that partially posts another ledger transaction.
       #
-      # @param id [String] The ID of the ledger transaction to partially post.
-      #
-      # @param params [ModernTreasury::Models::LedgerTransactionCreatePartialPostParams, Hash{Symbol=>Object}] .
+      # @overload create_partial_post(id, posted_ledger_entries:, description: nil, effective_at: nil, metadata: nil, request_options: {})
       #
-      #   @option params [Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>] :posted_ledger_entries An array of ledger entry objects to be set on the posted ledger transaction.
-      #     There must be one entry for each of the existing entries with a lesser amount
-      #     than the existing entry.
-      #
-      #   @option params [String] :description An optional free-form description for the posted ledger transaction. Maximum of
-      #     1000 characters allowed.
-      #
-      #   @option params [Time] :effective_at The timestamp (IS08601 format) at which the posted ledger transaction happened
-      #     for reporting purposes.
-      #
-      #   @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 posted_ledger_entries [Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>]
+      # @param description [String]
+      # @param effective_at [Time]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerTransaction]
       #
+      # @see ModernTreasury::Models::LedgerTransactionCreatePartialPostParams
       def create_partial_post(id, params)
         parsed, options = ModernTreasury::Models::LedgerTransactionCreatePartialPostParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["api/ledger_transactions/%0s/partial_post", id],
+          path: ["api/ledger_transactions/%1$s/partial_post", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerTransaction,
           options: options
@@ -218,48 +149,35 @@ module ModernTreasury
 
       # Create a ledger transaction reversal.
       #
-      # @param id [String] The id of ledger transaction to reverse.
-      #
-      # @param params [ModernTreasury::Models::LedgerTransactionCreateReversalParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :description An optional free-form description for the reversal ledger transaction. Maximum
-      #     of 1000 characters allowed.
-      #
-      #   @option params [Time, nil] :effective_at The timestamp (ISO8601 format) at which the reversal ledger transaction happened
-      #     for reporting purposes. It defaults to the `effective_at` of the original ledger
-      #     transaction if not provided.
+      # @overload create_reversal(id, description: nil, effective_at: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :external_id Must be unique within the ledger.
-      #
-      #   @option params [String] :ledgerable_id Specify this if you'd like to link the reversal ledger transaction to a Payment
-      #     object like Return or Reversal.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::LedgerableType] :ledgerable_type Specify this if you'd like to link the reversal ledger transaction to a Payment
-      #     object like Return or Reversal.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data to be added to the reversal ledger transaction as key-value
-      #     pairs. Both the key and value must be strings.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::Status] :status Status of the reversal ledger transaction. It defaults to `posted` if not
-      #     provided.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param description [String]
+      # @param effective_at [Time, nil]
+      # @param external_id [String]
+      # @param ledgerable_id [String]
+      # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::LedgerableType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param status [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerTransaction]
       #
+      # @see ModernTreasury::Models::LedgerTransactionCreateReversalParams
       def create_reversal(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerTransactionCreateReversalParams.dump_request(params)
         @client.request(
           method: :post,
-          path: ["api/ledger_transactions/%0s/reversal", id],
+          path: ["api/ledger_transactions/%1$s/reversal", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerTransaction,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
         @versions = ModernTreasury::Resources::LedgerTransactions::Versions.new(client: client)

data/lib/modern_treasury/resources/ledgerable_events.rb

@@ -5,21 +5,17 @@ module ModernTreasury
     class LedgerableEvents
       # Create a ledgerable event.
       #
-      # @param params [ModernTreasury::Models::LedgerableEventCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(name:, custom_data: nil, description: nil, metadata: nil, request_options: {})
       #
-      #   @option params [String] :name Name of the ledgerable event.
-      #
-      #   @option params [Object, nil] :custom_data Additionally data to be used by the Ledger Event Handler.
-      #
-      #   @option params [String, nil] :description Description of the ledgerable event.
-      #
-      #   @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 name [String]
+      # @param custom_data [Object, nil]
+      # @param description [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerableEvent]
       #
+      # @see ModernTreasury::Models::LedgerableEventCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerableEventCreateParams.dump_request(params)
         @client.request(
@@ -33,25 +29,26 @@ module ModernTreasury
 
       # Get details on a single ledgerable event.
       #
-      # @param id [String] id
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerableEventRetrieveParams, 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::LedgerableEvent]
       #
+      # @see ModernTreasury::Models::LedgerableEventRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledgerable_events/%0s", id],
+          path: ["api/ledgerable_events/%1$s", id],
           model: ModernTreasury::Models::LedgerableEvent,
           options: params[:request_options]
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/ledgers.rb

@@ -5,19 +5,16 @@ module ModernTreasury
     class Ledgers
       # Create a ledger.
       #
-      # @param params [ModernTreasury::Models::LedgerCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(name:, description: nil, metadata: nil, request_options: {})
       #
-      #   @option params [String] :name The name of the ledger.
-      #
-      #   @option params [String, nil] :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 name [String]
+      # @param description [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Ledger]
       #
+      # @see ModernTreasury::Models::LedgerCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerCreateParams.dump_request(params)
         @client.request(
@@ -31,18 +28,18 @@ module ModernTreasury
 
       # Get details on a single ledger.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerRetrieveParams, 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::Ledger]
       #
+      # @see ModernTreasury::Models::LedgerRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledgers/%0s", id],
+          path: ["api/ledgers/%1$s", id],
           model: ModernTreasury::Models::Ledger,
           options: params[:request_options]
         )
@@ -50,26 +47,22 @@ module ModernTreasury
 
       # Update the details of a ledger.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :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 [String] :name The name of the ledger.
+      # @overload update(id, description: nil, metadata: nil, name: nil, request_options: {})
       #
-      #   @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::Ledger]
       #
+      # @see ModernTreasury::Models::LedgerUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledgers/%0s", id],
+          path: ["api/ledgers/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::Ledger,
           options: options
@@ -78,34 +71,25 @@ module ModernTreasury
 
       # Get a list of ledgers.
       #
-      # @param params [ModernTreasury::Models::LedgerListParams, Hash{Symbol=>Object}] .
+      # @overload list(id: nil, after_cursor: nil, metadata: nil, per_page: nil, updated_at: nil, request_options: {})
       #
-      #   @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`.
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param updated_at [Hash{Symbol=>Time}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @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 [Hash{Symbol=>Time}] :updated_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     posted 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::Ledger>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Ledger>]
       #
+      # @see ModernTreasury::Models::LedgerListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledgers",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Ledger,
           options: options
         )
@@ -113,25 +97,26 @@ module ModernTreasury
 
       # Delete a ledger.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerDeleteParams, 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::Ledger]
       #
+      # @see ModernTreasury::Models::LedgerDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/ledgers/%0s", id],
+          path: ["api/ledgers/%1$s", id],
           model: ModernTreasury::Models::Ledger,
           options: params[:request_options]
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end