modern-treasury 2.6.0 → 2.7.2

package/resources/ledger-entries.d.ts

@@ -1,280 +1,274 @@
 import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class LedgerEntries extends APIResource {
-  /**
-   * Get details on a single ledger entry.
-   */
-  retrieve(
-    id: string,
-    query?: LedgerEntryRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerEntry>;
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEntry>;
-  /**
-   * Get a list of all ledger entries.
-   */
-  list(
-    query?: LedgerEntryListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
+    /**
+     * Get details on a single ledger entry.
+     */
+    retrieve(id: string, query?: LedgerEntryRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LedgerEntry>;
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEntry>;
+    /**
+     * Get a list of all ledger entries.
+     */
+    list(query?: LedgerEntryListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
+    list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
+}
+export declare class LedgerEntriesPage extends Page<LedgerEntry> {
 }
-export declare class LedgerEntriesPage extends Page<LedgerEntry> {}
 type _LedgerEntriesPage = LedgerEntriesPage;
 export interface LedgerEntry {
-  id: string;
-  /**
-   * Value in specified currency's smallest unit. e.g. $10 would be represented
-   * as 1000. Can be any integer up to 36 digits.
-   */
-  amount: number;
-  created_at: string;
-  /**
-   * One of `credit`, `debit`. Describes the direction money is flowing in the
-   * transaction. A `credit` moves money from your account to someone else's. A
-   * `debit` pulls money from someone else's account to your own. Note that wire,
-   * rtp, and check payments will always be `credit`.
-   */
-  direction: 'credit' | 'debit';
-  discarded_at: string | null;
-  /**
-   * The currency of the ledger account.
-   */
-  ledger_account_currency: string;
-  /**
-   * The currency exponent of the ledger account.
-   */
-  ledger_account_currency_exponent: number;
-  /**
-   * The ledger account that this ledger entry is associated with.
-   */
-  ledger_account_id: string;
-  /**
-   * Lock version of the ledger account. This can be passed when creating a ledger
-   * transaction to only succeed if no ledger transactions have posted since the
-   * given version. See our post about Designing the Ledgers API with Optimistic
-   * Locking for more details.
-   */
-  ledger_account_lock_version: number | null;
-  /**
-   * The ledger transaction that this ledger entry is associated with.
-   */
-  ledger_transaction_id: string;
-  /**
-   * This field will be true if this object exists in the live environment or false
-   * if it exists in the test environment.
-   */
-  live_mode: boolean;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata: Record<string, string>;
-  object: string;
-  /**
-   * The pending, posted, and available balances for this ledger entry's ledger
-   * account. The posted balance is the sum of all posted entries on the account. The
-   * pending balance is the sum of all pending and posted entries on the account. The
-   * available balance is the posted incoming entries minus the sum of the pending
-   * and posted outgoing amounts. Please see
-   * https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
-   * details.
-   */
-  resulting_ledger_account_balances: LedgerEntry.ResultingLedgerAccountBalances | null;
-  /**
-   * Equal to the state of the ledger transaction when the ledger entry was created.
-   * One of `pending`, `posted`, or `archived`.
-   */
-  status: 'archived' | 'pending' | 'posted';
-  updated_at: string;
-}
-export declare namespace LedgerEntry {
-  /**
-   * The pending, posted, and available balances for this ledger entry's ledger
-   * account. The posted balance is the sum of all posted entries on the account. The
-   * pending balance is the sum of all pending and posted entries on the account. The
-   * available balance is the posted incoming entries minus the sum of the pending
-   * and posted outgoing amounts. Please see
-   * https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
-   * details.
-   */
-  interface ResultingLedgerAccountBalances {
+    id: string;
     /**
-     * The available_balance is the sum of all posted inbound entries and pending
-     * outbound entries. For credit normal, available_amount = posted_credits -
-     * pending_debits; for debit normal, available_amount = posted_debits -
-     * pending_credits.
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000. Can be any integer up to 36 digits.
      */
-    available_balance: ResultingLedgerAccountBalances.AvailableBalance;
+    amount: number;
+    created_at: string;
     /**
-     * The pending_balance is the sum of all pending and posted entries.
+     * One of `credit`, `debit`. Describes the direction money is flowing in the
+     * transaction. A `credit` moves money from your account to someone else's. A
+     * `debit` pulls money from someone else's account to your own. Note that wire,
+     * rtp, and check payments will always be `credit`.
      */
-    pending_balance: ResultingLedgerAccountBalances.PendingBalance;
+    direction: 'credit' | 'debit';
+    discarded_at: string | null;
     /**
-     * The posted_balance is the sum of all posted entries.
+     * The currency of the ledger account.
      */
-    posted_balance: ResultingLedgerAccountBalances.PostedBalance;
-  }
-  namespace ResultingLedgerAccountBalances {
+    ledger_account_currency: string;
     /**
-     * The available_balance is the sum of all posted inbound entries and pending
-     * outbound entries. For credit normal, available_amount = posted_credits -
-     * pending_debits; for debit normal, available_amount = posted_debits -
-     * pending_credits.
+     * The currency exponent of the ledger account.
      */
-    interface AvailableBalance {
-      amount: number;
-      credits: number;
-      /**
-       * The currency of the ledger account.
-       */
-      currency: string;
-      /**
-       * The currency exponent of the ledger account.
-       */
-      currency_exponent: number;
-      debits: number;
-    }
+    ledger_account_currency_exponent: number;
     /**
-     * The pending_balance is the sum of all pending and posted entries.
+     * The ledger account that this ledger entry is associated with.
      */
-    interface PendingBalance {
-      amount: number;
-      credits: number;
-      /**
-       * The currency of the ledger account.
-       */
-      currency: string;
-      /**
-       * The currency exponent of the ledger account.
-       */
-      currency_exponent: number;
-      debits: number;
-    }
+    ledger_account_id: string;
+    /**
+     * Lock version of the ledger account. This can be passed when creating a ledger
+     * transaction to only succeed if no ledger transactions have posted since the
+     * given version. See our post about Designing the Ledgers API with Optimistic
+     * Locking for more details.
+     */
+    ledger_account_lock_version: number | null;
+    /**
+     * The ledger transaction that this ledger entry is associated with.
+     */
+    ledger_transaction_id: string;
+    /**
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
+     */
+    live_mode: boolean;
     /**
-     * The posted_balance is the sum of all posted entries.
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
      */
-    interface PostedBalance {
-      amount: number;
-      credits: number;
-      /**
-       * The currency of the ledger account.
-       */
-      currency: string;
-      /**
-       * The currency exponent of the ledger account.
-       */
-      currency_exponent: number;
-      debits: number;
+    metadata: Record<string, string>;
+    object: string;
+    /**
+     * The pending, posted, and available balances for this ledger entry's ledger
+     * account. The posted balance is the sum of all posted entries on the account. The
+     * pending balance is the sum of all pending and posted entries on the account. The
+     * available balance is the posted incoming entries minus the sum of the pending
+     * and posted outgoing amounts. Please see
+     * https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+     * details.
+     */
+    resulting_ledger_account_balances: LedgerEntry.ResultingLedgerAccountBalances | null;
+    /**
+     * Equal to the state of the ledger transaction when the ledger entry was created.
+     * One of `pending`, `posted`, or `archived`.
+     */
+    status: 'archived' | 'pending' | 'posted';
+    updated_at: string;
+}
+export declare namespace LedgerEntry {
+    /**
+     * The pending, posted, and available balances for this ledger entry's ledger
+     * account. The posted balance is the sum of all posted entries on the account. The
+     * pending balance is the sum of all pending and posted entries on the account. The
+     * available balance is the posted incoming entries minus the sum of the pending
+     * and posted outgoing amounts. Please see
+     * https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+     * details.
+     */
+    interface ResultingLedgerAccountBalances {
+        /**
+         * The available_balance is the sum of all posted inbound entries and pending
+         * outbound entries. For credit normal, available_amount = posted_credits -
+         * pending_debits; for debit normal, available_amount = posted_debits -
+         * pending_credits.
+         */
+        available_balance: ResultingLedgerAccountBalances.AvailableBalance;
+        /**
+         * The pending_balance is the sum of all pending and posted entries.
+         */
+        pending_balance: ResultingLedgerAccountBalances.PendingBalance;
+        /**
+         * The posted_balance is the sum of all posted entries.
+         */
+        posted_balance: ResultingLedgerAccountBalances.PostedBalance;
+    }
+    namespace ResultingLedgerAccountBalances {
+        /**
+         * The available_balance is the sum of all posted inbound entries and pending
+         * outbound entries. For credit normal, available_amount = posted_credits -
+         * pending_debits; for debit normal, available_amount = posted_debits -
+         * pending_credits.
+         */
+        interface AvailableBalance {
+            amount: number;
+            credits: number;
+            /**
+             * The currency of the ledger account.
+             */
+            currency: string;
+            /**
+             * The currency exponent of the ledger account.
+             */
+            currency_exponent: number;
+            debits: number;
+        }
+        /**
+         * The pending_balance is the sum of all pending and posted entries.
+         */
+        interface PendingBalance {
+            amount: number;
+            credits: number;
+            /**
+             * The currency of the ledger account.
+             */
+            currency: string;
+            /**
+             * The currency exponent of the ledger account.
+             */
+            currency_exponent: number;
+            debits: number;
+        }
+        /**
+         * The posted_balance is the sum of all posted entries.
+         */
+        interface PostedBalance {
+            amount: number;
+            credits: number;
+            /**
+             * The currency of the ledger account.
+             */
+            currency: string;
+            /**
+             * The currency exponent of the ledger account.
+             */
+            currency_exponent: number;
+            debits: number;
+        }
     }
-  }
 }
 export interface LedgerEntryRetrieveParams {
-  /**
-   * If true, response will include the balances attached to the ledger entry. If
-   * there is no balance available, null will be returned instead.
-   */
-  show_balances?: boolean;
+    /**
+     * If true, response will include the balances attached to the ledger entry. If
+     * there is no balance available, null will be returned instead.
+     */
+    show_balances?: boolean;
 }
 export interface LedgerEntryListParams extends PageParams {
-  /**
-   * 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`.
-   */
-  id?: Array<string>;
-  /**
-   * Shows all ledger entries that were present on a ledger account at a particular
-   * `lock_version`. You must also specify `ledger_account_id`.
-   */
-  as_of_lock_version?: number;
-  /**
-   * 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.
-   */
-  direction?: 'credit' | 'debit';
-  /**
-   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-   * transaction's effective time. Format ISO8601
-   */
-  effective_at?: Record<string, string>;
-  /**
-   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-   * transaction's effective date. Format YYYY-MM-DD
-   */
-  effective_date?: Record<string, string>;
-  /**
-   * Get all ledger entries that match the direction specified. One of `credit`,
-   * `debit`.
-   */
-  ledger_account_category_id?: string;
-  ledger_account_id?: string;
-  /**
-   * 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`.
-   */
-  ledger_account_lock_version?: Record<string, number>;
-  ledger_account_payout_id?: string;
-  /**
-   * Get all ledger entries that are included in the ledger account statement.
-   */
-  ledger_account_statement_id?: string;
-  ledger_transaction_id?: string;
-  /**
-   * 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.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * 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.
-   */
-  order_by?: LedgerEntryListParams.OrderBy;
-  /**
-   * If true, response will include the balances attached to the ledger entry. If
-   * there is no balance available, null will be returned instead.
-   */
-  show_balances?: boolean;
-  /**
-   * 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.
-   */
-  show_deleted?: boolean;
-  /**
-   * Get all ledger entries that match the status specified. One of `pending`,
-   * `posted`, or `archived`.
-   */
-  status?: 'pending' | 'posted' | 'archived';
-  /**
-   * 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.
-   */
-  updated_at?: Record<string, string>;
+    /**
+     * 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`.
+     */
+    id?: Array<string>;
+    /**
+     * Shows all ledger entries that were present on a ledger account at a particular
+     * `lock_version`. You must also specify `ledger_account_id`.
+     */
+    as_of_lock_version?: number;
+    /**
+     * 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.
+     */
+    direction?: 'credit' | 'debit';
+    /**
+     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+     * transaction's effective time. Format ISO8601
+     */
+    effective_at?: Record<string, string>;
+    /**
+     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+     * transaction's effective date. Format YYYY-MM-DD
+     */
+    effective_date?: Record<string, string>;
+    /**
+     * Get all ledger entries that match the direction specified. One of `credit`,
+     * `debit`.
+     */
+    ledger_account_category_id?: string;
+    ledger_account_id?: string;
+    /**
+     * 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`.
+     */
+    ledger_account_lock_version?: Record<string, number>;
+    ledger_account_payout_id?: string;
+    /**
+     * Get all ledger entries that are included in the ledger account statement.
+     */
+    ledger_account_statement_id?: string;
+    ledger_transaction_id?: string;
+    /**
+     * 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.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * 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.
+     */
+    order_by?: LedgerEntryListParams.OrderBy;
+    /**
+     * If true, response will include the balances attached to the ledger entry. If
+     * there is no balance available, null will be returned instead.
+     */
+    show_balances?: boolean;
+    /**
+     * 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.
+     */
+    show_deleted?: boolean;
+    /**
+     * Get all ledger entries that match the status specified. One of `pending`,
+     * `posted`, or `archived`.
+     */
+    status?: 'pending' | 'posted' | 'archived';
+    /**
+     * 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.
+     */
+    updated_at?: Record<string, string>;
 }
 export declare namespace LedgerEntryListParams {
-  /**
-   * 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.
-   */
-  interface OrderBy {
-    created_at?: 'asc' | 'desc';
-    effective_at?: 'asc' | 'desc';
-  }
+    /**
+     * 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.
+     */
+    interface OrderBy {
+        created_at?: 'asc' | 'desc';
+        effective_at?: 'asc' | 'desc';
+    }
 }
 export declare namespace LedgerEntries {
-  export import LedgerEntry = API.LedgerEntry;
-  type LedgerEntriesPage = _LedgerEntriesPage;
-  export import LedgerEntryRetrieveParams = API.LedgerEntryRetrieveParams;
-  export import LedgerEntryListParams = API.LedgerEntryListParams;
+    export import LedgerEntry = API.LedgerEntry;
+    type LedgerEntriesPage = _LedgerEntriesPage;
+    export import LedgerEntryRetrieveParams = API.LedgerEntryRetrieveParams;
+    export import LedgerEntryListParams = API.LedgerEntryListParams;
 }
 export {};
-//# sourceMappingURL=ledger-entries.d.ts.map
+//# sourceMappingURL=ledger-entries.d.ts.map

package/resources/ledger-entries.js

@@ -1,26 +1,28 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.LedgerEntriesPage = exports.LedgerEntries = void 0;
-const resource_1 = require('modern-treasury/resource');
-const core_1 = require('modern-treasury/core');
-const pagination_1 = require('modern-treasury/pagination');
+const resource_1 = require("modern-treasury/resource");
+const core_1 = require("modern-treasury/core");
+const pagination_1 = require("modern-treasury/pagination");
 class LedgerEntries extends resource_1.APIResource {
-  retrieve(id, query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.retrieve(id, {}, query);
+    retrieve(id, query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.retrieve(id, {}, query);
+        }
+        return this.get(`/api/ledger_entries/${id}`, { query, ...options });
     }
-    return this.get(`/api/ledger_entries/${id}`, { query, ...options });
-  }
-  list(query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.list({}, query);
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/ledger_entries', LedgerEntriesPage, { query, ...options });
     }
-    return this.getAPIList('/api/ledger_entries', LedgerEntriesPage, { query, ...options });
-  }
 }
 exports.LedgerEntries = LedgerEntries;
-class LedgerEntriesPage extends pagination_1.Page {}
+class LedgerEntriesPage extends pagination_1.Page {
+}
 exports.LedgerEntriesPage = LedgerEntriesPage;
-(function (LedgerEntries) {})((LedgerEntries = exports.LedgerEntries || (exports.LedgerEntries = {})));
-//# sourceMappingURL=ledger-entries.js.map
+(function (LedgerEntries) {
+})(LedgerEntries = exports.LedgerEntries || (exports.LedgerEntries = {}));
+//# sourceMappingURL=ledger-entries.js.map

package/resources/ledger-entries.mjs

@@ -3,19 +3,21 @@ import { APIResource } from 'modern-treasury/resource';
 import { isRequestOptions } from 'modern-treasury/core';
 import { Page } from 'modern-treasury/pagination';
 export class LedgerEntries extends APIResource {
-  retrieve(id, query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.retrieve(id, {}, query);
+    retrieve(id, query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.retrieve(id, {}, query);
+        }
+        return this.get(`/api/ledger_entries/${id}`, { query, ...options });
     }
-    return this.get(`/api/ledger_entries/${id}`, { query, ...options });
-  }
-  list(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/api/ledger_entries', LedgerEntriesPage, { query, ...options });
     }
-    return this.getAPIList('/api/ledger_entries', LedgerEntriesPage, { query, ...options });
-  }
 }
-export class LedgerEntriesPage extends Page {}
-(function (LedgerEntries) {})(LedgerEntries || (LedgerEntries = {}));
-//# sourceMappingURL=ledger-entries.mjs.map
+export class LedgerEntriesPage extends Page {
+}
+(function (LedgerEntries) {
+})(LedgerEntries || (LedgerEntries = {}));
+//# sourceMappingURL=ledger-entries.mjs.map