@mutagent/sdk 0.4.0 → 0.4.2

package/src/models/definition-provider.ts

@@ -0,0 +1,355 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+/**
+ * CPU architecture the image was built for. Validated against the provider at preflight.
+ */
+export enum DefinitionProviderArch {
+  X8664 = "x86_64",
+  Arm64 = "arm64",
+}
+
+/**
+ * Requested resources. A provider that does not expose a given dial REJECTS a definition that sets it, at preflight — never a silent downgrade.
+ */
+export type DefinitionProviderResources = {
+  /**
+   * Requested vCPU count
+   */
+  vcpu?: number | undefined;
+  /**
+   * Requested memory in MB
+   */
+  memoryMb?: number | undefined;
+  /**
+   * Requested disk in MB
+   */
+  diskMb?: number | undefined;
+  /**
+   * Whether a GPU is required
+   */
+  gpu?: boolean | undefined;
+};
+
+/**
+ * Outbound policy. Defaults to deny — opening egress is explicit.
+ */
+export enum DefinitionProviderEgress {
+  Deny = "deny",
+  Allowlist = "allowlist",
+  Allow = "allow",
+}
+
+/**
+ * What this rule constrains
+ */
+export enum DefinitionProviderKind {
+  Port = "port",
+  Cidr = "cidr",
+  Domain = "domain",
+}
+
+/**
+ * A single outbound-access allowance
+ */
+export type DefinitionProviderAllow = {
+  /**
+   * What this rule constrains
+   */
+  kind?: DefinitionProviderKind | undefined;
+  /**
+   * Port, CIDR block, or domain
+   */
+  value: string;
+};
+
+/**
+ * Network policy for the sandbox
+ */
+export type DefinitionProviderNetwork = {
+  /**
+   * Outbound policy. Defaults to deny — opening egress is explicit.
+   */
+  egress?: DefinitionProviderEgress | undefined;
+  /**
+   * Allowances, when egress is "allowlist". Requires provider egressControl support.
+   */
+  allow?: Array<DefinitionProviderAllow> | undefined;
+};
+
+/**
+ * Whether the working directory is archived at every consistency point. `auto` (default) archives it whenever an object store exists; `never` records the leg as disabled in the checkpoint manifest, so a restore reports it as disabled rather than as an archive that failed to travel.
+ */
+export enum DefinitionProviderWorkspace {
+  Auto = "auto",
+  Never = "never",
+}
+
+/**
+ * Which legs continuous capture carries for sessions on this definition.
+ */
+export type DefinitionProviderCapture = {
+  /**
+   * Whether the working directory is archived at every consistency point. `auto` (default) archives it whenever an object store exists; `never` records the leg as disabled in the checkpoint manifest, so a restore reports it as disabled rather than as an archive that failed to travel.
+   */
+  workspace?: DefinitionProviderWorkspace | undefined;
+  /**
+   * Whether `$HOME/.mutagent` (memory, plans, extension state; never the session transcript) is archived. Defaults to true.
+   */
+  home?: boolean | undefined;
+};
+
+/**
+ * Sandbox configuration. Separate artifact from the image content (R-C20).
+ */
+export type Definition = {
+  /**
+   * Human-readable definition name
+   */
+  name: string;
+  /**
+   * Image reference (repository:tag or @digest). The image content is a separate artifact.
+   */
+  image: string;
+  /**
+   * CPU architecture the image was built for. Validated against the provider at preflight.
+   */
+  arch?: DefinitionProviderArch | undefined;
+  /**
+   * Requested resources. A provider that does not expose a given dial REJECTS a definition that sets it, at preflight — never a silent downgrade.
+   */
+  resources?: DefinitionProviderResources | undefined;
+  /**
+   * Network policy for the sandbox
+   */
+  network?: DefinitionProviderNetwork | undefined;
+  /**
+   * Name of the Environment (secrets + variables) to load at spawn. Distinct from `provider`.
+   */
+  environment?: string | undefined;
+  /**
+   * Provider registry key. When omitted the backend default applies.
+   */
+  provider?: string | undefined;
+  /**
+   * Requested max lifetime. Rejected at preflight if it exceeds the provider ceiling.
+   */
+  timeoutMs?: number | undefined;
+  /**
+   * Working directory inside the sandbox
+   */
+  workdir?: string | undefined;
+  /**
+   * Non-secret environment variables. Secret material must come from an Environment.
+   */
+  vars?: { [k: string]: string } | undefined;
+  /**
+   * Which legs continuous capture carries for sessions on this definition.
+   */
+  capture?: DefinitionProviderCapture | undefined;
+};
+
+export type DefinitionProvider = {
+  /**
+   * Sandbox configuration. Separate artifact from the image content (R-C20).
+   */
+  definition: Definition;
+  provider?: string | undefined;
+};
+
+/** @internal */
+export const DefinitionProviderArch$outboundSchema: z.ZodMiniEnum<
+  typeof DefinitionProviderArch
+> = z.enum(DefinitionProviderArch);
+
+/** @internal */
+export type DefinitionProviderResources$Outbound = {
+  vcpu?: number | undefined;
+  memoryMb?: number | undefined;
+  diskMb?: number | undefined;
+  gpu?: boolean | undefined;
+};
+
+/** @internal */
+export const DefinitionProviderResources$outboundSchema: z.ZodMiniType<
+  DefinitionProviderResources$Outbound,
+  DefinitionProviderResources
+> = z.object({
+  vcpu: z.optional(z.number()),
+  memoryMb: z.optional(z.number()),
+  diskMb: z.optional(z.number()),
+  gpu: z.optional(z.boolean()),
+});
+
+export function definitionProviderResourcesToJSON(
+  definitionProviderResources: DefinitionProviderResources,
+): string {
+  return JSON.stringify(
+    DefinitionProviderResources$outboundSchema.parse(
+      definitionProviderResources,
+    ),
+  );
+}
+
+/** @internal */
+export const DefinitionProviderEgress$outboundSchema: z.ZodMiniEnum<
+  typeof DefinitionProviderEgress
+> = z.enum(DefinitionProviderEgress);
+
+/** @internal */
+export const DefinitionProviderKind$outboundSchema: z.ZodMiniEnum<
+  typeof DefinitionProviderKind
+> = z.enum(DefinitionProviderKind);
+
+/** @internal */
+export type DefinitionProviderAllow$Outbound = {
+  kind: string;
+  value: string;
+};
+
+/** @internal */
+export const DefinitionProviderAllow$outboundSchema: z.ZodMiniType<
+  DefinitionProviderAllow$Outbound,
+  DefinitionProviderAllow
+> = z.object({
+  kind: z._default(
+    DefinitionProviderKind$outboundSchema,
+    DefinitionProviderKind.Port,
+  ),
+  value: z.string(),
+});
+
+export function definitionProviderAllowToJSON(
+  definitionProviderAllow: DefinitionProviderAllow,
+): string {
+  return JSON.stringify(
+    DefinitionProviderAllow$outboundSchema.parse(definitionProviderAllow),
+  );
+}
+
+/** @internal */
+export type DefinitionProviderNetwork$Outbound = {
+  egress: string;
+  allow?: Array<DefinitionProviderAllow$Outbound> | undefined;
+};
+
+/** @internal */
+export const DefinitionProviderNetwork$outboundSchema: z.ZodMiniType<
+  DefinitionProviderNetwork$Outbound,
+  DefinitionProviderNetwork
+> = z.object({
+  egress: z._default(
+    DefinitionProviderEgress$outboundSchema,
+    DefinitionProviderEgress.Deny,
+  ),
+  allow: z.optional(
+    z.array(z.lazy(() => DefinitionProviderAllow$outboundSchema)),
+  ),
+});
+
+export function definitionProviderNetworkToJSON(
+  definitionProviderNetwork: DefinitionProviderNetwork,
+): string {
+  return JSON.stringify(
+    DefinitionProviderNetwork$outboundSchema.parse(definitionProviderNetwork),
+  );
+}
+
+/** @internal */
+export const DefinitionProviderWorkspace$outboundSchema: z.ZodMiniEnum<
+  typeof DefinitionProviderWorkspace
+> = z.enum(DefinitionProviderWorkspace);
+
+/** @internal */
+export type DefinitionProviderCapture$Outbound = {
+  workspace: string;
+  home?: boolean | undefined;
+};
+
+/** @internal */
+export const DefinitionProviderCapture$outboundSchema: z.ZodMiniType<
+  DefinitionProviderCapture$Outbound,
+  DefinitionProviderCapture
+> = z.object({
+  workspace: z._default(
+    DefinitionProviderWorkspace$outboundSchema,
+    DefinitionProviderWorkspace.Auto,
+  ),
+  home: z.optional(z.boolean()),
+});
+
+export function definitionProviderCaptureToJSON(
+  definitionProviderCapture: DefinitionProviderCapture,
+): string {
+  return JSON.stringify(
+    DefinitionProviderCapture$outboundSchema.parse(definitionProviderCapture),
+  );
+}
+
+/** @internal */
+export type Definition$Outbound = {
+  name: string;
+  image: string;
+  arch: string;
+  resources?: DefinitionProviderResources$Outbound | undefined;
+  network?: DefinitionProviderNetwork$Outbound | undefined;
+  environment?: string | undefined;
+  provider?: string | undefined;
+  timeoutMs?: number | undefined;
+  workdir?: string | undefined;
+  vars?: { [k: string]: string } | undefined;
+  capture?: DefinitionProviderCapture$Outbound | undefined;
+};
+
+/** @internal */
+export const Definition$outboundSchema: z.ZodMiniType<
+  Definition$Outbound,
+  Definition
+> = z.object({
+  name: z.string(),
+  image: z.string(),
+  arch: z._default(
+    DefinitionProviderArch$outboundSchema,
+    DefinitionProviderArch.X8664,
+  ),
+  resources: z.optional(
+    z.lazy(() => DefinitionProviderResources$outboundSchema),
+  ),
+  network: z.optional(z.lazy(() => DefinitionProviderNetwork$outboundSchema)),
+  environment: z.optional(z.string()),
+  provider: z.optional(z.string()),
+  timeoutMs: z.optional(z.number()),
+  workdir: z.optional(z.string()),
+  vars: z.optional(z.record(z.string(), z.string())),
+  capture: z.optional(z.lazy(() => DefinitionProviderCapture$outboundSchema)),
+});
+
+export function definitionToJSON(definition: Definition): string {
+  return JSON.stringify(Definition$outboundSchema.parse(definition));
+}
+
+/** @internal */
+export type DefinitionProvider$Outbound = {
+  definition: Definition$Outbound;
+  provider?: string | undefined;
+};
+
+/** @internal */
+export const DefinitionProvider$outboundSchema: z.ZodMiniType<
+  DefinitionProvider$Outbound,
+  DefinitionProvider
+> = z.object({
+  definition: z.lazy(() => Definition$outboundSchema),
+  provider: z.optional(z.string()),
+});
+
+export function definitionProviderToJSON(
+  definitionProvider: DefinitionProvider,
+): string {
+  return JSON.stringify(
+    DefinitionProvider$outboundSchema.parse(definitionProvider),
+  );
+}

