@shipeasy/openapi 1.1.0 → 1.2.0

package/dist/index.js

@@ -671,7 +671,7 @@ var experimentUpdateSchema = z6.object({
 );
 var experimentStatusUpdateSchema = z6.object({
   status: z6.enum(["draft", "running", "stopped", "archived"]).describe(
-    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`. Restarting an archived experiment is not allowed."
+    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`, and `archived \u2192 draft` (restore \u2014 only if the experiment never started). Restarting an archived experiment directly is not allowed; restore it to draft first, then start."
   )
 }).describe("Body for `POST /api/admin/experiments/{id}/status`.");
 var experimentMetricsUpdateSchema = z6.object({
@@ -776,24 +776,29 @@ function experimentsClient(t) {
     if (opts.cursor) query.cursor = opts.cursor;
     return t.request("GET", BASE2, void 0, query);
   }
-  async function listAll() {
+  async function listAllWith(status) {
     const out = [];
     let cursor;
     do {
-      const page = await list({ limit: 500, cursor });
+      const query = { limit: "500" };
+      if (cursor) query.cursor = cursor;
+      if (status) query.status = status;
+      const page = await t.request("GET", BASE2, void 0, query);
       out.push(...page.data);
       cursor = page.next_cursor ?? void 0;
     } while (cursor);
     return out;
   }
+  async function listAll() {
+    return listAllWith();
+  }
   async function resolve(idOrName) {
     try {
       return await t.request("GET", `${BASE2}/${idOrName}`);
     } catch (err) {
       if (!(err instanceof ApiError) || err.status !== 404) throw err;
     }
-    const all = await listAll();
-    const found = all.find((e) => e.name === idOrName);
+    const found = (await listAllWith()).find((e) => e.name === idOrName) ?? (await listAllWith("archived")).find((e) => e.name === idOrName);
     if (!found) throw new ApiError(`Experiment '${idOrName}' not found`, 404);
     return found;
   }
@@ -816,6 +821,7 @@ function experimentsClient(t) {
     start: (id) => setStatus(id, "running"),
     stop: (id) => setStatus(id, "stopped"),
     archive: (id) => setStatus(id, "archived"),
+    restore: (id) => setStatus(id, "draft"),
     setMetrics: (id, input) => t.request("POST", `${BASE2}/${id}/metrics`, experimentMetricsUpdateSchema.parse(input)),
     results: (id) => t.request("GET", `${BASE2}/${id}/results`),
     timeseries: (id, metric) => t.request(
@@ -862,7 +868,7 @@ var experimentsResource = {
       "",
       "**Identity.** Stable `name` (a-z, 0-9, `_`/`-`, max 64 chars). Immutable after create.",
       "",
-      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. Restarting an archived experiment is not allowed.",
+      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. An archived experiment that never started can be restored with `archived \u2192 draft`; restarting an archived experiment directly is not allowed.",
       "",
       "**Allocation.** `allocation_pct` (basis points, 0\u201310000) is the share of the targeted audience enrolled; `groups[].weight` (must sum to 10000) splits the enrolled audience. `targeting_gate` narrows the eligible audience before allocation.",
       "",
@@ -881,6 +887,7 @@ var experimentsResource = {
     { name: "start", description: "Transition draft experiment to running" },
     { name: "stop", description: "Stop a running experiment" },
     { name: "archive", description: "Archive a stopped experiment" },
+    { name: "restore", description: "Restore an archived (never-started) experiment to draft" },
     { name: "reanalyze", description: "Re-run analysis pass for the experiment" }
   ],
   endpoints: [
@@ -1061,8 +1068,9 @@ var experimentsResource = {
         "- `running \u2192 stopped` \u2014 halts allocation. Existing exposures stay in the dataset.",
         "- `stopped \u2192 archived` \u2014 soft-delete.",
         "- `draft \u2192 archived` \u2014 discard an unstarted experiment.",
+        "- `archived \u2192 draft` \u2014 restore a soft-deleted experiment so it can be re-completed and started. Allowed only if it never started; one that already ran must be cloned instead.",
         "",
-        "Restarting an `archived` experiment is not allowed; clone instead. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
+        "Restarting an `archived` experiment directly is not allowed \u2014 restore it to `draft` first. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
       ].join("\n"),
       pathParams: { id: "Stable opaque experiment id." },
       request: experimentStatusUpdateSchema,
@@ -1083,6 +1091,11 @@ var experimentsResource = {
             summary: "Archive \u2014 stopped \u2192 archived",
             description: "Soft-deletes the experiment. List endpoints exclude archived rows by default.",
             value: { status: "archived" }
+          },
+          restore: {
+            summary: "Restore \u2014 archived \u2192 draft",
+            description: "Un-deletes a soft-deleted experiment so it can be re-completed and started. Allowed only if it never ran.",
+            value: { status: "draft" }
           }
         },
         response: { id: "exp_01j7wb12c3d4e5f6g7h8j9k0l1", status: "running" }

package/dist/resources/experiments.d.ts

@@ -59,6 +59,8 @@ interface ExperimentsClient {
     start(id: string): Promise<Experiment>;
     stop(id: string): Promise<Experiment>;
     archive(id: string): Promise<Experiment>;
+    /** Restore a soft-deleted (archived) experiment back to `draft`. */
+    restore(id: string): Promise<Experiment>;
     setMetrics(id: string, input: ExperimentMetricsInput): Promise<unknown>;
     results(id: string): Promise<ExperimentResult[]>;
     timeseries(id: string, metric?: string): Promise<ExperimentTimeseriesPoint[]>;
@@ -167,6 +169,9 @@ declare const experimentsResource: {
     }, {
         readonly name: "archive";
         readonly description: "Archive a stopped experiment";
+    }, {
+        readonly name: "restore";
+        readonly description: "Restore an archived (never-started) experiment to draft";
     }, {
         readonly name: "reanalyze";
         readonly description: "Re-run analysis pass for the experiment";
@@ -637,6 +642,13 @@ declare const experimentsResource: {
                         readonly status: "archived";
                     };
                 };
+                readonly restore: {
+                    readonly summary: "Restore — archived → draft";
+                    readonly description: "Un-deletes a soft-deleted experiment so it can be re-completed and started. Allowed only if it never ran.";
+                    readonly value: {
+                        readonly status: "draft";
+                    };
+                };
             };
             readonly response: {
                 readonly id: "exp_01j7wb12c3d4e5f6g7h8j9k0l1";

package/dist/resources/experiments.js

@@ -106,7 +106,7 @@ var experimentUpdateSchema = z3.object({
 );
 var experimentStatusUpdateSchema = z3.object({
   status: z3.enum(["draft", "running", "stopped", "archived"]).describe(
-    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`. Restarting an archived experiment is not allowed."
+    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`, and `archived \u2192 draft` (restore \u2014 only if the experiment never started). Restarting an archived experiment directly is not allowed; restore it to draft first, then start."
   )
 }).describe("Body for `POST /api/admin/experiments/{id}/status`.");
 var experimentMetricsUpdateSchema = z3.object({
@@ -221,24 +221,29 @@ function experimentsClient(t) {
     if (opts.cursor) query.cursor = opts.cursor;
     return t.request("GET", BASE, void 0, query);
   }
-  async function listAll() {
+  async function listAllWith(status) {
     const out = [];
     let cursor;
     do {
-      const page = await list({ limit: 500, cursor });
+      const query = { limit: "500" };
+      if (cursor) query.cursor = cursor;
+      if (status) query.status = status;
+      const page = await t.request("GET", BASE, void 0, query);
       out.push(...page.data);
       cursor = page.next_cursor ?? void 0;
     } while (cursor);
     return out;
   }
+  async function listAll() {
+    return listAllWith();
+  }
   async function resolve(idOrName) {
     try {
       return await t.request("GET", `${BASE}/${idOrName}`);
     } catch (err) {
       if (!(err instanceof ApiError) || err.status !== 404) throw err;
     }
-    const all = await listAll();
-    const found = all.find((e) => e.name === idOrName);
+    const found = (await listAllWith()).find((e) => e.name === idOrName) ?? (await listAllWith("archived")).find((e) => e.name === idOrName);
     if (!found) throw new ApiError(`Experiment '${idOrName}' not found`, 404);
     return found;
   }
@@ -261,6 +266,7 @@ function experimentsClient(t) {
     start: (id) => setStatus(id, "running"),
     stop: (id) => setStatus(id, "stopped"),
     archive: (id) => setStatus(id, "archived"),
+    restore: (id) => setStatus(id, "draft"),
     setMetrics: (id, input) => t.request("POST", `${BASE}/${id}/metrics`, experimentMetricsUpdateSchema.parse(input)),
     results: (id) => t.request("GET", `${BASE}/${id}/results`),
     timeseries: (id, metric) => t.request(
@@ -307,7 +313,7 @@ var experimentsResource = {
       "",
       "**Identity.** Stable `name` (a-z, 0-9, `_`/`-`, max 64 chars). Immutable after create.",
       "",
-      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. Restarting an archived experiment is not allowed.",
+      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. An archived experiment that never started can be restored with `archived \u2192 draft`; restarting an archived experiment directly is not allowed.",
       "",
       "**Allocation.** `allocation_pct` (basis points, 0\u201310000) is the share of the targeted audience enrolled; `groups[].weight` (must sum to 10000) splits the enrolled audience. `targeting_gate` narrows the eligible audience before allocation.",
       "",
@@ -326,6 +332,7 @@ var experimentsResource = {
     { name: "start", description: "Transition draft experiment to running" },
     { name: "stop", description: "Stop a running experiment" },
     { name: "archive", description: "Archive a stopped experiment" },
+    { name: "restore", description: "Restore an archived (never-started) experiment to draft" },
     { name: "reanalyze", description: "Re-run analysis pass for the experiment" }
   ],
   endpoints: [
@@ -506,8 +513,9 @@ var experimentsResource = {
         "- `running \u2192 stopped` \u2014 halts allocation. Existing exposures stay in the dataset.",
         "- `stopped \u2192 archived` \u2014 soft-delete.",
         "- `draft \u2192 archived` \u2014 discard an unstarted experiment.",
+        "- `archived \u2192 draft` \u2014 restore a soft-deleted experiment so it can be re-completed and started. Allowed only if it never started; one that already ran must be cloned instead.",
         "",
-        "Restarting an `archived` experiment is not allowed; clone instead. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
+        "Restarting an `archived` experiment directly is not allowed \u2014 restore it to `draft` first. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
       ].join("\n"),
       pathParams: { id: "Stable opaque experiment id." },
       request: experimentStatusUpdateSchema,
@@ -528,6 +536,11 @@ var experimentsResource = {
             summary: "Archive \u2014 stopped \u2192 archived",
             description: "Soft-deletes the experiment. List endpoints exclude archived rows by default.",
             value: { status: "archived" }
+          },
+          restore: {
+            summary: "Restore \u2014 archived \u2192 draft",
+            description: "Un-deletes a soft-deleted experiment so it can be re-completed and started. Allowed only if it never ran.",
+            value: { status: "draft" }
           }
         },
         response: { id: "exp_01j7wb12c3d4e5f6g7h8j9k0l1", status: "running" }

package/dist/resources/index.d.ts

@@ -792,6 +792,9 @@ declare const RESOURCE_REGISTRY: readonly [{
     }, {
         readonly name: "archive";
         readonly description: "Archive a stopped experiment";
+    }, {
+        readonly name: "restore";
+        readonly description: "Restore an archived (never-started) experiment to draft";
     }, {
         readonly name: "reanalyze";
         readonly description: "Re-run analysis pass for the experiment";
@@ -1262,6 +1265,13 @@ declare const RESOURCE_REGISTRY: readonly [{
                         readonly status: "archived";
                     };
                 };
+                readonly restore: {
+                    readonly summary: "Restore — archived → draft";
+                    readonly description: "Un-deletes a soft-deleted experiment so it can be re-completed and started. Allowed only if it never ran.";
+                    readonly value: {
+                        readonly status: "draft";
+                    };
+                };
             };
             readonly response: {
                 readonly id: "exp_01j7wb12c3d4e5f6g7h8j9k0l1";

package/dist/resources/index.js

@@ -602,7 +602,7 @@ var experimentUpdateSchema = z5.object({
 );
 var experimentStatusUpdateSchema = z5.object({
   status: z5.enum(["draft", "running", "stopped", "archived"]).describe(
-    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`. Restarting an archived experiment is not allowed."
+    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`, and `archived \u2192 draft` (restore \u2014 only if the experiment never started). Restarting an archived experiment directly is not allowed; restore it to draft first, then start."
   )
 }).describe("Body for `POST /api/admin/experiments/{id}/status`.");
 var experimentMetricsUpdateSchema = z5.object({
@@ -707,24 +707,29 @@ function experimentsClient(t) {
     if (opts.cursor) query.cursor = opts.cursor;
     return t.request("GET", BASE2, void 0, query);
   }
-  async function listAll() {
+  async function listAllWith(status) {
     const out = [];
     let cursor;
     do {
-      const page = await list({ limit: 500, cursor });
+      const query = { limit: "500" };
+      if (cursor) query.cursor = cursor;
+      if (status) query.status = status;
+      const page = await t.request("GET", BASE2, void 0, query);
       out.push(...page.data);
       cursor = page.next_cursor ?? void 0;
     } while (cursor);
     return out;
   }
+  async function listAll() {
+    return listAllWith();
+  }
   async function resolve(idOrName) {
     try {
       return await t.request("GET", `${BASE2}/${idOrName}`);
     } catch (err) {
       if (!(err instanceof ApiError) || err.status !== 404) throw err;
     }
-    const all = await listAll();
-    const found = all.find((e) => e.name === idOrName);
+    const found = (await listAllWith()).find((e) => e.name === idOrName) ?? (await listAllWith("archived")).find((e) => e.name === idOrName);
     if (!found) throw new ApiError(`Experiment '${idOrName}' not found`, 404);
     return found;
   }
@@ -747,6 +752,7 @@ function experimentsClient(t) {
     start: (id) => setStatus(id, "running"),
     stop: (id) => setStatus(id, "stopped"),
     archive: (id) => setStatus(id, "archived"),
+    restore: (id) => setStatus(id, "draft"),
     setMetrics: (id, input) => t.request("POST", `${BASE2}/${id}/metrics`, experimentMetricsUpdateSchema.parse(input)),
     results: (id) => t.request("GET", `${BASE2}/${id}/results`),
     timeseries: (id, metric) => t.request(
@@ -793,7 +799,7 @@ var experimentsResource = {
       "",
       "**Identity.** Stable `name` (a-z, 0-9, `_`/`-`, max 64 chars). Immutable after create.",
       "",
-      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. Restarting an archived experiment is not allowed.",
+      "**Lifecycle.** `draft \u2192 running \u2192 stopped \u2192 archived`. Transition via `POST /{id}/status`. An archived experiment that never started can be restored with `archived \u2192 draft`; restarting an archived experiment directly is not allowed.",
       "",
       "**Allocation.** `allocation_pct` (basis points, 0\u201310000) is the share of the targeted audience enrolled; `groups[].weight` (must sum to 10000) splits the enrolled audience. `targeting_gate` narrows the eligible audience before allocation.",
       "",
@@ -812,6 +818,7 @@ var experimentsResource = {
     { name: "start", description: "Transition draft experiment to running" },
     { name: "stop", description: "Stop a running experiment" },
     { name: "archive", description: "Archive a stopped experiment" },
+    { name: "restore", description: "Restore an archived (never-started) experiment to draft" },
     { name: "reanalyze", description: "Re-run analysis pass for the experiment" }
   ],
   endpoints: [
@@ -992,8 +999,9 @@ var experimentsResource = {
         "- `running \u2192 stopped` \u2014 halts allocation. Existing exposures stay in the dataset.",
         "- `stopped \u2192 archived` \u2014 soft-delete.",
         "- `draft \u2192 archived` \u2014 discard an unstarted experiment.",
+        "- `archived \u2192 draft` \u2014 restore a soft-deleted experiment so it can be re-completed and started. Allowed only if it never started; one that already ran must be cloned instead.",
         "",
-        "Restarting an `archived` experiment is not allowed; clone instead. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
+        "Restarting an `archived` experiment directly is not allowed \u2014 restore it to `draft` first. Returns `409` on illegal transitions and `429` if the plan's `experiments_running` limit is exceeded on `\u2192 running`."
       ].join("\n"),
       pathParams: { id: "Stable opaque experiment id." },
       request: experimentStatusUpdateSchema,
@@ -1014,6 +1022,11 @@ var experimentsResource = {
             summary: "Archive \u2014 stopped \u2192 archived",
             description: "Soft-deletes the experiment. List endpoints exclude archived rows by default.",
             value: { status: "archived" }
+          },
+          restore: {
+            summary: "Restore \u2014 archived \u2192 draft",
+            description: "Un-deletes a soft-deleted experiment so it can be re-completed and started. Allowed only if it never ran.",
+            value: { status: "draft" }
           }
         },
         response: { id: "exp_01j7wb12c3d4e5f6g7h8j9k0l1", status: "running" }

package/dist/schemas/experiments.js

@@ -103,7 +103,7 @@ var experimentUpdateSchema = z3.object({
 );
 var experimentStatusUpdateSchema = z3.object({
   status: z3.enum(["draft", "running", "stopped", "archived"]).describe(
-    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`. Restarting an archived experiment is not allowed."
+    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`, and `archived \u2192 draft` (restore \u2014 only if the experiment never started). Restarting an archived experiment directly is not allowed; restore it to draft first, then start."
   )
 }).describe("Body for `POST /api/admin/experiments/{id}/status`.");
 var experimentMetricsUpdateSchema = z3.object({

package/dist/schemas/index.js

@@ -530,7 +530,7 @@ var experimentUpdateSchema = z8.object({
 );
 var experimentStatusUpdateSchema = z8.object({
   status: z8.enum(["draft", "running", "stopped", "archived"]).describe(
-    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`. Restarting an archived experiment is not allowed."
+    "Target status. Allowed transitions: `draft \u2192 running`, `running \u2192 stopped`, `stopped \u2192 archived`, `draft \u2192 archived`, and `archived \u2192 draft` (restore \u2014 only if the experiment never started). Restarting an archived experiment directly is not allowed; restore it to draft first, then start."
   )
 }).describe("Body for `POST /api/admin/experiments/{id}/status`.");
 var experimentMetricsUpdateSchema = z8.object({