modern-treasury 2.6.0 → 2.7.2

package/resources/ledger-account-categories.d.ts

@@ -1,304 +1,283 @@
 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 LedgerAccountCategories extends APIResource {
-  /**
-   * Create a ledger account category.
-   */
-  create(
-    params: LedgerAccountCategoryCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerAccountCategory>;
-  /**
-   * Get the details on a single ledger account category.
-   */
-  retrieve(
-    id: string,
-    query?: LedgerAccountCategoryRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerAccountCategory>;
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
-  /**
-   * Update the details of a ledger account category.
-   */
-  update(
-    id: string,
-    body?: LedgerAccountCategoryUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerAccountCategory>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
-  /**
-   * Get a list of ledger account categories.
-   */
-  list(
-    query?: LedgerAccountCategoryListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
-  /**
-   * Delete a ledger account category.
-   */
-  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
-  /**
-   * Add a ledger account to a ledger account category.
-   */
-  addLedgerAccount(id: string, ledgerAccountId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
-  /**
-   * Add a ledger account category to a ledger account category.
-   */
-  addNestedCategory(id: string, subCategoryId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
-  /**
-   * Remove a ledger account from a ledger account category.
-   */
-  removeLedgerAccount(
-    id: string,
-    ledgerAccountId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void>;
-  /**
-   * Delete a ledger account category from a ledger account category.
-   */
-  removeNestedCategory(
-    id: string,
-    subCategoryId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void>;
+    /**
+     * Create a ledger account category.
+     */
+    create(params: LedgerAccountCategoryCreateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    /**
+     * Get the details on a single ledger account category.
+     */
+    retrieve(id: string, query?: LedgerAccountCategoryRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    /**
+     * Update the details of a ledger account category.
+     */
+    update(id: string, body?: LedgerAccountCategoryUpdateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    /**
+     * Get a list of ledger account categories.
+     */
+    list(query?: LedgerAccountCategoryListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
+    list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
+    /**
+     * Delete a ledger account category.
+     */
+    del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
+    /**
+     * Add a ledger account to a ledger account category.
+     */
+    addLedgerAccount(id: string, ledgerAccountId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Add a ledger account category to a ledger account category.
+     */
+    addNestedCategory(id: string, subCategoryId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Remove a ledger account from a ledger account category.
+     */
+    removeLedgerAccount(id: string, ledgerAccountId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Delete a ledger account category from a ledger account category.
+     */
+    removeNestedCategory(id: string, subCategoryId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+}
+export declare class LedgerAccountCategoriesPage extends Page<LedgerAccountCategory> {
 }
-export declare class LedgerAccountCategoriesPage extends Page<LedgerAccountCategory> {}
 type _LedgerAccountCategoriesPage = LedgerAccountCategoriesPage;
 export interface LedgerAccountCategory {
-  id: string;
-  /**
-   * The pending, posted, and available balances for this ledger account category.
-   * 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.
-   */
-  balances: LedgerAccountCategory.Balances;
-  created_at: string;
-  /**
-   * The description of the ledger account category.
-   */
-  description: string | null;
-  discarded_at: string | null;
-  /**
-   * The id of the ledger that this account category belongs to.
-   */
-  ledger_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>;
-  /**
-   * The name of the ledger account category.
-   */
-  name: string;
-  /**
-   * The normal balance of the ledger account category.
-   */
-  normal_balance: 'credit' | 'debit';
-  object: string;
-  updated_at: string;
+    id: string;
+    /**
+     * The pending, posted, and available balances for this ledger account category.
+     * 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.
+     */
+    balances: LedgerAccountCategory.Balances;
+    created_at: string;
+    /**
+     * The description of the ledger account category.
+     */
+    description: string | null;
+    discarded_at: string | null;
+    /**
+     * The id of the ledger that this account category belongs to.
+     */
+    ledger_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>;
+    /**
+     * The name of the ledger account category.
+     */
+    name: string;
+    /**
+     * The normal balance of the ledger account category.
+     */
+    normal_balance: 'credit' | 'debit';
+    object: string;
+    updated_at: string;
 }
 export declare namespace LedgerAccountCategory {
-  /**
-   * The pending, posted, and available balances for this ledger account category.
-   * 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.
-   */
-  interface Balances {
-    /**
-     * 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: Balances.AvailableBalance;
-    /**
-     * The pending_balance is the sum of all pending and posted entries.
-     */
-    pending_balance: Balances.PendingBalance;
-    /**
-     * The posted_balance is the sum of all posted entries.
-     */
-    posted_balance: Balances.PostedBalance;
-  }
-  namespace Balances {
-    /**
-     * 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 pending, posted, and available balances for this ledger account category.
+     * 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.
+     */
+    interface Balances {
+        /**
+         * 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: Balances.AvailableBalance;
+        /**
+         * The pending_balance is the sum of all pending and posted entries.
+         */
+        pending_balance: Balances.PendingBalance;
+        /**
+         * The posted_balance is the sum of all posted entries.
+         */
+        posted_balance: Balances.PostedBalance;
     }
-    /**
-     * 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;
+    namespace Balances {
+        /**
+         * 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 LedgerAccountCategoryCreateParams {
-  /**
-   * The currency of the ledger account category.
-   */
-  currency: string;
-  /**
-   * The id of the ledger that this account category belongs to.
-   */
-  ledger_id: string;
-  /**
-   * The name of the ledger account category.
-   */
-  name: string;
-  /**
-   * The normal balance of the ledger account category.
-   */
-  normal_balance: 'credit' | 'debit';
-  /**
-   * The currency exponent of the ledger account category.
-   */
-  currency_exponent?: number | null;
-  /**
-   * The description of the ledger account category.
-   */
-  description?: string | null;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
+    /**
+     * The currency of the ledger account category.
+     */
+    currency: string;
+    /**
+     * The id of the ledger that this account category belongs to.
+     */
+    ledger_id: string;
+    /**
+     * The name of the ledger account category.
+     */
+    name: string;
+    /**
+     * The normal balance of the ledger account category.
+     */
+    normal_balance: 'credit' | 'debit';
+    /**
+     * The currency exponent of the ledger account category.
+     */
+    currency_exponent?: number | null;
+    /**
+     * The description of the ledger account category.
+     */
+    description?: string | null;
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
 }
 export interface LedgerAccountCategoryRetrieveParams {
-  /**
-   * For example, if you want the balances as of a particular time (ISO8601), the
-   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-   * The balances as of a time are inclusive of entries with that exact time.
-   */
-  balances?: LedgerAccountCategoryRetrieveParams.Balances;
+    /**
+     * For example, if you want the balances as of a particular time (ISO8601), the
+     * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+     * The balances as of a time are inclusive of entries with that exact time.
+     */
+    balances?: LedgerAccountCategoryRetrieveParams.Balances;
 }
 export declare namespace LedgerAccountCategoryRetrieveParams {
-  /**
-   * For example, if you want the balances as of a particular time (ISO8601), the
-   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-   * The balances as of a time are inclusive of entries with that exact time.
-   */
-  interface Balances {
-    as_of_date?: string;
-    effective_at?: string;
-  }
+    /**
+     * For example, if you want the balances as of a particular time (ISO8601), the
+     * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+     * The balances as of a time are inclusive of entries with that exact time.
+     */
+    interface Balances {
+        as_of_date?: string;
+        effective_at?: string;
+    }
 }
 export interface LedgerAccountCategoryUpdateParams {
-  /**
-   * The description of the ledger account category.
-   */
-  description?: string | null;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * The name of the ledger account category.
-   */
-  name?: string;
+    /**
+     * The description of the ledger account category.
+     */
+    description?: string | null;
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * The name of the ledger account category.
+     */
+    name?: string;
 }
 export interface LedgerAccountCategoryListParams 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>;
-  /**
-   * For example, if you want the balances as of a particular time (ISO8601), the
-   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-   * The balances as of a time are inclusive of entries with that exact time.
-   */
-  balances?: LedgerAccountCategoryListParams.Balances;
-  /**
-   * Query categories which contain a ledger account directly or through child
-   * categories.
-   */
-  ledger_account_id?: string;
-  ledger_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>;
-  name?: string;
-  /**
-   * Query categories that are nested underneath a parent category
-   */
-  parent_ledger_account_category_id?: 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>;
+    /**
+     * For example, if you want the balances as of a particular time (ISO8601), the
+     * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+     * The balances as of a time are inclusive of entries with that exact time.
+     */
+    balances?: LedgerAccountCategoryListParams.Balances;
+    /**
+     * Query categories which contain a ledger account directly or through child
+     * categories.
+     */
+    ledger_account_id?: string;
+    ledger_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>;
+    name?: string;
+    /**
+     * Query categories that are nested underneath a parent category
+     */
+    parent_ledger_account_category_id?: string;
 }
 export declare namespace LedgerAccountCategoryListParams {
-  /**
-   * For example, if you want the balances as of a particular time (ISO8601), the
-   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-   * The balances as of a time are inclusive of entries with that exact time.
-   */
-  interface Balances {
-    effective_at?: string;
-  }
+    /**
+     * For example, if you want the balances as of a particular time (ISO8601), the
+     * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+     * The balances as of a time are inclusive of entries with that exact time.
+     */
+    interface Balances {
+        effective_at?: string;
+    }
 }
 export declare namespace LedgerAccountCategories {
-  export import LedgerAccountCategory = API.LedgerAccountCategory;
-  type LedgerAccountCategoriesPage = _LedgerAccountCategoriesPage;
-  export import LedgerAccountCategoryCreateParams = API.LedgerAccountCategoryCreateParams;
-  export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
-  export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
-  export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
+    export import LedgerAccountCategory = API.LedgerAccountCategory;
+    type LedgerAccountCategoriesPage = _LedgerAccountCategoriesPage;
+    export import LedgerAccountCategoryCreateParams = API.LedgerAccountCategoryCreateParams;
+    export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
+    export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
+    export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
 }
 export {};
-//# sourceMappingURL=ledger-account-categories.d.ts.map
+//# sourceMappingURL=ledger-account-categories.d.ts.map