@vertracloud/api-types 0.1.1 → 0.2.1

package/payloads/v1/workspace.mjs

@@ -1,12 +1,120 @@
 // payloads/v1/workspace.ts
-var WorkspaceMemberRole = {
-  OWNER: "owner",
-  ADMIN: "admin",
-  DEVELOPER: "developer",
-  OPERATOR: "operator",
-  VIEWER: "viewer"
+var WorkspacePermission = {
+  APPS_READ: "apps:read",
+  APPS_MANAGE: "apps:manage",
+  APPS_LIFECYCLE: "apps:lifecycle",
+  APPS_ENVS: "apps:envs",
+  APPS_FILES: "apps:files",
+  APPS_DELETE: "apps:delete",
+  DATABASES_READ: "databases:read",
+  DATABASES_MANAGE: "databases:manage",
+  DATABASES_LIFECYCLE: "databases:lifecycle",
+  DATABASES_CREDENTIALS: "databases:credentials",
+  DATABASES_DATA: "databases:data",
+  DATABASES_DELETE: "databases:delete",
+  SNAPSHOTS_READ: "snapshots:read",
+  SNAPSHOTS_MANAGE: "snapshots:manage",
+  MEMBERS_READ: "members:read",
+  MEMBERS_MANAGE: "members:manage",
+  ROLES_MANAGE: "roles:manage",
+  ACTIVITIES_READ: "activities:read"
+};
+var WORKSPACE_PERMISSIONS = {
+  "apps:read": { group: "apps" },
+  "apps:manage": { group: "apps" },
+  "apps:lifecycle": { group: "apps" },
+  "apps:envs": { group: "apps" },
+  "apps:files": { group: "apps" },
+  "apps:delete": { group: "apps" },
+  "databases:read": { group: "databases" },
+  "databases:manage": { group: "databases" },
+  "databases:lifecycle": { group: "databases" },
+  "databases:credentials": { group: "databases" },
+  "databases:data": { group: "databases" },
+  "databases:delete": { group: "databases" },
+  "snapshots:read": { group: "snapshots" },
+  "snapshots:manage": { group: "snapshots" },
+  "members:read": { group: "members" },
+  "members:manage": { group: "members" },
+  "roles:manage": { group: "roles" },
+  "activities:read": { group: "activities" }
+};
+var WORKSPACE_PERMISSION_LIST = Object.keys(WORKSPACE_PERMISSIONS);
+var WorkspaceRolePreset = {
+  Admin: "admin",
+  Developer: "developer",
+  Operator: "operator",
+  Viewer: "viewer"
+};
+function workspacePresetPermissions(preset) {
+  switch (preset) {
+    case "admin":
+      return WORKSPACE_PERMISSION_LIST.filter((p) => p !== "snapshots:manage");
+    case "developer":
+      return ["apps:read", "apps:manage", "apps:lifecycle", "apps:envs", "apps:files", "databases:read", "databases:manage", "databases:lifecycle", "databases:credentials", "databases:data", "snapshots:read", "members:read", "activities:read"];
+    case "operator":
+      return ["apps:read", "apps:lifecycle", "databases:read", "databases:lifecycle", "snapshots:read", "members:read", "activities:read"];
+    case "viewer":
+      return ["apps:read", "databases:read", "snapshots:read", "members:read", "activities:read"];
+  }
+}
+var WorkspaceResourceType = { Application: "application", Database: "database" };
+var WorkspaceResourceOrganizationScope = { Personal: "personal", Workspace: "workspace" };
+var WorkspaceFolderColor = { Neutral: "neutral", Red: "red", Orange: "orange", Yellow: "yellow", Green: "green", Blue: "blue", Purple: "purple" };
+var WORKSPACE_FOLDER_COLORS = Object.values(WorkspaceFolderColor);
+var WorkspaceInviteKind = { Email: "email", Link: "link" };
+var WorkspaceActionRequestAction = {
+  AppDelete: "app_delete",
+  DatabaseDelete: "database_delete",
+  SnapshotCreate: "snapshot_create",
+  SnapshotRestore: "snapshot_restore"
+};
+var WorkspaceActionRequestStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Rejected: "rejected",
+  Expired: "expired"
+};
+var WORKSPACE_ERROR_CODES = {
+  WORKSPACE_NOT_FOUND: "WORKSPACE_NOT_FOUND",
+  WORKSPACE_NAME_ALREADY_EXISTS: "WORKSPACE_NAME_ALREADY_EXISTS",
+  WORKSPACE_MEMBER_LIMIT_REACHED: "WORKSPACE_MEMBER_LIMIT_REACHED",
+  WORKSPACE_ROLE_LIMIT_REACHED: "WORKSPACE_ROLE_LIMIT_REACHED",
+  WORKSPACE_ROLE_IN_USE: "WORKSPACE_ROLE_IN_USE",
+  WORKSPACE_ROLE_NOT_FOUND: "WORKSPACE_ROLE_NOT_FOUND",
+  WORKSPACE_ROLE_NAME_ALREADY_EXISTS: "WORKSPACE_ROLE_NAME_ALREADY_EXISTS",
+  WORKSPACE_PERMISSION_DENIED: "WORKSPACE_PERMISSION_DENIED",
+  WORKSPACE_PERMISSION_ESCALATION: "WORKSPACE_PERMISSION_ESCALATION",
+  WORKSPACE_INVITE_NOT_FOUND: "WORKSPACE_INVITE_NOT_FOUND",
+  WORKSPACE_INVITE_EXPIRED: "WORKSPACE_INVITE_EXPIRED",
+  WORKSPACE_INVITE_EMAIL_MISMATCH: "WORKSPACE_INVITE_EMAIL_MISMATCH",
+  WORKSPACE_OWNER_ONLY: "WORKSPACE_OWNER_ONLY",
+  WORKSPACE_ACTION_REQUEST_NOT_FOUND: "WORKSPACE_ACTION_REQUEST_NOT_FOUND",
+  /** 409 — the request was already approved or rejected. */
+  /** 400 — the requester already has the permission; perform the action directly. */
+  WORKSPACE_ACTION_NOT_NEEDED: "WORKSPACE_ACTION_NOT_NEEDED",
+  /** 400 — the request `params` failed the action's validation (e.g. a snapshot of another resource). */
+  WORKSPACE_ACTION_INVALID_PARAMS: "WORKSPACE_ACTION_INVALID_PARAMS",
+  /** 409 — a pending request already exists for the same action on the same resource. */
+  WORKSPACE_ACTION_REQUEST_PENDING: "WORKSPACE_ACTION_REQUEST_PENDING",
+  WORKSPACE_RESOURCE_FOLDER_NOT_FOUND: "WORKSPACE_RESOURCE_FOLDER_NOT_FOUND",
+  WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT: "WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT",
+  WORKSPACE_RESOURCE_NOT_FOUND: "WORKSPACE_RESOURCE_NOT_FOUND",
+  PLAN_RESTRICTED_FEATURE: "PLAN_RESTRICTED_FEATURE"
 };
 export {
-  WorkspaceMemberRole
+  WORKSPACE_ERROR_CODES,
+  WORKSPACE_FOLDER_COLORS,
+  WORKSPACE_PERMISSIONS,
+  WORKSPACE_PERMISSION_LIST,
+  WorkspaceActionRequestAction,
+  WorkspaceActionRequestStatus,
+  WorkspaceFolderColor,
+  WorkspaceInviteKind,
+  WorkspacePermission,
+  WorkspaceResourceOrganizationScope,
+  WorkspaceResourceType,
+  WorkspaceRolePreset,
+  workspacePresetPermissions
 };
 //# sourceMappingURL=workspace.mjs.map

