@continuous-labs/sdk 0.0.5 → 0.0.6

package/src/models/build-world-request.ts

@@ -6,11 +6,11 @@ import * as z from "zod/v4-mini";
 
 export type BuildWorldRequest = {
   /**
-   * Build guidance. At most 16,384 characters and 65,536 UTF-8 bytes. U+0000 is not permitted.
+   * Instructions for the builder. At most 16,384 characters and 65,536 UTF-8 bytes; must not be blank or contain U+0000.
    */
   instructions?: string | undefined;
   /**
-   * Stable Simulator IDs for the World.
+   * Simulator IDs for the World.
    */
   simulators: Array<string>;
 };

package/src/models/create-simulation-request.ts

@@ -11,7 +11,7 @@ export type CreateSimulationRequest = {
    */
   name?: string | undefined;
   /**
-   * Stable ID of the ready Simulator.
+   * ID of the ready Simulator.
    */
   simulatorId: string;
 };

package/src/models/created-simulation.ts

@@ -12,7 +12,7 @@ import * as types from "../types/primitives.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 /**
- * Current Simulation status.
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
  */
 export const CreatedSimulationStatus = {
   Running: "running",
@@ -20,7 +20,7 @@ export const CreatedSimulationStatus = {
   Stopped: "stopped",
 } as const;
 /**
- * Current Simulation status.
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
  */
 export type CreatedSimulationStatus = OpenEnum<typeof CreatedSimulationStatus>;
 
@@ -30,7 +30,7 @@ export type CreatedSimulation = {
    */
   createdAt: Date;
   /**
-   * Data-plane endpoint for the Simulation.
+   * Base URL for requests to the Simulation.
    */
   endpoint: string;
   /**
@@ -38,7 +38,7 @@ export type CreatedSimulation = {
    */
   expiresAt: Date;
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
   /**
@@ -46,19 +46,19 @@ export type CreatedSimulation = {
    */
   name: string;
   /**
-   * Stable source Simulation ID for a fork, or null.
+   * Source Simulation ID for a fork, or null.
    */
   parentId: string | null;
   /**
-   * Stable ID of the Simulator.
+   * ID of the Simulator.
    */
   simulatorId: string;
   /**
-   * Current Simulation status.
+   * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
    */
   status: CreatedSimulationStatus;
   /**
-   * One-time data-plane token.
+   * Token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header. It is returned only here; list and get omit it. Create more with POST /v1/simulations/{id}/tokens.
    */
   token: string;
 };

package/src/models/list-worlds-response.ts

@@ -12,7 +12,7 @@ import { World, World$inboundSchema } from "./world.js";
 
 export type ListWorldsResponse = {
   /**
-   * Cursor for the next page, or null when this is the last page.
+   * Cursor for the next page, or null.
    */
   nextCursor: string | null;
   /**

package/src/models/operations/build-simulator.ts

@@ -14,7 +14,7 @@ export type Spec = {
 export type BuildSimulatorRequest = {
   request: models.BuildSimulatorRequest;
   /**
-   * OpenAPI or WSDL file. A spec build sends it. At most 67,108,864 UTF-8 bytes.
+   * OpenAPI or WSDL document, UTF-8 encoded, at most 64 MiB. Required unless the request is an incremental build (parent_id and instructions, no spec).
    */
   spec?: Spec | Blob | undefined;
 };

package/src/models/operations/cancel-simulator-build.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type CancelSimulatorBuildRequest = {
   /**
-   * Stable Simulator ID.
+   * Simulator ID.
    */
   id: string;
 };

package/src/models/operations/cancel-world-build.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type CancelWorldBuildRequest = {
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
 };

package/src/models/operations/delete-simulation.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type DeleteSimulationRequest = {
   /**
-   * Stable resource ID.
+   * Simulation ID.
    */
   id: string;
 };

package/src/models/operations/delete-simulator.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type DeleteSimulatorRequest = {
   /**
-   * Stable Simulator ID.
+   * Simulator ID.
    */
   id: string;
 };

package/src/models/operations/delete-world.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type DeleteWorldRequest = {
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
 };

package/src/models/operations/fork-simulation.ts

@@ -7,7 +7,7 @@ import * as models from "../index.js";
 
 export type ForkSimulationRequest = {
   /**
-   * Stable source Simulation ID.
+   * Source Simulation ID.
    */
   id: string;
   body: models.ForkSimulationRequest;

package/src/models/operations/get-simulation.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type GetSimulationRequest = {
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
 };

package/src/models/operations/get-simulator.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type GetSimulatorRequest = {
   /**
-   * Stable Simulator ID.
+   * Simulator ID.
    */
   id: string;
 };

package/src/models/operations/get-world.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type GetWorldRequest = {
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
 };

package/src/models/operations/list-simulation-steps.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type ListSimulationStepsRequest = {
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
   /**

package/src/models/operations/list-simulations.ts

@@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * Optional lifecycle status filter.
+ * Optional status filter.
  */
 export const ListSimulationsStatus = {
   Running: "running",
@@ -15,17 +15,17 @@ export const ListSimulationsStatus = {
   Stopped: "stopped",
 } as const;
 /**
- * Optional lifecycle status filter.
+ * Optional status filter.
  */
 export type ListSimulationsStatus = ClosedEnum<typeof ListSimulationsStatus>;
 
 export type ListSimulationsRequest = {
   /**
-   * Optional lifecycle status filter.
+   * Optional status filter.
    */
   status?: ListSimulationsStatus | undefined;
   /**
-   * Optional stable Simulator ID filter.
+   * Optional Simulator ID filter.
    */
   simulatorId?: string | undefined;
   /**

package/src/models/operations/list-simulators.ts

@@ -25,7 +25,7 @@ export type ListSimulatorsRequest = {
    */
   status?: ListSimulatorsStatus | undefined;
   /**
-   * Optional exact Simulator name. Prefix a catalog name with continuous/. Names cannot start with smr_.
+   * Return only the Simulator with this exact name. For a Simulator from the Continuous catalog, prefix the name with continuous/. Names cannot start with smr_.
    */
   name?: string | undefined;
   /**

package/src/models/operations/list-worlds.ts

@@ -10,7 +10,7 @@ export type ListWorldsRequest = {
    */
   limit?: number | undefined;
   /**
-   * Opaque cursor from the previous page.
+   * Opaque next_cursor value from a previous page.
    */
   cursor?: string | undefined;
 };

package/src/models/operations/mint-simulation-token.ts

@@ -7,7 +7,7 @@ import * as models from "../index.js";
 
 export type MintSimulationTokenRequest = {
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
   body: models.MintSimulationTokenRequest;

package/src/models/operations/start-simulation.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type StartSimulationRequest = {
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
 };

package/src/models/operations/start-world.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type StartWorldRequest = {
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
 };

package/src/models/operations/stop-simulation.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type StopSimulationRequest = {
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
 };

package/src/models/operations/stop-world.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v4-mini";
 
 export type StopWorldRequest = {
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
 };

package/src/models/simulation-token.ts

@@ -15,7 +15,7 @@ export type SimulationToken = {
    */
   expiresAt: Date;
   /**
-   * New data-plane token.
+   * New token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header.
    */
   token: string;
 };

package/src/models/simulation.ts

@@ -12,7 +12,7 @@ import * as types from "../types/primitives.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 /**
- * Current Simulation status.
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
  */
 export const SimulationStatus = {
   Running: "running",
@@ -20,7 +20,7 @@ export const SimulationStatus = {
   Stopped: "stopped",
 } as const;
 /**
- * Current Simulation status.
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
  */
 export type SimulationStatus = OpenEnum<typeof SimulationStatus>;
 
@@ -30,11 +30,11 @@ export type Simulation = {
    */
   createdAt: Date;
   /**
-   * Data-plane endpoint for the Simulation.
+   * Base URL for requests to the Simulation.
    */
   endpoint: string;
   /**
-   * Stable Simulation ID.
+   * Simulation ID.
    */
   id: string;
   /**
@@ -42,15 +42,15 @@ export type Simulation = {
    */
   name: string;
   /**
-   * Stable source Simulation ID for a fork, or null.
+   * Source Simulation ID for a fork, or null.
    */
   parentId: string | null;
   /**
-   * Stable ID of the Simulator.
+   * ID of the Simulator.
    */
   simulatorId: string;
   /**
-   * Current Simulation status.
+   * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
    */
   status: SimulationStatus;
 };

package/src/models/simulator.ts

@@ -16,19 +16,19 @@ import {
 } from "./resource-error.js";
 
 /**
- * Simulator source.
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
  */
 export const Source = {
   Workspace: "workspace",
   Catalog: "catalog",
 } as const;
 /**
- * Simulator source.
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
  */
 export type Source = OpenEnum<typeof Source>;
 
 /**
- * Current build status.
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
  */
 export const SimulatorStatus = {
   Building: "building",
@@ -37,7 +37,7 @@ export const SimulatorStatus = {
   Canceled: "canceled",
 } as const;
 /**
- * Current build status.
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
  */
 export type SimulatorStatus = OpenEnum<typeof SimulatorStatus>;
 
@@ -48,7 +48,7 @@ export type Simulator = {
   createdAt: Date;
   error: ResourceError | null;
   /**
-   * Stable Simulator ID.
+   * Simulator ID.
    */
   id: string;
   /**
@@ -56,15 +56,15 @@ export type Simulator = {
    */
   name: string;
   /**
-   * Stable parent Simulator ID, or null.
+   * Parent Simulator ID, or null.
    */
   parentId: string | null;
   /**
-   * Simulator source.
+   * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
    */
   source: Source;
   /**
-   * Current build status.
+   * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
    */
   status: SimulatorStatus;
 };

package/src/models/step.ts

@@ -10,11 +10,11 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type Step = {
   /**
-   * Request label. It usually contains the HTTP method and path.
+   * HTTP method and path of the request that produced this step, without the query string, for example POST /v1/widgets.
    */
   label: string;
   /**
-   * Completed request number. Use this value as at_step when you fork the Simulation.
+   * Step number. Use it as at_step when you fork.
    */
   step: number;
 };

package/src/models/world-simulation.ts

@@ -11,11 +11,11 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type WorldSimulation = {
   /**
-   * Stable ID of the created Simulation.
+   * ID of the created Simulation.
    */
   id: string;
   /**
-   * Stable ID of the Simulator that this Simulation runs.
+   * ID of the Simulator that this Simulation runs.
    */
   simulatorId: string;
 };

package/src/models/world.ts

@@ -20,7 +20,7 @@ import {
 } from "./world-simulation.js";
 
 /**
- * Current World lifecycle status.
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
  */
 export const WorldStatus = {
   Building: "building",
@@ -31,18 +31,18 @@ export const WorldStatus = {
   Canceled: "canceled",
 } as const;
 /**
- * Current World lifecycle status.
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
  */
 export type WorldStatus = OpenEnum<typeof WorldStatus>;
 
 export type World = {
   /**
-   * Time when the World build started.
+   * World creation time.
    */
   createdAt: Date;
   error: ResourceError | null;
   /**
-   * Stable World ID.
+   * World ID.
    */
   id: string;
   /**
@@ -50,15 +50,15 @@ export type World = {
    */
   instructions: string;
   /**
-   * Created member Simulations. This list is empty before first start.
+   * Simulations in the World. Empty unless the World is running or stopped.
    */
   simulations: Array<WorldSimulation>;
   /**
-   * Stable Simulator IDs in member order.
+   * Simulator IDs in member order.
    */
   simulators: Array<string>;
   /**
-   * Current World lifecycle status.
+   * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
    */
   status: WorldStatus;
 };

package/src/sdk/simulations.ts

@@ -38,7 +38,7 @@ export class Simulations extends ClientSDK {
    * Create Simulation
    *
    * @remarks
-   * Creates an isolated runtime from a ready Simulator. The response includes its endpoint and a 1-hour token.
+   * Creates a Simulation from a ready Simulator and starts it. The response includes the Simulation endpoint and a token that expires in 1 hour. List and get do not return the token.
    */
   async createSimulation(
     request: models.CreateSimulationRequest,
@@ -72,7 +72,7 @@ export class Simulations extends ClientSDK {
    * Get Simulation
    *
    * @remarks
-   * Returns a Simulation and its current runtime status. The response does not include data-plane tokens.
+   * Returns a Simulation and its current status. The response does not include tokens.
    */
   async getSimulation(
     request: operations.GetSimulationRequest,
@@ -89,7 +89,7 @@ export class Simulations extends ClientSDK {
    * Fork Simulation
    *
    * @remarks
-   * Creates a Simulation with a 1-hour token. The source Simulation continues to run.
+   * Creates a new Simulation from the source Simulation's current state, or from an earlier recorded step when you set at_step. The source must be running or paused; a stopped source returns 409 simulation_stopped. Forking does not change the source. The response includes the new endpoint and a token that expires in 1 hour.
    */
   async forkSimulation(
     request: operations.ForkSimulationRequest,
@@ -106,7 +106,7 @@ export class Simulations extends ClientSDK {
    * Start Simulation
    *
    * @remarks
-   * Starts a stopped Simulation from its saved runtime state. Its endpoint becomes available after the runtime starts.
+   * Starts a stopped Simulation from its saved state. The endpoint serves requests once the response returns. A Simulation that is already running or paused is returned unchanged.
    */
   async startSimulation(
     request: operations.StartSimulationRequest,
@@ -123,7 +123,7 @@ export class Simulations extends ClientSDK {
    * List Simulation Steps
    *
    * @remarks
-   * Returns recorded steps for a running or paused Simulation. Use any step to create a deterministic fork.
+   * Lists the Simulation's steps in order. Each request that changed state is one step; a request that only reads registers none. Pass a step number as at_step when you fork to start the child from the state after that step. A stopped Simulation returns 409 simulation_stopped; start it first.
    */
   async listSimulationSteps(
     request: operations.ListSimulationStepsRequest,
@@ -140,7 +140,7 @@ export class Simulations extends ClientSDK {
    * Stop Simulation
    *
    * @remarks
-   * Stops a Simulation and saves its runtime state. You can start it later from the saved state.
+   * Stops a Simulation and saves its state. Requests to its endpoint return 409 simulation_stopped until you start it again. A stopped Simulation is returned unchanged.
    */
   async stopSimulation(
     request: operations.StopSimulationRequest,
@@ -157,7 +157,7 @@ export class Simulations extends ClientSDK {
    * Mint Simulation Token
    *
    * @remarks
-   * Mints an expiring data-plane token. Send it in X-Continuous-Simulation-Token. Other unexpired tokens remain valid.
+   * Creates another token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header. Earlier tokens stay valid until they expire.
    */
   async mintSimulationToken(
     request: operations.MintSimulationTokenRequest,

package/src/sdk/simulators.ts

@@ -34,7 +34,7 @@ export class Simulators extends ClientSDK {
    * Build Simulator
    *
    * @remarks
-   * Creates a Simulator from an OpenAPI or WSDL source. The build runs asynchronously. Send multipart/form-data with one JSON request part, and one spec file part for a spec build.
+   * Starts an asynchronous Simulator build and returns the Simulator with status building. Send multipart/form-data with a JSON part named request. To build from a document, add a file part named spec with the OpenAPI or WSDL document. For an incremental build, omit spec and set parent_id and instructions.
    */
   async buildSimulator(
     request: operations.BuildSimulatorRequest,

package/src/sdk/worlds.ts

@@ -36,7 +36,7 @@ export class Worlds extends ClientSDK {
    * Build World
    *
    * @remarks
-   * Builds a World definition from stable Simulator IDs. Start the World to create its Simulations.
+   * Starts an asynchronous World build from one or more ready Simulators and returns the World in the building state. Start the World once it is ready to create its Simulations.
    */
   async buildWorld(
     request: models.BuildWorldRequest,
@@ -104,7 +104,7 @@ export class Worlds extends ClientSDK {
    * Start World
    *
    * @remarks
-   * Creates member Simulations on first start. Later starts restore stopped Simulations from saved state.
+   * Starts every Simulation in the World. The first start creates the Simulations; later starts restore them from saved state. The World must be ready or stopped, and the workspace must have room for all members under its active-Simulation limit. A running World is returned unchanged.
    */
   async startWorld(
     request: operations.StartWorldRequest,