docs: use @deprecated decorator for deprecated params (#354)

Modern-Treasury · Mar 7, 2024 · e8e2144 · e8e2144
1 parent 085dae2
commit e8e2144
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/src/resources/bulk-requests.ts b/src/resources/bulk-requests.ts
@@ -173,14 +173,14 @@ export namespace BulkRequestCreateParams {
     accounting?: PaymentOrderAsyncCreateRequest.Accounting;
 
     /**
-     * The ID of one of your accounting categories. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting categories. Note that these will
+     * only be accessible if your accounting system has been connected.
      */
     accounting_category_id?: string | null;
 
     /**
-     * The ID of one of your accounting ledger classes. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting ledger classes. Note that these
+     * will only be accessible if your accounting system has been connected.
      */
     accounting_ledger_class_id?: string | null;
 
@@ -1177,14 +1177,14 @@ export namespace BulkRequestCreateParams {
     accounting?: PaymentOrderUpdateRequestWithID.Accounting;
 
     /**
-     * The ID of one of your accounting categories. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting categories. Note that these will
+     * only be accessible if your accounting system has been connected.
      */
     accounting_category_id?: string | null;
 
     /**
-     * The ID of one of your accounting ledger classes. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting ledger classes. Note that these
+     * will only be accessible if your accounting system has been connected.
      */
     accounting_ledger_class_id?: string | null;
 

diff --git a/src/resources/payment-orders/payment-orders.ts b/src/resources/payment-orders/payment-orders.ts
@@ -112,14 +112,14 @@ export interface PaymentOrder {
   accounting: PaymentOrder.Accounting;
 
   /**
-   * The ID of one of your accounting categories. Note that these will only be
-   * accessible if your accounting system has been connected.
+   * @deprecated: The ID of one of your accounting categories. Note that these will
+   * only be accessible if your accounting system has been connected.
    */
   accounting_category_id: string | null;
 
   /**
-   * The ID of one of your accounting ledger classes. Note that these will only be
-   * accessible if your accounting system has been connected.
+   * @deprecated: The ID of one of your accounting ledger classes. Note that these
+   * will only be accessible if your accounting system has been connected.
    */
   accounting_ledger_class_id: string | null;