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

data/lib/modern_treasury/resources/ledger_entries.rb

@@ -5,21 +5,20 @@ module ModernTreasury
     class LedgerEntries
       # Get details on a single ledger entry.
       #
-      # @param id [String] id
+      # @overload retrieve(id, show_balances: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerEntryRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :show_balances If true, response will include the balances attached to the ledger entry. If
-      #     there is no balance available, null will be returned instead.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param show_balances [Boolean]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerEntry]
+      #
+      # @see ModernTreasury::Models::LedgerEntryRetrieveParams
       def retrieve(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerEntryRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["api/ledger_entries/%0s", id],
+          path: ["api/ledger_entries/%1$s", id],
           query: parsed,
           model: ModernTreasury::Models::LedgerEntry,
           options: options
@@ -28,21 +27,20 @@ module ModernTreasury
 
       # Update the details of a ledger entry.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerEntryUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, 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 metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerEntry]
+      #
+      # @see ModernTreasury::Models::LedgerEntryUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerEntryUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_entries/%0s", id],
+          path: ["api/ledger_entries/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerEntry,
           options: options
@@ -51,83 +49,47 @@ module ModernTreasury
 
       # Get a list of all ledger entries.
       #
-      # @param params [ModernTreasury::Models::LedgerEntryListParams, 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 [Integer] :as_of_lock_version Shows all ledger entries that were present on a ledger account at a particular
-      #     `lock_version`. You must also specify `ledger_account_id`.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction If true, response will include ledger entries that were deleted. When you update
-      #     a ledger transaction to specify a new set of entries, the previous entries are
-      #     deleted.
-      #
-      #   @option params [Hash{Symbol=>Time}] :effective_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     transaction's effective time. Format ISO8601
-      #
-      #   @option params [Hash{Symbol=>Date}] :effective_date Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     transaction's effective date. Format YYYY-MM-DD
-      #
-      #   @option params [String] :ledger_account_category_id Get all ledger entries that match the direction specified. One of `credit`,
-      #     `debit`.
-      #
-      #   @option params [String] :ledger_account_id
-      #
-      #   @option params [Hash{Symbol=>Integer}] :ledger_account_lock_version Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     lock_version of a ledger account. For example, for all entries created at or
-      #     before before lock_version 1000 of a ledger account, use
-      #     `ledger_account_lock_version%5Blte%5D=1000`.
-      #
-      #   @option params [String] :ledger_account_payout_id
-      #
-      #   @option params [String] :ledger_account_settlement_id
-      #
-      #   @option params [String] :ledger_account_statement_id Get all ledger entries that are included in the ledger account statement.
-      #
-      #   @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.
-      #
-      #   @option params [ModernTreasury::Models::LedgerEntryListParams::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 [Integer] :per_page
-      #
-      #   @option params [Boolean] :show_balances If true, response will include the balances attached to the ledger entry. If
-      #     there is no balance available, null will be returned instead.
-      #
-      #   @option params [Boolean] :show_deleted If true, response will include ledger entries that were deleted. When you update
-      #     a ledger transaction to specify a new set of entries, the previous entries are
-      #     deleted.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status] :status Get all ledger entries that match the status specified. One of `pending`,
-      #     `posted`, or `archived`.
-      #
-      #   @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::LedgerEntry>]
+      # @overload list(id: nil, after_cursor: nil, as_of_lock_version: nil, direction: nil, effective_at: nil, effective_date: nil, ledger_account_category_id: nil, ledger_account_id: nil, ledger_account_lock_version: nil, ledger_account_payout_id: nil, ledger_account_settlement_id: nil, ledger_account_statement_id: nil, ledger_transaction_id: nil, metadata: nil, order_by: nil, per_page: nil, show_balances: nil, show_deleted: nil, status: nil, updated_at: nil, request_options: {})
+      #
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param as_of_lock_version [Integer]
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      # @param effective_at [Hash{Symbol=>Time}]
+      # @param effective_date [Hash{Symbol=>Date}]
+      # @param ledger_account_category_id [String]
+      # @param ledger_account_id [String]
+      # @param ledger_account_lock_version [Hash{Symbol=>Integer}]
+      # @param ledger_account_payout_id [String]
+      # @param ledger_account_settlement_id [String]
+      # @param ledger_account_statement_id [String]
+      # @param ledger_transaction_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param order_by [ModernTreasury::Models::LedgerEntryListParams::OrderBy]
+      # @param per_page [Integer]
+      # @param show_balances [Boolean]
+      # @param show_deleted [Boolean]
+      # @param status [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status]
+      # @param updated_at [Hash{Symbol=>Time}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerEntry>]
+      #
+      # @see ModernTreasury::Models::LedgerEntryListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerEntryListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_entries",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerEntry,
           options: options
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/ledger_event_handlers.rb

@@ -5,26 +5,20 @@ module ModernTreasury
     class LedgerEventHandlers
       # create ledger_event_handler
       #
-      # @param params [ModernTreasury::Models::LedgerEventHandlerCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(ledger_transaction_template:, name:, conditions: nil, description: nil, ledger_id: nil, metadata: nil, variables: nil, request_options: {})
       #
-      #   @option params [ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate] :ledger_transaction_template
-      #
-      #   @option params [String] :name Name of the ledger event handler.
-      #
-      #   @option params [ModernTreasury::Models::LedgerEventHandlerCreateParams::Conditions, nil] :conditions
-      #
-      #   @option params [String, nil] :description An optional description.
-      #
-      #   @option params [String] :ledger_id The id of the ledger that this account belongs to.
-      #
-      #   @option params [Hash{Symbol=>String}, nil] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil] :variables
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param ledger_transaction_template [ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate]
+      # @param name [String]
+      # @param conditions [ModernTreasury::Models::LedgerEventHandlerCreateParams::Conditions, nil]
+      # @param description [String, nil]
+      # @param ledger_id [String]
+      # @param metadata [Hash{Symbol=>String}, nil]
+      # @param variables [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerEventHandler]
+      #
+      # @see ModernTreasury::Models::LedgerEventHandlerCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerEventHandlerCreateParams.dump_request(params)
         @client.request(
@@ -38,17 +32,18 @@ module ModernTreasury
 
       # Get details on a single ledger event handler.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerEventHandlerRetrieveParams, 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::LedgerEventHandler]
+      #
+      # @see ModernTreasury::Models::LedgerEventHandlerRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledger_event_handlers/%0s", id],
+          path: ["api/ledger_event_handlers/%1$s", id],
           model: ModernTreasury::Models::LedgerEventHandler,
           options: params[:request_options]
         )
@@ -56,32 +51,25 @@ module ModernTreasury
 
       # Get a list of ledger event handlers.
       #
-      # @param params [ModernTreasury::Models::LedgerEventHandlerListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Hash{Symbol=>Time}] :created_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
-      #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
-      #
-      #   @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(after_cursor: nil, created_at: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
       #
-      #   @option params [String] :name
+      # @param after_cursor [String, nil]
+      # @param created_at [Hash{Symbol=>Time}]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [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::LedgerEventHandler>]
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerEventHandler>]
+      # @see ModernTreasury::Models::LedgerEventHandlerListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerEventHandlerListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_event_handlers",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerEventHandler,
           options: options
         )
@@ -89,22 +77,25 @@ module ModernTreasury
 
       # Archive a ledger event handler.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerEventHandlerDeleteParams, 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::LedgerEventHandler]
+      #
+      # @see ModernTreasury::Models::LedgerEventHandlerDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/ledger_event_handlers/%0s", id],
+          path: ["api/ledger_event_handlers/%1$s", id],
           model: ModernTreasury::Models::LedgerEventHandler,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

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

@@ -6,40 +6,33 @@ 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.
+        # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion>]
         #
-        #   @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>]
+        # @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
 
+        # @api private
+        #
         # @param client [ModernTreasury::Client]
         def initialize(client:)
           @client = client