@usestatemachines/sdk 0.11.0 → 0.12.0

package/esm/models/snapshot-app-full-load.d.ts

@@ -0,0 +1,101 @@
+import * as z from "zod/v4-mini";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { AbsentRecord } from "./absent-record.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { FilledField } from "./filled-field.js";
+import { ImportActor } from "./import-actor.js";
+import { ImportProblem } from "./import-problem.js";
+import { KnownDifference } from "./known-difference.js";
+import { MadeId } from "./made-id.js";
+import { MatchedRecord } from "./matched-record.js";
+import { ObjectLoad } from "./object-load.js";
+import { ProblemCounts } from "./problem-counts.js";
+/**
+ * The report of the load of the snapshot's import into the app. Each list holds its first items, which fit in the report's size, and the count beside it counts all of them. Null for a snapshot of an environment, and until the app's load ends.
+ */
+export type SnapshotAppFullLoad = {
+    /**
+     * The first records of the import that did not load, in the order of the import.
+     */
+    absent: Array<AbsentRecord>;
+    /**
+     * How many records of the import did not load.
+     */
+    absentCount: number;
+    /**
+     * How many users the import names in `actors` for the app.
+     */
+    actorCount: number;
+    /**
+     * The first users that the import names in `actors`, in that order. The first is the default user.
+     */
+    actors: Array<ImportActor>;
+    /**
+     * The IDs of the first seed users that the load deactivated.
+     */
+    deactivated: Array<string>;
+    /**
+     * How many seed users the load deactivated, because the import brings users of its own.
+     */
+    deactivatedCount: number;
+    details: "full";
+    /**
+     * How many differences from the vendor's app the load knows of.
+     */
+    differenceCount: number;
+    /**
+     * The first differences from the vendor's app.
+     */
+    differences: Array<KnownDifference>;
+    /**
+     * The first fields that the app filled, by object and field.
+     */
+    filled: Array<FilledField>;
+    /**
+     * How many fields the app filled for loaded records that did not write them.
+     */
+    filledCount: number;
+    /**
+     * How many values the app filled in those fields.
+     */
+    filledValueCount: number;
+    /**
+     * The first IDs that the app made, in the order of the import.
+     */
+    made: Array<MadeId>;
+    /**
+     * How many IDs the app made for records, from the text that a record wrote as its ID or from the record's place.
+     */
+    madeCount: number;
+    /**
+     * The first records that took over a seed record, in the order of the import.
+     */
+    matched: Array<MatchedRecord>;
+    /**
+     * How many records took over a seed record.
+     */
+    matchedCount: number;
+    /**
+     * How many objects of the app the import holds records of.
+     */
+    objectCount: number;
+    /**
+     * For the first objects of the app that the import holds records of, by name, how many of its records loaded, took over a seed record, or did not load.
+     */
+    objects: Array<ObjectLoad>;
+    /**
+     * For each severity, how many problems of the load have each code. The errors are those of the records that did not load in `skipRecord` mode.
+     */
+    problemCounts: ProblemCounts;
+    /**
+     * How many warnings the load found.
+     */
+    warningCount: number;
+    /**
+     * The first warnings of the load, in the order of file, line and pointer.
+     */
+    warnings: Array<ImportProblem>;
+};
+/** @internal */
+export declare const SnapshotAppFullLoad$inboundSchema: z.ZodMiniType<SnapshotAppFullLoad, unknown>;
+export declare function snapshotAppFullLoadFromJSON(jsonString: string): SafeParseResult<SnapshotAppFullLoad, SDKValidationError>;

