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

data/lib/modern_treasury/resources/ledger_account_settlements.rb

@@ -8,36 +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(
@@ -51,17 +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]
         )
@@ -69,26 +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.
+      # @overload update(id, description: nil, metadata: nil, status: 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 [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
@@ -97,50 +79,37 @@ 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
+      # @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 [String] :ledger_transaction_id
+      # @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 [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.
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccountSettlement>]
       #
-      #   @option params [Integer] :per_page
-      #
-      #   @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>]
+      # @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
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/ledger_account_statements.rb

@@ -5,25 +5,18 @@ module ModernTreasury
     class LedgerAccountStatements
       # Create a ledger account statement.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountStatementCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(effective_at_lower_bound:, effective_at_upper_bound:, ledger_account_id:, description: nil, metadata: nil, request_options: {})
       #
-      #   @option params [Time] :effective_at_lower_bound The inclusive lower bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
-      #
-      #   @option params [Time] :effective_at_upper_bound The exclusive upper bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
-      #
-      #   @option params [String] :ledger_account_id The id of the ledger account whose ledger entries are queried against, and its
-      #     balances are computed as a result.
-      #
-      #   @option params [String, nil] :description The description of the ledger account statement.
-      #
-      #   @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 effective_at_lower_bound [Time]
+      # @param effective_at_upper_bound [Time]
+      # @param ledger_account_id [String]
+      # @param description [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccountStatementCreateResponse]
+      #
+      # @see ModernTreasury::Models::LedgerAccountStatementCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerAccountStatementCreateParams.dump_request(params)
         @client.request(
@@ -37,22 +30,25 @@ module ModernTreasury
 
       # Get details on a single ledger account statement.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountStatementRetrieveParams, 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::LedgerAccountStatementRetrieveResponse]
+      #
+      # @see ModernTreasury::Models::LedgerAccountStatementRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/ledger_account_statements/%0s", id],
+          path: ["api/ledger_account_statements/%1$s", id],
           model: ModernTreasury::Models::LedgerAccountStatementRetrieveResponse,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client

data/lib/modern_treasury/resources/ledger_accounts.rb

@@ -5,36 +5,23 @@ module ModernTreasury
     class LedgerAccounts
       # Create a ledger account.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :currency The currency of the ledger account.
-      #
-      #   @option params [String] :ledger_id The id of the ledger that this account belongs to.
-      #
-      #   @option params [String] :name The name of the ledger account.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :normal_balance The normal balance of the ledger account.
-      #
-      #   @option params [Integer, nil] :currency_exponent The currency exponent of the ledger account.
-      #
-      #   @option params [String, nil] :description The description of the ledger account.
-      #
-      #   @option params [Array<String>] :ledger_account_category_ids The array of ledger account category ids that this ledger account should be a
-      #     child of.
-      #
-      #   @option params [String] :ledgerable_id If the ledger account links to another object in Modern Treasury, the id will be
-      #     populated here, otherwise null.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType] :ledgerable_type If the ledger account links to another object in Modern Treasury, the type will
-      #     be populated here, otherwise null. The value is one of internal_account or
-      #     external_account.
-      #
-      #   @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, ledgerable_id: nil, ledgerable_type: 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 ledgerable_id [String]
+      # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      # @see ModernTreasury::Models::LedgerAccountCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::LedgerAccountCreateParams.dump_request(params)
         @client.request(
@@ -48,25 +35,20 @@ module ModernTreasury
 
       # Get details on a single ledger account.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, balances: nil, request_options: {})
       #
-      #   @option params [ModernTreasury::Models::LedgerAccountRetrieveParams::Balances] :balances Use `balances[effective_at_lower_bound]` and
-      #     `balances[effective_at_upper_bound]` to get the balances change between the two
-      #     timestamps. The lower bound is inclusive while the upper bound is exclusive of
-      #     the provided timestamps. If no value is supplied the balances will be retrieved
-      #     not including that bound. Use `balances[as_of_lock_version]` to retrieve a
-      #     balance as of a specific Ledger Account `lock_version`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param balances [ModernTreasury::Models::LedgerAccountRetrieveParams::Balances]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      # @see ModernTreasury::Models::LedgerAccountRetrieveParams
       def retrieve(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["api/ledger_accounts/%0s", id],
+          path: ["api/ledger_accounts/%1$s", id],
           query: parsed,
           model: ModernTreasury::Models::LedgerAccount,
           options: options
@@ -75,25 +57,22 @@ module ModernTreasury
 
       # Update the details of a ledger account.
       #
-      # @param id [String] id
+      # @overload update(id, description: nil, metadata: nil, name: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::LedgerAccountUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :description The description of the ledger account.
-      #
-      #   @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 account.
-      #
-      #   @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::LedgerAccount]
+      #
+      # @see ModernTreasury::Models::LedgerAccountUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/ledger_accounts/%0s", id],
+          path: ["api/ledger_accounts/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::LedgerAccount,
           options: options
@@ -102,61 +81,34 @@ module ModernTreasury
 
       # Get a list of ledger accounts.
       #
-      # @param params [ModernTreasury::Models::LedgerAccountListParams, 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::LedgerAccountListParams::AvailableBalanceAmount] :available_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
-      #     filter by balance amount.
-      #
-      #   @option params [ModernTreasury::Models::LedgerAccountListParams::Balances] :balances Use `balances[effective_at_lower_bound]` and
-      #     `balances[effective_at_upper_bound]` to get the balances change between the two
-      #     timestamps. The lower bound is inclusive while the upper bound is exclusive of
-      #     the provided timestamps. If no value is supplied the balances will be retrieved
-      #     not including that bound.
-      #
-      #   @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] :currency
-      #
-      #   @option params [String] :ledger_account_category_id
-      #
-      #   @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 [Array<String>] :name If you have specific names to retrieve in bulk, you can pass them as query
-      #     parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`.
-      #
-      #   @option params [ModernTreasury::Models::LedgerAccountListParams::PendingBalanceAmount] :pending_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
-      #     filter by balance amount.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::Models::LedgerAccountListParams::PostedBalanceAmount] :posted_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
-      #     filter by balance amount.
-      #
-      #   @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::LedgerAccount>]
+      # @overload list(id: nil, after_cursor: nil, available_balance_amount: nil, balances: nil, created_at: nil, currency: nil, ledger_account_category_id: nil, ledger_id: nil, metadata: nil, name: nil, pending_balance_amount: nil, per_page: nil, posted_balance_amount: nil, updated_at: nil, request_options: {})
+      #
+      # @param id [Array<String>]
+      # @param after_cursor [String, nil]
+      # @param available_balance_amount [ModernTreasury::Models::LedgerAccountListParams::AvailableBalanceAmount]
+      # @param balances [ModernTreasury::Models::LedgerAccountListParams::Balances]
+      # @param created_at [Hash{Symbol=>Time}]
+      # @param currency [String]
+      # @param ledger_account_category_id [String]
+      # @param ledger_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [Array<String>]
+      # @param pending_balance_amount [ModernTreasury::Models::LedgerAccountListParams::PendingBalanceAmount]
+      # @param per_page [Integer]
+      # @param posted_balance_amount [ModernTreasury::Models::LedgerAccountListParams::PostedBalanceAmount]
+      # @param updated_at [Hash{Symbol=>Time}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerAccount>]
+      #
+      # @see ModernTreasury::Models::LedgerAccountListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::LedgerAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/ledger_accounts",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::LedgerAccount,
           options: options
         )
@@ -164,22 +116,25 @@ module ModernTreasury
 
       # Delete a ledger account.
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::LedgerAccountDeleteParams, 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::LedgerAccount]
+      #
+      # @see ModernTreasury::Models::LedgerAccountDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/ledger_accounts/%0s", id],
+          path: ["api/ledger_accounts/%1$s", id],
           model: ModernTreasury::Models::LedgerAccount,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client