feat(api): updates (#180)

- Remove `balances` query param from `update/delete ledger account categories`
- add `metadata` query param to `list/retrieve ledger account payouts`
- add `currency` query param to `list ledger accounts/ledger entries`
- add `ledger account payout id` query param to `list ledger entries/ledger transactions`
- rename `ledger transaction id` path param to `id` in `create ledger transaction reversal`
- add `skip payout ledger transaction` property to `ledger account payout create request`
- make `effective at` property optional in `ledger transaction create request`

api.md

@@ -229,7 +229,7 @@ Methods:
 - <code title="get /api/ledger_account_categories/{id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">retrieve</a>(id, { ...params }) -> LedgerAccountCategory</code>
 - <code title="patch /api/ledger_account_categories/{id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">update</a>(id, { ...params }) -> LedgerAccountCategory</code>
 - <code title="get /api/ledger_account_categories">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">list</a>({ ...params }) -> LedgerAccountCategoriesPage</code>
-- <code title="delete /api/ledger_account_categories/{id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">del</a>(id, { ...params }) -> LedgerAccountCategory</code>
+- <code title="delete /api/ledger_account_categories/{id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">del</a>(id) -> LedgerAccountCategory</code>
 - <code title="put /api/ledger_account_categories/{id}/ledger_accounts/{ledger_account_id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">addLedgerAccount</a>(id, ledgerAccountId) -> void</code>
 - <code title="put /api/ledger_account_categories/{id}/ledger_account_categories/{sub_category_id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">addNestedCategory</a>(id, subCategoryId) -> void</code>
 - <code title="delete /api/ledger_account_categories/{id}/ledger_accounts/{ledger_account_id}">client.ledgerAccountCategories.<a href="./src/resources/ledger-account-categories.ts">removeLedgerAccount</a>(id, ledgerAccountId) -> void</code>
@@ -313,7 +313,7 @@ Methods:
 - <code title="get /api/ledger_transactions/{id}">client.ledgerTransactions.<a href="./src/resources/ledger-transactions/ledger-transactions.ts">retrieve</a>(id) -> LedgerTransaction</code>
 - <code title="patch /api/ledger_transactions/{id}">client.ledgerTransactions.<a href="./src/resources/ledger-transactions/ledger-transactions.ts">update</a>(id, { ...params }) -> LedgerTransaction</code>
 - <code title="get /api/ledger_transactions">client.ledgerTransactions.<a href="./src/resources/ledger-transactions/ledger-transactions.ts">list</a>({ ...params }) -> LedgerTransactionsPage</code>
-- <code title="post /api/ledger_transactions/{ledger_transaction_id}/reversal">client.ledgerTransactions.<a href="./src/resources/ledger-transactions/ledger-transactions.ts">createReversal</a>(ledgerTransactionId, { ...params }) -> LedgerTransaction</code>
+- <code title="post /api/ledger_transactions/{id}/reversal">client.ledgerTransactions.<a href="./src/resources/ledger-transactions/ledger-transactions.ts">createReversal</a>(id, { ...params }) -> LedgerTransaction</code>
 
 ## Versions
 

src/index.ts

@@ -329,7 +329,6 @@ export namespace ModernTreasury {
   export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
   export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
   export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
-  export import LedgerAccountCategoryDeleteParams = API.LedgerAccountCategoryDeleteParams;
 
   export import LedgerAccounts = API.LedgerAccounts;
   export import LedgerAccount = API.LedgerAccount;

src/resources/index.ts

@@ -97,7 +97,6 @@ export {
   LedgerAccountCategoryRetrieveParams,
   LedgerAccountCategoryUpdateParams,
   LedgerAccountCategoryListParams,
-  LedgerAccountCategoryDeleteParams,
   LedgerAccountCategoriesPage,
   LedgerAccountCategories,
 } from './ledger-account-categories';

src/resources/ledger-account-categories.ts

@@ -47,20 +47,19 @@ export class LedgerAccountCategories extends APIResource {
    */
   update(
     id: string,
-    params?: LedgerAccountCategoryUpdateParams,
+    body?: LedgerAccountCategoryUpdateParams,
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<LedgerAccountCategory>>;
   update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>>;
   update(
     id: string,
-    params: LedgerAccountCategoryUpdateParams | Core.RequestOptions = {},
+    body: LedgerAccountCategoryUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<LedgerAccountCategory>> {
-    if (isRequestOptions(params)) {
-      return this.update(id, {}, params);
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
     }
-    const { balances, ...body } = params;
-    return this.patch(`/api/ledger_account_categories/${id}`, { query: { balances }, body, ...options });
+    return this.patch(`/api/ledger_account_categories/${id}`, { body, ...options });
   }
 
   /**
@@ -87,26 +86,12 @@ export class LedgerAccountCategories extends APIResource {
   /**
    * Delete a ledger account category.
    */
-  del(
-    id: string,
-    body?: LedgerAccountCategoryDeleteParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  del(
-    id: string,
-    body: LedgerAccountCategoryDeleteParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
-    if (isRequestOptions(body)) {
-      return this.del(id, {}, body);
-    }
-    const { balances } = body;
-    return this.delete(`/api/ledger_account_categories/${id}`, { query: { balances }, ...options });
+  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>> {
+    return this.delete(`/api/ledger_account_categories/${id}`, options);
   }
 
   /**
-   * Add a ledger account category to an account.
+   * Add a ledger account to a ledger account category.
    */
   addLedgerAccount(
     id: string,
@@ -134,7 +119,7 @@ export class LedgerAccountCategories extends APIResource {
   }
 
   /**
-   * Delete a ledger account category from an account.
+   * Remove a ledger account from a ledger account category.
    */
   removeLedgerAccount(
     id: string,
@@ -362,20 +347,18 @@ export interface LedgerAccountCategoryCreateParams {
 
 export interface LedgerAccountCategoryRetrieveParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * 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 namespace LedgerAccountCategoryRetrieveParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * 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.
    */
   export interface Balances {
     as_of_date?: string;
@@ -386,45 +369,30 @@ export namespace LedgerAccountCategoryRetrieveParams {
 
 export interface LedgerAccountCategoryUpdateParams {
   /**
-   * Query param: For example, if you want the balances as of a particular effective
-   * date (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
-   */
-  balances?: LedgerAccountCategoryUpdateParams.Balances;
-
-  /**
-   * Body param: The description of the ledger account category.
+   * The description of the ledger account category.
    */
   description?: string | null;
 
   /**
-   * Body param: Additional data represented as key-value pairs. Both the key and
-   * value must be strings.
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
    */
   metadata?: Record<string, string>;
 
   /**
-   * Body param: The name of the ledger account category.
+   * The name of the ledger account category.
    */
   name?: string;
 }
 
-export namespace LedgerAccountCategoryUpdateParams {
+export interface LedgerAccountCategoryListParams extends PageParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * 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.
    */
-  export interface Balances {
-    as_of_date?: string;
+  balances?: LedgerAccountCategoryListParams.Balances;
 
-    effective_at?: string;
-  }
-}
-
-export interface LedgerAccountCategoryListParams extends PageParams {
   /**
    * Query categories which contain a ledger account directly or through child
    * categories.
@@ -448,26 +416,13 @@ export interface LedgerAccountCategoryListParams extends PageParams {
   parent_ledger_account_category_id?: string;
 }
 
-export interface LedgerAccountCategoryDeleteParams {
-  /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
-   */
-  balances?: LedgerAccountCategoryDeleteParams.Balances;
-}
-
-export namespace LedgerAccountCategoryDeleteParams {
+export namespace LedgerAccountCategoryListParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * 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.
    */
   export interface Balances {
-    as_of_date?: string;
-
     effective_at?: string;
   }
 }
@@ -479,5 +434,4 @@ export namespace LedgerAccountCategories {
   export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
   export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
   export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
-  export import LedgerAccountCategoryDeleteParams = API.LedgerAccountCategoryDeleteParams;
 }

src/resources/ledger-account-payouts.ts

@@ -180,6 +180,12 @@ export interface LedgerAccountPayoutCreateParams {
    */
   metadata?: Record<string, string>;
 
+  /**
+   * Body param: It is set to `false` by default. It should be set to `true` when
+   * migrating existing payouts.
+   */
+  skip_payout_ledger_transaction?: boolean | null;
+
   /**
    * Body param: The status of the ledger account payout. It is set to `pending` by
    * default. To post a ledger account payout at creation, use `posted`.
@@ -213,6 +219,13 @@ export interface LedgerAccountPayoutUpdateParams {
 }
 
 export interface LedgerAccountPayoutListParams extends PageParams {
+  /**
+   * 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>;
+
   payout_ledger_account_id?: string;
 }
 

src/resources/ledger-accounts.ts

@@ -397,6 +397,8 @@ export interface LedgerAccountListParams extends PageParams {
    */
   created_at?: Record<string, string>;
 
+  currency?: string;
+
   ledger_account_category_id?: string;
 
   ledger_id?: string;

src/resources/ledger-entries.ts

@@ -254,7 +254,7 @@ export interface LedgerEntryListParams extends PageParams {
   direction?: 'credit' | 'debit';
 
   /**
-   * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by the
+   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
    * transaction's effective time. Format ISO8601
    */
   effective_at?: Record<string, string>;
@@ -281,6 +281,8 @@ export interface LedgerEntryListParams extends PageParams {
    */
   ledger_account_lock_version?: Record<string, number>;
 
+  ledger_account_payout_id?: string;
+
   /**
    * Get all ledger entries that are included in the ledger account statement.
    */

src/resources/ledger-transactions/ledger-transactions.ts

@@ -75,23 +75,20 @@ export class LedgerTransactions extends APIResource {
    * Create a ledger transaction reversal.
    */
   createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body?: LedgerTransactionCreateReversalParams,
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<LedgerTransaction>>;
+  createReversal(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerTransaction>>;
   createReversal(
-    ledgerTransactionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
-  createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body: LedgerTransactionCreateReversalParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<LedgerTransaction>> {
     if (isRequestOptions(body)) {
-      return this.createReversal(ledgerTransactionId, {}, body);
+      return this.createReversal(id, {}, body);
     }
-    return this.post(`/api/ledger_transactions/${ledgerTransactionId}/reversal`, { body, ...options });
+    return this.post(`/api/ledger_transactions/${id}/reversal`, { body, ...options });
   }
 }
 
@@ -195,12 +192,6 @@ export interface LedgerTransaction {
 }
 
 export interface LedgerTransactionCreateParams {
-  /**
-   * Body param: The timestamp (ISO8601 format) at which the ledger transaction
-   * happened for reporting purposes.
-   */
-  effective_at: string;
-
   /**
    * Body param: An array of ledger entry objects.
    */
@@ -211,6 +202,12 @@ export interface LedgerTransactionCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Body param: The timestamp (ISO8601 format) at which the ledger transaction
+   * happened for reporting purposes.
+   */
+  effective_at?: string;
+
   /**
    * Body param: The date (YYYY-MM-DD) on which the ledger transaction happened for
    * reporting purposes.
@@ -335,6 +332,12 @@ export interface LedgerTransactionUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_at?: string;
+
   /**
    * An array of ledger entry objects.
    */
@@ -439,6 +442,8 @@ export interface LedgerTransactionListParams extends PageParams {
 
   ledger_account_id?: string;
 
+  ledger_account_payout_id?: string;
+
   ledger_id?: string;
 
   ledgerable_id?: string;