package/esm/models/snapshot-app-full-load.js

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as types from "../types/primitives.js";
+import { AbsentRecord$inboundSchema } from "./absent-record.js";
+import { FilledField$inboundSchema } from "./filled-field.js";
+import { ImportActor$inboundSchema } from "./import-actor.js";
+import { ImportProblem$inboundSchema, } from "./import-problem.js";
+import { KnownDifference$inboundSchema, } from "./known-difference.js";
+import { MadeId$inboundSchema } from "./made-id.js";
+import { MatchedRecord$inboundSchema, } from "./matched-record.js";
+import { ObjectLoad$inboundSchema } from "./object-load.js";
+import { ProblemCounts$inboundSchema, } from "./problem-counts.js";
+/** @internal */
+export const SnapshotAppFullLoad$inboundSchema = z.object({
+    absent: z.array(AbsentRecord$inboundSchema),
+    absentCount: types.number(),
+    actorCount: types.number(),
+    actors: z.array(ImportActor$inboundSchema),
+    deactivated: z.array(types.string()),
+    deactivatedCount: types.number(),
+    details: types.literal("full"),
+    differenceCount: types.number(),
+    differences: z.array(KnownDifference$inboundSchema),
+    filled: z.array(FilledField$inboundSchema),
+    filledCount: types.number(),
+    filledValueCount: types.number(),
+    made: z.array(MadeId$inboundSchema),
+    madeCount: types.number(),
+    matched: z.array(MatchedRecord$inboundSchema),
+    matchedCount: types.number(),
+    objectCount: types.number(),
+    objects: z.array(ObjectLoad$inboundSchema),
+    problemCounts: ProblemCounts$inboundSchema,
+    warningCount: types.number(),
+    warnings: z.array(ImportProblem$inboundSchema),
+});
+export function snapshotAppFullLoadFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotAppFullLoad$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotAppFullLoad' from JSON`);
+}

package/esm/models/snapshot-app-limited-load-counts.d.ts

@@ -0,0 +1,16 @@
+import * as z from "zod/v4-mini";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+/**
+ * The recorded count of skipped records. Additional import diagnostics were not recorded for this snapshot.
+ */
+export type SnapshotAppLimitedLoadCounts = {
+    /**
+     * How many records of the import did not load.
+     */
+    absentCount: number;
+    details: "limited";
+};
+/** @internal */
+export declare const SnapshotAppLimitedLoadCounts$inboundSchema: z.ZodMiniType<SnapshotAppLimitedLoadCounts, unknown>;
+export declare function snapshotAppLimitedLoadCountsFromJSON(jsonString: string): SafeParseResult<SnapshotAppLimitedLoadCounts, SDKValidationError>;

package/esm/models/snapshot-app-limited-load-counts.js

@@ -0,0 +1,14 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as types from "../types/primitives.js";
+/** @internal */
+export const SnapshotAppLimitedLoadCounts$inboundSchema = z.object({
+    absentCount: types.number(),
+    details: types.literal("limited"),
+});
+export function snapshotAppLimitedLoadCountsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotAppLimitedLoadCounts$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotAppLimitedLoadCounts' from JSON`);
+}

package/esm/models/snapshot-app-limited-load.d.ts

@@ -0,0 +1,18 @@
+import * as z from "zod/v4-mini";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { AbsentRecord } from "./absent-record.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+/**
+ * The recorded count and first skipped records. Additional import diagnostics were not recorded for this snapshot.
+ */
+export type SnapshotAppLimitedLoad = {
+    absent: Array<AbsentRecord>;
+    /**
+     * How many records of the import did not load.
+     */
+    absentCount: number;
+    details: "limited";
+};
+/** @internal */
+export declare const SnapshotAppLimitedLoad$inboundSchema: z.ZodMiniType<SnapshotAppLimitedLoad, unknown>;
+export declare function snapshotAppLimitedLoadFromJSON(jsonString: string): SafeParseResult<SnapshotAppLimitedLoad, SDKValidationError>;

package/esm/models/snapshot-app-limited-load.js

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as types from "../types/primitives.js";
+import { AbsentRecord$inboundSchema } from "./absent-record.js";
+/** @internal */
+export const SnapshotAppLimitedLoad$inboundSchema = z.object({
+    absent: z.array(AbsentRecord$inboundSchema),
+    absentCount: types.number(),
+    details: types.literal("limited"),
+});
+export function snapshotAppLimitedLoadFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotAppLimitedLoad$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotAppLimitedLoad' from JSON`);
+}

package/esm/models/snapshot-app-load-counts.d.ts

