@vertracloud/api-types 0.3.6 → 0.4.0

package/v1.mjs

@@ -61,6 +61,8 @@ var APIApiKeyScope = {
   WORKSPACES_WRITE: "workspaces:write",
   WORKSPACES_DELETE: "workspaces:delete",
   WORKSPACES_INVITES: "workspaces:invites",
+  BLOB_READ: "blob:read",
+  BLOB_WRITE: "blob:write",
   BILLING_READ: "billing:read",
   BILLING_WRITE: "billing:write",
   REDEEM_WRITE: "redeem:write"
@@ -245,6 +247,47 @@ var API_KEY_SCOPES = {
       { method: "POST", path: "/v1/workspaces/invites/:token/decline" }
     ]
   },
+  /** Blob Storage (`blob.vertracloud.app`). Upload tokens (`vcup_`) are a separate credential, not a scope. */
+  "blob:read": {
+    group: "blob",
+    routes: [
+      { method: "GET", path: "/v1/blob/objects" },
+      { method: "GET", path: "/v1/blob/objects/:object_id" },
+      { method: "GET", path: "/v1/blob/objects/:object_id/download" },
+      { method: "GET", path: "/v1/blob/shares" },
+      { method: "GET", path: "/v1/blob/rules" },
+      { method: "GET", path: "/v1/blob/stats" },
+      { method: "GET", path: "/v1/blob/s3/credentials" },
+      { method: "GET", path: "/v1/blob/domains" }
+    ]
+  },
+  "blob:write": {
+    group: "blob",
+    routes: [
+      { method: "POST", path: "/v1/blob/objects" },
+      { method: "PATCH", path: "/v1/blob/objects" },
+      { method: "PATCH", path: "/v1/blob/objects/:object_id" },
+      { method: "POST", path: "/v1/blob/objects/copy" },
+      { method: "DELETE", path: "/v1/blob/objects" },
+      { method: "DELETE", path: "/v1/blob/objects/:object_id" },
+      { method: "POST", path: "/v1/blob/uploads" },
+      { method: "GET", path: "/v1/blob/uploads" },
+      { method: "GET", path: "/v1/blob/uploads/:upload_id" },
+      { method: "POST", path: "/v1/blob/uploads/:upload_id/parts" },
+      { method: "POST", path: "/v1/blob/uploads/:upload_id/complete" },
+      { method: "DELETE", path: "/v1/blob/uploads/:upload_id" },
+      { method: "POST", path: "/v1/blob/shares" },
+      { method: "DELETE", path: "/v1/blob/shares/:share_id" },
+      { method: "PUT", path: "/v1/blob/rules" },
+      { method: "PUT", path: "/v1/blob/rules/:prefix" },
+      { method: "DELETE", path: "/v1/blob/rules/:prefix" },
+      { method: "POST", path: "/v1/blob/upload-tokens" },
+      { method: "POST", path: "/v1/blob/domains" },
+      { method: "POST", path: "/v1/blob/domains/:domain_id/verify" },
+      { method: "PATCH", path: "/v1/blob/domains/:domain_id" },
+      { method: "DELETE", path: "/v1/blob/domains/:domain_id" }
+    ]
+  },
   "billing:read": {
     group: "billing",
     routes: [
@@ -292,6 +335,8 @@ var WorkspacePermission = {
   DATABASES_DELETE: "databases:delete",
   SNAPSHOTS_READ: "snapshots:read",
   SNAPSHOTS_MANAGE: "snapshots:manage",
+  BLOB_READ: "blob:read",
+  BLOB_MANAGE: "blob:manage",
   MEMBERS_READ: "members:read",
   MEMBERS_MANAGE: "members:manage",
   ROLES_MANAGE: "roles:manage",
@@ -312,6 +357,8 @@ var WORKSPACE_PERMISSIONS = {
   "databases:delete": { group: "databases" },
   "snapshots:read": { group: "snapshots" },
   "snapshots:manage": { group: "snapshots" },
+  "blob:read": { group: "blob" },
+  "blob:manage": { group: "blob" },
   "members:read": { group: "members" },
   "members:manage": { group: "members" },
   "roles:manage": { group: "roles" },
@@ -327,7 +374,7 @@ var WorkspaceRolePreset = {
 function workspacePresetPermissions(preset) {
   switch (preset) {
     case "admin":
-      return WORKSPACE_PERMISSION_LIST.filter((p) => p !== "snapshots:manage");
+      return WORKSPACE_PERMISSION_LIST.filter((p) => p !== "snapshots:manage" && p !== "blob:read" && p !== "blob: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":
@@ -412,6 +459,52 @@ var API_ERROR_CODES = {
   APP_NOT_PUBLISHED: "APP_NOT_PUBLISHED",
   APP_ALREADY_IN_WORKSPACE: "APP_ALREADY_IN_WORKSPACE",
   APP_NOT_FOUND_IN_WORKSPACE: "APP_NOT_FOUND_IN_WORKSPACE",
+  /** 404 — the object does not exist or belongs to another account. */
+  BLOB_OBJECT_NOT_FOUND: "BLOB_OBJECT_NOT_FOUND",
+  /** 409 — the path is taken and `overwrite` is not set. */
+  BLOB_OBJECT_ALREADY_EXISTS: "BLOB_OBJECT_ALREADY_EXISTS",
+  /** 404 — the upload does not exist, is not yours, or is already completed or aborted. */
+  BLOB_UPLOAD_NOT_FOUND: "BLOB_UPLOAD_NOT_FOUND",
+  /** 410 — the upload passed its deadline. */
+  BLOB_UPLOAD_EXPIRED: "BLOB_UPLOAD_EXPIRED",
+  /** 409 — parts are missing or the stored size differs from the declared size. */
+  BLOB_UPLOAD_INCOMPLETE: "BLOB_UPLOAD_INCOMPLETE",
+  /** 409 — more uploads open than the plan allows. */
+  BLOB_UPLOAD_LIMIT: "BLOB_UPLOAD_LIMIT",
+  /** 400 — the SHA-256 sent does not match the file. */
+  BLOB_CHECKSUM_MISMATCH: "BLOB_CHECKSUM_MISMATCH",
+  /** 413 — the file exceeds the plan, single-request upload, folder rule or upload token limit. */
+  BLOB_FILE_TOO_LARGE: "BLOB_FILE_TOO_LARGE",
+  /** 403 — Blob Storage is suspended for the account (grace period, abuse or deletion). */
+  BLOB_NAMESPACE_SUSPENDED: "BLOB_NAMESPACE_SUSPENDED",
+  /** 401 — the upload token does not exist, expired or was revoked. */
+  BLOB_UPLOAD_TOKEN_INVALID: "BLOB_UPLOAD_TOKEN_INVALID",
+  /** 401 — the upload token has no uses left. */
+  BLOB_UPLOAD_TOKEN_EXHAUSTED: "BLOB_UPLOAD_TOKEN_EXHAUSTED",
+  /** 403 — upload tokens only work on the upload routes. */
+  BLOB_UPLOAD_TOKEN_NOT_ALLOWED: "BLOB_UPLOAD_TOKEN_NOT_ALLOWED",
+  /** 403 — the path, size or extension is outside what the upload token allows. */
+  BLOB_UPLOAD_TOKEN_CONSTRAINT: "BLOB_UPLOAD_TOKEN_CONSTRAINT",
+  /** 404 — the share does not exist, was revoked or expired. */
+  BLOB_SHARE_NOT_FOUND: "BLOB_SHARE_NOT_FOUND",
+  /** 410 — the share reached its download limit. */
+  BLOB_SHARE_EXHAUSTED: "BLOB_SHARE_EXHAUSTED",
+  /** 401 — wrong share password. */
+  BLOB_SHARE_PASSWORD_INVALID: "BLOB_SHARE_PASSWORD_INVALID",
+  /** 409 — the `If-Match` of the rule list is outdated; read it again. */
+  BLOB_RULES_CONFLICT: "BLOB_RULES_CONFLICT",
+  /** 409 — more folder rules than the plan allows. */
+  BLOB_RULE_LIMIT: "BLOB_RULE_LIMIT",
+  /** 409 — more custom domains than the plan allows. */
+  BLOB_CUSTOM_DOMAIN_LIMIT: "BLOB_CUSTOM_DOMAIN_LIMIT",
+  /** 409 — the hostname is already in use. */
+  BLOB_CUSTOM_DOMAIN_TAKEN: "BLOB_CUSTOM_DOMAIN_TAKEN",
+  /** 404 — the domain does not exist or belongs to another account. */
+  BLOB_CUSTOM_DOMAIN_NOT_FOUND: "BLOB_CUSTOM_DOMAIN_NOT_FOUND",
+  /** 422 — the file extension is blocked, outside the rule or token, or the content is an executable. */
+  BLOCKED_FILE_TYPE: "BLOCKED_FILE_TYPE",
+  /** 403 — the upload would exceed the storage quota. */
+  STORAGE_QUOTA_EXCEEDED: "STORAGE_QUOTA_EXCEEDED",
   BUILD_FAILED: "BUILD_FAILED",
   BUILD_TIMEOUT: "BUILD_TIMEOUT",
   /** 400 — the order needs complete billing details for the service invoice (name, address and, in Brazil, CPF/CNPJ). Fill them with `PUT /v1/users/me/billing`. */
@@ -667,6 +760,26 @@ var BillingTaxIdType = {
   CNPJ: "cnpj"
 };
 
+// payloads/v1/blob.ts
+var BlobVisibility = { PUBLIC: "public", PRIVATE: "private" };
+var BlobContentDisposition = {
+  INLINE: "inline",
+  ATTACHMENT: "attachment"
+};
+var BlobUploadMode = { SINGLE: "single", MULTIPART: "multipart" };
+var BlobUploadStatus = {
+  PENDING: "pending",
+  COMPLETED: "completed",
+  ABORTED: "aborted",
+  EXPIRED: "expired"
+};
+var BlobCustomDomainStatus = {
+  PENDING: "pending",
+  ACTIVE: "active",
+  FAILED: "failed",
+  SUSPENDED: "suspended"
+};
+
 // payloads/v1/database.ts
 var DatabaseType = {
   POSTGRESQL: 1,
@@ -805,6 +918,11 @@ export {
   ApplicationVersion,
   ApplicationZeroDowntime,
   BillingTaxIdType,
+  BlobContentDisposition,
+  BlobCustomDomainStatus,
+  BlobUploadMode,
+  BlobUploadStatus,
+  BlobVisibility,
   DatabaseCluster,
   DatabaseFilterOperator,
   DatabaseRedisKeyType,