feat(types): add clientOrderId to IDEXCanceledOrder

This change adds a new optional `clientOrderId` property to the `IDEXCanceledOrder` interface. This property will be included in the cancel object when an order is cancelled by any request.
idexio · May 14, 2024 · 5f63a39 · 5f63a39
1 parent ac81fc4
commit 5f63a39
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -177,7 +177,7 @@
     "semantic-release-slack-bot": "^4.0.2",
     "slackify-markdown": "^4.4.0",
     "tsx": "^4.7.2",
-    "typedoc": "^0.25.13",
+    "typedoc": "0.25.13",
     "typedoc-plugin-extras": "^3.0.0",
     "typedoc-plugin-mdn-links": "^3.1.19",
     "typedoc-plugin-merge-modules": "^5.1.0",

diff --git a/src/types/rest/endpoints/CancelOrders.ts b/src/types/rest/endpoints/CancelOrders.ts
@@ -120,6 +120,11 @@ export type RestRequestCancelOrders =
 export interface IDEXCanceledOrder {
   /** Exchange-assigned order identifier */
   readonly orderId: string;
+  /**
+   * If the order was created with a `clientOrderId`, it will be included
+   * within the cancel object when cancelled by any of your requests.
+   */
+  readonly clientOrderId?: string;
 }
 
 /**