@@ -0,0 +1,13 @@
+import * as z from "zod/v4-mini";
+import * as discriminatedUnionTypes from "../types/discriminated-union.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { SnapshotAppFullLoadCounts } from "./snapshot-app-full-load-counts.js";
+import { SnapshotAppLimitedLoadCounts } from "./snapshot-app-limited-load-counts.js";
+/**
+ * Recorded import counts. Full reports contain every diagnostic count. Limited reports contain only the skipped-record count.
+ */
+export type SnapshotAppLoadCounts = SnapshotAppFullLoadCounts | SnapshotAppLimitedLoadCounts | discriminatedUnionTypes.Unknown<"details">;
+/** @internal */
+export declare const SnapshotAppLoadCounts$inboundSchema: z.ZodMiniType<SnapshotAppLoadCounts, unknown>;
+export declare function snapshotAppLoadCountsFromJSON(jsonString: string): SafeParseResult<SnapshotAppLoadCounts, SDKValidationError>;

package/esm/models/snapshot-app-load-counts.js

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { safeParse } from "../lib/schemas.js";
+import { discriminatedUnion } from "../types/discriminated-union.js";
+import { SnapshotAppFullLoadCounts$inboundSchema, } from "./snapshot-app-full-load-counts.js";
+import { SnapshotAppLimitedLoadCounts$inboundSchema, } from "./snapshot-app-limited-load-counts.js";
+/** @internal */
+export const SnapshotAppLoadCounts$inboundSchema = discriminatedUnion("details", {
+    full: SnapshotAppFullLoadCounts$inboundSchema,
+    limited: SnapshotAppLimitedLoadCounts$inboundSchema,
+});
+export function snapshotAppLoadCountsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotAppLoadCounts$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotAppLoadCounts' from JSON`);
+}

package/esm/models/snapshot-app-load.d.ts

@@ -1,20 +1,13 @@
 import * as z from "zod/v4-mini";
+import * as discriminatedUnionTypes from "../types/discriminated-union.js";
 import { Result as SafeParseResult } from "../types/fp.js";
-import { AbsentRecord } from "./absent-record.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { SnapshotAppFullLoad } from "./snapshot-app-full-load.js";
+import { SnapshotAppLimitedLoad } from "./snapshot-app-limited-load.js";
 /**
- * What the load of the snapshot's import left out of the app. Null for a snapshot of an environment, and until the app's load ends.
+ * Recorded import diagnostics. Full reports contain every diagnostic category. Limited reports preserve skipped records when additional details were not recorded.
  */
-export type SnapshotAppLoad = {
-    /**
-     * The first records of the import that did not load, in the order of the import.
-     */
-    absent: Array<AbsentRecord>;
-    /**
-     * How many records of the import did not load. It is larger than the length of `absent` when they did not all fit.
-     */
-    absentCount: number;
-};
+export type SnapshotAppLoad = SnapshotAppFullLoad | SnapshotAppLimitedLoad | discriminatedUnionTypes.Unknown<"details">;
 /** @internal */
 export declare const SnapshotAppLoad$inboundSchema: z.ZodMiniType<SnapshotAppLoad, unknown>;
 export declare function snapshotAppLoadFromJSON(jsonString: string): SafeParseResult<SnapshotAppLoad, SDKValidationError>;

package/esm/models/snapshot-app-load.js

@@ -1,14 +1,14 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
-import * as z from "zod/v4-mini";
 import { safeParse } from "../lib/schemas.js";
-import * as types from "../types/primitives.js";
-import { AbsentRecord$inboundSchema } from "./absent-record.js";
+import { discriminatedUnion } from "../types/discriminated-union.js";
+import { SnapshotAppFullLoad$inboundSchema, } from "./snapshot-app-full-load.js";
+import { SnapshotAppLimitedLoad$inboundSchema, } from "./snapshot-app-limited-load.js";
 /** @internal */