package/src/models/definition-run-id.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  NameImageArch,
+  NameImageArch$Outbound,
+  NameImageArch$outboundSchema,
+} from "./name-image-arch.js";
+
+export type DefinitionRunId = {
+  /**
+   * Sandbox configuration. Separate artifact from the image content (R-C20).
+   */
+  definition: NameImageArch;
+  /**
+   * Correlation id for trace attribution
+   */
+  runId?: string | undefined;
+};
+
+/** @internal */
+export type DefinitionRunId$Outbound = {
+  definition: NameImageArch$Outbound;
+  runId?: string | undefined;
+};
+
+/** @internal */
+export const DefinitionRunId$outboundSchema: z.ZodMiniType<
+  DefinitionRunId$Outbound,
+  DefinitionRunId
+> = z.object({
+  definition: NameImageArch$outboundSchema,
+  runId: z.optional(z.string()),
+});
+
+export function definitionRunIdToJSON(
+  definitionRunId: DefinitionRunId,
+): string {
+  return JSON.stringify(DefinitionRunId$outboundSchema.parse(definitionRunId));
+}

package/src/models/errors/error-message-model.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as types from "../../types/primitives.js";
+import { MutagentError } from "./mutagent-error.js";
+
+export type ErrorMessageModelData = {
+  error: string;
+  message: string;
+  model: string;
+  available: Array<string>;
+};
+
+export class ErrorMessageModel extends MutagentError {
+  error: string;
+  model: string;
+  available: Array<string>;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorMessageModelData;
+
+  constructor(
+    err: ErrorMessageModelData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    this.model = err.model;
+    this.available = err.available;
+
+    this.name = "ErrorMessageModel";
+  }
+}
+
+/** @internal */
+export const ErrorMessageModel$inboundSchema: z.ZodMiniType<
+  ErrorMessageModel,
+  unknown
+> = z.pipe(
+  z.object({
+    error: types.string(),
+    message: types.string(),
+    model: types.string(),
+    available: z.array(types.string()),
+    request$: z.custom<Request>(x => x instanceof Request),
+    response$: z.custom<Response>(x => x instanceof Response),
+    body$: z.string(),
+  }),
+  z.transform((v) => {
+    return new ErrorMessageModel(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  }),
+);

package/src/models/errors/error-message2.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as types from "../../types/primitives.js";
+import { MutagentError } from "./mutagent-error.js";
+
+export type ErrorMessage2Data = {
+  error: string;
+  message: string;
+
+  [additionalProperties: string]: unknown;
+};
+
+export class ErrorMessage2 extends MutagentError {
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorMessage2Data;
+
+  constructor(
+    err: ErrorMessage2Data,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "ErrorMessage2";
+  }
+}
+
+/** @internal */
+export const ErrorMessage2$inboundSchema: z.ZodMiniType<
+  ErrorMessage2,
+  unknown
+> = z.pipe(
+  z.object({
+    error: types.string(),
+    message: types.string(),
+    request$: z.custom<Request>(x => x instanceof Request),
+    response$: z.custom<Response>(x => x instanceof Response),
+    body$: z.string(),
+  }),
+  z.transform((v) => {
+    return new ErrorMessage2(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  }),
+);

package/src/models/errors/get-api-sandbox-by-id.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as types from "../../types/primitives.js";
+import { MutagentError } from "./mutagent-error.js";
+
+/**
+ * Response for status 503
+ */
+export type ServiceUnavailableErrorData = {
+  error: string;
+  message: string;
+  provider: string;
+};
+
+/**
+ * Response for status 503
+ */
+export class ServiceUnavailableError extends MutagentError {
+  error: string;
+  provider: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: ServiceUnavailableErrorData;
+
+  constructor(
+    err: ServiceUnavailableErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    this.provider = err.provider;
+
+    this.name = "ServiceUnavailableError";
+  }
+}
+
+/** @internal */
+export const ServiceUnavailableError$inboundSchema: z.ZodMiniType<
+  ServiceUnavailableError,
+  unknown
+> = z.pipe(
+  z.object({
+    error: types.string(),
+    message: types.string(),
+    provider: types.string(),
+    request$: z.custom<Request>(x => x instanceof Request),
+    response$: z.custom<Response>(x => x instanceof Response),
+    body$: z.string(),
+  }),
+  z.transform((v) => {
+    return new ServiceUnavailableError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  }),
+);

package/src/models/errors/index.ts

@@ -2,13 +2,20 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./error-message-model.js";
 export * from "./error-message-status-code.js";
 export * from "./error-message.js";
+export * from "./error-message2.js";
+export * from "./get-api-sandbox-by-id.js";
 export * from "./http-client-errors.js";
 export * from "./mutagent-error.js";
+export * from "./post-api-sandbox-agent-run.js";
+export * from "./post-api-sandbox-by-id-session.js";
 export * from "./provider-error.js";
+export * from "./put-api-sandbox-helix-defaults.js";
 export * from "./response-validation-error.js";
 export * from "./sdk-error.js";
 export * from "./sdk-validation-error.js";
 export * from "./test-connection-result-error.js";
+export * from "./workspace-model-listing-error.js";
 export * from "./ws-error.js";