@epilot/sdk 2.8.0-rc.0 → 2.8.1

package/dist/{event-catalog.d-mQJLSYUo.d.cts → event-catalog.d-CXbUn8T1.d.ts}

@@ -132,7 +132,7 @@ declare namespace Components {
          *   "_event_time": "2024-01-01T12:00:00Z",
          *   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
          *   "_event_name": "MeterReading",
-         *   "_event_version": "1.0.0",
+         *   "_event_version": "1.0",
          *   "_event_source": "api",
          *   "_trigger_source_type": "api",
          *   "_trigger_source": "user_123456",
@@ -170,9 +170,9 @@ declare namespace Components {
              */
             _event_name: string;
             /**
-             * Event version (semver)
+             * Event payload version (MAJOR.MINOR)
              * example:
-             * 1.0.0
+             * 1.0
              */
             _event_version: string;
             /**
@@ -268,9 +268,9 @@ declare namespace Components {
              */
             event_description?: string;
             /**
-             * Event version (semver)
+             * Event payload version (MAJOR.MINOR)
              * example:
-             * 1.0.0
+             * 1.0
              */
             event_version: string;
             /**
@@ -418,9 +418,9 @@ declare namespace Components {
              */
             event_description?: string;
             /**
-             * Event version (semver)
+             * Event payload version (MAJOR.MINOR)
              * example:
-             * 1.0.0
+             * 1.0
              */
             event_version?: string;
             /**
@@ -570,7 +570,7 @@ declare namespace Components {
          *     },
          *     "_event_version": {
          *       "type": "string",
-         *       "description": "Event version (semver)"
+         *       "description": "Event payload version (MAJOR.MINOR)"
          *     },
          *     "_event_source": {
          *       "type": "string",
@@ -690,9 +690,11 @@ declare namespace Components {
          * A lightweight event summary returned by the v2 history endpoint.
          *
          * Includes the standard `_*` metadata fields plus a projected subset of the
-         * event payload. Hydrated entity objects (values carrying `_schema` or `_id`
-         * and arrays of such objects) are stripped — fetch via
-         * `GET /v2/events/{event_name}/history/{event_id}` for full hydration.
+         * event payload. Hydrated entity objects (values carrying `_schema` or `_id`)
+         * — and arrays of such objects — are reduced to reference stubs
+         * `{_schema, _id, _title}` so consumers can identify and follow up on each
+         * entity without paying the cost of the full hydrated graph. Fetch
+         * `GET /v2/events/{event_name}/history/{event_id}` for the full hydration.
          *
          * Projected scalar payload fields appear as additional top-level properties.
          *
@@ -716,9 +718,9 @@ declare namespace Components {
              */
             _event_name: string;
             /**
-             * Event version (semver)
+             * Event payload version (MAJOR.MINOR)
              * example:
-             * 1.0.0
+             * 1.0
              */
             _event_version: string;
             /**
@@ -744,6 +746,56 @@ declare namespace Components {
              */
             _ack_id?: string;
         }
+        /**
+         * Summary of an event's version timeline returned by
+         * `GET /v1/events/{event_name}/versions`.
+         *
+         */
+        export interface EventVersionRegistrySummary {
+            /**
+             * example:
+             * MeterReadingAdded
+             */
+            event_name: string;
+            /**
+             * The newest registered version.
+             * example:
+             * 1.0
+             */
+            latest: string;
+            /**
+             * Full version timeline, ordered oldest → newest.
+             */
+            versions: /* One entry of an event's version timeline. */ VersionMeta[];
+        }
+        /**
+         * A field-level change descriptor. Powers the declarative half of the
+         * version DSL.
+         *
+         */
+        export interface FieldChange {
+            /**
+             * Name of the field affected by this change.
+             * example:
+             * reading
+             */
+            field: string;
+            /**
+             * Kind of change. Renames are NOT a first-class op — represent them
+             * as a `removed` + `added` pair (semantic intent goes into
+             * `change_summary` / `change_notes`).
+             *
+             */
+            op: "added" | "removed" | "type-changed";
+            /**
+             * Type label for the previous shape (for `removed` and `type-changed`).
+             */
+            type_old?: string;
+            /**
+             * Type label for the new shape (for `added` and `type-changed`).
+             */
+            type_new?: string;
+        }
         /**
          * List of entity fields to include or exclude in the response
          *
@@ -1093,9 +1145,9 @@ declare namespace Components {
              */
             event_description?: string;
             /**
-             * Event version (semver)
+             * Event payload version (MAJOR.MINOR)
              * example:
-             * 1.0.0
+             * 1.0
              */
             event_version?: string;
             /**
@@ -1220,6 +1272,40 @@ declare namespace Components {
              */
             automation_trigger?: boolean;
         }