package/rest/v1/activity.d.ts

@@ -1,14 +1,25 @@
-import { APIPayload } from '../../common/v1.js';
-import { APIActivity } from '../../payloads/v1/activity.js';
+import { APIPaginatedPayload } from '../../common/v1.js';
+import { ActivityTargetType, ActivityStatus, ActivityOrigin, APIActivity } from '../../payloads/v1/activity.js';
+import '../../payloads/v1/api-error.js';
 import '../../payloads/v1/notification.js';
 
+/** Dashboard session only (not reachable with an API key). */
+interface RESTGetAPIActivitiesQuery {
+    page?: number;
+    limit?: number;
+    target_id?: string;
+    target_type?: ActivityTargetType;
+    status?: ActivityStatus;
+    origin?: ActivityOrigin;
+    search?: string;
+    workspace_id?: string;
+    /** Only applies when `workspace_id` is also provided. */
+    author_id?: string;
+}
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/activities
+ * A page of activities.
+ * Dashboard session only (not reachable with an API key).
  */
-type RESTGetAPIActivityResponse = APIPayload<APIActivity>;
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/activities
- */
-type RESTGetAPIActivitiesResponse = APIPayload<APIActivity[]>;
+type RESTGetAPIActivitiesResponse = APIPaginatedPayload<APIActivity>;
 