-export const SnapshotAppLoad$inboundSchema = z.object({
-    absent: z.array(AbsentRecord$inboundSchema),
-    absentCount: types.number(),
+export const SnapshotAppLoad$inboundSchema = discriminatedUnion("details", {
+    full: SnapshotAppFullLoad$inboundSchema,
+    limited: SnapshotAppLimitedLoad$inboundSchema,
 });
 export function snapshotAppLoadFromJSON(jsonString) {
     return safeParse(jsonString, (x) => SnapshotAppLoad$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotAppLoad' from JSON`);

package/esm/models/snapshot-list-item.d.ts

@@ -0,0 +1,53 @@
+import * as z from "zod/v4-mini";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { Principal } from "./principal.js";
+import { SnapshotAppLoadCounts } from "./snapshot-app-load-counts.js";
+import { SnapshotFailureUnion } from "./snapshot-failure-union.js";
+import { SnapshotStatus } from "./snapshot-status.js";
+export type SnapshotListItemApp = {
+    appId: string;
+    /**
+     * Recorded import counts. Full reports contain every diagnostic count. Limited reports contain only the skipped-record count.
+     */
+    load?: SnapshotAppLoadCounts | null | undefined;
+    name: string;
+    services: {
+        [k: string]: any;
+    };
+    setup: {
+        [k: string]: any;
+    };
+    version: string;
+    versionId: string;
+};
+/**
+ * A snapshot as the list answers it: each app's load holds its counts only. Get the snapshot for the lists of each load.
+ */
+export type SnapshotListItem = {
+    apps: Array<SnapshotListItemApp>;
+    createdAt: Date;
+    createdBy: Principal;
+    deletedAt: Date | null;
+    /**
+     * The environment that the snapshot copies, or null for a snapshot built from an import.
+     */
+    environmentId: string | null;
+    environmentName: string | null;
+    failure: SnapshotFailureUnion | null;
+    id: string;
+    /**
+     * The import that the snapshot was built from, or null for a snapshot of an environment.
+     */
+    importId?: string | null | undefined;
+    name: string | null;
+    readyAt: Date | null;
+    status: SnapshotStatus;
+    workspaceId: string;
+};
+/** @internal */
+export declare const SnapshotListItemApp$inboundSchema: z.ZodMiniType<SnapshotListItemApp, unknown>;
+export declare function snapshotListItemAppFromJSON(jsonString: string): SafeParseResult<SnapshotListItemApp, SDKValidationError>;
+/** @internal */
+export declare const SnapshotListItem$inboundSchema: z.ZodMiniType<SnapshotListItem, unknown>;
+export declare function snapshotListItemFromJSON(jsonString: string): SafeParseResult<SnapshotListItem, SDKValidationError>;

package/esm/models/snapshot-list-item.js

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as types from "../types/primitives.js";
+import { Principal$inboundSchema } from "./principal.js";
+import { SnapshotAppLoadCounts$inboundSchema, } from "./snapshot-app-load-counts.js";
+import { SnapshotFailureUnion$inboundSchema, } from "./snapshot-failure-union.js";
+import { SnapshotStatus$inboundSchema, } from "./snapshot-status.js";
+/** @internal */
+export const SnapshotListItemApp$inboundSchema = z.object({
+    appId: types.string(),
+    load: z.optional(z.nullable(SnapshotAppLoadCounts$inboundSchema)),
+    name: types.string(),
+    services: z.record(z.string(), z.any()),
+    setup: z.record(z.string(), z.any()),
+    version: types.string(),
+    versionId: types.string(),
+});
+export function snapshotListItemAppFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotListItemApp$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotListItemApp' from JSON`);
+}
+/** @internal */
+export const SnapshotListItem$inboundSchema = z.object({
+    apps: z.array(z.lazy(() => SnapshotListItemApp$inboundSchema)),
+    createdAt: types.date(),
+    createdBy: Principal$inboundSchema,
+    deletedAt: types.nullable(types.date()),
+    environmentId: types.nullable(types.string()),
+    environmentName: types.nullable(types.string()),
+    failure: types.nullable(SnapshotFailureUnion$inboundSchema),
+    id: types.string(),
+    importId: z.optional(z.nullable(types.string())),
+    name: types.nullable(types.string()),
+    readyAt: types.nullable(types.date()),
+    status: SnapshotStatus$inboundSchema,
+    workspaceId: types.string(),
+});
+export function snapshotListItemFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SnapshotListItem$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SnapshotListItem' from JSON`);
+}

package/esm/models/snapshot.d.ts

@@ -8,7 +8,7 @@ import { SnapshotStatus } from "./snapshot-status.js";
 export type SnapshotApp = {
     appId: string;
     /**
-     * What the load of the snapshot's import left out of the app. Null for a snapshot of an environment, and until the app's load ends.
+     * Recorded import diagnostics. Full reports contain every diagnostic category. Limited reports preserve skipped records when additional details were not recorded.
      */
     load?: SnapshotAppLoad | null | undefined;
     name: string;

package/esm/models/version.d.ts

@@ -10,6 +10,9 @@ export declare const Status: {
 };
 export type Status = OpenEnum<typeof Status>;
 export type Version = {
+    /**
+     * The seed's users, for display. Credentials can act as any user who can sign in to the running app. `GET /v1/environments/{environmentId}/apps/{appName}/actors` lists them.
+     */
     actors: Array<Actor>;
     appId: string;
     id: string;

package/esm/sdk/environments.d.ts

@@ -8,5 +8,6 @@ export declare class Environments extends ClientSDK {
     delete(request: operations.DeleteEnvironmentRequest, options?: RequestOptions): Promise<models.Environment>;
     get(request: operations.GetEnvironmentRequest, options?: RequestOptions): Promise<models.Environment>;
     update(request: operations.UpdateEnvironmentRequest, options?: RequestOptions): Promise<models.Environment>;
+    actors(request: operations.ListActorsRequest, options?: RequestOptions): Promise<operations.ListActorsResponse>;
     connect(request: operations.CreateCredentialsRequest, options?: RequestOptions): Promise<models.Credentials>;
 }

package/esm/sdk/environments.js

@@ -1,6 +1,7 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
+import { environmentsActors } from "../funcs/environments-actors.js";
 import { environmentsConnect } from "../funcs/environments-connect.js";
 import { environmentsCreate } from "../funcs/environments-create.js";
 import { environmentsCreators } from "../funcs/environments-creators.js";
@@ -29,6 +30,9 @@ export class Environments extends ClientSDK {
     async update(request, options) {
         return unwrapAsync(environmentsUpdate(this, request, options));
     }
+    async actors(request, options) {
+        return unwrapAsync(environmentsActors(this, request, options));
+    }
     async connect(request, options) {
         return unwrapAsync(environmentsConnect(this, request, options));
     }

package/esm/sdk/sdk.d.ts

@@ -31,6 +31,9 @@ export declare class StateMachines extends ClientSDK {
      * Revokes a browser session that the caller's own credential launched. Revoking again answers the same result. Another credential's session is not found.
      */
     revokeUiSession(request: operations.RevokeUiSessionRequest, options?: RequestOptions): Promise<models.UiSessionRevocation>;
+    getImportFile(request: operations.GetImportFileRequest, options?: RequestOptions): Promise<models.ImportFile>;
+    listImportFiles(request: operations.ListImportFilesRequest, options?: RequestOptions): Promise<models.ImportFolder>;
+    uploadImport(request: operations.UploadImportRequest, options?: RequestOptions): Promise<models.ReceivedImport>;
     me(options?: RequestOptions): Promise<models.Me>;
     listSnapshotCreators(request?: operations.ListSnapshotCreatorsRequest | undefined, options?: RequestOptions): Promise<operations.ListSnapshotCreatorsResponse>;
 }

package/esm/sdk/sdk.js

@@ -1,10 +1,13 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
+import { getImportFile } from "../funcs/get-import-file.js";
 import { launchUiSession } from "../funcs/launch-ui-session.js";
+import { listImportFiles } from "../funcs/list-import-files.js";
 import { listSnapshotCreators } from "../funcs/list-snapshot-creators.js";
 import { me } from "../funcs/me.js";
 import { revokeUiSession } from "../funcs/revoke-ui-session.js";
+import { uploadImport } from "../funcs/upload-import.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 import { Apps } from "./apps.js";
@@ -55,6 +58,15 @@ export class StateMachines extends ClientSDK {
     async revokeUiSession(request, options) {
         return unwrapAsync(revokeUiSession(this, request, options));
     }
+    async getImportFile(request, options) {
+        return unwrapAsync(getImportFile(this, request, options));
+    }
+    async listImportFiles(request, options) {
+        return unwrapAsync(listImportFiles(this, request, options));
+    }
+    async uploadImport(request, options) {
+        return unwrapAsync(uploadImport(this, request, options));
+    }
     async me(options) {
         return unwrapAsync(me(this, options));
     }