+        /**
+         * One entry of an event's version timeline.
+         */
+        export interface VersionMeta {
+            /**
+             * MAJOR.MINOR version label.
+             * example:
+             * 1.0
+             */
+            version: string;
+            /**
+             * ISO 8601 release timestamp.
+             * example:
+             * 2025-11-15
+             */
+            released_at: string;
+            /**
+             * Required one-liner describing what changed in this version (≤280 chars).
+             */
+            change_summary: string;
+            /**
+             * Optional longer-form prose (markdown).
+             */
+            change_notes?: string;
+            /**
+             * Hand-authored list of field-level changes from the previous version. Empty for v1.
+             */
+            changes: /**
+             * A field-level change descriptor. Powers the declarative half of the
+             * version DSL.
+             *
+             */
+            FieldChange[];
+        }
     }
 }
 declare namespace Paths {
@@ -1235,7 +1321,11 @@ declare namespace Paths {
         }
     }
     namespace GetEventExample {
+        export interface HeaderParameters {
+            "Epilot-Event-Version"?: Parameters.EpilotEventVersion;
+        }
         namespace Parameters {
+            export type EpilotEventVersion = string;
             export type EventName = string;
         }
         export interface PathParameters {
@@ -1247,10 +1337,16 @@ declare namespace Paths {
              */
             export interface $200 {
             }
+            export interface $404 {
+            }
         }
     }
     namespace GetEventJSONSchema {
+        export interface HeaderParameters {
+            "Epilot-Event-Version"?: Parameters.EpilotEventVersion;
+        }
         namespace Parameters {
+            export type EpilotEventVersion = string;
             export type EventName = string;
         }
         export interface PathParameters {
@@ -1282,7 +1378,7 @@ declare namespace Paths {
              *     },
              *     "_event_version": {
              *       "type": "string",
-             *       "description": "Event version (semver)"
+             *       "description": "Event payload version (MAJOR.MINOR)"
              *     },
              *     "_event_source": {
              *       "type": "string",
@@ -1397,6 +1493,8 @@ declare namespace Paths {
              * }
              */
             Components.Schemas.EventJsonSchema;
+            export interface $404 {
+            }
         }
     }
     namespace GetHistoricalEvent {
@@ -1417,7 +1515,7 @@ declare namespace Paths {
              *   "_event_time": "2024-01-01T12:00:00Z",
              *   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
              *   "_event_name": "MeterReading",
-             *   "_event_version": "1.0.0",
+             *   "_event_version": "1.0",
              *   "_event_source": "api",
              *   "_trigger_source_type": "api",
              *   "_trigger_source": "user_123456",
@@ -1441,6 +1539,24 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListEventVersions {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        namespace Responses {
+            export type $200 = /**
+             * Summary of an event's version timeline returned by
+             * `GET /v1/events/{event_name}/versions`.
+             *
+             */
+            Components.Schemas.EventVersionRegistrySummary;
+            export interface $404 {
+            }
+        }
+    }
     namespace ListEvents {
         namespace Responses {
             export interface $200 {
@@ -1486,7 +1602,7 @@ declare namespace Paths {
                  *   "_event_time": "2024-01-01T12:00:00Z",
                  *   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
                  *   "_event_name": "MeterReading",
-                 *   "_event_version": "1.0.0",
+                 *   "_event_version": "1.0",
                  *   "_event_source": "api",
                  *   "_trigger_source_type": "api",
                  *   "_trigger_source": "user_123456",
@@ -1551,9 +1667,11 @@ declare namespace Paths {
                  * A lightweight event summary returned by the v2 history endpoint.
                  *
                  * Includes the standard `_*` metadata fields plus a projected subset of the
-                 * event payload. Hydrated entity objects (values carrying `_schema` or `_id`
-                 * and arrays of such objects) are stripped — fetch via
-                 * `GET /v2/events/{event_name}/history/{event_id}` for full hydration.
+                 * event payload. Hydrated entity objects (values carrying `_schema` or `_id`)
+                 * — and arrays of such objects — are reduced to reference stubs
+                 * `{_schema, _id, _title}` so consumers can identify and follow up on each
+                 * entity without paying the cost of the full hydrated graph. Fetch
+                 * `GET /v2/events/{event_name}/history/{event_id}` for the full hydration.
                  *
                  * Projected scalar payload fields appear as additional top-level properties.
                  *
@@ -1634,23 +1752,42 @@ interface OperationMethods {
   /**
    * getEventJSONSchema - getEventJSONSchema
    * 
-   * Retrieve the JSON Schema of a specific business event
+   * Retrieve the JSON Schema of a specific business event. Pass an optional
+   * `Epilot-Event-Version` header to retrieve a specific version's schema;
+   * when omitted, the event's latest version is returned.
+   * 
    */
   'getEventJSONSchema'(
-    parameters?: Parameters<Paths.GetEventJSONSchema.PathParameters> | null,
+    parameters?: Parameters<Paths.GetEventJSONSchema.HeaderParameters & Paths.GetEventJSONSchema.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetEventJSONSchema.Responses.$200>
   /**
    * getEventExample - getEventExample
    * 
-   * Generate a sample event payload based on the event's JSON Schema
+   * Generate a sample event payload based on the event's JSON Schema. Pass an
+   * optional `Epilot-Event-Version` header to generate the example for a
+   * specific version; when omitted, the event's latest version is used.
+   * 
    */
   'getEventExample'(
-    parameters?: Parameters<Paths.GetEventExample.PathParameters> | null,
+    parameters?: Parameters<Paths.GetEventExample.HeaderParameters & Paths.GetEventExample.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetEventExample.Responses.$200>
+  /**
+   * listEventVersions - listEventVersions
+   * 
+   * List every known version of an event, along with the `latest`
+   * and the set of currently `active` versions. See §3.2 of the
+   * Event Payload Versioning RFC.
+   * 
+   */
+  'listEventVersions'(
+    parameters?: Parameters<Paths.ListEventVersions.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListEventVersions.Responses.$200>
   /**
    * searchEventHistory - searchEventHistory
    * 
@@ -1667,9 +1804,10 @@ interface OperationMethods {
    * Paginated history of events with projected/lightweight payload (v2).
    * 
    * Returns `EventSummary` objects instead of fully hydrated `Event` objects:
-   * nested entity graphs (objects/arrays-of-objects carrying `_schema`/`_id`)
-   * are stripped. Use GET /v2/events/{event_name}/history/{event_id} to fetch
-   * the full hydrated event for a single result.
+   * hydrated entity objects (values carrying `_schema`/`_id`) are reduced to
+   * reference stubs `{_schema, _id, _title}` — the full entity is recoverable
+   * via GET /v2/events/{event_name}/history/{event_id} or by hitting
+   * entity-api directly with the `_id`.
    * 
    */
   'searchEventHistoryV2'(
@@ -1745,10 +1883,13 @@ interface PathsDictionary {
     /**
      * getEventJSONSchema - getEventJSONSchema
      * 
-     * Retrieve the JSON Schema of a specific business event
+     * Retrieve the JSON Schema of a specific business event. Pass an optional
+     * `Epilot-Event-Version` header to retrieve a specific version's schema;
+     * when omitted, the event's latest version is returned.
+     * 
      */
     'get'(
-      parameters?: Parameters<Paths.GetEventJSONSchema.PathParameters> | null,
+      parameters?: Parameters<Paths.GetEventJSONSchema.HeaderParameters & Paths.GetEventJSONSchema.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetEventJSONSchema.Responses.$200>
@@ -1757,14 +1898,32 @@ interface PathsDictionary {
     /**
      * getEventExample - getEventExample
      * 
-     * Generate a sample event payload based on the event's JSON Schema
+     * Generate a sample event payload based on the event's JSON Schema. Pass an
+     * optional `Epilot-Event-Version` header to generate the example for a
+     * specific version; when omitted, the event's latest version is used.
+     * 
      */
     'get'(
-      parameters?: Parameters<Paths.GetEventExample.PathParameters> | null,
+      parameters?: Parameters<Paths.GetEventExample.HeaderParameters & Paths.GetEventExample.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetEventExample.Responses.$200>
   }
+  ['/v1/events/{event_name}/versions']: {
+    /**
+     * listEventVersions - listEventVersions
+     * 
+     * List every known version of an event, along with the `latest`
+     * and the set of currently `active` versions. See §3.2 of the
+     * Event Payload Versioning RFC.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListEventVersions.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListEventVersions.Responses.$200>
+  }
   ['/v1/events/{event_name}:history']: {
     /**
      * searchEventHistory - searchEventHistory
@@ -1784,9 +1943,10 @@ interface PathsDictionary {
      * Paginated history of events with projected/lightweight payload (v2).
      * 
      * Returns `EventSummary` objects instead of fully hydrated `Event` objects:
-     * nested entity graphs (objects/arrays-of-objects carrying `_schema`/`_id`)
-     * are stripped. Use GET /v2/events/{event_name}/history/{event_id} to fetch
-     * the full hydrated event for a single result.
+     * hydrated entity objects (values carrying `_schema`/`_id`) are reduced to
+     * reference stubs `{_schema, _id, _title}` — the full entity is recoverable
+     * via GET /v2/events/{event_name}/history/{event_id} or by hitting
+     * entity-api directly with the `_id`.
      * 
      */
     'post'(
@@ -1841,6 +2001,8 @@ type EventConfig = Components.Schemas.EventConfig;
 type EventConfigBase = Components.Schemas.EventConfigBase;
 type EventJsonSchema = Components.Schemas.EventJsonSchema;
 type EventSummary = Components.Schemas.EventSummary;
+type EventVersionRegistrySummary = Components.Schemas.EventVersionRegistrySummary;
+type FieldChange = Components.Schemas.FieldChange;
 type FieldsParam = Components.Schemas.FieldsParam;
 type GraphDefinition = Components.Schemas.GraphDefinition;
 type GraphEdge = Components.Schemas.GraphEdge;
@@ -1852,5 +2014,6 @@ type SearchOptionsV2 = Components.Schemas.SearchOptionsV2;
 type TriggerEventPayload = Components.Schemas.TriggerEventPayload;
 type TriggerEventResponse = Components.Schemas.TriggerEventResponse;
 type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
+type VersionMeta = Components.Schemas.VersionMeta;
 
-export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldsParam as F, type GraphDefinition as G, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type GraphEdge as k, type GraphNode as l, type PrimitiveField as m, type SearchOptions as n, type SearchOptionsV2 as o, type TriggerEventResponse as p };
+export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type VersionMeta as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type EventVersionRegistrySummary as k, type FieldsParam as l, type GraphEdge as m, type GraphNode as n, type PrimitiveField as o, type SearchOptions as p, type SearchOptionsV2 as q, type TriggerEventResponse as r };

package/dist/file-2MSILSPP.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// 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- [`generateFileSummary`](#generatefilesummary)\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- [`FileSummaryStatus`](#filesummarystatus)\n- [`FileSummaryGenerationStatus`](#filesummarygenerationstatus)\n- [`CustomDownloadUrl`](#customdownloadurl)\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    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    preview_summary_de: \'string\',\n    short_summary_de: \'string\',\n    preview_summary_en: \'string\',\n    short_summary_en: \'string\',\n    summary_status: \'processing\',\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  "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  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "summary_status": "processing",\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    }\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  "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  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "summary_status": "processing",\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    }\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  "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  "preview_summary_de": "string",\n  "short_summary_de": "string",\n  "preview_summary_en": "string",\n  "short_summary_en": "string",\n  "summary_status": "processing",\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    }\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### `generateFileSummary`\n\nRequest AI generation of preview and short summaries 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### `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    "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    "preview_summary_de": "string",\n    "short_summary_de": "string",\n    "preview_summary_en": "string",\n    "short_summary_en": "string",\n    "summary_status": "processing",\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      }\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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### `FileSummaryStatus`\n\nCurrent AI summary generation state for the file.\n\n```ts\ntype FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported"\n```\n\n### `FileSummaryGenerationStatus`\n\n```ts\ntype FileSummaryGenerationStatus = {\n  status: "processing" | "completed" | "failed" | "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### `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  access_control: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  }>\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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  access_control?: "private" | "public-read"\n  public_url?: string // url\n  custom_download_url?: string // uri\n  preview_summary_de?: string\n  short_summary_de?: string\n  preview_summary_en?: string\n  short_summary_en?: string\n  summary_status?: "processing" | "completed" | "failed" | "unsupported"\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}\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';
+
+
+exports.default = file_default;