@vertracloud/api-types 0.1.0 → 0.2.0

package/README.md

@@ -1,65 +1,93 @@
-# @vertracloud/api-types
+<div align="center">
+  <a href="https://vertracloud.app">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://vertracloud.app/brand/github-banner.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://vertracloud.app/brand/github-banner-light.png">
+      <img src="https://vertracloud.app/brand/github-banner-light.png" alt="Vertra Cloud" width="1200">
+    </picture>
+  </a>
+</div>
 
-Simple type definitions for the **Vertra Cloud API**.
+# @vertracloud/api-types
 
-[![GitHub](https://img.shields.io/github/license/vertracloud/api-types)](https://github.com/vertracloud/api-types/blob/main/LICENSE)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![npm](https://img.shields.io/npm/v/@vertracloud/api-types?color=red&logo=npm)](https://www.npmjs.com/package/@vertracloud/api-types)
 
+TypeScript types for the public API of [Vertra Cloud](https://vertracloud.app), a Brazilian application hosting platform (PaaS) for applications, managed databases and bots.
+
+- Imports are scoped by API version (`/v1`).
+- Every route documented with a link to the [API reference](https://docs.vertracloud.app/api-reference/introduction).
+
+**[Leia em português](#em-português)**
+
 ## Installation
 
 ```bash
 npm install @vertracloud/api-types
-// or
-yarn add @vertracloud/api-types
-// or
-pnpm add @vertracloud/api-types
 ```
 
-## Getting Started
+## Usage
 
-Using these type definitions is straightforward. To specify a particular API version, simply append `/v*` to the import path, where `*` corresponds to your desired version. For example:
+Import from the API version you target:
 
 ```ts
-// Importing type definitions for version 1
-import { APIUser, APIDatabase, APIApplication } from '@vertracloud/api-types/v1';
+import type { APIApplication, RESTGetAPIApplicationResponse } from "@vertracloud/api-types/v1";
+
+const res = await fetch(`https://api.vertracloud.app/v1/apps/${id}`, {
+	headers: { Authorization: `Bearer ${process.env.VERTRA_API_KEY}` },
+});
+const body = (await res.json()) as RESTGetAPIApplicationResponse;
+
+if ("code" in body) {
+	console.error(body.code, body.message);
+} else {
+	const app: APIApplication = body.response;
+	console.log(app.name);
+}
 ```
 
-You can also import only the specific types you need:
+Prefer the official SDK if you don't want to write the requests yourself: [`@vertracloud/sdk-api`](https://www.npmjs.com/package/@vertracloud/sdk-api).
 
-```ts
-// Importing only the APIUser type from version 1
-import { APIUser } from '@vertracloud/api-types/v1';
-```
+## Conventions
 
-> ***Note:** The versioned exports (`@vertracloud/api-types/v*`) include relevant types for `user`, `database`, as well as additional utilities and helpers.*
+**Envelope.** Every JSON response is `{ response }` on success and `{ code, message?, details? }` on error (`APIPayload<T>`). `code` is a stable English sentinel listed in `APIErrorCode`; routes with nothing to return answer `{ response: null }`. `APIPayload<T>` is a union of both shapes: check `"code" in body` and TypeScript narrows each branch.
 
-## Project Structure
+**Naming.**
 
-The exported types for each API version are organized into two main categories:
+| Prefix | Meaning | Example |
+|---|---|---|
+| `API*` | A payload returned by the API | `APIApplication` |
+| `REST<Method>API<Resource>*Body` | Request body | `RESTPostAPIApplicationCreateBody` |
+| `REST<Method>API<Resource>*Query` | Query string | `RESTGetAPIApplicationMetricsQuery` |
+| `REST<Method>API<Resource>*Response` | Full response envelope | `RESTGetAPIApplicationResponse` |
 
-* Types prefixed with `API` represent the payloads returned by the REST API.
-* Types prefixed with `REST` represent the data sent to or received from REST API endpoints.
+**Wire format.** Fields are `snake_case`. Most string unions have a companion `const` with the same name, so you can use either the literal or the constant:
 
-REST types follow a specific naming convention:
+```ts
+import { ApplicationLanguage } from "@vertracloud/api-types/v1";
 
-```
-REST<HTTP Method><Action><Type>
+ApplicationLanguage.PYTHON === "python"; // true
 ```
 
-Where:
+## Em português
 
-* `HTTP Method` is one of: `Get`, `Post`, `Put`, `Delete`, etc.
-* `Action` describes the intent (e.g., `Create`, `Update`, `Delete`)
-* `Type` represents the related resource (e.g., `User`, `Database`, `Application`)
+Tipos TypeScript da API pública da [Vertra Cloud](https://vertracloud.app), a plataforma brasileira de hospedagem de aplicações, bancos de dados e bots.
 
-### Examples
+```bash
+npm install @vertracloud/api-types
+```
+
+```ts
+import type { RESTGetAPIApplicationResponse } from "@vertracloud/api-types/v1";
+```
 
-* `RESTPostAPIApplicationCreateBody`: request payload for creating a app.
-* `RESTGetAPIApplicationResponse`: expected response when retrieving a app.
+- **Envelope:** sucesso é `{ response }`; erro é `{ code, message?, details? }`. O `code` é uma constante estável em inglês, listada em `APIErrorCode`. `APIPayload<T>` é a união das duas formas: cheque `"code" in body` e o TypeScript separa cada caso.
+- **Nomes:** `API*` é o que a API devolve; `REST*Body`, `REST*Query` e `REST*Response` são o corpo, a query e a resposta de cada rota.
+- **Campos** em `snake_case`. A maioria das uniões de strings tem um `const` com o mesmo nome.
+- Prefere não montar as requisições? Use o SDK oficial, [`@vertracloud/sdk-api`](https://www.npmjs.com/package/@vertracloud/sdk-api).
 
-If a type name ends with `Response`, it refers to the structure returned by the API for that route.
+Documentação completa: [docs.vertracloud.app](https://docs.vertracloud.app/api-reference/introduction). Histórico de versões: [CHANGELOG.md](CHANGELOG.md).
 
-This separation provides a clear distinction between:
+## License
 
-* What is **sent to** the API (via `REST*Body` or similar types)
-* And what is **returned from** the API (via `API*` or `REST*Response` types)
+[MIT](LICENSE)

package/common/v1.d.ts

@@ -1,3 +1,5 @@
+import { APIErrorCode } from '../payloads/v1/api-error.js';
+
 type SnowFlake = string;
 interface PaginationMeta<T> {
     data: T[];
@@ -11,14 +13,28 @@ interface PaginationMeta<T> {
 interface APIPaginatedPayload<T> {
     response: PaginationMeta<T>;
 }
-interface APIPayload<T> {
-    response?: T;
-    code?: string;
+/**
+ * Error body: `code` is a stable English sentinel, `details` carries the machine-readable context
+ * of the error (e.g. the invalid field's `path` on `VALIDATION_ERROR`).
+ */
+interface APIErrorPayload<TErrorCode extends string = APIErrorCode> {
+    code: TErrorCode;
     message?: string;
+    details?: Record<string, unknown>;
 }
-interface APIReturnService<T> {
-    status: number;
-    payload: APIPayload<T>;
+/**
+ * Envelope of every JSON response: `{ response }` on success — routes with nothing to return send
+ * `{ response: null }` (`APIPayload<null>`) — or an `APIErrorPayload`. Narrow with `"code" in body`.
+ */
+type APIPayload<T, TErrorCode extends string = APIErrorCode> = {
+    response: T;
+} | APIErrorPayload<TErrorCode>;
+/**
+ * Query accepted by the application and database routes: the workspace the resource belongs to.
+ * Required for a workspace member acting on a resource they do not own; the owner may omit it.
+ */
+interface RESTAPIWorkspaceQuery {
+    workspace_id?: string;
 }
 interface APIPayloadMessageOnly {
     message: string;
@@ -54,4 +70,4 @@ declare const UserPlan: {
     readonly ENTERPRISE_32: 8;
 };
 
-export { type APIHeaders, type APIPaginatedPayload, type APIPayload, type APIPayloadMessageOnly, type APIReturnService, type APIVersion, type DeepPartial, type ISODateString, type PaginationMeta, type SnowFlake, UserPlan };
+export { type APIErrorPayload, type APIHeaders, type APIPaginatedPayload, type APIPayload, type APIPayloadMessageOnly, type APIVersion, type DeepPartial, type ISODateString, type PaginationMeta, type RESTAPIWorkspaceQuery, type SnowFlake, UserPlan };

package/common/v1.js.map

@@ -1 +1 @@
-{"version":3,"sources":["v1.ts"],"sourcesContent":["export type SnowFlake = string;\n\nexport interface PaginationMeta<T> {\n\tdata: T[];\n\ttotal_count: number;\n\tpage: number;\n\tlimit: number;\n\ttotal_pages: number;\n\thas_next_page: boolean;\n\thas_previous_page: boolean;\n}\n\nexport interface APIPaginatedPayload<T> {\n\tresponse: PaginationMeta<T>;\n}\n\nexport interface APIPayload<T> {\n\tresponse?: T;\n\tcode?: string;\n\tmessage?: string;\n}\n\nexport interface APIReturnService<T> {\n\tstatus: number;\n\tpayload: APIPayload<T>;\n}\n\nexport interface APIPayloadMessageOnly {\n\tmessage: string;\n}\n\nexport interface APIHeaders {\n\tAuthorization: string;\n}\n\nexport type DeepPartial<T> = T extends object\n\t? {\n\t\t\t[P in keyof T]?: DeepPartial<T[P]>;\n\t\t}\n\t: T;\n\nexport type APIVersion<TVersion extends number> = `v${TVersion}`;\n\nexport type ISODateString = string;\n\nexport type UserPlan = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19;\n\nexport const UserPlan = {\n\tFREE: 1,\n\tECONOMY: 2,\n\tPRO: 3,\n\tSCALE: 4,\n\tINTERMEDIARY: 9,\n\n\tENTERPRISE_4: 5,\n\tENTERPRISE_6: 19,\n\tENTERPRISE_8: 6,\n\tENTERPRISE_12: 10,\n\tENTERPRISE_14: 11,\n\tENTERPRISE_16: 7,\n\tENTERPRISE_18: 12,\n\tENTERPRISE_20: 13,\n\tENTERPRISE_22: 14,\n\tENTERPRISE_24: 15,\n\tENTERPRISE_26: 16,\n\tENTERPRISE_28: 17,\n\tENTERPRISE_30: 18,\n\tENTERPRISE_32: 8,\n} as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA+CO,IAAM,WAAW;AAAA,EACvB,MAAM;AAAA,EACN,SAAS;AAAA,EACT,KAAK;AAAA,EACL,OAAO;AAAA,EACP,cAAc;AAAA,EAEd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAChB;","names":[]}
+{"version":3,"sources":["v1.ts"],"sourcesContent":["import type { APIErrorCode } from \"../payloads/v1/api-error\";\n\nexport type SnowFlake = string;\n\nexport interface PaginationMeta<T> {\n\tdata: T[];\n\ttotal_count: number;\n\tpage: number;\n\tlimit: number;\n\ttotal_pages: number;\n\thas_next_page: boolean;\n\thas_previous_page: boolean;\n}\n\nexport interface APIPaginatedPayload<T> {\n\tresponse: PaginationMeta<T>;\n}\n\n/**\n * Error body: `code` is a stable English sentinel, `details` carries the machine-readable context\n * of the error (e.g. the invalid field's `path` on `VALIDATION_ERROR`).\n */\nexport interface APIErrorPayload<TErrorCode extends string = APIErrorCode> {\n\tcode: TErrorCode;\n\tmessage?: string;\n\tdetails?: Record<string, unknown>;\n}\n\n/**\n * Envelope of every JSON response: `{ response }` on success — routes with nothing to return send\n * `{ response: null }` (`APIPayload<null>`) — or an `APIErrorPayload`. Narrow with `\"code\" in body`.\n */\nexport type APIPayload<T, TErrorCode extends string = APIErrorCode> = { response: T } | APIErrorPayload<TErrorCode>;\n\n/**\n * Query accepted by the application and database routes: the workspace the resource belongs to.\n * Required for a workspace member acting on a resource they do not own; the owner may omit it.\n */\nexport interface RESTAPIWorkspaceQuery {\n\tworkspace_id?: string;\n}\n\nexport interface APIPayloadMessageOnly {\n\tmessage: string;\n}\n\nexport interface APIHeaders {\n\tAuthorization: string;\n}\n\nexport type DeepPartial<T> = T extends object\n\t? {\n\t\t\t[P in keyof T]?: DeepPartial<T[P]>;\n\t\t}\n\t: T;\n\nexport type APIVersion<TVersion extends number> = `v${TVersion}`;\n\nexport type ISODateString = string;\n\nexport type UserPlan = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19;\n\nexport const UserPlan = {\n\tFREE: 1,\n\tECONOMY: 2,\n\tPRO: 3,\n\tSCALE: 4,\n\tINTERMEDIARY: 9,\n\n\tENTERPRISE_4: 5,\n\tENTERPRISE_6: 19,\n\tENTERPRISE_8: 6,\n\tENTERPRISE_12: 10,\n\tENTERPRISE_14: 11,\n\tENTERPRISE_16: 7,\n\tENTERPRISE_18: 12,\n\tENTERPRISE_20: 13,\n\tENTERPRISE_22: 14,\n\tENTERPRISE_24: 15,\n\tENTERPRISE_26: 16,\n\tENTERPRISE_28: 17,\n\tENTERPRISE_30: 18,\n\tENTERPRISE_32: 8,\n} as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA8DO,IAAM,WAAW;AAAA,EACvB,MAAM;AAAA,EACN,SAAS;AAAA,EACT,KAAK;AAAA,EACL,OAAO;AAAA,EACP,cAAc;AAAA,EAEd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAChB;","names":[]}

package/package.json

@@ -1,9 +1,9 @@
 {
 	"name": "@vertracloud/api-types",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"private": false,
-	"description": "Typings for Vertra Cloud API",
-	"homepage": "https://github.com/vertracloud/api-types#readme",
+	"description": "TypeScript types for the public API of Vertra Cloud, a Brazilian application hosting platform (PaaS) for applications, managed databases and bots.",
+	"homepage": "https://vertracloud.app",
 	"exports": {
 		"./v*": {
 			"types": "./v*.d.ts",
@@ -32,7 +32,7 @@
 		}
 	},
 	"scripts": {
-		"build": "run-s lint tsc",
+		"build": "run-s clean lint tsc",
 		"clean": "rimraf {common,payloads,rest}/**/*.{*js,d.*ts,*map} {utils,v*}.{*js,d.*ts,*map}",
 		"lint": "biome check --fix .",
 		"tsc": "tsup",
@@ -48,7 +48,7 @@
 		"type": "git",
 		"url": "git+https://github.com/vertracloud/api-types.git"
 	},
-	"keywords": ["api", "vertracloud", "vertra cloud api", "vertra", "types"],
+	"keywords": ["api", "vertracloud", "vertra cloud", "vertra cloud api", "vertra", "types", "typescript", "paas", "hosting", "deploy", "brazil"],
 	"author": "Eydrenn Araujo",
 	"bugs": {
 		"url": "https://github.com/vertracloud/api-types/issues"

package/payloads/v1/activity.d.ts

@@ -1,9 +1,8 @@
 import { SnowFlake, ISODateString } from '../../common/v1.js';
 import { LocalizedContent } from './notification.js';
+import './api-error.js';
 
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/activities
- */
+/** Dashboard session only (not reachable with an API key). */
 type ActivityStatus = "success" | "warning" | "error" | "info";
 declare const ActivityStatus: {
     readonly Success: "success";
@@ -11,9 +10,7 @@ declare const ActivityStatus: {
     readonly Error: "error";
     readonly Info: "info";
 };
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/activities
- */
+/** Dashboard session only (not reachable with an API key). */
 type ActivityTargetType = "app" | "database" | "workspace" | "audit";
 declare const ActivityTargetType: {
     readonly App: "app";
@@ -21,18 +18,33 @@ declare const ActivityTargetType: {
     readonly Workspace: "workspace";
     readonly Audit: "audit";
 };
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/activities
- */
+/** Dashboard session only (not reachable with an API key). */
+type ActivityOrigin = "user" | "agent" | "api_key" | "system" | "admin";
+declare const ActivityOrigin: {
+    readonly User: "user";
+    readonly Agent: "agent";
+    readonly ApiKey: "api_key";
+    readonly System: "system";
+    readonly Admin: "admin";
+};
+/** Dashboard session only (not reachable with an API key). */
 interface APIActivity {
     id: SnowFlake;
     status: ActivityStatus;
     target_id: string;
     target_type: ActivityTargetType;
     author_id: SnowFlake | null;
+    /** Workspace the resource belonged to; `null` outside a workspace. */
+    workspace_id: SnowFlake | null;
+    /** Who generated the activity; `null` when `origin` has no human author (`system`). */
+    author: {
+        id: SnowFlake;
+        display_name: string;
+    } | null;
+    origin: ActivityOrigin;
     title: LocalizedContent;
     message: LocalizedContent;
     timestamp: ISODateString;
 }
 
-export { type APIActivity, ActivityStatus, ActivityTargetType };
+export { type APIActivity, ActivityOrigin, ActivityStatus, ActivityTargetType };

package/payloads/v1/activity.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // payloads/v1/activity.ts
 var activity_exports = {};
 __export(activity_exports, {
+  ActivityOrigin: () => ActivityOrigin,
   ActivityStatus: () => ActivityStatus,
   ActivityTargetType: () => ActivityTargetType
 });
@@ -36,8 +37,16 @@ var ActivityTargetType = {
   Workspace: "workspace",
   Audit: "audit"
 };
+var ActivityOrigin = {
+  User: "user",
+  Agent: "agent",
+  ApiKey: "api_key",
+  System: "system",
+  Admin: "admin"
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ActivityOrigin,
   ActivityStatus,
   ActivityTargetType
 });

package/payloads/v1/activity.js.map

@@ -1 +1 @@
-{"version":3,"sources":["activity.ts"],"sourcesContent":["import type { ISODateString, SnowFlake } from \"../../v1\";\nimport type { LocalizedContent } from \"./notification\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/activities\n */\nexport type ActivityStatus = \"success\" | \"warning\" | \"error\" | \"info\";\nexport const ActivityStatus = {\n\tSuccess: \"success\",\n\tWarning: \"warning\",\n\tError: \"error\",\n\tInfo: \"info\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/activities\n */\nexport type ActivityTargetType = \"app\" | \"database\" | \"workspace\" | \"audit\";\nexport const ActivityTargetType = {\n\tApp: \"app\",\n\tDatabase: \"database\",\n\tWorkspace: \"workspace\",\n\tAudit: \"audit\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/activities\n */\nexport interface APIActivity {\n\tid: SnowFlake;\n\tstatus: ActivityStatus;\n\ttarget_id: string;\n\ttarget_type: ActivityTargetType;\n\tauthor_id: SnowFlake | null;\n\ttitle: LocalizedContent;\n\tmessage: LocalizedContent;\n\ttimestamp: ISODateString;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOO,IAAM,iBAAiB;AAAA,EAC7B,SAAS;AAAA,EACT,SAAS;AAAA,EACT,OAAO;AAAA,EACP,MAAM;AACP;AAMO,IAAM,qBAAqB;AAAA,EACjC,KAAK;AAAA,EACL,UAAU;AAAA,EACV,WAAW;AAAA,EACX,OAAO;AACR;","names":[]}
+{"version":3,"sources":["activity.ts"],"sourcesContent":["import type { ISODateString, SnowFlake } from \"../../v1\";\nimport type { LocalizedContent } from \"./notification\";\n\n/** Dashboard session only (not reachable with an API key). */\nexport type ActivityStatus = \"success\" | \"warning\" | \"error\" | \"info\";\nexport const ActivityStatus = {\n\tSuccess: \"success\",\n\tWarning: \"warning\",\n\tError: \"error\",\n\tInfo: \"info\",\n} as const;\n\n/** Dashboard session only (not reachable with an API key). */\nexport type ActivityTargetType = \"app\" | \"database\" | \"workspace\" | \"audit\";\nexport const ActivityTargetType = {\n\tApp: \"app\",\n\tDatabase: \"database\",\n\tWorkspace: \"workspace\",\n\tAudit: \"audit\",\n} as const;\n\n/** Dashboard session only (not reachable with an API key). */\nexport type ActivityOrigin = \"user\" | \"agent\" | \"api_key\" | \"system\" | \"admin\";\nexport const ActivityOrigin = {\n\tUser: \"user\",\n\tAgent: \"agent\",\n\tApiKey: \"api_key\",\n\tSystem: \"system\",\n\tAdmin: \"admin\",\n} as const;\n\n/** Dashboard session only (not reachable with an API key). */\nexport interface APIActivity {\n\tid: SnowFlake;\n\tstatus: ActivityStatus;\n\ttarget_id: string;\n\ttarget_type: ActivityTargetType;\n\tauthor_id: SnowFlake | null;\n\t/** Workspace the resource belonged to; `null` outside a workspace. */\n\tworkspace_id: SnowFlake | null;\n\t/** Who generated the activity; `null` when `origin` has no human author (`system`). */\n\tauthor: { id: SnowFlake; display_name: string } | null;\n\torigin: ActivityOrigin;\n\ttitle: LocalizedContent;\n\tmessage: LocalizedContent;\n\ttimestamp: ISODateString;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,IAAM,iBAAiB;AAAA,EAC7B,SAAS;AAAA,EACT,SAAS;AAAA,EACT,OAAO;AAAA,EACP,MAAM;AACP;AAIO,IAAM,qBAAqB;AAAA,EACjC,KAAK;AAAA,EACL,UAAU;AAAA,EACV,WAAW;AAAA,EACX,OAAO;AACR;AAIO,IAAM,iBAAiB;AAAA,EAC7B,MAAM;AAAA,EACN,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,OAAO;AACR;","names":[]}

package/payloads/v1/activity.mjs

@@ -11,7 +11,15 @@ var ActivityTargetType = {
   Workspace: "workspace",
   Audit: "audit"
 };
+var ActivityOrigin = {
+  User: "user",
+  Agent: "agent",
+  ApiKey: "api_key",
+  System: "system",
+  Admin: "admin"
+};
 export {
+  ActivityOrigin,
   ActivityStatus,
   ActivityTargetType
 };

package/payloads/v1/api-error.d.ts

@@ -0,0 +1,302 @@
+/** Stable error sentinels returned by routes available to API keys. */
+declare const API_ERROR_CODES: {
+    readonly WORKSPACE_NOT_FOUND: "WORKSPACE_NOT_FOUND";
+    readonly WORKSPACE_NAME_ALREADY_EXISTS: "WORKSPACE_NAME_ALREADY_EXISTS";
+    readonly WORKSPACE_MEMBER_LIMIT_REACHED: "WORKSPACE_MEMBER_LIMIT_REACHED";
+    readonly WORKSPACE_ROLE_LIMIT_REACHED: "WORKSPACE_ROLE_LIMIT_REACHED";
+    readonly WORKSPACE_ROLE_IN_USE: "WORKSPACE_ROLE_IN_USE";
+    readonly WORKSPACE_ROLE_NOT_FOUND: "WORKSPACE_ROLE_NOT_FOUND";
+    readonly WORKSPACE_ROLE_NAME_ALREADY_EXISTS: "WORKSPACE_ROLE_NAME_ALREADY_EXISTS";
+    readonly WORKSPACE_PERMISSION_DENIED: "WORKSPACE_PERMISSION_DENIED";
+    readonly WORKSPACE_PERMISSION_ESCALATION: "WORKSPACE_PERMISSION_ESCALATION";
+    readonly WORKSPACE_INVITE_NOT_FOUND: "WORKSPACE_INVITE_NOT_FOUND";
+    readonly WORKSPACE_INVITE_EXPIRED: "WORKSPACE_INVITE_EXPIRED";
+    readonly WORKSPACE_INVITE_EMAIL_MISMATCH: "WORKSPACE_INVITE_EMAIL_MISMATCH";
+    readonly WORKSPACE_OWNER_ONLY: "WORKSPACE_OWNER_ONLY";
+    readonly WORKSPACE_ACTION_REQUEST_NOT_FOUND: "WORKSPACE_ACTION_REQUEST_NOT_FOUND";
+    readonly WORKSPACE_ACTION_NOT_NEEDED: "WORKSPACE_ACTION_NOT_NEEDED";
+    readonly WORKSPACE_ACTION_INVALID_PARAMS: "WORKSPACE_ACTION_INVALID_PARAMS";
+    readonly WORKSPACE_ACTION_REQUEST_PENDING: "WORKSPACE_ACTION_REQUEST_PENDING";
+    readonly WORKSPACE_RESOURCE_FOLDER_NOT_FOUND: "WORKSPACE_RESOURCE_FOLDER_NOT_FOUND";
+    readonly WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT: "WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT";
+    readonly WORKSPACE_RESOURCE_NOT_FOUND: "WORKSPACE_RESOURCE_NOT_FOUND";
+    readonly PLAN_RESTRICTED_FEATURE: "PLAN_RESTRICTED_FEATURE";
+    readonly ACCESS_DENIED: "ACCESS_DENIED";
+    readonly API_KEY_INVALID: "API_KEY_INVALID";
+    readonly API_KEY_IP_DENIED: "API_KEY_IP_DENIED";
+    readonly API_KEY_SCOPE_DENIED: "API_KEY_SCOPE_DENIED";
+    readonly AUTH_TOKEN_MISSING: "AUTH_TOKEN_MISSING";
+    readonly ACCOUNT_BANNED: "ACCOUNT_BANNED";
+    readonly APP_SHIELD_COOLDOWN: "APP_SHIELD_COOLDOWN";
+    readonly APP_BANNED: "APP_BANNED";
+    readonly APP_ALREADY_PUBLISHED: "APP_ALREADY_PUBLISHED";
+    readonly APP_HAS_NO_SUBDOMAIN: "APP_HAS_NO_SUBDOMAIN";
+    readonly APP_NOT_FOUND: "APP_NOT_FOUND";
+    readonly APP_NOT_PUBLISHED: "APP_NOT_PUBLISHED";
+    readonly APP_ALREADY_IN_WORKSPACE: "APP_ALREADY_IN_WORKSPACE";
+    readonly APP_NOT_FOUND_IN_WORKSPACE: "APP_NOT_FOUND_IN_WORKSPACE";
+    readonly BUILD_FAILED: "BUILD_FAILED";
+    readonly BUILD_TIMEOUT: "BUILD_TIMEOUT";
+    readonly CERTIFICATE_NOT_FOUND: "CERTIFICATE_NOT_FOUND";
+    readonly CLEANUP_LANGUAGE_SAME_AS_CURRENT: "CLEANUP_LANGUAGE_SAME_AS_CURRENT";
+    readonly CONTAINER_ALREADY_RUNNING: "CONTAINER_ALREADY_RUNNING";
+    readonly CUSTOM_DOMAIN_RECORD_NOT_FOUND: "CUSTOM_DOMAIN_RECORD_NOT_FOUND";
+    readonly CUSTOM_DOMAIN_REGISTRATION_FAILED: "CUSTOM_DOMAIN_REGISTRATION_FAILED";
+    readonly DAILY_QUOTA_EXCEEDED: "DAILY_QUOTA_EXCEEDED";
+    readonly DATABASE_NOT_FOUND: "DATABASE_NOT_FOUND";
+    readonly DATABASE_NOT_RUNNING: "DATABASE_NOT_RUNNING";
+    readonly DATABASE_ALREADY_IN_WORKSPACE: "DATABASE_ALREADY_IN_WORKSPACE";
+    readonly DATABASE_NOT_FOUND_IN_WORKSPACE: "DATABASE_NOT_FOUND_IN_WORKSPACE";
+    readonly DATABASE_PERSISTENCE_FAILED: "DATABASE_PERSISTENCE_FAILED";
+    readonly DEPLOY_FAILED: "DEPLOY_FAILED";
+    readonly DEPLOYMENT_NOT_FOUND: "DEPLOYMENT_NOT_FOUND";
+    readonly DEPLOY_RATE_LIMITED: "DEPLOY_RATE_LIMITED";
+    readonly DOMAIN_ALREADY_IN_USE: "DOMAIN_ALREADY_IN_USE";
+    readonly ENV_LIMIT_EXCEEDED: "ENV_LIMIT_EXCEEDED";
+    readonly ENV_DUPLICATE_KEY: "ENV_DUPLICATE_KEY";
+    readonly ENV_NOT_FOUND: "ENV_NOT_FOUND";
+    readonly FILE_TOO_LARGE: "FILE_TOO_LARGE";
+    readonly FILE_MODIFIED: "FILE_MODIFIED";
+    readonly FILE_NOT_FOUND: "FILE_NOT_FOUND";
+    readonly FILE_OR_FOLDER_NOT_FOUND: "FILE_OR_FOLDER_NOT_FOUND";
+    readonly FORBIDDEN: "FORBIDDEN";
+    readonly FORBIDDEN_DOMAIN: "FORBIDDEN_DOMAIN";
+    readonly FORBIDDEN_PATH: "FORBIDDEN_PATH";
+    readonly FORBIDDEN_KEY: "FORBIDDEN_KEY";
+    readonly FORCED_SNAPSHOT_RATE_LIMIT: "FORCED_SNAPSHOT_RATE_LIMIT";
+    readonly FREE_PLAN_NO_WEB_PUBLISH: "FREE_PLAN_NO_WEB_PUBLISH";
+    readonly INSTALLATION_NOT_FOUND: "INSTALLATION_NOT_FOUND";
+    readonly INSTALL_SHIELD_BLOCKED: "INSTALL_SHIELD_BLOCKED";
+    readonly INSTALL_TIMEOUT: "INSTALL_TIMEOUT";
+    readonly INSTALL_FAILED: "INSTALL_FAILED";
+    readonly INSTALL_CANCELLED: "INSTALL_CANCELLED";
+    readonly INSTALL_OUT_OF_MEMORY: "INSTALL_OUT_OF_MEMORY";
+    readonly INSTALL_QUEUE_FULL: "INSTALL_QUEUE_FULL";
+    readonly INSUFFICIENT_MEMORY: "INSUFFICIENT_MEMORY";
+    readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
+    readonly INVALID_CONFIG: "INVALID_CONFIG";
+    readonly INVALID_CUSTOM_DOMAIN_FORMAT: "INVALID_CUSTOM_DOMAIN_FORMAT";
+    readonly INVALID_HOSTNAME_FOR_APP: "INVALID_HOSTNAME_FOR_APP";
+    readonly INVALID_LANGUAGE: "INVALID_LANGUAGE";
+    readonly INVALID_MEMORY_FORMAT: "INVALID_MEMORY_FORMAT";
+    readonly INVALID_MONTHS: "INVALID_MONTHS";
+    readonly INVALID_OR_EXPIRED_CODE: "INVALID_OR_EXPIRED_CODE";
+    readonly INVALID_PARAMS: "INVALID_PARAMS";
+    readonly INVALID_PAYLOAD: "INVALID_PAYLOAD";
+    readonly INVALID_PATH: "INVALID_PATH";
+    readonly INVALID_PLAN: "INVALID_PLAN";
+    readonly INVALID_PLAN_NAME: "INVALID_PLAN_NAME";
+    readonly INVALID_RAM_LIMIT: "INVALID_RAM_LIMIT";
+    readonly INVALID_RANGE: "INVALID_RANGE";
+    readonly INVALID_SUBDOMAIN_FORMAT: "INVALID_SUBDOMAIN_FORMAT";
+    readonly INVALID_ZIP: "INVALID_ZIP";
+    readonly INVALID_ZIP_STRUCTURE: "INVALID_ZIP_STRUCTURE";
+    readonly MAIN_FILE_NOT_FOUND: "MAIN_FILE_NOT_FOUND";
+    readonly MAX_APPS_REACHED: "MAX_APPS_REACHED";
+    readonly MAX_DATABASES_REACHED: "MAX_DATABASES_REACHED";
+    readonly MEMORY_BELOW_MINIMUM: "MEMORY_BELOW_MINIMUM";
+    readonly MEMORY_LIMIT_EXCEEDED: "MEMORY_LIMIT_EXCEEDED";
+    readonly MEMORY_MUST_BE_INTEGER: "MEMORY_MUST_BE_INTEGER";
+    readonly MEMORY_REQUIRED: "MEMORY_REQUIRED";
+    readonly MISSING_HEADERS: "MISSING_HEADERS";
+    readonly MISSING_PLAN_OR_MONTHS: "MISSING_PLAN_OR_MONTHS";
+    readonly MISSING_CONTENT: "MISSING_CONTENT";
+    readonly NOT_AN_UPGRADE: "NOT_AN_UPGRADE";
+    readonly NO_AUTHORIZED_PATHS: "NO_AUTHORIZED_PATHS";
+    readonly NO_CHANGES_PROVIDED: "NO_CHANGES_PROVIDED";
+    readonly NO_CUSTOM_DOMAIN: "NO_CUSTOM_DOMAIN";
+    readonly NO_FIELDS_TO_UPDATE: "NO_FIELDS_TO_UPDATE";
+    readonly NO_FILE_UPLOADED: "NO_FILE_UPLOADED";
+    readonly OPERATION_IN_PROGRESS: "OPERATION_IN_PROGRESS";
+    readonly ORDER_NOT_FOUND: "ORDER_NOT_FOUND";
+    readonly ORDER_NOT_PAID: "ORDER_NOT_PAID";
+    readonly ORDER_NOT_PAYABLE: "ORDER_NOT_PAYABLE";
+    readonly ORDER_NOT_REFUNDED: "ORDER_NOT_REFUNDED";
+    readonly OWNER_APP_WITHOUT_LIMITS: "OWNER_APP_WITHOUT_LIMITS";
+    readonly PAYLOAD_TOO_LARGE: "PAYLOAD_TOO_LARGE";
+    readonly PENDING_ORDER_LIMIT_REACHED: "PENDING_ORDER_LIMIT_REACHED";
+    readonly PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN";
+    readonly PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN";
+    readonly PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH: "PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH";
+    readonly PLAN_MISMATCH_FOR_RENEWAL: "PLAN_MISMATCH_FOR_RENEWAL";
+    readonly PLAN_NOT_ALLOWED: "PLAN_NOT_ALLOWED";
+    readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
+    readonly REFUND_AMOUNT_EXCEEDS_PRICE: "REFUND_AMOUNT_EXCEEDS_PRICE";
+    readonly REPO_ALREADY_LINKED: "REPO_ALREADY_LINKED";
+    readonly RESTORE_COOLDOWN: "RESTORE_COOLDOWN";
+    readonly SNAPSHOT_ENGINE_MISMATCH: "SNAPSHOT_ENGINE_MISMATCH";
+    readonly SNAPSHOT_IMPORT_FAILED: "SNAPSHOT_IMPORT_FAILED";
+    readonly SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND";
+    readonly SNAPSHOT_RATE_LIMITED: "SNAPSHOT_RATE_LIMITED";
+    readonly SNAPSHOT_TYPE_MISMATCH: "SNAPSHOT_TYPE_MISMATCH";
+    readonly SNAPSHOT_TOO_LARGE: "SNAPSHOT_TOO_LARGE";
+    readonly SOURCE_CONFLICT: "SOURCE_CONFLICT";
+    readonly SOURCE_REQUIRED: "SOURCE_REQUIRED";
+    readonly STORAGE_ABOVE_NEW_LIMIT: "STORAGE_ABOVE_NEW_LIMIT";
+    readonly SUBDOMAIN_ALREADY_IN_USE: "SUBDOMAIN_ALREADY_IN_USE";
+    readonly SUBDOMAIN_CHANGE_RATE_LIMITED: "SUBDOMAIN_CHANGE_RATE_LIMITED";
+    readonly SUBDOMAIN_FORBIDDEN: "SUBDOMAIN_FORBIDDEN";
+    readonly SUBDOMAIN_TAKEN: "SUBDOMAIN_TAKEN";
+    readonly TYPE_MISMATCH: "TYPE_MISMATCH";
+    readonly USER_LIMITS_NOT_FOUND: "USER_LIMITS_NOT_FOUND";
+    readonly USER_NOT_FOUND: "USER_NOT_FOUND";
+    readonly USER_NOT_IN_WORKSPACE: "USER_NOT_IN_WORKSPACE";
+    readonly DATABASE_BANNED: "DATABASE_BANNED";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly ZIP_TOO_LARGE: "ZIP_TOO_LARGE";
+    readonly ZIP_TOO_SMALL: "ZIP_TOO_SMALL";
+    readonly STORAGE_FULL: "STORAGE_FULL";
+    readonly TARGET_IS_DIRECTORY: "TARGET_IS_DIRECTORY";
+};
+declare const APIErrorCode: {
+    readonly WORKSPACE_NOT_FOUND: "WORKSPACE_NOT_FOUND";
+    readonly WORKSPACE_NAME_ALREADY_EXISTS: "WORKSPACE_NAME_ALREADY_EXISTS";
+    readonly WORKSPACE_MEMBER_LIMIT_REACHED: "WORKSPACE_MEMBER_LIMIT_REACHED";
+    readonly WORKSPACE_ROLE_LIMIT_REACHED: "WORKSPACE_ROLE_LIMIT_REACHED";
+    readonly WORKSPACE_ROLE_IN_USE: "WORKSPACE_ROLE_IN_USE";
+    readonly WORKSPACE_ROLE_NOT_FOUND: "WORKSPACE_ROLE_NOT_FOUND";
+    readonly WORKSPACE_ROLE_NAME_ALREADY_EXISTS: "WORKSPACE_ROLE_NAME_ALREADY_EXISTS";
+    readonly WORKSPACE_PERMISSION_DENIED: "WORKSPACE_PERMISSION_DENIED";
+    readonly WORKSPACE_PERMISSION_ESCALATION: "WORKSPACE_PERMISSION_ESCALATION";
+    readonly WORKSPACE_INVITE_NOT_FOUND: "WORKSPACE_INVITE_NOT_FOUND";
+    readonly WORKSPACE_INVITE_EXPIRED: "WORKSPACE_INVITE_EXPIRED";
+    readonly WORKSPACE_INVITE_EMAIL_MISMATCH: "WORKSPACE_INVITE_EMAIL_MISMATCH";
+    readonly WORKSPACE_OWNER_ONLY: "WORKSPACE_OWNER_ONLY";
+    readonly WORKSPACE_ACTION_REQUEST_NOT_FOUND: "WORKSPACE_ACTION_REQUEST_NOT_FOUND";
+    readonly WORKSPACE_ACTION_NOT_NEEDED: "WORKSPACE_ACTION_NOT_NEEDED";
+    readonly WORKSPACE_ACTION_INVALID_PARAMS: "WORKSPACE_ACTION_INVALID_PARAMS";
+    readonly WORKSPACE_ACTION_REQUEST_PENDING: "WORKSPACE_ACTION_REQUEST_PENDING";
+    readonly WORKSPACE_RESOURCE_FOLDER_NOT_FOUND: "WORKSPACE_RESOURCE_FOLDER_NOT_FOUND";
+    readonly WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT: "WORKSPACE_RESOURCE_FOLDER_NAME_CONFLICT";
+    readonly WORKSPACE_RESOURCE_NOT_FOUND: "WORKSPACE_RESOURCE_NOT_FOUND";
+    readonly PLAN_RESTRICTED_FEATURE: "PLAN_RESTRICTED_FEATURE";
+    readonly ACCESS_DENIED: "ACCESS_DENIED";
+    readonly API_KEY_INVALID: "API_KEY_INVALID";
+    readonly API_KEY_IP_DENIED: "API_KEY_IP_DENIED";
+    readonly API_KEY_SCOPE_DENIED: "API_KEY_SCOPE_DENIED";
+    readonly AUTH_TOKEN_MISSING: "AUTH_TOKEN_MISSING";
+    readonly ACCOUNT_BANNED: "ACCOUNT_BANNED";
+    readonly APP_SHIELD_COOLDOWN: "APP_SHIELD_COOLDOWN";
+    readonly APP_BANNED: "APP_BANNED";
+    readonly APP_ALREADY_PUBLISHED: "APP_ALREADY_PUBLISHED";
+    readonly APP_HAS_NO_SUBDOMAIN: "APP_HAS_NO_SUBDOMAIN";
+    readonly APP_NOT_FOUND: "APP_NOT_FOUND";
+    readonly APP_NOT_PUBLISHED: "APP_NOT_PUBLISHED";
+    readonly APP_ALREADY_IN_WORKSPACE: "APP_ALREADY_IN_WORKSPACE";
+    readonly APP_NOT_FOUND_IN_WORKSPACE: "APP_NOT_FOUND_IN_WORKSPACE";
+    readonly BUILD_FAILED: "BUILD_FAILED";
+    readonly BUILD_TIMEOUT: "BUILD_TIMEOUT";
+    readonly CERTIFICATE_NOT_FOUND: "CERTIFICATE_NOT_FOUND";
+    readonly CLEANUP_LANGUAGE_SAME_AS_CURRENT: "CLEANUP_LANGUAGE_SAME_AS_CURRENT";
+    readonly CONTAINER_ALREADY_RUNNING: "CONTAINER_ALREADY_RUNNING";
+    readonly CUSTOM_DOMAIN_RECORD_NOT_FOUND: "CUSTOM_DOMAIN_RECORD_NOT_FOUND";
+    readonly CUSTOM_DOMAIN_REGISTRATION_FAILED: "CUSTOM_DOMAIN_REGISTRATION_FAILED";
+    readonly DAILY_QUOTA_EXCEEDED: "DAILY_QUOTA_EXCEEDED";
+    readonly DATABASE_NOT_FOUND: "DATABASE_NOT_FOUND";
+    readonly DATABASE_NOT_RUNNING: "DATABASE_NOT_RUNNING";
+    readonly DATABASE_ALREADY_IN_WORKSPACE: "DATABASE_ALREADY_IN_WORKSPACE";
+    readonly DATABASE_NOT_FOUND_IN_WORKSPACE: "DATABASE_NOT_FOUND_IN_WORKSPACE";
+    readonly DATABASE_PERSISTENCE_FAILED: "DATABASE_PERSISTENCE_FAILED";
+    readonly DEPLOY_FAILED: "DEPLOY_FAILED";
+    readonly DEPLOYMENT_NOT_FOUND: "DEPLOYMENT_NOT_FOUND";
+    readonly DEPLOY_RATE_LIMITED: "DEPLOY_RATE_LIMITED";
+    readonly DOMAIN_ALREADY_IN_USE: "DOMAIN_ALREADY_IN_USE";
+    readonly ENV_LIMIT_EXCEEDED: "ENV_LIMIT_EXCEEDED";
+    readonly ENV_DUPLICATE_KEY: "ENV_DUPLICATE_KEY";
+    readonly ENV_NOT_FOUND: "ENV_NOT_FOUND";
+    readonly FILE_TOO_LARGE: "FILE_TOO_LARGE";
+    readonly FILE_MODIFIED: "FILE_MODIFIED";
+    readonly FILE_NOT_FOUND: "FILE_NOT_FOUND";
+    readonly FILE_OR_FOLDER_NOT_FOUND: "FILE_OR_FOLDER_NOT_FOUND";
+    readonly FORBIDDEN: "FORBIDDEN";
+    readonly FORBIDDEN_DOMAIN: "FORBIDDEN_DOMAIN";
+    readonly FORBIDDEN_PATH: "FORBIDDEN_PATH";
+    readonly FORBIDDEN_KEY: "FORBIDDEN_KEY";
+    readonly FORCED_SNAPSHOT_RATE_LIMIT: "FORCED_SNAPSHOT_RATE_LIMIT";
+    readonly FREE_PLAN_NO_WEB_PUBLISH: "FREE_PLAN_NO_WEB_PUBLISH";
+    readonly INSTALLATION_NOT_FOUND: "INSTALLATION_NOT_FOUND";
+    readonly INSTALL_SHIELD_BLOCKED: "INSTALL_SHIELD_BLOCKED";
+    readonly INSTALL_TIMEOUT: "INSTALL_TIMEOUT";
+    readonly INSTALL_FAILED: "INSTALL_FAILED";
+    readonly INSTALL_CANCELLED: "INSTALL_CANCELLED";
+    readonly INSTALL_OUT_OF_MEMORY: "INSTALL_OUT_OF_MEMORY";
+    readonly INSTALL_QUEUE_FULL: "INSTALL_QUEUE_FULL";
+    readonly INSUFFICIENT_MEMORY: "INSUFFICIENT_MEMORY";
+    readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
+    readonly INVALID_CONFIG: "INVALID_CONFIG";
+    readonly INVALID_CUSTOM_DOMAIN_FORMAT: "INVALID_CUSTOM_DOMAIN_FORMAT";
+    readonly INVALID_HOSTNAME_FOR_APP: "INVALID_HOSTNAME_FOR_APP";
+    readonly INVALID_LANGUAGE: "INVALID_LANGUAGE";
+    readonly INVALID_MEMORY_FORMAT: "INVALID_MEMORY_FORMAT";
+    readonly INVALID_MONTHS: "INVALID_MONTHS";
+    readonly INVALID_OR_EXPIRED_CODE: "INVALID_OR_EXPIRED_CODE";
+    readonly INVALID_PARAMS: "INVALID_PARAMS";
+    readonly INVALID_PAYLOAD: "INVALID_PAYLOAD";
+    readonly INVALID_PATH: "INVALID_PATH";
+    readonly INVALID_PLAN: "INVALID_PLAN";
+    readonly INVALID_PLAN_NAME: "INVALID_PLAN_NAME";
+    readonly INVALID_RAM_LIMIT: "INVALID_RAM_LIMIT";
+    readonly INVALID_RANGE: "INVALID_RANGE";
+    readonly INVALID_SUBDOMAIN_FORMAT: "INVALID_SUBDOMAIN_FORMAT";
+    readonly INVALID_ZIP: "INVALID_ZIP";
+    readonly INVALID_ZIP_STRUCTURE: "INVALID_ZIP_STRUCTURE";
+    readonly MAIN_FILE_NOT_FOUND: "MAIN_FILE_NOT_FOUND";
+    readonly MAX_APPS_REACHED: "MAX_APPS_REACHED";
+    readonly MAX_DATABASES_REACHED: "MAX_DATABASES_REACHED";
+    readonly MEMORY_BELOW_MINIMUM: "MEMORY_BELOW_MINIMUM";
+    readonly MEMORY_LIMIT_EXCEEDED: "MEMORY_LIMIT_EXCEEDED";
+    readonly MEMORY_MUST_BE_INTEGER: "MEMORY_MUST_BE_INTEGER";
+    readonly MEMORY_REQUIRED: "MEMORY_REQUIRED";
+    readonly MISSING_HEADERS: "MISSING_HEADERS";
+    readonly MISSING_PLAN_OR_MONTHS: "MISSING_PLAN_OR_MONTHS";
+    readonly MISSING_CONTENT: "MISSING_CONTENT";
+    readonly NOT_AN_UPGRADE: "NOT_AN_UPGRADE";
+    readonly NO_AUTHORIZED_PATHS: "NO_AUTHORIZED_PATHS";
+    readonly NO_CHANGES_PROVIDED: "NO_CHANGES_PROVIDED";
+    readonly NO_CUSTOM_DOMAIN: "NO_CUSTOM_DOMAIN";
+    readonly NO_FIELDS_TO_UPDATE: "NO_FIELDS_TO_UPDATE";
+    readonly NO_FILE_UPLOADED: "NO_FILE_UPLOADED";
+    readonly OPERATION_IN_PROGRESS: "OPERATION_IN_PROGRESS";
+    readonly ORDER_NOT_FOUND: "ORDER_NOT_FOUND";
+    readonly ORDER_NOT_PAID: "ORDER_NOT_PAID";
+    readonly ORDER_NOT_PAYABLE: "ORDER_NOT_PAYABLE";
+    readonly ORDER_NOT_REFUNDED: "ORDER_NOT_REFUNDED";
+    readonly OWNER_APP_WITHOUT_LIMITS: "OWNER_APP_WITHOUT_LIMITS";
+    readonly PAYLOAD_TOO_LARGE: "PAYLOAD_TOO_LARGE";
+    readonly PENDING_ORDER_LIMIT_REACHED: "PENDING_ORDER_LIMIT_REACHED";
+    readonly PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN";
+    readonly PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN";
+    readonly PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH: "PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH";
+    readonly PLAN_MISMATCH_FOR_RENEWAL: "PLAN_MISMATCH_FOR_RENEWAL";
+    readonly PLAN_NOT_ALLOWED: "PLAN_NOT_ALLOWED";
+    readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
+    readonly REFUND_AMOUNT_EXCEEDS_PRICE: "REFUND_AMOUNT_EXCEEDS_PRICE";
+    readonly REPO_ALREADY_LINKED: "REPO_ALREADY_LINKED";
+    readonly RESTORE_COOLDOWN: "RESTORE_COOLDOWN";
+    readonly SNAPSHOT_ENGINE_MISMATCH: "SNAPSHOT_ENGINE_MISMATCH";
+    readonly SNAPSHOT_IMPORT_FAILED: "SNAPSHOT_IMPORT_FAILED";
+    readonly SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND";
+    readonly SNAPSHOT_RATE_LIMITED: "SNAPSHOT_RATE_LIMITED";
+    readonly SNAPSHOT_TYPE_MISMATCH: "SNAPSHOT_TYPE_MISMATCH";
+    readonly SNAPSHOT_TOO_LARGE: "SNAPSHOT_TOO_LARGE";
+    readonly SOURCE_CONFLICT: "SOURCE_CONFLICT";
+    readonly SOURCE_REQUIRED: "SOURCE_REQUIRED";
+    readonly STORAGE_ABOVE_NEW_LIMIT: "STORAGE_ABOVE_NEW_LIMIT";
+    readonly SUBDOMAIN_ALREADY_IN_USE: "SUBDOMAIN_ALREADY_IN_USE";
+    readonly SUBDOMAIN_CHANGE_RATE_LIMITED: "SUBDOMAIN_CHANGE_RATE_LIMITED";
+    readonly SUBDOMAIN_FORBIDDEN: "SUBDOMAIN_FORBIDDEN";
+    readonly SUBDOMAIN_TAKEN: "SUBDOMAIN_TAKEN";
+    readonly TYPE_MISMATCH: "TYPE_MISMATCH";
+    readonly USER_LIMITS_NOT_FOUND: "USER_LIMITS_NOT_FOUND";
+    readonly USER_NOT_FOUND: "USER_NOT_FOUND";
+    readonly USER_NOT_IN_WORKSPACE: "USER_NOT_IN_WORKSPACE";
+    readonly DATABASE_BANNED: "DATABASE_BANNED";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly ZIP_TOO_LARGE: "ZIP_TOO_LARGE";
+    readonly ZIP_TOO_SMALL: "ZIP_TOO_SMALL";
+    readonly STORAGE_FULL: "STORAGE_FULL";
+    readonly TARGET_IS_DIRECTORY: "TARGET_IS_DIRECTORY";
+};
+type APIErrorCode = (typeof API_ERROR_CODES)[keyof typeof API_ERROR_CODES];
+
+export { APIErrorCode, API_ERROR_CODES };