@stable_sea/sdk 0.2.26 → 0.2.27

package/README.md

@@ -99,6 +99,26 @@ do not place another subscription to resolve it. Instructions can lag the native
 state: retry a 503 read. Sandbox instructions are synthetic and must never be used
 to send real funds. Existing native eligibility, agreements and controls apply.
 
+## Cancel an unbooked order
+
+Use the original key with `investments:write` to request cancellation. Save the
+mutation object and reuse it after a lost response. A replacement key cannot
+cancel the original key's order.
+
+```ts
+const cancellation = client.mutation();
+const result = await cancellation.POST("/v1/orders/{id}/cancel", {
+  params: { path: { id: orderId } },
+});
+if (result.error) throw new Error(result.error.error.message);
+console.log(result.data.state);
+```
+
+Cancellation is asynchronous. Poll `GET /v1/orders/{id}` for the outcome: a
+stopped order has `state: "failed"` and `failure_code: "order_cancelled"`.
+A concurrent booking or final approval can win; its transaction remains visible
+and is never reversed. An already-booked order returns `order_not_cancellable`.
+
 ## Member administration and personal actions
 
 Use `createStableSeaSessionClient` for onboarding, legal documents, your profile

package/dist/gen/schema.d.ts

@@ -570,6 +570,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orders/{id}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Cancel an order
+         * @description Requests cancellation of an unbooked order created by this credential. Requires `investments:write` and an `Idempotency-Key`. Poll the order for its final outcome.
+         *
+         *     Cancellation is asynchronous. A concurrent booking or final approval can win; its transaction remains visible and is never reversed. An order stopped by this request fails with `order_cancelled`. Orders that have already booked cannot be canceled.
+         */
+        post: operations["orders.cancel"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/policies": {
         parameters: {
             query?: never;
@@ -4240,6 +4262,47 @@ export interface operations {
             };
         };
     };
+    "orders.cancel": {
+        parameters: {
+            query?: never;
+            header: {
+                "Idempotency-Key": components["parameters"]["Idempotency-Key"];
+            };
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    "X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
+                    "X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
+                    "X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Order"];
+                };
+            };
+            400: components["responses"]["Error400"];
+            401: components["responses"]["Error401"];
+            403: components["responses"]["Error403"];
+            409: components["responses"]["Error409"];
+            429: components["responses"]["Error429"];
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "policies.snapshot": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stable_sea/sdk",
-  "version": "0.2.26",
+  "version": "0.2.27",
   "type": "module",
   "sideEffects": false,
   "files": [