@epilot/sdk 2.8.0-rc.0 → 2.8.1

package/dist/file-JVFTT5RZ.js

@@ -0,0 +1,7 @@
+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- [`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';
+export {
+  file_default as default
+};

package/dist/file-runtime-7AWKNQU6.cjs

@@ -0,0 +1,5 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk4M5V6BITcjs = require('./chunk-4M5V6BIT.cjs');
+require('./chunk-NJK5F5TF.cjs');
+exports. default = _chunk4M5V6BITcjs.require_file_runtime.call(void 0, );

package/dist/{file-runtime-BIRMXYRH.js → file-runtime-DKGFS44O.js}

@@ -1,5 +1,5 @@
 import {
   require_file_runtime
-} from "./chunk-3APTSPY4.js";
+} from "./chunk-RDVFQOCQ.js";
 import "./chunk-YPSWSI3M.js";
 export default require_file_runtime();

package/dist/{file.d-DTlrbI40.d.cts → file.d-BjlMgTwj.d.cts}

@@ -56,6 +56,28 @@ declare namespace Components {
              */
             error?: string;
         }
+        /**
+         * A generic error returned by the API
+         * example:
+         * {
+         *   "status": 409,
+         *   "error": "Extracted file content is still being prepared"
+         * }
+         */
+        export interface ConflictError {
+            /**
+             * The HTTP status code of the error
+             * example:
+             * 400
+             */
+            status?: number;
+            /**
+             * The error message
+             * example:
+             * Bad Request
+             */
+            error?: string;
+        }
         /**
          * A generic error returned by the API
          * example:
@@ -1279,9 +1301,11 @@ declare namespace Components {
              */
             zip_filename?: string;
             /**
-             * Send email notification when ZIP is ready
+             * Email address to notify when the ZIP is ready. Omit to skip the email notification.
+             * example:
+             * user@example.com
              */
-            notify_email?: boolean;
+            notify_email?: string; // email
         } | {
             /**
              * List of file entity IDs to include in the ZIP
@@ -2317,9 +2341,11 @@ declare namespace Components {
              */
             zip_filename?: string;
             /**
-             * Send email notification when ZIP is ready
+             * Email address to notify when the ZIP is ready. Omit to skip the email notification.
+             * example:
+             * user@example.com
              */
-            notify_email?: boolean;
+            notify_email?: string; // email
         };
         /**
          * Custom external download url used for the file
@@ -2426,6 +2452,23 @@ declare namespace Components {
              * https://some-api-url.com/download?file_id=123
              */
             CustomDownloadUrl /* uri */;
+            /**
+             * Compact German summary for hover and list preview surfaces.
+             */
+            preview_summary_de?: string;
+            /**
+             * Short German paragraph summary for file preview surfaces.
+             */
+            short_summary_de?: string;
+            /**
+             * Compact English summary for hover and list preview surfaces.
+             */
+            preview_summary_en?: string;
+            /**
+             * Short English paragraph summary for file preview surfaces.
+             */
+            short_summary_en?: string;
+            summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
         }
         export interface FileCollectionAttributes {
             /**
@@ -2625,6 +2668,23 @@ declare namespace Components {
              * https://some-api-url.com/download?file_id=123
              */
             CustomDownloadUrl /* uri */;
+            /**
+             * Compact German summary for hover and list preview surfaces.
+             */
+            preview_summary_de?: string;
+            /**
+             * Short German paragraph summary for file preview surfaces.
+             */
+            short_summary_de?: string;
+            /**
+             * Compact English summary for hover and list preview surfaces.
+             */
+            preview_summary_en?: string;
+            /**
+             * Short English paragraph summary for file preview surfaces.
+             */
+            short_summary_en?: string;
+            summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
             /**
              * Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
              * example:
@@ -2696,6 +2756,13 @@ declare namespace Components {
             EntitySlug;
             _tags?: string[];
         }
+        export interface FileSummaryGenerationStatus {
+            status: /* Current AI summary generation state for the file. */ FileSummaryStatus;
+        }
+        /**
+         * Current AI summary generation state for the file.
+         */
+        export type FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported";
         export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
         export interface FileUpload {
             s3ref?: S3Reference;
@@ -2820,6 +2887,23 @@ declare namespace Components {
              * https://some-api-url.com/download?file_id=123
              */
             CustomDownloadUrl /* uri */;
+            /**
+             * Compact German summary for hover and list preview surfaces.
+             */
+            preview_summary_de?: string;
+            /**
+             * Short German paragraph summary for file preview surfaces.
+             */
+            short_summary_de?: string;
+            /**
+             * Compact English summary for hover and list preview surfaces.
+             */
+            preview_summary_en?: string;
+            /**
+             * Short English paragraph summary for file preview surfaces.
+             */
+            short_summary_en?: string;
+            summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
         }
         export interface SaveFileFromSourceURLPayload {
             [name: string]: any;
@@ -2899,6 +2983,23 @@ declare namespace Components {
              * https://some-api-url.com/download?file_id=123
              */
             CustomDownloadUrl /* uri */;
+            /**
+             * Compact German summary for hover and list preview surfaces.
+             */
+            preview_summary_de?: string;
+            /**
+             * Short German paragraph summary for file preview surfaces.
+             */
+            short_summary_de?: string;
+            /**
+             * Compact English summary for hover and list preview surfaces.
+             */
+            preview_summary_en?: string;
+            /**
+             * Short English paragraph summary for file preview surfaces.
+             */
+            short_summary_en?: string;
+            summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
             source_url?: /**
              * Custom external download url used for the file
              * example:
@@ -2986,6 +3087,23 @@ declare namespace Components {
              * https://some-api-url.com/download?file_id=123
              */
             CustomDownloadUrl /* uri */;
+            /**
+             * Compact German summary for hover and list preview surfaces.
+             */
+            preview_summary_de?: string;
+            /**
+             * Short German paragraph summary for file preview surfaces.
+             */
+            short_summary_de?: string;
+            /**
+             * Compact English summary for hover and list preview surfaces.
+             */
+            preview_summary_en?: string;
+            /**
+             * Short English paragraph summary for file preview surfaces.
+             */
+            short_summary_en?: string;
+            summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
             s3ref?: S3Ref;
         }
         export interface UploadFilePayload {
@@ -3513,6 +3631,75 @@ declare namespace Paths {
             Components.Responses.InternalServerError;
         }
     }
+    namespace GenerateFileSummary {
+        namespace Parameters {
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.FileEntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $202 = Components.Schemas.FileSummaryGenerationStatus;
+            export type $400 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 400,
+             *   "error": "Bad Request: filename is required"
+             * }
+             */
+            Components.Responses.BadRequestError;
+            export type $401 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 401,
+             *   "error": "Unauthorized: Invalid or expired token"
+             * }
+             */
+            Components.Responses.UnauthorizedError;
+            export type $403 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 403,
+             *   "error": "Forbidden: You do not have permission to access this file"
+             * }
+             */
+            Components.Responses.ForbiddenError;
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found: File entity not found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+            export type $409 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 409,
+             *   "error": "Extracted file content is still being prepared"
+             * }
+             */
+            Components.Responses.ConflictError;
+            export type $500 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 500,
+             *   "error": "Internal Server Error"
+             * }
+             */
+            Components.Responses.InternalServerError;
+        }
+    }
     namespace GeneratePublicLink {
         namespace Parameters {
             export type Id = /**
@@ -3864,6 +4051,8 @@ declare namespace Paths {
         }
         namespace Responses {
             export type $200 = string; // binary
+            export interface $304 {
+            }
             export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
             export type $404 = /**
              * A generic error returned by the API
@@ -4533,6 +4722,16 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetZipJob.Responses.$200>
+  /**
+   * generateFileSummary - generateFileSummary
+   * 
+   * Request AI generation of preview and short summaries for a file entity.
+   */
+  'generateFileSummary'(
+    parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
   /**
    * previewFile - previewFile
    * 
@@ -4984,6 +5183,18 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetZipJob.Responses.$200>
   }
+  ['/v1/files/{id}/summary:generate']: {
+    /**
+     * generateFileSummary - generateFileSummary
+     * 
+     * Request AI generation of preview and short summaries for a file entity.
+     */
+    'post'(
+      parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
+  }
   ['/v1/files/{id}/preview']: {
     /**
      * previewFile - previewFile
@@ -5292,6 +5503,8 @@ type FileEntity = Components.Schemas.FileEntity;
 type FileEntityId = Components.Schemas.FileEntityId;
 type FileItem = Components.Schemas.FileItem;
 type FileRelationItem = Components.Schemas.FileRelationItem;
+type FileSummaryGenerationStatus = Components.Schemas.FileSummaryGenerationStatus;
+type FileSummaryStatus = Components.Schemas.FileSummaryStatus;
 type FileType = Components.Schemas.FileType;
 type FileUpload = Components.Schemas.FileUpload;
 type PublicLink = Components.Schemas.PublicLink;
@@ -5306,4 +5519,4 @@ type UploadFilePayload = Components.Schemas.UploadFilePayload;
 type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
 type ZipJob = Components.Schemas.ZipJob;
 
-export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type OperationMethods as O, Paths as P, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, type ZipJob as Z, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type EntitySlug as h, type ErrorObject as i, type FileCollectionAttributes as j, type FileCollectionCreateRequest as k, type FileCollectionId as l, type FileCollectionItem as m, type FileEntity as n, type FileEntityId as o, type FileItem as p, type FileRelationItem as q, type FileType as r, type FileUpload as s, type PublicLink as t, type S3Reference as u, type SaveCustomFilePayload as v, type SaveFileFromSourceURLPayload as w, type SaveFilePayload as x, type SaveFilePayloadV2 as y, type SaveS3FilePayload as z };
+export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type SaveFilePayloadV2 as G, type SaveS3FilePayload as H, type OperationMethods as O, Paths as P, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, type ZipJob as Z, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type EntitySlug as h, type ErrorObject as i, type FileCollectionAttributes as j, type FileCollectionCreateRequest as k, type FileCollectionId as l, type FileCollectionItem as m, type FileEntity as n, type FileEntityId as o, type FileItem as p, type FileRelationItem as q, type FileSummaryGenerationStatus as r, type FileSummaryStatus as s, type FileType as t, type FileUpload as u, type PublicLink as v, type S3Reference as w, type SaveCustomFilePayload as x, type SaveFileFromSourceURLPayload as y, type SaveFilePayload as z };