-export type { RESTGetAPIActivitiesResponse, RESTGetAPIActivityResponse };
+export type { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse };

package/rest/v1/activity.js.map

@@ -1 +1 @@
-{"version":3,"sources":["activity.ts"],"sourcesContent":["import type { APIActivity, APIPayload } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/activities\n */\nexport type RESTGetAPIActivityResponse = APIPayload<APIActivity>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/activities\n */\nexport type RESTGetAPIActivitiesResponse = APIPayload<APIActivity[]>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["activity.ts"],"sourcesContent":["import type { APIActivity, APIPaginatedPayload, ActivityOrigin, ActivityStatus, ActivityTargetType } from \"../../v1\";\n\n/** Dashboard session only (not reachable with an API key). */\nexport interface RESTGetAPIActivitiesQuery {\n\tpage?: number;\n\tlimit?: number;\n\ttarget_id?: string;\n\ttarget_type?: ActivityTargetType;\n\tstatus?: ActivityStatus;\n\torigin?: ActivityOrigin;\n\tsearch?: string;\n\tworkspace_id?: string;\n\t/** Only applies when `workspace_id` is also provided. */\n\tauthor_id?: string;\n}\n\n/**\n * A page of activities.\n * Dashboard session only (not reachable with an API key).\n */\nexport type RESTGetAPIActivitiesResponse = APIPaginatedPayload<APIActivity>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/api-key.d.ts

@@ -0,0 +1,26 @@
+import { APIPayload } from '../../common/v1.js';
+import { APIApiKey, APIApiKeyScope, APIApiKeyCreated } from '../../payloads/v1/api-key.js';
+import '../../payloads/v1/api-error.js';
+
+/**
+ * Key management under `/v1/users/me/api-keys`. Dashboard session only: every route rejects API key authentication (`WEBSITE_ONLY`).
+ * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/list
+ */
+type RESTGetAPIUserApiKeysResponse = APIPayload<APIApiKey[]>;
+interface RESTPostAPIUserApiKeyCreateBody {
+    /** 1–40 characters. */
+    name: string;
+    /** At least one scope. */
+    scopes: APIApiKeyScope[];
+    /** One IP or CIDR per entry, max. 20. Omitted/empty = any IP. */
+    allowed_ips?: string[];
+}
+type RESTPostAPIUserApiKeyCreateResponse = APIPayload<APIApiKeyCreated>;
+/** Never changes the secret — use `rotate` for that. */
+type RESTPatchAPIUserApiKeyBody = Partial<RESTPostAPIUserApiKeyCreateBody>;
+type RESTPatchAPIUserApiKeyResponse = APIPayload<APIApiKey>;
+/** New secret; same `id`, name, scopes and IPs. */
+type RESTPostAPIUserApiKeyRotateResponse = APIPayload<APIApiKeyCreated>;
+type RESTDeleteAPIUserApiKeyResponse = APIPayload<never>;
+
+export type { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse };

package/{payloads/v1/credits.js → rest/v1/api-key.js}

@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// payloads/v1/credits.ts
-var credits_exports = {};
-module.exports = __toCommonJS(credits_exports);
-//# sourceMappingURL=credits.js.map
+// rest/v1/api-key.ts
+var api_key_exports = {};
+module.exports = __toCommonJS(api_key_exports);
+//# sourceMappingURL=api-key.js.map

package/rest/v1/api-key.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["api-key.ts"],"sourcesContent":["import type { APIApiKey, APIApiKeyCreated, APIApiKeyScope, APIPayload } from \"../../v1\";\n\n/**\n * Key management under `/v1/users/me/api-keys`. Dashboard session only: every route rejects API key authentication (`WEBSITE_ONLY`).\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/list\n */\nexport type RESTGetAPIUserApiKeysResponse = APIPayload<APIApiKey[]>;\n\nexport interface RESTPostAPIUserApiKeyCreateBody {\n\t/** 1–40 characters. */\n\tname: string;\n\t/** At least one scope. */\n\tscopes: APIApiKeyScope[];\n\t/** One IP or CIDR per entry, max. 20. Omitted/empty = any IP. */\n\tallowed_ips?: string[];\n}\nexport type RESTPostAPIUserApiKeyCreateResponse = APIPayload<APIApiKeyCreated>;\n\n/** Never changes the secret — use `rotate` for that. */\nexport type RESTPatchAPIUserApiKeyBody = Partial<RESTPostAPIUserApiKeyCreateBody>;\nexport type RESTPatchAPIUserApiKeyResponse = APIPayload<APIApiKey>;\n\n/** New secret; same `id`, name, scopes and IPs. */\nexport type RESTPostAPIUserApiKeyRotateResponse = APIPayload<APIApiKeyCreated>;\n\nexport type RESTDeleteAPIUserApiKeyResponse = APIPayload<never>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/api-key.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=api-key.mjs.map

package/rest/v1/application.d.ts

@@ -1,6 +1,11 @@
-import { APIPayload } from '../../common/v1.js';
-import { APIApplication, APIApplicationStatus, APIApplicationStatusShort, APIApplicationMetric, APIApplicationFile, APIApplicationFileContent, APIApplicationEnvironment, APIApplicationOperationResponse, APIDnsRecord, APICustomDomainResponse, APISubdomainResponse, APIWebhookUrl, APIApplicationDeployment } from '../../payloads/v1/application.js';
+import { APIPayload, RESTAPIWorkspaceQuery, ISODateString } from '../../common/v1.js';
+import { APIApplicationWebPublish, APIApplicationCustomDomain, APIApplicationDeployment, APIApplicationDnsRecord, APIApplicationEnvironment, APIApplicationFileContent, APIApplicationFileTree, APIApplicationFile, APIApplicationMetric, APIApplicationRealtimeEvent, APIApplication, APIApplicationRuntimes, APIApplicationStatus, APIApplicationStatusShort, APIApplicationWebhook, APIApplicationSubdomain, ApplicationLanguage, APIApplicationFileUpload, APIApplicationOperationResponse, APIApplicationScanSuggestions, APIApplicationWebhookUrl } from '../../payloads/v1/application.js';
+import '../../payloads/v1/api-error.js';
 
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes
+ */
+type RESTGetAPIApplicationRuntimesResponse = APIPayload<APIApplicationRuntimes>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
@@ -12,47 +17,204 @@ type RESTGetAPIApplicationStatusResponse = APIPayload<APIApplicationStatus>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/allstatus
  */
-type RESTGetAPIApplicationStatusShortResponse = APIPayload<APIApplicationStatusShort>;
+type RESTGetAPIApplicationStatusShortResponse = APIPayload<APIApplicationStatusShort[]>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/logs
  */
 type RESTGetAPIApplicationLogsResponse = APIPayload<string>;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics
+ */
+interface RESTGetAPIApplicationMetricsQuery extends RESTAPIWorkspaceQuery {
+    range?: "10m" | "30m" | "24h";
+}
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics
  */
 type RESTGetAPIApplicationMetricsResponse = APIPayload<APIApplicationMetric[]>;
+/**
+ * `GET /v1/apps/:id/files`. `path` absent = the application root.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files
+ */
+interface RESTGetAPIApplicationFilesQuery extends RESTAPIWorkspaceQuery {
+    path?: string;
+}
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files
  */
 type RESTGetAPIApplicationFilesResponse = APIPayload<APIApplicationFile[]>;
+/**
+ * `GET /v1/apps/:id/files/tree` — the whole file tree (depth-limited), as a list of root entries.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/tree
+ */
+type RESTGetAPIApplicationFileTreeResponse = APIPayload<APIApplicationFileTree[]>;
+/**
+ * `GET /v1/apps/:id/files/content`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content
+ */
+interface RESTGetAPIApplicationFileContentQuery extends RESTAPIWorkspaceQuery {
+    path: string;
+}
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content
  */
 type RESTGetAPIApplicationFileContentResponse = APIPayload<APIApplicationFileContent>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start
+ * `POST /v1/apps/:id/files/upload` (multipart zip). `restart: "true"` restarts the app after the upload.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload
  */
-type RESTGetAPIApplicationStartResponse = APIPayload<boolean>;
+interface RESTPostAPIApplicationFileUploadQuery extends RESTAPIWorkspaceQuery {
+    restart?: "true" | "false";
+}
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload
  */
-type RESTGetAPIApplicationRestartResponse = APIPayload<boolean>;
+type RESTPostAPIApplicationFileUploadResponse = APIPayload<APIApplicationFileUpload>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/stop
+ * Creates or overwrites a file. Without `content`, creates (or truncates to) an empty file.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/save
+ */
+interface RESTPutAPIApplicationFileBody {
+    path: string;
+    content?: string;
+    /** ISO 8601 datetime from the last read; a mismatch returns `409 FILE_MODIFIED`. */
+    last_modified?: ISODateString;
+    workspace_id?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/save
  */
-type RESTGetAPIApplicationStopResponse = APIPayload<boolean>;
+type RESTPutAPIApplicationFileResponse = APIPayload<null>;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/delete
+ */
+interface RESTDeleteAPIApplicationFileBody {
+    path: string;
+    workspace_id?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/delete
+ */
+type RESTDeleteAPIApplicationFileResponse = APIPayload<null>;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/move
+ */
+interface RESTPatchAPIApplicationFileMoveBody {
+    path: string;
+    to: string;
+    workspace_id?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/move
+ */
+type RESTPatchAPIApplicationFileMoveResponse = APIPayload<null>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/get
  */
 type RESTGetAPIApplicationEnvironmentResponse = APIPayload<APIApplicationEnvironment[]>;
 /**
+ * One variable of the `POST /apps/:id/envs` body. `note: null` clears the existing note.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit
+ */
+interface RESTPostAPIApplicationEnvironmentVariableBody {
+    key: string;
+    value: string;
+    note?: string | null;
+}
+/**
+ * Body of `POST /apps/:id/envs`: a single object (one variable) or an array (batch), with no repeated keys.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit
+ */
+type RESTPostAPIApplicationEnvironmentBody = RESTPostAPIApplicationEnvironmentVariableBody | RESTPostAPIApplicationEnvironmentVariableBody[];
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/createOrEdit
+ */
+type RESTPostAPIApplicationEnvironmentResponse = APIPayload<APIApplicationEnvironment[]>;
+/**
+ * `DELETE /v1/apps/:id/envs/:envId`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/delete
+ */
+type RESTDeleteAPIApplicationEnvironmentResponse = APIPayload<null>;
+/**
+ * Body of `POST /apps` — **`multipart/form-data`**, not JSON. Each field below is one multipart
+ * part: `file` as a file and **every other field as a text field** (including `snapshot_id`,
+ * `memory` and `envs`, the latter as a JSON-serialized string).
+ *
+ * The application has **two mutually exclusive sources**:
+ *
+ * - `file` — the zip uploaded by the user;
+ * - `snapshot_id` — alternative to `file`: the app is created from that snapshot (which already
+ *   includes its `vertracloud.config`).
+ *
+ * **Exactly one of them must be present.** Neither → `SOURCE_REQUIRED`; both →
+ * `SOURCE_CONFLICT`.
+ *
+ * Error codes:
+ *
+ * - `SOURCE_REQUIRED` — neither `file` nor `snapshot_id`.
+ * - `SOURCE_CONFLICT` — `file` and `snapshot_id` together.
+ * - `SNAPSHOT_NOT_FOUND` — the snapshot does not exist or does not belong to the user.
+ * - `SNAPSHOT_TYPE_MISMATCH` — the snapshot is from a database, not an application.
+ * - `SNAPSHOT_TOO_LARGE` — the snapshot exceeds the size limit for creation.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create
+ */
+interface RESTPostAPIApplicationCreateBody {
+    /** Application zip. Absent when the source is `snapshot_id`. */
+    file?: unknown;
+    /**
+     * Alternative to `file`: id of the **application** snapshot to create the app from. Sent as a
+     * multipart text field. Exactly one of `file` and `snapshot_id`.
+     */
+    snapshot_id?: string;
+    name: string;
+    description?: string | null;
+    /** RAM in MB. Multipart text field. Required with `file`; with `snapshot_id` defaults to the snapshot's config. */
+    memory?: number;
+    /** Required with `file`; with `snapshot_id` defaults to the snapshot's config. */
+    main?: string;
+    /** Required with `file`; with `snapshot_id` defaults to the snapshot's config. */
+    version?: string;
+    start?: string;
+    /** Build command (see `APIApplication.build_command`). */
+    build?: string;
+    /** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */
+    autorestart?: boolean;
+    /** `"random"` = the platform picks one at random. */
+    subdomain?: string;
+    workspace_id?: string;
+    /** JSON-serialized string in the multipart body. */
+    envs?: RESTPostAPIApplicationEnvironmentVariableBody[];
+}
+/**
+ * The created application, plus the directories removed from the uploaded zip.
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create
  */
-type RESTPostAPIApplicationCreateResponse = APIPayload<APIApplication>;
+type RESTPostAPIApplicationCreateResponse = APIPayload<APIApplication & {
+    removed_directories: string[];
+}>;
+/**
+ * Scans a zip before creating the application and returns suggestions (start/build command,
+ * memory). Creates nothing.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan
+ */
+interface RESTPostAPIApplicationScanBody {
+    /** Application zip. */
+    file: unknown;
+    /** Main file of the application — used only to infer the language, as on create. */
+    main: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan
+ */
+type RESTPostAPIApplicationScanResponse = APIPayload<APIApplicationScanSuggestions>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/delete
  */
-type RESTDeleteAPIApplicationResponse = APIPayload<void>;
+type RESTDeleteAPIApplicationResponse = APIPayload<null>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/download
  */
@@ -60,7 +222,14 @@ type RESTGetAPIApplicationDownloadResponse = ArrayBuffer;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime
  */
-type RESTGetAPIApplicationRealtimeResponse = EventSource;
+interface RESTGetAPIApplicationRealtimeQuery extends RESTAPIWorkspaceQuery {
+    since?: number;
+}
+/**
+ * The route answers with a `text/event-stream`; this is the shape of each event in it.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime
+ */
+type RESTGetAPIApplicationRealtimeResponse = APIApplicationRealtimeEvent;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start
  */
@@ -69,43 +238,146 @@ type RESTPostAPIApplicationStartResponse = APIPayload<APIApplicationOperationRes
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/stop
  */
 type RESTPostAPIApplicationStopResponse = APIPayload<APIApplicationOperationResponse>;
+/**
+ * Optional restart body. No body = regular restart, reusing the install and build cache.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart
+ */
+interface RESTPostAPIApplicationRestartBody {
+    /** Reinstalls dependencies from scratch, ignoring the install cache. */
+    reinstall_dependencies?: boolean;
+    /** Runs the build command again even without code changes. Counts as a deploy toward the hourly limit. */
+    force_build?: boolean;
+    /**
+     * After changing the app's language, removes the dependencies left by the previous runtime.
+     * Must differ from the current language (`CLEANUP_LANGUAGE_SAME_AS_CURRENT`).
+     */
+    cleanup_old_runtime_language?: ApplicationLanguage;
+}
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/restart
  */
 type RESTPostAPIApplicationRestartResponse = APIPayload<APIApplicationOperationResponse>;
 /**
+ * Body for updating the app configuration. Every field is optional, but at least one must be
+ * provided.
+ *
  * @see https://docs.vertracloud.app/api-reference/endpoint/apps/updateconfig
  */
-type RESTPostAPIApplicationUpdateConfigResponse = APIPayload<string>;
+interface RESTPatchAPIApplicationUpdateConfigBody {
+    name?: string;
+    description?: string | null;
+    main_file?: string;
+    version?: string;
+    auto_restart?: boolean;
+    start_command?: string | null;
+    build_command?: string | null;
+    ram?: number;
+    language?: ApplicationLanguage;
+}
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/dnsrecords
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/updateconfig
  */
-type RESTGetAPIApplicationDnsRecordsResponse = APIPayload<APIDnsRecord[]>;
+type RESTPatchAPIApplicationUpdateConfigResponse = APIPayload<string>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/customdomain
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns
  */
-type RESTPostAPIApplicationCustomDomainResponse = APIPayload<APICustomDomainResponse>;
+type RESTGetAPIApplicationDnsRecordsResponse = APIPayload<APIApplicationDnsRecord[]>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/subdomain
+ * Purges the edge cache of a published application.
+ *
+ * `hostnames` absent or empty = every host of the application (subdomain and custom domain).
+ * When provided, each host must belong to the application. `paths` narrows the purge to
+ * specific URLs within those hosts.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/purgecache
  */
-type RESTPatchAPIApplicationSubdomainResponse = APIPayload<APISubdomainResponse>;
+interface RESTPostAPIApplicationPurgeCacheBody {
+    hostnames?: string[];
+    paths?: string[];
+}
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/webhook
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/purgecache
  */
-type RESTGetAPIApplicationWebhookUrlResponse = APIPayload<APIWebhookUrl>;
+type RESTPostAPIApplicationPurgeCacheResponse = APIPayload<null>;
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deployments
+ * `GET /v1/apps/:id/network/custom` — `404 NO_CUSTOM_DOMAIN` when the application has none.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain
  */
-type RESTGetAPIApplicationDeploymentsResponse = APIPayload<APIApplicationDeployment[]>;
+type RESTGetAPIApplicationCustomDomainResponse = APIPayload<APIApplicationCustomDomain>;
+/**
+ * `POST /v1/apps/:id/network/custom`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain
+ */
+interface RESTPostAPIApplicationCustomDomainBody {
+    domain: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain
+ */
+type RESTPostAPIApplicationCustomDomainResponse = APIPayload<APIApplicationCustomDomain>;
+/**
+ * `DELETE /v1/apps/:id/network/custom`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain
+ */
+type RESTDeleteAPIApplicationCustomDomainResponse = APIPayload<null>;
+/**
+ * `PATCH /v1/apps/:id/network/subdomain`. Only the label (`my-app`), 3–50 characters.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain
+ */
+interface RESTPatchAPIApplicationSubdomainBody {
+    subdomain: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain
+ */
+type RESTPatchAPIApplicationSubdomainResponse = APIPayload<APIApplicationSubdomain>;
+/**
+ * Turns on web publishing for an application created without it.
+ * `subdomain` absent = the platform picks one at random; choosing one requires a plan with custom subdomains.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish
+ */
+interface RESTPostAPIApplicationWebPublishBody {
+    subdomain?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish
+ */
+type RESTPostAPIApplicationWebPublishResponse = APIPayload<APIApplicationWebPublish>;
 /**
- * @see https://docs.vertracloud.app/api-reference/applications
+ * Turns off web publishing: releases the subdomain, removes the custom domain and makes the application private again.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish
  */
-type RESTPostAPIApplicationInstallDependenciesBody = {
-    dependencies: string[];
-};
+type RESTDeleteAPIApplicationWebPublishResponse = APIPayload<APIApplicationWebPublish>;
 /**
- * @see https://docs.vertracloud.app/api-reference/applications
+ * `GET /v1/apps/:id/deploys/webhook`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/webhookurl
  */
-type RESTPostAPIApplicationInstallDependenciesResponse = APIPayload<APIApplication>;
+type RESTGetAPIApplicationWebhookUrlResponse = APIPayload<APIApplicationWebhook>;
+/**
+ * Creates the auto-deploy webhook from an already connected repository.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create
+ */
+interface RESTPostAPIApplicationWebhookCreateBody {
+    owner: string;
+    repo_name: string;
+    repo_id: string;
+    account_id: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create
+ */
+type RESTPostAPIApplicationWebhookCreateResponse = APIPayload<APIApplicationWebhookUrl>;
+/**
+ * `DELETE /v1/apps/:id/deploys/webhook`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/delete
+ */
+type RESTDeleteAPIApplicationWebhookResponse = APIPayload<null>;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/recents
+ */
+type RESTGetAPIApplicationDeploymentsResponse = APIPayload<APIApplicationDeployment[]>;
 
-export type { RESTDeleteAPIApplicationResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRestartResponse, RESTGetAPIApplicationStartResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationStopResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationSubdomainResponse, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationInstallDependenciesBody, RESTPostAPIApplicationInstallDependenciesResponse, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationUpdateConfigResponse };
+export type { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse };