@epilot/sdk 2.16.2 → 2.17.0

package/docs/integration-toolkit.md

@@ -1011,6 +1011,7 @@ const { data } = await client.listUseCases({
       "type": "inbound",
       "enabled": true,
       "change_description": "string",
+      "changed_by": "string",
       "created_at": "1970-01-01T00:00:00.000Z",
       "updated_at": "1970-01-01T00:00:00.000Z",
       "configuration": {}
@@ -1063,6 +1064,7 @@ const { data } = await client.createUseCase(
   "type": "inbound",
   "enabled": true,
   "change_description": "string",
+  "changed_by": "string",
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z",
   "configuration": {
@@ -1105,6 +1107,7 @@ const { data } = await client.getUseCase({
   "type": "inbound",
   "enabled": true,
   "change_description": "string",
+  "changed_by": "string",
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z",
   "configuration": {
@@ -1164,6 +1167,7 @@ const { data } = await client.updateUseCase(
   "type": "inbound",
   "enabled": true,
   "change_description": "string",
+  "changed_by": "string",
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z",
   "configuration": {
@@ -1449,6 +1453,7 @@ const { data } = await client.createIntegrationV2(
       "type": "inbound",
       "enabled": true,
       "change_description": "string",
+      "changed_by": "string",
       "created_at": "1970-01-01T00:00:00.000Z",
       "updated_at": "1970-01-01T00:00:00.000Z",
       "configuration": {}
@@ -1547,6 +1552,7 @@ const { data } = await client.getIntegrationV2({
       "type": "inbound",
       "enabled": true,
       "change_description": "string",
+      "changed_by": "string",
       "created_at": "1970-01-01T00:00:00.000Z",
       "updated_at": "1970-01-01T00:00:00.000Z",
       "configuration": {}
@@ -1720,6 +1726,7 @@ const { data } = await client.updateIntegrationV2(
       "type": "inbound",
       "enabled": true,
       "change_description": "string",
+      "changed_by": "string",
       "created_at": "1970-01-01T00:00:00.000Z",
       "updated_at": "1970-01-01T00:00:00.000Z",
       "configuration": {}
@@ -1879,7 +1886,9 @@ const { data } = await client.getNotificationStatus({
 
 ### `getSecureProxyWhitelist`
 
-Get secure_proxy whitelist (admin portal only)
+Returns the current allowed_domains, allowed_ips, and vpc_mode for a secure_proxy use case.
+Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool membership.
+Rejects Login-As t
 
 `GET /v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist`
 
@@ -1907,7 +1916,9 @@ const { data } = await client.getSecureProxyWhitelist({
 
 ### `updateSecureProxyWhitelist`
 
-Update secure_proxy whitelist (admin portal only)
+Replaces allowed_domains and/or allowed_ips on a secure_proxy use case.
+At least one of the two fields is required. Validation mirrors the CLI's
+`validateDomainPatterns` / `validateCidrs`. Writes a US
 
 `PUT /v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist`
 
@@ -1941,7 +1952,9 @@ const { data } = await client.updateSecureProxyWhitelist(
 
 ### `listSecureProxyWhitelistHistory`
 
-List secure_proxy whitelist change history (admin portal only)
+Returns the most recent USECASE_HISTORY entries for a secure_proxy use case,
+in reverse chronological order (newest first). Each entry includes the
+actor email (`changed_by`), the ISO-8601 timestamp (
 
 `GET /v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history`
 
@@ -2914,7 +2927,8 @@ const { data } = await client.getMonitoringTraceByCorrelation({
 
 ### `listSecureProxies`
 
-List all secure proxy use cases
+Lists all secure_proxy use cases across all integrations for the authenticated organization.
+Returns minimal data suitable for dropdowns and selection UIs.
 
 `GET /v1/integrations/secure-proxies`
 
@@ -2949,7 +2963,9 @@ const { data } = await client.listSecureProxies()
 
 ### `secureProxy`
 
-Proxy HTTP request through secure VPC
+Routes an HTTP request through a VPC with either static IP egress or VPN secure link access.
+The VPC mode is determined by the referenced secure_proxy use case configuration.
+For secure_link mode, the
 
 `POST /v1/secure-proxy`
 
@@ -2986,7 +3002,8 @@ const { data } = await client.secureProxy(
 
 ### `managedCallExecute`
 
-Execute a managed call operation
+Execute a managed call operation synchronously. The slug in the path acts as the RPC method name.
+Calls an external partner API with JSONata mapping on both request and response.
 
 `POST /v1/managed-call/{slug}/execute`
 
@@ -3016,7 +3033,7 @@ const { data } = await client.managedCallExecute(
 
 ### `generateTypesPreview`
 
-Preview scaffolded types for a connector integration
+Analyses the JSONata mappings of all managed-call use cases in the integration and returns scaffolded type descriptors. The frontend uses these to show the type editor modal where developers fill in l
 
 `POST /v1/integrations/{integrationId}/generate-types-preview`
 
@@ -3030,7 +3047,7 @@ const { data } = await client.generateTypesPreview({
 
 ### `generateTypes`
 
-Generate a TypeScript npm package for a connector integration
+Generates a complete TypeScript npm package with typed interfaces for all managed-call use cases. This is a stateless operation that does not persist any changes. Use the commit-types endpoint to lock
 
 `POST /v1/integrations/{integrationId}/generate-types`
 
@@ -3068,7 +3085,7 @@ const { data } = await client.generateTypes(
 
 ### `commitTypes`
 
-Commit generated types and lock use case configurations
+Commits the generated types by locking use case configurations and updating version tracking. Should be called after the user reviews and downloads the generated package.
 
 `POST /v1/integrations/{integrationId}/commit-types`
 
@@ -4222,6 +4239,7 @@ type IntegrationWithUseCases = {
     type: "inbound"
     enabled: boolean
     change_description?: string
+    changed_by?: string
     created_at: string // date-time
     updated_at: string // date-time
     configuration?: {
@@ -4236,6 +4254,7 @@ type IntegrationWithUseCases = {
     type: "outbound"
     enabled: boolean
     change_description?: string
+    changed_by?: string
     created_at: string // date-time
     updated_at: string // date-time
     configuration?: {
@@ -4250,6 +4269,7 @@ type IntegrationWithUseCases = {
     type: "file_proxy"
     enabled: boolean
     change_description?: string
+    changed_by?: string
     created_at: string // date-time
     updated_at: string // date-time
     configuration?: {
@@ -4269,6 +4289,7 @@ type IntegrationWithUseCases = {
     type: "managed_call"
     enabled: boolean
     change_description?: string
+    changed_by?: string
     created_at: string // date-time
     updated_at: string // date-time
     configuration?: {
@@ -4290,6 +4311,7 @@ type IntegrationWithUseCases = {
     type: "secure_proxy"
     enabled: boolean
     change_description?: string
+    changed_by?: string
     created_at: string // date-time
     updated_at: string // date-time
     configuration?: {
@@ -5198,6 +5220,7 @@ type UseCaseBase = {
   type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
 }
@@ -5214,6 +5237,7 @@ type InboundUseCase = {
   type: "inbound"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5250,6 +5274,7 @@ type OutboundUseCase = {
   type: "outbound"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5278,6 +5303,7 @@ type FileProxyUseCase = {
   type: "file_proxy"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5333,6 +5359,7 @@ type ManagedCallUseCase = {
   type: "managed_call"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5365,6 +5392,7 @@ type SecureProxyUseCase = {
   type: "secure_proxy"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5386,6 +5414,7 @@ type UseCase = {
   type: "inbound"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5416,6 +5445,7 @@ type UseCase = {
   type: "outbound"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5438,6 +5468,7 @@ type UseCase = {
   type: "file_proxy"
   enabled: boolean
   change_description?: string
+  changed_by?: string
   created_at: string // date-time
   updated_at: string // date-time
   configuration?: {
@@ -5475,9 +5506,6 @@ type UseCase = {
       body: { ... }
       encoding: { ... }
       filename?: { ... }
-      content_type?: { ... }
-    }
-    prevent_indirect_serving?: boolean
   // ...
 }
 ```

package/docs/user.md

@@ -2025,7 +2025,8 @@ const { data } = await client.getUserLoginParametersV2({
       "cognito_oauth_domain": "epilot-org-123",
       "cognito_oauth_scopes": ["openid"],
       "oauth_response_type": "code",
-      "passkey_enabled": true
+      "passkey_enabled": true,
+      "passkeys_registered": true
     }
   ]
 }
@@ -2124,7 +2125,8 @@ const { data } = await client.resolveDiscoverableCredential(
       "cognito_oauth_domain": "epilot-org-123",
       "cognito_oauth_scopes": ["openid"],
       "oauth_response_type": "code",
-      "passkey_enabled": true
+      "passkey_enabled": true,
+      "passkeys_registered": true
     }
   ]
 }
@@ -2433,7 +2435,8 @@ const { data } = await client.getUserLoginParameters({
       "cognito_oauth_domain": "epilot-org-123",
       "cognito_oauth_scopes": ["openid"],
       "oauth_response_type": "code",
-      "passkey_enabled": true
+      "passkey_enabled": true,
+      "passkeys_registered": true
     }
   ]
 }
@@ -2728,6 +2731,7 @@ type LoginParameters = {
   cognito_oauth_scopes?: string[]
   oauth_response_type?: "code" | "token"
   passkey_enabled?: boolean
+  passkeys_registered?: boolean
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.16.2",
+  "version": "2.17.0",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -322,6 +322,16 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "epilot",
     "sdk",
@@ -515,14 +525,5 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
-  },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix"
   }
-}
+}

package/dist/chunk-3SZOSNO2.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/file-runtime.json
-var require_file_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["getFileSummary", "get", "/v1/files/{id}/summary", [["id", "p", true]]], ["createFileSummaryJob", "post", "/v1/files/{id}/summary-jobs", [["id", "p", true]]], ["getCurrentFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/current", [["id", "p", true]]], ["getFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/{job_id}", [["id", "p", true], ["job_id", "p", true]]], ["generateFileSummary", "post", "/v1/files/{id}/summary:generate", [["id", "p", true]]], ["getFileText", "get", "/v1/files/{id}/text", [["id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-
-
-exports.require_file_runtime = require_file_runtime;

package/dist/chunk-G7IFFKKJ.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/file-runtime.json
-var require_file_runtime = __commonJS({
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["getFileSummary", "get", "/v1/files/{id}/summary", [["id", "p", true]]], ["createFileSummaryJob", "post", "/v1/files/{id}/summary-jobs", [["id", "p", true]]], ["getCurrentFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/current", [["id", "p", true]]], ["getFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/{job_id}", [["id", "p", true], ["job_id", "p", true]]], ["generateFileSummary", "post", "/v1/files/{id}/summary:generate", [["id", "p", true]]], ["getFileText", "get", "/v1/files/{id}/text", [["id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-export {
-  require_file_runtime
-};

package/dist/file-M7VPFJWG.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/file.json
-var file_default = '# File API\n\n- **Base URL:** `https://file.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/file](https://docs.epilot.io/api/file)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.file.uploadFileV2(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/file\'\n\nconst fileClient = getClient()\nauthorize(fileClient, () => \'<token>\')\nconst { data } = await fileClient.uploadFileV2(...)\n```\n\n## Operations\n\n**File**\n- [`uploadFileV2`](#uploadfilev2)\n- [`saveFileV2`](#savefilev2)\n- [`getFile`](#getfile)\n- [`deleteFile`](#deletefile)\n- [`downloadFile`](#downloadfile)\n- [`downloadS3File`](#downloads3file)\n- [`downloadFiles`](#downloadfiles)\n- [`createZipJob`](#createzipjob)\n- [`getZipJob`](#getzipjob)\n- [`getFileSummary`](#getfilesummary)\n- [`createFileSummaryJob`](#createfilesummaryjob)\n- [`getCurrentFileSummaryJob`](#getcurrentfilesummaryjob)\n- [`getFileSummaryJob`](#getfilesummaryjob)\n- [`generateFileSummary`](#generatefilesummary)\n- [`getFileText`](#getfiletext)\n- [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)\n- [`uploadFilePublic`](#uploadfilepublic)\n\n**Preview**\n- [`previewFile`](#previewfile)\n- [`previewS3File`](#previews3file)\n- [`previewS3FileGet`](#previews3fileget)\n- [`previewPublicFile`](#previewpublicfile)\n\n**Session**\n- [`getSession`](#getsession)\n- [`deleteSession`](#deletesession)\n\n**Public Links**\n- [`generatePublicLink`](#generatepubliclink)\n- [`listPublicLinksForFile`](#listpubliclinksforfile)\n- [`accessPublicLink`](#accesspubliclink)\n- [`revokePublicLink`](#revokepubliclink)\n\n**File Collections**\n- [`getUserSchemaFileCollections`](#getuserschemafilecollections)\n- [`createUserSchemaFileCollection`](#createuserschemafilecollection)\n- [`updateUserSchemaFileCollection`](#updateuserschemafilecollection)\n- [`deleteUserSchemaFileCollection`](#deleteuserschemafilecollection)\n- [`getFilesInCollection`](#getfilesincollection)\n- [`getGlobalFileCollections`](#getglobalfilecollections)\n\n**Schemas**\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`ActivityId`](#activityid)\n- [`FileEntityId`](#fileentityid)\n- [`FileAttributes`](#fileattributes)\n- [`FileType`](#filetype)\n- [`FileSummaryJobStatus`](#filesummaryjobstatus)\n- [`FileSummaryJob`](#filesummaryjob)\n- [`FileSummary`](#filesummary)\n- [`FileTextStatus`](#filetextstatus)\n- [`FileText`](#filetext)\n- [`FileTextReady`](#filetextready)\n- [`FileTextNotReady`](#filetextnotready)\n- [`FileTextUnsupported`](#filetextunsupported)\n- [`CustomDownloadUrl`](#customdownloadurl)\n- [`CustomDownloadUrlAuth`](#customdownloadurlauth)\n- [`FileEntity`](#fileentity)\n- [`CommonSaveFilePayload`](#commonsavefilepayload)\n- [`SaveS3FilePayload`](#saves3filepayload)\n- [`SaveFileFromSourceURLPayload`](#savefilefromsourceurlpayload)\n- [`SaveCustomFilePayload`](#savecustomfilepayload)\n- [`SaveFilePayload`](#savefilepayload)\n- [`SaveFilePayloadV2`](#savefilepayloadv2)\n- [`BatchSaveFileVersionPayload`](#batchsavefileversionpayload)\n- [`UploadFilePayload`](#uploadfilepayload)\n- [`FileUpload`](#fileupload)\n- [`DownloadFilesPayload`](#downloadfilespayload)\n- [`CreateZipJobPayload`](#createzipjobpayload)\n- [`ZipJob`](#zipjob)\n- [`VerifyCustomDownloadUrlPayload`](#verifycustomdownloadurlpayload)\n- [`S3Reference`](#s3reference)\n- [`S3Ref`](#s3ref)\n- [`FileItem`](#fileitem)\n- [`FileRelationItem`](#filerelationitem)\n- [`PublicLink`](#publiclink)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`ErrorObject`](#errorobject)\n- [`FileCollectionId`](#filecollectionid)\n- [`FileCollectionItem`](#filecollectionitem)\n- [`FileCollectionAttributes`](#filecollectionattributes)\n- [`FileCollectionCreateRequest`](#filecollectioncreaterequest)\n\n### `uploadFileV2`\n\nCreate pre-signed S3 URL to upload a file to keep temporarily (one week).\n\n`POST /v2/files/upload`\n\n```ts\nconst { data } = await client.uploadFileV2(\n  {\n    file_entity_id: \'example\',\n  },\n  {\n    filename: \'document.pdf\',\n    mime_type: \'application/pdf\',\n    index_tag: \'2f6a377c8e78\',\n    metadata: {\n      color: \'blue\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "s3ref": {\n    "bucket": "epilot-prod-user-content",\n    "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"\n  },\n  "upload_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123",\n  "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"\n}\n```\n\n</details>\n\n---\n\n### `saveFileV2`\n\nSaves a permanent file entity. Updates an existing file entity when `_id` is passed.\n\n`POST /v2/files`\n\n```ts\nconst { data } = await client.saveFileV2(\n  {\n    activity_id: \'example\',\n    fill_activity: true,\n    strict: true,\n    async: true,\n    delete_temp_file: true,\n    version_only: true,\n  },\n  {\n    _id: \'ef7d985c-2385-44f4-9c71-ae06a52264f8\',\n    file_entity_id: \'string\',\n    relations: [\n      {\n        entity_id: \'ef7d985c-2385-44f4-9c71-ae06a52264f8\',\n        _schema: \'contact\',\n        _tags: [\'string\']\n      }\n    ],\n    _tags: [\'tag1\', \'tag2\'],\n    _purpose: [\'8d396871-95a0-4c9d-bb4d-9eda9c35776c\', \'da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    filename: \'document.pdf\',\n    type: \'document\',\n    mime_type: \'application/pdf\',\n    size_bytes: 1234,\n    readable_size: \'1.2 MB\',\n    etag: \'9bb58f26192e4ba00f01e2e7b136bbd8\',\n    access_control: \'private\',\n    public_url: \'https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf\',\n    custom_download_url: \'https://some-api-url.com/download?file_id=123\',\n    custom_download_url_auth: \'token\',\n    preview_summary_de: \'string\',\n    short_summary_de: \'string\',\n    preview_summary_en: \'string\',\n    short_summary_en: \'string\',\n    s3ref: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_title": "document.pdf",\n  "_schema": "file",\n  "_org": "123",\n  "_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n  "_tags": ["tag1", "tag2"],\n  "_purpose": ["8d396871-95a0-4c9d-bb4d-9eda9c35776c", "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "filename": "document.pdf",\n  "type": "document",\n  "mime_type": "application/pdf",\n  "size_bytes": 1234,\n  "readable_size": "1.2 MB",\n  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",\n  "access_control": "private",\n  "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",\n  "custom_download_url": "https://some-api-url.com/download?file_id=123",\n  "custom_download_url_auth": "token",\n  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",\n  "s3ref": {},\n  "versions": [\n    {\n      "s3ref": {},\n      "filename": "document.pdf",\n      "size_bytes": 1234,\n      "readable_size": "1.2 MB",\n      "mime_type": "image/jpeg",\n      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"\n    }\n  ],\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_acl": {\n    "view": ["org:456"],\n    "edit": ["org:456"],\n    "delete": ["org:456"]\n  },\n  "_owners": [\n    {\n      "org_id": "123",\n      "user_id": "123"\n    }\n  ],\n  "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `getFile`\n\nGet a file entity by id\n\n`GET /v2/files/{id}`\n\n```ts\nconst { data } = await client.getFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  source_url: true,\n  strict: true,\n  async: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_title": "document.pdf",\n  "_schema": "file",\n  "_org": "123",\n  "_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n  "_tags": ["tag1", "tag2"],\n  "_purpose": ["8d396871-95a0-4c9d-bb4d-9eda9c35776c", "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "filename": "document.pdf",\n  "type": "document",\n  "mime_type": "application/pdf",\n  "size_bytes": 1234,\n  "readable_size": "1.2 MB",\n  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",\n  "access_control": "private",\n  "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",\n  "custom_download_url": "https://some-api-url.com/download?file_id=123",\n  "custom_download_url_auth": "token",\n  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",\n  "s3ref": {},\n  "versions": [\n    {\n      "s3ref": {},\n      "filename": "document.pdf",\n      "size_bytes": 1234,\n      "readable_size": "1.2 MB",\n      "mime_type": "image/jpeg",\n      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"\n    }\n  ],\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_acl": {\n    "view": ["org:456"],\n    "edit": ["org:456"],\n    "delete": ["org:456"]\n  },\n  "_owners": [\n    {\n      "org_id": "123",\n      "user_id": "123"\n    }\n  ],\n  "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `deleteFile`\n\nDelete a file entity by id\n\n`DELETE /v2/files/{id}`\n\n```ts\nconst { data } = await client.deleteFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  purge: true,\n  activity_id: \'example\',\n  strict: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_title": "document.pdf",\n  "_schema": "file",\n  "_org": "123",\n  "_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n  "_tags": ["tag1", "tag2"],\n  "_purpose": ["8d396871-95a0-4c9d-bb4d-9eda9c35776c", "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "filename": "document.pdf",\n  "type": "document",\n  "mime_type": "application/pdf",\n  "size_bytes": 1234,\n  "readable_size": "1.2 MB",\n  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",\n  "access_control": "private",\n  "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",\n  "custom_download_url": "https://some-api-url.com/download?file_id=123",\n  "custom_download_url_auth": "token",\n  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",\n  "s3ref": {},\n  "versions": [\n    {\n      "s3ref": {},\n      "filename": "document.pdf",\n      "size_bytes": 1234,\n      "readable_size": "1.2 MB",\n      "mime_type": "image/jpeg",\n      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"\n    }\n  ],\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_acl": {\n    "view": ["org:456"],\n    "edit": ["org:456"],\n    "delete": ["org:456"]\n  },\n  "_owners": [\n    {\n      "org_id": "123",\n      "user_id": "123"\n    }\n  ],\n  "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `downloadFile`\n\nGenerate a pre-signed download URL for a file.\n\n`GET /v1/files/{id}/download`\n\n```ts\nconst { data } = await client.downloadFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  attachment: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"\n}\n```\n\n</details>\n\n---\n\n### `downloadS3File`\n\nGenerate a pre-signed download URL for a file using its S3 reference.\n\n`POST /v1/files:downloadS3`\n\n```ts\nconst { data } = await client.downloadS3File({\n  s3_key: \'example\',\n  s3_bucket: \'example\',\n  attachment: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"\n}\n```\n\n</details>\n\n---\n\n### `downloadFiles`\n\nBulk generate pre-signed download URLs for multiple files in a single request.\n\n`POST /v1/files:downloadFiles`\n\n```ts\nconst { data } = await client.downloadFiles(\n  null,\n  [\n    {\n      id: \'ef7d985c-2385-44f4-9c71-ae06a52264f8\',\n      version: 0\n    }\n  ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123",\n    "file_entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  }\n]\n```\n\n</details>\n\n---\n\n### `createZipJob`\n\nCreate a background job to ZIP multiple files and send a download link via email.\n\n`POST /v1/files:zipJob`\n\n```ts\nconst { data } = await client.createZipJob(\n  null,\n  {},\n)\n```\n\n---\n\n### `getZipJob`\n\nGet the status of a ZIP job\n\n`GET /v1/files:zipJob/{job_id}`\n\n```ts\nconst { data } = await client.getZipJob({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "status": "completed",\n  "progress": {\n    "total_files": 100,\n    "downloaded_files": 75,\n    "failed_files": 2\n  },\n  "result": {\n    "file_entity_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n    "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/files.zip?X-Amz-...",\n    "expires_at": "2024-01-02T12:00:00Z",\n    "zip_size_bytes": 104857600\n  },\n  "error": "Failed to download file: access denied",\n  "created_at": "2024-01-01T12:00:00Z",\n  "created_by": "10234",\n  "org_id": "123",\n  "updated_at": "2024-01-01T12:05:00Z"\n}\n```\n\n</details>\n\n---\n\n### `getFileSummary`\n\nGet summary text for a file entity together with the current summary job status when available.\n\n`GET /v1/files/{id}/summary`\n\n```ts\nconst { data } = await client.getFileSummary({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "queued",\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string"\n}\n```\n\n</details>\n\n---\n\n### `createFileSummaryJob`\n\nCreate or return the current AI summary job for a file entity.\n\n`POST /v1/files/{id}/summary-jobs`\n\n```ts\nconst { data } = await client.createFileSummaryJob({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getCurrentFileSummaryJob`\n\nGet the latest AI summary job for the file entity\'s current source.\n\n`GET /v1/files/{id}/summary-jobs/current`\n\n```ts\nconst { data } = await client.getCurrentFileSummaryJob({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "file_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n  "status": "queued",\n  "error": "string",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getFileSummaryJob`\n\nGet an AI summary job by id.\n\n`GET /v1/files/{id}/summary-jobs/{job_id}`\n\n```ts\nconst { data } = await client.getFileSummaryJob({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "file_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n  "status": "queued",\n  "error": "string",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `generateFileSummary`\n\nCompatibility alias for creating or returning the current AI summary job for a file entity.\n\n`POST /v1/files/{id}/summary:generate`\n\n```ts\nconst { data } = await client.generateFileSummary({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getFileText`\n\nGet the plain-text representation of a file entity. Returns status `not_ready` while text is being prepared and `unsupported` when text is unavailable for the file or organization.\n\n`GET /v1/files/{id}/text`\n\n```ts\nconst { data } = await client.getFileText({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "ready",\n  "text": "string",\n  "truncated": true,\n  "total_chars": 0\n}\n```\n\n</details>\n\n---\n\n### `previewFile`\n\nGenerate a thumbnail preview for a file entity.\n\n`GET /v1/files/{id}/preview`\n\n```ts\nconst { data } = await client.previewFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  w: 1,\n  h: 1,\n})\n```\n\n---\n\n### `previewS3File`\n\nGenerate a thumbnail preview from an S3 reference.\n\n`POST /v1/files:previewS3`\n\n```ts\nconst { data } = await client.previewS3File(\n  {\n    w: 1,\n    h: 1,\n  },\n  {},\n)\n```\n\n---\n\n### `previewS3FileGet`\n\nGet a thumbnail preview from an S3 reference using query parameters.\n\n`GET /v1/files:previewS3`\n\n```ts\nconst { data } = await client.previewS3FileGet({\n  key: \'example\',\n  bucket: \'example\',\n  w: 1,\n  h: 1,\n})\n```\n\n---\n\n### `previewPublicFile`\n\nGenerate a thumbnail preview for a public file entity.\n\n`GET /v1/files/public/{id}/preview`\n\n```ts\nconst { data } = await client.previewPublicFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  w: 1,\n  h: 1,\n  org_id: \'example\',\n})\n```\n\n---\n\n### `getSession`\n\nStart a browser session by converting a Bearer token into a server-side cookie.\n\n`GET /v1/files/session`\n\n```ts\nconst { data } = await client.getSession()\n```\n\n---\n\n### `deleteSession`\n\nEnd a browser session by deleting the token cookie.\n\n`DELETE /v1/files/session`\n\n```ts\nconst { data } = await client.deleteSession()\n```\n\n---\n\n### `generatePublicLink`\n\nGenerate a public link to share a private file externally.\n\n`POST /v1/files/{id}/public/links`\n\n```ts\nconst { data } = await client.generatePublicLink({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n"string"\n```\n\n</details>\n\n---\n\n### `listPublicLinksForFile`\n\nFetches all public links previously generated for a file\n\n`GET /v1/files/{id}/public/links`\n\n```ts\nconst { data } = await client.listPublicLinksForFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "3ef5c6d9-818d-45e6-8efb-b1de59079a1c",\n      "link": "https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c",\n      "last_accessed_at": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `accessPublicLink`\n\nAccess a file via its public link.\n\n`GET /v1/files/public/links/{id}/{filename}`\n\n```ts\nconst { data } = await client.accessPublicLink({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  filename: \'example\',\n  hash: \'example\',\n})\n```\n\n---\n\n### `revokePublicLink`\n\nRevokes a given public link by ID\n\n`DELETE /v1/files/public/links/{id}`\n\n```ts\nconst { data } = await client.revokePublicLink({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `verifyCustomDownloadUrl`\n\nVerify that a custom download URL is valid and has not expired.\n\n`POST /v1/files/download:verify`\n\n```ts\nconst { data } = await client.verifyCustomDownloadUrl(\n  null,\n  {\n    custom_download_url: \'https://some-api-url.com?file_id=123&expires_at=1699273500029&signature=abcdefg\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "valid": true\n}\n```\n\n</details>\n\n---\n\n### `uploadFilePublic`\n\nCreate a pre-signed S3 URL for uploading a file without authentication.\n\n`POST /v1/files/public/upload`\n\n```ts\nconst { data } = await client.uploadFilePublic(\n  null,\n  {\n    filename: \'document.pdf\',\n    mime_type: \'application/pdf\',\n    index_tag: \'2f6a377c8e78\',\n    metadata: {\n      color: \'blue\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "s3ref": {\n    "bucket": "epilot-prod-user-content",\n    "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"\n  },\n  "upload_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123",\n  "error": "File entity not found"\n}\n```\n\n</details>\n\n---\n\n### `getUserSchemaFileCollections`\n\nGet all file collections for the current user within a specific schema.\n\n`GET /v1/{slug}/collections`\n\n```ts\nconst { data } = await client.getUserSchemaFileCollections({\n  slug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "slug": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents",\n    "name": "Documents",\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "parents": ["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"],\n    "starred": false,\n    "order": 0,\n    "enabled_locations": ["string"],\n    "enabled_purposes": ["9eefcb98-93cf-4c5b-a040-f1d26d57c177", "5c544c09-a691-43ed-a7fa-0a8b44b5b161"],\n    "created_at": "2024-01-01T12:00:00Z",\n    "updated_at": "2024-01-02T12:00:00Z"\n  }\n]\n```\n\n</details>\n\n---\n\n### `createUserSchemaFileCollection`\n\nCreate a new file collection for the current user within a specific schema.\n\n`POST /v1/{slug}/collections`\n\n```ts\nconst { data } = await client.createUserSchemaFileCollection(\n  {\n    slug: \'example\',\n  },\n  {\n    name: \'string\',\n    parents: [\'string\'],\n    starred: false,\n    enabled_locations: [\'string\'],\n    enabled_purposes: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "slug": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents",\n  "name": "Documents",\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "parents": ["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"],\n  "starred": false,\n  "order": 0,\n  "enabled_locations": ["string"],\n  "enabled_purposes": ["9eefcb98-93cf-4c5b-a040-f1d26d57c177", "5c544c09-a691-43ed-a7fa-0a8b44b5b161"],\n  "created_at": "2024-01-01T12:00:00Z",\n  "updated_at": "2024-01-02T12:00:00Z"\n}\n```\n\n</details>\n\n---\n\n### `updateUserSchemaFileCollection`\n\nUpdate an existing file collection.\n\n`PUT /v1/{slug}/collections/{collectionSlug}`\n\n```ts\nconst { data } = await client.updateUserSchemaFileCollection(\n  {\n    slug: \'example\',\n    collectionSlug: \'example\',\n  },\n  {\n    name: \'string\',\n    parents: [\'string\'],\n    starred: false,\n    enabled_locations: [\'string\'],\n    enabled_purposes: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "slug": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents",\n  "name": "Documents",\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "parents": ["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"],\n  "starred": false,\n  "order": 0,\n  "enabled_locations": ["string"],\n  "enabled_purposes": ["9eefcb98-93cf-4c5b-a040-f1d26d57c177", "5c544c09-a691-43ed-a7fa-0a8b44b5b161"],\n  "created_at": "2024-01-01T12:00:00Z",\n  "updated_at": "2024-01-02T12:00:00Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteUserSchemaFileCollection`\n\nDelete a file collection.\n\n`DELETE /v1/{slug}/collections/{collectionSlug}`\n\n```ts\nconst { data } = await client.deleteUserSchemaFileCollection({\n  slug: \'example\',\n  collectionSlug: \'example\',\n})\n```\n\n---\n\n### `getFilesInCollection`\n\nGet all files within a specific collection for an entity.\n\n`GET /v1/entity/{id}/collections/{collectionSlug}/files`\n\n```ts\nconst { data } = await client.getFilesInCollection({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  collectionSlug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "_title": "document.pdf",\n    "_schema": "file",\n    "_org": "123",\n    "_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",\n    "_tags": ["tag1", "tag2"],\n    "_purpose": ["8d396871-95a0-4c9d-bb4d-9eda9c35776c", "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"],\n    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n    "filename": "document.pdf",\n    "type": "document",\n    "mime_type": "application/pdf",\n    "size_bytes": 1234,\n    "readable_size": "1.2 MB",\n    "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",\n    "access_control": "private",\n    "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",\n    "custom_download_url": "https://some-api-url.com/download?file_id=123",\n    "custom_download_url_auth": "token",\n    "preview_summary_de": "string",\n    "short_summary_de": "string",\n    "preview_summary_en": "string",\n    "short_summary_en": "string",\n    "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",\n    "s3ref": {},\n    "versions": [\n      {\n        "s3ref": {},\n        "filename": "document.pdf",\n        "size_bytes": 1234,\n        "readable_size": "1.2 MB",\n        "mime_type": "image/jpeg",\n        "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"\n      }\n    ],\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_acl": {\n      "view": ["org:456"],\n      "edit": ["org:456"],\n      "delete": ["org:456"]\n    },\n    "_owners": [\n      {\n        "org_id": "123",\n        "user_id": "123"\n      }\n    ],\n    "__additional": {}\n  }\n]\n```\n\n</details>\n\n---\n\n### `getGlobalFileCollections`\n\nGet all global file collections for a specific schema.\n\n`GET /v1/collections/{schemaSlug}`\n\n```ts\nconst { data } = await client.getGlobalFileCollections({\n  schemaSlug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "slug": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents",\n    "name": "Documents",\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "parents": ["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"],\n    "starred": false,\n    "order": 0,\n    "enabled_locations": ["string"],\n    "enabled_purposes": ["9eefcb98-93cf-4c5b-a040-f1d26d57c177", "5c544c09-a691-43ed-a7fa-0a8b44b5b161"],\n    "created_at": "2024-01-01T12:00:00Z",\n    "updated_at": "2024-01-02T12:00:00Z"\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EntityId`\n\n```ts\ntype EntityId = string\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n\n### `FileEntityId`\n\n```ts\ntype FileEntityId = string | string // uuid\n```\n\n### `FileAttributes`\n\n```ts\ntype FileAttributes = {\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n}\n```\n\n### `FileType`\n\n```ts\ntype FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n```\n\n### `FileSummaryJobStatus`\n\nCurrent state of a file summary job.\n\n```ts\ntype FileSummaryJobStatus = "queued" | "waiting_for_extraction" | "processing" | "completed" | "failed" | "unsupported" | "stale"\n```\n\n### `FileSummaryJob`\n\n```ts\ntype FileSummaryJob = {\n  job_id: string // uuid\n  file_id: string | string // uuid\n  status: "queued" | "waiting_for_extraction" | "processing" | "completed" | "failed" | "unsupported" | "stale"\n  error?: string\n  created_at: string // date-time\n  updated_at: string // date-time\n  completed_at?: string // date-time\n}\n```\n\n### `FileSummary`\n\n```ts\ntype FileSummary = {\n  status?: "queued" | "waiting_for_extraction" | "processing" | "completed" | "failed" | "unsupported" | "stale"\n  job_id?: string // uuid\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n}\n```\n\n### `FileTextStatus`\n\nAvailability of the plain-text representation for a file entity.\n\n```ts\ntype FileTextStatus = "ready" | "not_ready" | "unsupported"\n```\n\n### `FileText`\n\n```ts\ntype FileText = {\n  status: "ready"\n  text: string\n  truncated: boolean\n  total_chars: number\n} | {\n  status: "not_ready"\n} | {\n  status: "unsupported"\n}\n```\n\n### `FileTextReady`\n\n```ts\ntype FileTextReady = {\n  status: "ready"\n  text: string\n  truncated: boolean\n  total_chars: number\n}\n```\n\n### `FileTextNotReady`\n\n```ts\ntype FileTextNotReady = {\n  status: "not_ready"\n}\n```\n\n### `FileTextUnsupported`\n\n```ts\ntype FileTextUnsupported = {\n  status: "unsupported"\n}\n```\n\n### `CustomDownloadUrl`\n\nCustom external download url used for the file\n\n```ts\ntype CustomDownloadUrl = string // uri\n```\n\n### `CustomDownloadUrlAuth`\n\nAuthorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller\'s bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/s\n\n```ts\ntype CustomDownloadUrlAuth = "presigned" | "token"\n```\n\n### `FileEntity`\n\n```ts\ntype FileEntity = {\n  _title: string\n  _schema: "file"\n  _org: string\n  _id: string | string // uuid\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename: string\n  type: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  source_url?: string\n  s3ref?: object\n  versions: Array<{\n    s3ref?: unknown\n    filename?: string\n    size_bytes?: number\n    readable_size?: string\n    mime_type?: string\n    etag?: string\n  }>\n  _updated_at?: string // date-time\n  _created_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  __additional?: Record<string, unknown>\n}\n```\n\n### `CommonSaveFilePayload`\n\n```ts\ntype CommonSaveFilePayload = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n}\n```\n\n### `SaveS3FilePayload`\n\n```ts\ntype SaveS3FilePayload = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  s3ref?: unknown\n}\n```\n\n### `SaveFileFromSourceURLPayload`\n\n```ts\ntype SaveFileFromSourceURLPayload = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  source_url?: string // uri\n}\n```\n\n### `SaveCustomFilePayload`\n\n```ts\ntype SaveCustomFilePayload = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n}\n```\n\n### `SaveFilePayload`\n\n```ts\ntype SaveFilePayload = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  s3ref?: unknown\n} | {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  source_url?: string // uri\n} | {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n}\n```\n\n### `SaveFilePayloadV2`\n\n```ts\ntype SaveFilePayloadV2 = {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  s3ref?: unknown\n} | {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  source_url?: string // uri\n} | {\n  _id?: object\n  file_entity_id?: string\n  relations?: Array<{\n    entity_id: string\n    _schema?: string\n    _tags?: string[]\n  }>\n  _tags?: string[]\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  filename?: string\n  type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"\n  mime_type?: string\n  size_bytes?: number\n  readable_size?: string\n  etag?: string\n  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  custom_download_url_auth?: "presigned" | "token"\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n}\n```\n\n### `BatchSaveFileVersionPayload`\n\nPayload for batch version save. Only s3ref payloads are supported.\n\n```ts\ntype BatchSaveFileVersionPayload = {\n  _id?: object\n  file_entity_id?: string\n  filename?: string\n  mime_type?: string\n  access_control?: "private" | "public-read"\n  s3ref: unknown\n}\n```\n\n### `UploadFilePayload`\n\n```ts\ntype UploadFilePayload = {\n  filename: string\n  mime_type?: string\n  index_tag?: string\n  metadata?: Record<string, string>\n}\n```\n\n### `FileUpload`\n\n```ts\ntype FileUpload = {\n  s3ref?: object\n  upload_url?: string // url\n  public_url?: string // url\n}\n```\n\n### `DownloadFilesPayload`\n\n```ts\ntype DownloadFilesPayload = Array<{\n  id: string | string // uuid\n  version?: number\n}>\n```\n\n### `CreateZipJobPayload`\n\nRequest payload to create a ZIP job for bulk file download.\nProvide either an explicit list of `file_entity_ids` (up to 1000) or an\n`entity_query` that resolves to file entities (up to 10000).\n\n\n```ts\ntype CreateZipJobPayload = unknown | unknown\n```\n\n### `ZipJob`\n\nZIP job status and result\n\n```ts\ntype ZipJob = {\n  job_id?: string // uuid\n  status?: "queued" | "downloading" | "zipping" | "uploading" | "sending_notification" | "completed" | "failed"\n  progress?: {\n    total_files?: number\n    downloaded_files?: number\n    failed_files?: number\n  }\n  result?: {\n    file_entity_id?: string // uuid\n    download_url?: string // uri\n    expires_at?: string // date-time\n    zip_size_bytes?: number\n  }\n  error?: string\n  created_at?: string // date-time\n  created_by?: string\n  org_id?: string\n  updated_at?: string // date-time\n}\n```\n\n### `VerifyCustomDownloadUrlPayload`\n\n```ts\ntype VerifyCustomDownloadUrlPayload = {\n  custom_download_url: string\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n  bucket: string\n  key: string\n}\n```\n\n### `S3Ref`\n\n```ts\ntype S3Ref = {\n  bucket: string\n  key: string\n}\n```\n\n### `FileItem`\n\n```ts\ntype FileItem = {\n  s3ref?: unknown\n  filename?: string\n  size_bytes?: number\n  readable_size?: string\n  mime_type?: string\n  etag?: string\n}\n```\n\n### `FileRelationItem`\n\n```ts\ntype FileRelationItem = {\n  entity_id: string\n  _schema?: string\n  _tags?: string[]\n}\n```\n\n### `PublicLink`\n\n```ts\ntype PublicLink = {\n  id?: string\n  link?: string\n  last_accessed_at?: string\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n  org_id: string\n  user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `ErrorObject`\n\nA generic error returned by the API\n\n```ts\ntype ErrorObject = {\n  status?: number\n  error?: string\n}\n```\n\n### `FileCollectionId`\n\nGenerated uuid for a file collection\n\n```ts\ntype FileCollectionId = string // uuid\n```\n\n### `FileCollectionItem`\n\nA file collection with identifiers and timestamps\n\n```ts\ntype FileCollectionItem = {\n  slug?: string\n  name: string\n  id?: string // uuid\n  parents?: string[]\n  starred?: boolean\n  order?: number\n  enabled_locations?: string[]\n  enabled_purposes?: string[]\n  created_at?: string // date-time\n  updated_at?: string // date-time\n}\n```\n\n### `FileCollectionAttributes`\n\n```ts\ntype FileCollectionAttributes = {\n  name?: string\n  parents?: string[]\n  starred?: boolean\n  enabled_locations?: string[]\n  enabled_purposes?: string[]\n}\n```\n\n### `FileCollectionCreateRequest`\n\nRequest body for creating a file collection\n\n```ts\ntype FileCollectionCreateRequest = {\n  name: string\n  parents?: string[]\n  starred?: boolean\n  enabled_locations?: string[]\n  enabled_purposes?: string[]\n}\n```\n';
-export {
-  file_default as default
-};