@vertracloud/api-types 0.3.6 → 0.4.1

package/rest/v1/blob.d.ts

@@ -0,0 +1,394 @@
+import { ISODateString, RESTAPIWorkspaceQuery, APIPayload, SnowFlake } from '../../common/v1.js';
+import { BlobVisibility, BlobContentDisposition, APIBlobRule, APIBlobDeleteResult, APIBlobRules, APIBlobCustomDomain, APIBlobDownload, APIBlobObject, APIBlobObjectList, APIBlobS3Credentials, APIBlobSharePublic, APIBlobShare, APIBlobStats, APIBlobUpload, APIBlobBatchResult, APIBlobUploadPart, APIBlobUploadToken } from '../../payloads/v1/blob.js';
+import '../../payloads/v1/api-error.js';
+
+/**
+ * Options shared by both ways of uploading. Defaults: `visibility: "private"`, `overwrite: false`,
+ * `random_suffix: false` (always `true` for an upload token without a fixed `path`).
+ */
+interface RESTBlobObjectWriteOptions {
+    visibility?: BlobVisibility;
+    /** Replace an existing object at `path`. Without it a taken path returns `BLOB_OBJECT_ALREADY_EXISTS`. */
+    overwrite?: boolean;
+    /** Insert `-<10 random characters>` before the extension. */
+    random_suffix?: boolean;
+    /**
+     * When `path` is taken, save as `name-1.ext`, `name-2.ext`, … (the first free one) instead of returning
+     * `BLOB_OBJECT_ALREADY_EXISTS`. The object comes back with the final `path`. Cannot be combined with `overwrite`.
+     */
+    rename_on_conflict?: boolean;
+    cache_control?: string;
+    content_disposition?: BlobContentDisposition;
+    filename?: string;
+    expires_at?: ISODateString;
+    /**
+     * Hex SHA-256 of the file; a mismatch returns `BLOB_CHECKSUM_MISMATCH`. Only valid for the
+     * single-request upload and for a direct upload sent in one part: a multipart upload refuses it
+     * (`VALIDATION_ERROR`), because a SHA-256 of the whole object cannot be verified from separate parts.
+     */
+    checksum_sha256?: string;
+}
+/**
+ * `POST /v1/objects` — single-request upload (up to the plan's `max_simple_upload_bytes`). The
+ * body is `multipart/form-data` with one `file` field; options go in the query. Accepts an upload token.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/upload
+ */
+interface RESTPostAPIBlobObjectQuery extends RESTAPIWorkspaceQuery, RESTBlobObjectWriteOptions {
+    path: string;
+    /** JSON object, URL-encoded. */
+    metadata?: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/upload
+ */
+type RESTPostAPIBlobObjectResponse = APIPayload<APIBlobObject>;
+/**
+ * `POST /v1/uploads` — starts a direct upload (single or multipart, chosen by `size`). Accepts an upload token.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/create
+ */
+interface RESTPostAPIBlobUploadBody extends RESTBlobObjectWriteOptions {
+    path: string;
+    size: number;
+    metadata?: Record<string, string>;
+}
+type RESTPostAPIBlobUploadQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/create
+ */
+type RESTPostAPIBlobUploadResponse = APIPayload<APIBlobUpload>;
+/** `GET /v1/uploads` — uploads still in progress. */
+type RESTGetAPIBlobUploadsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/list
+ */
+type RESTGetAPIBlobUploadsResponse = APIPayload<APIBlobUpload[]>;
+/** `GET /v1/uploads/:upload_id` — status of one upload, to resume it. Accepts an upload token. */
+type RESTGetAPIBlobUploadQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/get
+ */
+type RESTGetAPIBlobUploadResponse = APIPayload<APIBlobUpload>;
+/**
+ * `POST /v1/uploads/:upload_id/parts` — URLs for up to 100 parts. Accepts an upload token.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/parts
+ */
+interface RESTPostAPIBlobUploadPartsBody {
+    part_numbers: number[];
+}
+type RESTPostAPIBlobUploadPartsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/parts
+ */
+type RESTPostAPIBlobUploadPartsResponse = APIPayload<APIBlobUploadPart[]>;
+/** `POST /v1/uploads/:upload_id/complete` — checks the parts and creates the object. Accepts an upload token. */
+type RESTPostAPIBlobUploadCompleteQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/complete
+ */
+type RESTPostAPIBlobUploadCompleteResponse = APIPayload<APIBlobObject>;
+/** `DELETE /v1/uploads/:upload_id` — aborts an upload; repeating it is not an error. Accepts an upload token. */
+type RESTDeleteAPIBlobUploadQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/abort
+ */
+type RESTDeleteAPIBlobUploadResponse = APIPayload<null>;
+/**
+ * `GET /v1/objects`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/list
+ */
+interface RESTGetAPIBlobObjectsQuery extends RESTAPIWorkspaceQuery {
+    prefix?: string;
+    /** Group paths into folders at `/`. Omit it for a flat list. */
+    delimiter?: "/";
+    visibility?: BlobVisibility;
+    cursor?: string;
+    /** 1–1000. Default 100. */
+    limit?: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/list
+ */
+type RESTGetAPIBlobObjectsResponse = APIPayload<APIBlobObjectList>;
+/** `GET /v1/objects/:object_id`. */
+type RESTGetAPIBlobObjectQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/get
+ */
+type RESTGetAPIBlobObjectResponse = APIPayload<APIBlobObject>;
+/**
+ * Fields of an object that can change. `null` restores the default; a `null` metadata value removes that key.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update
+ */
+interface RESTPatchAPIBlobObjectBody {
+    visibility?: BlobVisibility;
+    cache_control?: string | null;
+    content_disposition?: BlobContentDisposition | null;
+    filename?: string | null;
+    expires_at?: ISODateString | null;
+    metadata?: Record<string, string | null>;
+}
+/** `PATCH /v1/objects/:object_id`. */
+type RESTPatchAPIBlobObjectQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update
+ */
+type RESTPatchAPIBlobObjectResponse = APIPayload<APIBlobObject>;
+/**
+ * `PATCH /v1/objects` — applies the same changes to up to 100 objects.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update-many
+ */
+interface RESTPatchAPIBlobObjectsBody {
+    ids: SnowFlake[];
+    changes: RESTPatchAPIBlobObjectBody;
+}
+type RESTPatchAPIBlobObjectsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update-many
+ */
+type RESTPatchAPIBlobObjectsResponse = APIPayload<APIBlobBatchResult[]>;
+/**
+ * `POST /v1/objects/copy` — copies or moves an object. A move keeps the `id`; a copy creates
+ * another object that counts toward storage.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/copy
+ */
+interface RESTPostAPIBlobObjectCopyBody {
+    source: SnowFlake;
+    path: string;
+    move?: boolean;
+    overwrite?: boolean;
+    random_suffix?: boolean;
+    visibility?: BlobVisibility;
+}
+type RESTPostAPIBlobObjectCopyQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/copy
+ */
+type RESTPostAPIBlobObjectCopyResponse = APIPayload<APIBlobObject>;
+/** `DELETE /v1/objects/:object_id`. */
+type RESTDeleteAPIBlobObjectQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete
+ */
+type RESTDeleteAPIBlobObjectResponse = APIPayload<null>;
+/**
+ * `DELETE /v1/objects` — up to 1000 objects per call, by `ids` or by folder `prefix` (send one of them).
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete-many
+ */
+type RESTDeleteAPIBlobObjectsBody = {
+    ids: SnowFlake[];
+    prefix?: never;
+} | {
+    prefix: string;
+    ids?: never;
+};
+type RESTDeleteAPIBlobObjectsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete-many
+ */
+type RESTDeleteAPIBlobObjectsResponse = APIPayload<APIBlobDeleteResult>;
+/**
+ * `GET /v1/objects/:object_id/download` — temporary download link; it cannot be revoked. With
+ * `redirect` true (default) the response is a `302` to the link; with `false` it is `RESTGetAPIBlobObjectDownloadResponse`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/download
+ */
+interface RESTGetAPIBlobObjectDownloadQuery extends RESTAPIWorkspaceQuery {
+    /** Seconds, 60–86400. Default 3600. */
+    expires_in?: number;
+    disposition?: BlobContentDisposition;
+    filename?: string;
+    redirect?: boolean;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/download
+ */
+type RESTGetAPIBlobObjectDownloadResponse = APIPayload<APIBlobDownload>;
+/**
+ * `POST /v1/shares` — responds `201`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/create
+ */
+interface RESTPostAPIBlobShareBody {
+    object_id: SnowFlake;
+    /** Seconds, 60 to 30 days. Default 24 hours. */
+    expires_in?: number;
+    /** 1–10000. */
+    max_downloads?: number;
+    /** 8–128 characters; plan-dependent. */
+    password?: string;
+}
+type RESTPostAPIBlobShareQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/create
+ */
+type RESTPostAPIBlobShareResponse = APIPayload<APIBlobShare>;
+/**
+ * `GET /v1/shares`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/list
+ */
+interface RESTGetAPIBlobSharesQuery extends RESTAPIWorkspaceQuery {
+    object_id?: SnowFlake;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/list
+ */
+type RESTGetAPIBlobSharesResponse = APIPayload<APIBlobShare[]>;
+/** `DELETE /v1/shares/:share_id` — revokes the share. */
+type RESTDeleteAPIBlobShareQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/revoke
+ */
+type RESTDeleteAPIBlobShareResponse = APIPayload<null>;
+/** `GET /v1/shares/public/:token` — no authentication; used by the share page. `BLOB_SHARE_NOT_FOUND` / `BLOB_SHARE_EXHAUSTED`. */
+type RESTGetAPIBlobSharePublicResponse = APIPayload<APIBlobSharePublic>;
+/** `POST /v1/shares/public/:token/download` — no authentication. Counts one download and returns a temporary link. A wrong password returns `BLOB_SHARE_PASSWORD_INVALID` (rate limited). */
+interface RESTPostAPIBlobSharePublicDownloadBody {
+    password?: string;
+}
+type RESTPostAPIBlobSharePublicDownloadResponse = APIPayload<APIBlobDownload>;
+/** Rule fields a client sends; `prefix` and `created_at` are not part of the body, `active_from` is set by the platform. */
+type RESTBlobRuleInput = Omit<APIBlobRule, "prefix" | "created_at" | "active_from">;
+/** `GET /v1/rules`. */
+type RESTGetAPIBlobRulesQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/get
+ */
+type RESTGetAPIBlobRulesResponse = APIPayload<APIBlobRules>;
+/**
+ * `PUT /v1/rules` — replaces the whole list. Requires the `If-Match` header with the `etag` of the list you read. Returns the saved list and its new `etag`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace
+ */
+interface RESTPutAPIBlobRulesBody {
+    rules: (RESTBlobRuleInput & {
+        prefix: string;
+    })[];
+}
+type RESTPutAPIBlobRulesQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace
+ */
+interface RESTPutAPIBlobRulesHeaders {
+    "If-Match": string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace
+ */
+type RESTPutAPIBlobRulesResponse = APIPayload<APIBlobRules>;
+/**
+ * `PUT /v1/rules/:prefix` — creates or changes one rule (URL-encode the prefix). Returns the whole list and its new `etag`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/put
+ */
+type RESTPutAPIBlobRuleBody = RESTBlobRuleInput;
+type RESTPutAPIBlobRuleQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/put
+ */
+type RESTPutAPIBlobRuleResponse = APIPayload<APIBlobRules>;
+/** `DELETE /v1/rules/:prefix` (URL-encode the prefix). Returns the remaining list and its new `etag`. */
+type RESTDeleteAPIBlobRuleQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/delete
+ */
+type RESTDeleteAPIBlobRuleResponse = APIPayload<APIBlobRules>;
+/** `GET /v1/stats`. */
+type RESTGetAPIBlobStatsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/stats
+ */
+type RESTGetAPIBlobStatsResponse = APIPayload<APIBlobStats>;
+/**
+ * `POST /v1/upload-tokens` — creates a token that fixes every constraint below. Send `path` (one
+ * file) or `prefix` (any file under a folder, random suffix forced). It stops working when the
+ * API key that created it is revoked.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/upload-tokens
+ */
+interface RESTPostAPIBlobUploadTokenBody {
+    path?: string;
+    prefix?: string;
+    visibility?: BlobVisibility;
+    max_size?: number;
+    /** 1–20 extensions, lowercase, without the dot. */
+    allowed_extensions?: string[];
+    cache_control?: string;
+    content_disposition?: BlobContentDisposition;
+    expires_at?: ISODateString;
+    metadata?: Record<string, string>;
+    /**
+     * Allow the token to replace an existing object. Default `false`: a token without `overwrite: true`
+     * never replaces an object, even if the upload asks for `overwrite`.
+     */
+    overwrite?: boolean;
+    /** Seconds the token stays valid, 60–3600. Default 900. */
+    expires_in?: number;
+    /** 1–100. Default 1. */
+    max_uses?: number;
+}
+type RESTPostAPIBlobUploadTokenQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/upload-tokens
+ */
+type RESTPostAPIBlobUploadTokenResponse = APIPayload<APIBlobUploadToken>;
+/** `GET /v1/s3/credentials` — read-only access when the API key only has `blob:read`. Limited to 10 calls per hour. */
+type RESTGetAPIBlobS3CredentialsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/s3-credentials
+ */
+type RESTGetAPIBlobS3CredentialsResponse = APIPayload<APIBlobS3Credentials>;
+/** `GET /v1/domains`. */
+type RESTGetAPIBlobDomainsQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/list
+ */
+type RESTGetAPIBlobDomainsResponse = APIPayload<APIBlobCustomDomain[]>;
+/**
+ * `POST /v1/domains` — responds `201`. Plan-dependent.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/add
+ */
+interface RESTPostAPIBlobDomainBody {
+    hostname: string;
+    prefix?: string;
+    /** Defaults to `false`. See {@link APIBlobCustomDomain.web_content}. */
+    web_content?: boolean;
+}
+type RESTPostAPIBlobDomainQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/add
+ */
+type RESTPostAPIBlobDomainResponse = APIPayload<APIBlobCustomDomain>;
+/** `POST /v1/domains/:domain_id/verify` — checks the ownership record, the CNAME and the certificate again. */
+type RESTPostAPIBlobDomainVerifyQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/verify
+ */
+type RESTPostAPIBlobDomainVerifyResponse = APIPayload<APIBlobCustomDomain>;
+/** `PATCH /v1/domains/:domain_id`. */
+interface RESTPatchAPIBlobDomainBody {
+    /** See {@link APIBlobCustomDomain.web_content}. Takes effect within about a minute. */
+    web_content?: boolean;
+}
+type RESTPatchAPIBlobDomainQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/update
+ */
+type RESTPatchAPIBlobDomainResponse = APIPayload<APIBlobCustomDomain>;
+/** `DELETE /v1/domains/:domain_id`. */
+type RESTDeleteAPIBlobDomainQuery = RESTAPIWorkspaceQuery;
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/delete
+ */
+type RESTDeleteAPIBlobDomainResponse = APIPayload<null>;
+
+export type { RESTBlobObjectWriteOptions, RESTBlobRuleInput, RESTDeleteAPIBlobDomainQuery, RESTDeleteAPIBlobDomainResponse, RESTDeleteAPIBlobObjectQuery, RESTDeleteAPIBlobObjectResponse, RESTDeleteAPIBlobObjectsBody, RESTDeleteAPIBlobObjectsQuery, RESTDeleteAPIBlobObjectsResponse, RESTDeleteAPIBlobRuleQuery, RESTDeleteAPIBlobRuleResponse, RESTDeleteAPIBlobShareQuery, RESTDeleteAPIBlobShareResponse, RESTDeleteAPIBlobUploadQuery, RESTDeleteAPIBlobUploadResponse, RESTGetAPIBlobDomainsQuery, RESTGetAPIBlobDomainsResponse, RESTGetAPIBlobObjectDownloadQuery, RESTGetAPIBlobObjectDownloadResponse, RESTGetAPIBlobObjectQuery, RESTGetAPIBlobObjectResponse, RESTGetAPIBlobObjectsQuery, RESTGetAPIBlobObjectsResponse, RESTGetAPIBlobRulesQuery, RESTGetAPIBlobRulesResponse, RESTGetAPIBlobS3CredentialsQuery, RESTGetAPIBlobS3CredentialsResponse, RESTGetAPIBlobSharePublicResponse, RESTGetAPIBlobSharesQuery, RESTGetAPIBlobSharesResponse, RESTGetAPIBlobStatsQuery, RESTGetAPIBlobStatsResponse, RESTGetAPIBlobUploadQuery, RESTGetAPIBlobUploadResponse, RESTGetAPIBlobUploadsQuery, RESTGetAPIBlobUploadsResponse, RESTPatchAPIBlobDomainBody, RESTPatchAPIBlobDomainQuery, RESTPatchAPIBlobDomainResponse, RESTPatchAPIBlobObjectBody, RESTPatchAPIBlobObjectQuery, RESTPatchAPIBlobObjectResponse, RESTPatchAPIBlobObjectsBody, RESTPatchAPIBlobObjectsQuery, RESTPatchAPIBlobObjectsResponse, RESTPostAPIBlobDomainBody, RESTPostAPIBlobDomainQuery, RESTPostAPIBlobDomainResponse, RESTPostAPIBlobDomainVerifyQuery, RESTPostAPIBlobDomainVerifyResponse, RESTPostAPIBlobObjectCopyBody, RESTPostAPIBlobObjectCopyQuery, RESTPostAPIBlobObjectCopyResponse, RESTPostAPIBlobObjectQuery, RESTPostAPIBlobObjectResponse, RESTPostAPIBlobShareBody, RESTPostAPIBlobSharePublicDownloadBody, RESTPostAPIBlobSharePublicDownloadResponse, RESTPostAPIBlobShareQuery, RESTPostAPIBlobShareResponse, RESTPostAPIBlobUploadBody, RESTPostAPIBlobUploadCompleteQuery, RESTPostAPIBlobUploadCompleteResponse, RESTPostAPIBlobUploadPartsBody, RESTPostAPIBlobUploadPartsQuery, RESTPostAPIBlobUploadPartsResponse, RESTPostAPIBlobUploadQuery, RESTPostAPIBlobUploadResponse, RESTPostAPIBlobUploadTokenBody, RESTPostAPIBlobUploadTokenQuery, RESTPostAPIBlobUploadTokenResponse, RESTPutAPIBlobRuleBody, RESTPutAPIBlobRuleQuery, RESTPutAPIBlobRuleResponse, RESTPutAPIBlobRulesBody, RESTPutAPIBlobRulesHeaders, RESTPutAPIBlobRulesQuery, RESTPutAPIBlobRulesResponse };

package/rest/v1/blob.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// rest/v1/blob.ts
+var blob_exports = {};
+module.exports = __toCommonJS(blob_exports);
+//# sourceMappingURL=blob.js.map

package/rest/v1/blob.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["blob.ts"],"sourcesContent":["import type {\n\tAPIBlobBatchResult,\n\tAPIBlobCustomDomain,\n\tAPIBlobDeleteResult,\n\tAPIBlobDownload,\n\tAPIBlobObject,\n\tAPIBlobObjectList,\n\tAPIBlobRule,\n\tAPIBlobRules,\n\tAPIBlobS3Credentials,\n\tAPIBlobShare,\n\tAPIBlobSharePublic,\n\tAPIBlobStats,\n\tAPIBlobUpload,\n\tAPIBlobUploadPart,\n\tAPIBlobUploadToken,\n\tAPIPayload,\n\tBlobContentDisposition,\n\tBlobVisibility,\n\tISODateString,\n\tRESTAPIWorkspaceQuery,\n\tSnowFlake,\n} from \"../../v1\";\n\n// Blob Storage routes are served at `https://blob.vertracloud.app/v1/...`. Every route accepts\n// `workspace_id` (query) to act on the blob of a workspace owner. Authenticate with a dashboard\n// session, an API key (`blob:read` / `blob:write`) or, on the upload routes only, an upload token.\n\n/**\n * Options shared by both ways of uploading. Defaults: `visibility: \"private\"`, `overwrite: false`,\n * `random_suffix: false` (always `true` for an upload token without a fixed `path`).\n */\nexport interface RESTBlobObjectWriteOptions {\n\tvisibility?: BlobVisibility;\n\t/** Replace an existing object at `path`. Without it a taken path returns `BLOB_OBJECT_ALREADY_EXISTS`. */\n\toverwrite?: boolean;\n\t/** Insert `-<10 random characters>` before the extension. */\n\trandom_suffix?: boolean;\n\t/**\n\t * When `path` is taken, save as `name-1.ext`, `name-2.ext`, … (the first free one) instead of returning\n\t * `BLOB_OBJECT_ALREADY_EXISTS`. The object comes back with the final `path`. Cannot be combined with `overwrite`.\n\t */\n\trename_on_conflict?: boolean;\n\tcache_control?: string;\n\tcontent_disposition?: BlobContentDisposition;\n\tfilename?: string;\n\texpires_at?: ISODateString;\n\t/**\n\t * Hex SHA-256 of the file; a mismatch returns `BLOB_CHECKSUM_MISMATCH`. Only valid for the\n\t * single-request upload and for a direct upload sent in one part: a multipart upload refuses it\n\t * (`VALIDATION_ERROR`), because a SHA-256 of the whole object cannot be verified from separate parts.\n\t */\n\tchecksum_sha256?: string;\n}\n\n// ---------------------------------------------------------------------------\n// Upload\n// ---------------------------------------------------------------------------\n\n/**\n * `POST /v1/objects` — single-request upload (up to the plan's `max_simple_upload_bytes`). The\n * body is `multipart/form-data` with one `file` field; options go in the query. Accepts an upload token.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/upload\n */\nexport interface RESTPostAPIBlobObjectQuery extends RESTAPIWorkspaceQuery, RESTBlobObjectWriteOptions {\n\tpath: string;\n\t/** JSON object, URL-encoded. */\n\tmetadata?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/upload\n */\nexport type RESTPostAPIBlobObjectResponse = APIPayload<APIBlobObject>;\n\n/**\n * `POST /v1/uploads` — starts a direct upload (single or multipart, chosen by `size`). Accepts an upload token.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/create\n */\nexport interface RESTPostAPIBlobUploadBody extends RESTBlobObjectWriteOptions {\n\tpath: string;\n\tsize: number;\n\tmetadata?: Record<string, string>;\n}\nexport type RESTPostAPIBlobUploadQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/create\n */\nexport type RESTPostAPIBlobUploadResponse = APIPayload<APIBlobUpload>;\n\n/** `GET /v1/uploads` — uploads still in progress. */\nexport type RESTGetAPIBlobUploadsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/list\n */\nexport type RESTGetAPIBlobUploadsResponse = APIPayload<APIBlobUpload[]>;\n\n/** `GET /v1/uploads/:upload_id` — status of one upload, to resume it. Accepts an upload token. */\nexport type RESTGetAPIBlobUploadQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/get\n */\nexport type RESTGetAPIBlobUploadResponse = APIPayload<APIBlobUpload>;\n\n/**\n * `POST /v1/uploads/:upload_id/parts` — URLs for up to 100 parts. Accepts an upload token.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/parts\n */\nexport interface RESTPostAPIBlobUploadPartsBody {\n\tpart_numbers: number[];\n}\nexport type RESTPostAPIBlobUploadPartsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/parts\n */\nexport type RESTPostAPIBlobUploadPartsResponse = APIPayload<APIBlobUploadPart[]>;\n\n/** `POST /v1/uploads/:upload_id/complete` — checks the parts and creates the object. Accepts an upload token. */\nexport type RESTPostAPIBlobUploadCompleteQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/complete\n */\nexport type RESTPostAPIBlobUploadCompleteResponse = APIPayload<APIBlobObject>;\n\n/** `DELETE /v1/uploads/:upload_id` — aborts an upload; repeating it is not an error. Accepts an upload token. */\nexport type RESTDeleteAPIBlobUploadQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/uploads/abort\n */\nexport type RESTDeleteAPIBlobUploadResponse = APIPayload<null>;\n\n// ---------------------------------------------------------------------------\n// Objects\n// ---------------------------------------------------------------------------\n\n/**\n * `GET /v1/objects`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/list\n */\nexport interface RESTGetAPIBlobObjectsQuery extends RESTAPIWorkspaceQuery {\n\tprefix?: string;\n\t/** Group paths into folders at `/`. Omit it for a flat list. */\n\tdelimiter?: \"/\";\n\tvisibility?: BlobVisibility;\n\tcursor?: string;\n\t/** 1–1000. Default 100. */\n\tlimit?: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/list\n */\nexport type RESTGetAPIBlobObjectsResponse = APIPayload<APIBlobObjectList>;\n\n/** `GET /v1/objects/:object_id`. */\nexport type RESTGetAPIBlobObjectQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/get\n */\nexport type RESTGetAPIBlobObjectResponse = APIPayload<APIBlobObject>;\n\n/**\n * Fields of an object that can change. `null` restores the default; a `null` metadata value removes that key.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update\n */\nexport interface RESTPatchAPIBlobObjectBody {\n\tvisibility?: BlobVisibility;\n\tcache_control?: string | null;\n\tcontent_disposition?: BlobContentDisposition | null;\n\tfilename?: string | null;\n\texpires_at?: ISODateString | null;\n\tmetadata?: Record<string, string | null>;\n}\n\n/** `PATCH /v1/objects/:object_id`. */\nexport type RESTPatchAPIBlobObjectQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update\n */\nexport type RESTPatchAPIBlobObjectResponse = APIPayload<APIBlobObject>;\n\n/**\n * `PATCH /v1/objects` — applies the same changes to up to 100 objects.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update-many\n */\nexport interface RESTPatchAPIBlobObjectsBody {\n\tids: SnowFlake[];\n\tchanges: RESTPatchAPIBlobObjectBody;\n}\nexport type RESTPatchAPIBlobObjectsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/update-many\n */\nexport type RESTPatchAPIBlobObjectsResponse = APIPayload<APIBlobBatchResult[]>;\n\n/**\n * `POST /v1/objects/copy` — copies or moves an object. A move keeps the `id`; a copy creates\n * another object that counts toward storage.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/copy\n */\nexport interface RESTPostAPIBlobObjectCopyBody {\n\tsource: SnowFlake;\n\tpath: string;\n\tmove?: boolean;\n\toverwrite?: boolean;\n\trandom_suffix?: boolean;\n\tvisibility?: BlobVisibility;\n}\nexport type RESTPostAPIBlobObjectCopyQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/copy\n */\nexport type RESTPostAPIBlobObjectCopyResponse = APIPayload<APIBlobObject>;\n\n/** `DELETE /v1/objects/:object_id`. */\nexport type RESTDeleteAPIBlobObjectQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete\n */\nexport type RESTDeleteAPIBlobObjectResponse = APIPayload<null>;\n\n/**\n * `DELETE /v1/objects` — up to 1000 objects per call, by `ids` or by folder `prefix` (send one of them).\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete-many\n */\nexport type RESTDeleteAPIBlobObjectsBody = { ids: SnowFlake[]; prefix?: never } | { prefix: string; ids?: never };\nexport type RESTDeleteAPIBlobObjectsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/delete-many\n */\nexport type RESTDeleteAPIBlobObjectsResponse = APIPayload<APIBlobDeleteResult>;\n\n/**\n * `GET /v1/objects/:object_id/download` — temporary download link; it cannot be revoked. With\n * `redirect` true (default) the response is a `302` to the link; with `false` it is `RESTGetAPIBlobObjectDownloadResponse`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/download\n */\nexport interface RESTGetAPIBlobObjectDownloadQuery extends RESTAPIWorkspaceQuery {\n\t/** Seconds, 60–86400. Default 3600. */\n\texpires_in?: number;\n\tdisposition?: BlobContentDisposition;\n\tfilename?: string;\n\tredirect?: boolean;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/objects/download\n */\nexport type RESTGetAPIBlobObjectDownloadResponse = APIPayload<APIBlobDownload>;\n\n// ---------------------------------------------------------------------------\n// Shares\n// ---------------------------------------------------------------------------\n\n/**\n * `POST /v1/shares` — responds `201`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/create\n */\nexport interface RESTPostAPIBlobShareBody {\n\tobject_id: SnowFlake;\n\t/** Seconds, 60 to 30 days. Default 24 hours. */\n\texpires_in?: number;\n\t/** 1–10000. */\n\tmax_downloads?: number;\n\t/** 8–128 characters; plan-dependent. */\n\tpassword?: string;\n}\nexport type RESTPostAPIBlobShareQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/create\n */\nexport type RESTPostAPIBlobShareResponse = APIPayload<APIBlobShare>;\n\n/**\n * `GET /v1/shares`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/list\n */\nexport interface RESTGetAPIBlobSharesQuery extends RESTAPIWorkspaceQuery {\n\tobject_id?: SnowFlake;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/list\n */\nexport type RESTGetAPIBlobSharesResponse = APIPayload<APIBlobShare[]>;\n\n/** `DELETE /v1/shares/:share_id` — revokes the share. */\nexport type RESTDeleteAPIBlobShareQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/shares/revoke\n */\nexport type RESTDeleteAPIBlobShareResponse = APIPayload<null>;\n\n/** `GET /v1/shares/public/:token` — no authentication; used by the share page. `BLOB_SHARE_NOT_FOUND` / `BLOB_SHARE_EXHAUSTED`. */\nexport type RESTGetAPIBlobSharePublicResponse = APIPayload<APIBlobSharePublic>;\n\n/** `POST /v1/shares/public/:token/download` — no authentication. Counts one download and returns a temporary link. A wrong password returns `BLOB_SHARE_PASSWORD_INVALID` (rate limited). */\nexport interface RESTPostAPIBlobSharePublicDownloadBody {\n\tpassword?: string;\n}\nexport type RESTPostAPIBlobSharePublicDownloadResponse = APIPayload<APIBlobDownload>;\n\n// ---------------------------------------------------------------------------\n// Folder rules\n// ---------------------------------------------------------------------------\n\n/** Rule fields a client sends; `prefix` and `created_at` are not part of the body, `active_from` is set by the platform. */\nexport type RESTBlobRuleInput = Omit<APIBlobRule, \"prefix\" | \"created_at\" | \"active_from\">;\n\n/** `GET /v1/rules`. */\nexport type RESTGetAPIBlobRulesQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/get\n */\nexport type RESTGetAPIBlobRulesResponse = APIPayload<APIBlobRules>;\n\n/**\n * `PUT /v1/rules` — replaces the whole list. Requires the `If-Match` header with the `etag` of the list you read. Returns the saved list and its new `etag`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace\n */\nexport interface RESTPutAPIBlobRulesBody {\n\trules: (RESTBlobRuleInput & { prefix: string })[];\n}\nexport type RESTPutAPIBlobRulesQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace\n */\nexport interface RESTPutAPIBlobRulesHeaders {\n\t\"If-Match\": string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/replace\n */\nexport type RESTPutAPIBlobRulesResponse = APIPayload<APIBlobRules>;\n\n/**\n * `PUT /v1/rules/:prefix` — creates or changes one rule (URL-encode the prefix). Returns the whole list and its new `etag`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/put\n */\nexport type RESTPutAPIBlobRuleBody = RESTBlobRuleInput;\nexport type RESTPutAPIBlobRuleQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/put\n */\nexport type RESTPutAPIBlobRuleResponse = APIPayload<APIBlobRules>;\n\n/** `DELETE /v1/rules/:prefix` (URL-encode the prefix). Returns the remaining list and its new `etag`. */\nexport type RESTDeleteAPIBlobRuleQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/rules/delete\n */\nexport type RESTDeleteAPIBlobRuleResponse = APIPayload<APIBlobRules>;\n\n// ---------------------------------------------------------------------------\n// Account, upload tokens, S3 and custom domains\n// ---------------------------------------------------------------------------\n\n/** `GET /v1/stats`. */\nexport type RESTGetAPIBlobStatsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/stats\n */\nexport type RESTGetAPIBlobStatsResponse = APIPayload<APIBlobStats>;\n\n/**\n * `POST /v1/upload-tokens` — creates a token that fixes every constraint below. Send `path` (one\n * file) or `prefix` (any file under a folder, random suffix forced). It stops working when the\n * API key that created it is revoked.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/upload-tokens\n */\nexport interface RESTPostAPIBlobUploadTokenBody {\n\tpath?: string;\n\tprefix?: string;\n\tvisibility?: BlobVisibility;\n\tmax_size?: number;\n\t/** 1–20 extensions, lowercase, without the dot. */\n\tallowed_extensions?: string[];\n\tcache_control?: string;\n\tcontent_disposition?: BlobContentDisposition;\n\texpires_at?: ISODateString;\n\tmetadata?: Record<string, string>;\n\t/**\n\t * Allow the token to replace an existing object. Default `false`: a token without `overwrite: true`\n\t * never replaces an object, even if the upload asks for `overwrite`.\n\t */\n\toverwrite?: boolean;\n\t/** Seconds the token stays valid, 60–3600. Default 900. */\n\texpires_in?: number;\n\t/** 1–100. Default 1. */\n\tmax_uses?: number;\n}\nexport type RESTPostAPIBlobUploadTokenQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/upload-tokens\n */\nexport type RESTPostAPIBlobUploadTokenResponse = APIPayload<APIBlobUploadToken>;\n\n/** `GET /v1/s3/credentials` — read-only access when the API key only has `blob:read`. Limited to 10 calls per hour. */\nexport type RESTGetAPIBlobS3CredentialsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/account/s3-credentials\n */\nexport type RESTGetAPIBlobS3CredentialsResponse = APIPayload<APIBlobS3Credentials>;\n\n/** `GET /v1/domains`. */\nexport type RESTGetAPIBlobDomainsQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/list\n */\nexport type RESTGetAPIBlobDomainsResponse = APIPayload<APIBlobCustomDomain[]>;\n\n/**\n * `POST /v1/domains` — responds `201`. Plan-dependent.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/add\n */\nexport interface RESTPostAPIBlobDomainBody {\n\thostname: string;\n\tprefix?: string;\n\t/** Defaults to `false`. See {@link APIBlobCustomDomain.web_content}. */\n\tweb_content?: boolean;\n}\nexport type RESTPostAPIBlobDomainQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/add\n */\nexport type RESTPostAPIBlobDomainResponse = APIPayload<APIBlobCustomDomain>;\n\n/** `POST /v1/domains/:domain_id/verify` — checks the ownership record, the CNAME and the certificate again. */\nexport type RESTPostAPIBlobDomainVerifyQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/verify\n */\nexport type RESTPostAPIBlobDomainVerifyResponse = APIPayload<APIBlobCustomDomain>;\n\n/** `PATCH /v1/domains/:domain_id`. */\nexport interface RESTPatchAPIBlobDomainBody {\n\t/** See {@link APIBlobCustomDomain.web_content}. Takes effect within about a minute. */\n\tweb_content?: boolean;\n}\nexport type RESTPatchAPIBlobDomainQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/update\n */\nexport type RESTPatchAPIBlobDomainResponse = APIPayload<APIBlobCustomDomain>;\n\n/** `DELETE /v1/domains/:domain_id`. */\nexport type RESTDeleteAPIBlobDomainQuery = RESTAPIWorkspaceQuery;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/blob/domains/delete\n */\nexport type RESTDeleteAPIBlobDomainResponse = APIPayload<null>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/blob.mjs

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

package/rest/v1/index.d.ts

@@ -2,6 +2,7 @@ export { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse } from './activ
 export { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse } from './api-key.js';
 export { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationReleaseLogResponse, RESTGetAPIApplicationReleasesQuery, RESTGetAPIApplicationReleasesResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRollbackPreviewResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationRollbackBody, RESTPostAPIApplicationRollbackResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse } from './application.js';
 export { RESTDeleteAPIBillingCardResponse, RESTGetAPIBillingCardsResponse, RESTGetAPIBillingDetailsResponse, RESTGetAPIBillingRenewalResponse, RESTPatchAPIBillingRenewalBody, RESTPatchAPIBillingRenewalResponse, RESTPostAPIBillingCardDefaultResponse, RESTPostAPIBillingCardSetupResponse, RESTPutAPIBillingDetailsBody, RESTPutAPIBillingDetailsResponse } from './billing.js';
+export { RESTBlobObjectWriteOptions, RESTBlobRuleInput, RESTDeleteAPIBlobDomainQuery, RESTDeleteAPIBlobDomainResponse, RESTDeleteAPIBlobObjectQuery, RESTDeleteAPIBlobObjectResponse, RESTDeleteAPIBlobObjectsBody, RESTDeleteAPIBlobObjectsQuery, RESTDeleteAPIBlobObjectsResponse, RESTDeleteAPIBlobRuleQuery, RESTDeleteAPIBlobRuleResponse, RESTDeleteAPIBlobShareQuery, RESTDeleteAPIBlobShareResponse, RESTDeleteAPIBlobUploadQuery, RESTDeleteAPIBlobUploadResponse, RESTGetAPIBlobDomainsQuery, RESTGetAPIBlobDomainsResponse, RESTGetAPIBlobObjectDownloadQuery, RESTGetAPIBlobObjectDownloadResponse, RESTGetAPIBlobObjectQuery, RESTGetAPIBlobObjectResponse, RESTGetAPIBlobObjectsQuery, RESTGetAPIBlobObjectsResponse, RESTGetAPIBlobRulesQuery, RESTGetAPIBlobRulesResponse, RESTGetAPIBlobS3CredentialsQuery, RESTGetAPIBlobS3CredentialsResponse, RESTGetAPIBlobSharePublicResponse, RESTGetAPIBlobSharesQuery, RESTGetAPIBlobSharesResponse, RESTGetAPIBlobStatsQuery, RESTGetAPIBlobStatsResponse, RESTGetAPIBlobUploadQuery, RESTGetAPIBlobUploadResponse, RESTGetAPIBlobUploadsQuery, RESTGetAPIBlobUploadsResponse, RESTPatchAPIBlobDomainBody, RESTPatchAPIBlobDomainQuery, RESTPatchAPIBlobDomainResponse, RESTPatchAPIBlobObjectBody, RESTPatchAPIBlobObjectQuery, RESTPatchAPIBlobObjectResponse, RESTPatchAPIBlobObjectsBody, RESTPatchAPIBlobObjectsQuery, RESTPatchAPIBlobObjectsResponse, RESTPostAPIBlobDomainBody, RESTPostAPIBlobDomainQuery, RESTPostAPIBlobDomainResponse, RESTPostAPIBlobDomainVerifyQuery, RESTPostAPIBlobDomainVerifyResponse, RESTPostAPIBlobObjectCopyBody, RESTPostAPIBlobObjectCopyQuery, RESTPostAPIBlobObjectCopyResponse, RESTPostAPIBlobObjectQuery, RESTPostAPIBlobObjectResponse, RESTPostAPIBlobShareBody, RESTPostAPIBlobSharePublicDownloadBody, RESTPostAPIBlobSharePublicDownloadResponse, RESTPostAPIBlobShareQuery, RESTPostAPIBlobShareResponse, RESTPostAPIBlobUploadBody, RESTPostAPIBlobUploadCompleteQuery, RESTPostAPIBlobUploadCompleteResponse, RESTPostAPIBlobUploadPartsBody, RESTPostAPIBlobUploadPartsQuery, RESTPostAPIBlobUploadPartsResponse, RESTPostAPIBlobUploadQuery, RESTPostAPIBlobUploadResponse, RESTPostAPIBlobUploadTokenBody, RESTPostAPIBlobUploadTokenQuery, RESTPostAPIBlobUploadTokenResponse, RESTPutAPIBlobRuleBody, RESTPutAPIBlobRuleQuery, RESTPutAPIBlobRuleResponse, RESTPutAPIBlobRulesBody, RESTPutAPIBlobRulesHeaders, RESTPutAPIBlobRulesQuery, RESTPutAPIBlobRulesResponse } from './blob.js';
 export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse } from './database.js';
 export { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody } from './database-data.js';
 export { RESTGetAPINotificationsResponse } from './notification.js';
@@ -19,6 +20,7 @@ import '../../payloads/v1/notification.js';
 import '../../payloads/v1/api-key.js';
 import '../../payloads/v1/application.js';
 import '../../payloads/v1/billing.js';
+import '../../payloads/v1/blob.js';
 import '../../payloads/v1/database.js';
 import '../../payloads/v1/database-data.js';
 import '../../payloads/v1/oauth.js';

package/rest/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./api-key\";\nexport * from \"./application\";\nexport * from \"./billing\";\nexport * from \"./database\";\nexport * from \"./database-data\";\nexport * from \"./notification\";\nexport * from \"./oauth\";\nexport * from \"./orders\";\nexport * from \"./redeem\";\nexport * from \"./snapshot\";\nexport * from \"./status\";\nexport * from \"./user\";\nexport * from \"./workspace\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./api-key\";\nexport * from \"./application\";\nexport * from \"./billing\";\nexport * from \"./blob\";\nexport * from \"./database\";\nexport * from \"./database-data\";\nexport * from \"./notification\";\nexport * from \"./oauth\";\nexport * from \"./orders\";\nexport * from \"./redeem\";\nexport * from \"./snapshot\";\nexport * from \"./status\";\nexport * from \"./user\";\nexport * from \"./workspace\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/v1.d.ts

@@ -4,6 +4,7 @@ export { APIApiKey, APIApiKeyCreated, APIApiKeyPreset, APIApiKeyRoute, APIApiKey
 export { APIErrorCode, API_ERROR_CODES } from './payloads/v1/api-error.js';
 export { APIApplication, APIApplicationConfig, APIApplicationCustomDomain, APIApplicationDeploySettings, APIApplicationDeployment, APIApplicationDnsRecord, APIApplicationEnvironment, APIApplicationFile, APIApplicationFileContent, APIApplicationFileTree, APIApplicationFileUpload, APIApplicationGithub, APIApplicationMetric, APIApplicationNetwork, APIApplicationOperationResponse, APIApplicationRealtimeEvent, APIApplicationRelease, APIApplicationReleaseLog, APIApplicationRollbackPreview, APIApplicationRuntime, APIApplicationRuntimes, APIApplicationScanSuggestions, APIApplicationShieldCooldown, APIApplicationStatus, APIApplicationStatusShort, APIApplicationSubdomain, APIApplicationWebPublish, APIApplicationWebhook, APIApplicationWebhookUrl, ApplicationCluster, ApplicationDnsRecordStatus, ApplicationDnsRecordType, ApplicationEnvironmentChange, ApplicationFileContentType, ApplicationFileType, ApplicationLanguage, ApplicationRealtimeEventType, ApplicationReleaseSource, ApplicationReleaseStatus, ApplicationStatus, ApplicationType, ApplicationVersion, ApplicationZeroDowntime, ShieldIncidentDirection, ShieldIncidentReason } from './payloads/v1/application.js';
 export { APIBillingAddress, APIBillingCard, APIBillingDetails, APIBillingRenewal, APIBillingTaxId, BillingTaxIdType } from './payloads/v1/billing.js';
+export { APIBlobBatchResult, APIBlobCustomDomain, APIBlobDeleteResult, APIBlobDownload, APIBlobLimits, APIBlobObject, APIBlobObjectList, APIBlobRule, APIBlobRules, APIBlobS3Credentials, APIBlobShare, APIBlobSharePublic, APIBlobStats, APIBlobUpload, APIBlobUploadPart, APIBlobUploadToken, BlobContentDisposition, BlobCustomDomainStatus, BlobUploadMode, BlobUploadStatus, BlobVisibility } from './payloads/v1/blob.js';
 export { APIDatabase, APIDatabaseCertificate, APIDatabaseMetrics, APIDatabaseNetwork, APIDatabaseOperationResponse, APIDatabasePasswordReset, APIDatabaseStatus, APIDatabaseStatusShort, DatabaseCluster, DatabaseStatus, DatabaseType } from './payloads/v1/database.js';
 export { APIDatabaseCollection, APIDatabaseColumn, APIDatabaseColumnReference, APIDatabaseDataError, APIDatabaseDataOverview, APIDatabaseDocumentListParams, APIDatabaseDocumentsPage, APIDatabaseIndex, APIDatabaseListParams, APIDatabaseMongoIndex, APIDatabaseQueryResult, APIDatabaseRedisInfo, APIDatabaseRedisKey, APIDatabaseRedisKeyValue, APIDatabaseRedisKeysPage, APIDatabaseRedisScanParams, APIDatabaseRedisZSetMember, APIDatabaseRowFilter, APIDatabaseRowsPage, APIDatabaseSchema, APIDatabaseTable, DatabaseFilterOperator, DatabaseRedisKeyType, DatabaseSortDirection, DatabaseTableKind } from './payloads/v1/database-data.js';
 export { APINotification, LocalizedContent, NotificationImportance, NotificationType } from './payloads/v1/notification.js';
@@ -18,6 +19,7 @@ export { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse } from './rest/
 export { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse } from './rest/v1/api-key.js';
 export { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationReleaseLogResponse, RESTGetAPIApplicationReleasesQuery, RESTGetAPIApplicationReleasesResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRollbackPreviewResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationRollbackBody, RESTPostAPIApplicationRollbackResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse } from './rest/v1/application.js';
 export { RESTDeleteAPIBillingCardResponse, RESTGetAPIBillingCardsResponse, RESTGetAPIBillingDetailsResponse, RESTGetAPIBillingRenewalResponse, RESTPatchAPIBillingRenewalBody, RESTPatchAPIBillingRenewalResponse, RESTPostAPIBillingCardDefaultResponse, RESTPostAPIBillingCardSetupResponse, RESTPutAPIBillingDetailsBody, RESTPutAPIBillingDetailsResponse } from './rest/v1/billing.js';
+export { RESTBlobObjectWriteOptions, RESTBlobRuleInput, RESTDeleteAPIBlobDomainQuery, RESTDeleteAPIBlobDomainResponse, RESTDeleteAPIBlobObjectQuery, RESTDeleteAPIBlobObjectResponse, RESTDeleteAPIBlobObjectsBody, RESTDeleteAPIBlobObjectsQuery, RESTDeleteAPIBlobObjectsResponse, RESTDeleteAPIBlobRuleQuery, RESTDeleteAPIBlobRuleResponse, RESTDeleteAPIBlobShareQuery, RESTDeleteAPIBlobShareResponse, RESTDeleteAPIBlobUploadQuery, RESTDeleteAPIBlobUploadResponse, RESTGetAPIBlobDomainsQuery, RESTGetAPIBlobDomainsResponse, RESTGetAPIBlobObjectDownloadQuery, RESTGetAPIBlobObjectDownloadResponse, RESTGetAPIBlobObjectQuery, RESTGetAPIBlobObjectResponse, RESTGetAPIBlobObjectsQuery, RESTGetAPIBlobObjectsResponse, RESTGetAPIBlobRulesQuery, RESTGetAPIBlobRulesResponse, RESTGetAPIBlobS3CredentialsQuery, RESTGetAPIBlobS3CredentialsResponse, RESTGetAPIBlobSharePublicResponse, RESTGetAPIBlobSharesQuery, RESTGetAPIBlobSharesResponse, RESTGetAPIBlobStatsQuery, RESTGetAPIBlobStatsResponse, RESTGetAPIBlobUploadQuery, RESTGetAPIBlobUploadResponse, RESTGetAPIBlobUploadsQuery, RESTGetAPIBlobUploadsResponse, RESTPatchAPIBlobDomainBody, RESTPatchAPIBlobDomainQuery, RESTPatchAPIBlobDomainResponse, RESTPatchAPIBlobObjectBody, RESTPatchAPIBlobObjectQuery, RESTPatchAPIBlobObjectResponse, RESTPatchAPIBlobObjectsBody, RESTPatchAPIBlobObjectsQuery, RESTPatchAPIBlobObjectsResponse, RESTPostAPIBlobDomainBody, RESTPostAPIBlobDomainQuery, RESTPostAPIBlobDomainResponse, RESTPostAPIBlobDomainVerifyQuery, RESTPostAPIBlobDomainVerifyResponse, RESTPostAPIBlobObjectCopyBody, RESTPostAPIBlobObjectCopyQuery, RESTPostAPIBlobObjectCopyResponse, RESTPostAPIBlobObjectQuery, RESTPostAPIBlobObjectResponse, RESTPostAPIBlobShareBody, RESTPostAPIBlobSharePublicDownloadBody, RESTPostAPIBlobSharePublicDownloadResponse, RESTPostAPIBlobShareQuery, RESTPostAPIBlobShareResponse, RESTPostAPIBlobUploadBody, RESTPostAPIBlobUploadCompleteQuery, RESTPostAPIBlobUploadCompleteResponse, RESTPostAPIBlobUploadPartsBody, RESTPostAPIBlobUploadPartsQuery, RESTPostAPIBlobUploadPartsResponse, RESTPostAPIBlobUploadQuery, RESTPostAPIBlobUploadResponse, RESTPostAPIBlobUploadTokenBody, RESTPostAPIBlobUploadTokenQuery, RESTPostAPIBlobUploadTokenResponse, RESTPutAPIBlobRuleBody, RESTPutAPIBlobRuleQuery, RESTPutAPIBlobRuleResponse, RESTPutAPIBlobRulesBody, RESTPutAPIBlobRulesHeaders, RESTPutAPIBlobRulesQuery, RESTPutAPIBlobRulesResponse } from './rest/v1/blob.js';
 export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse } from './rest/v1/database.js';
 export { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody } from './rest/v1/database-data.js';
 export { RESTGetAPINotificationsResponse } from './rest/v1/notification.js';