@epilot/sdk 2.20.9 → 2.20.11

package/dist/chunk-CIKDOXDL.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/journey-runtime.json
-var require_journey_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/journey-runtime.json"(exports, module) {
-    module.exports = { s: "https://journey-config.sls.epilot.io", o: [["getJourneysByOrgId", "get", "/v1/journey/organization/{id}", [["id", "p", true], ["hydrate", "q"]]], ["getJourney", "get", "/v1/journey/configuration/{id}", [["id", "p", true], ["version", "q"], ["source", "q"], ["orgId", "q"]]], ["removeJourney", "delete", "/v1/journey/configuration/{id}", [["id", "p", true]]], ["getJourneyEnvironment", "get", "/v1/journey/configuration/{id}/environment", [["id", "p", true]]], ["getJourneyEnvironmentVariables", "get", "/v1/journey/environment-variables"], ["getJourneyProducts", "get", "/v1/journey/products/{id}", [["id", "p", true], ["source", "q"], ["postal_code", "q"], ["city", "q"], ["street", "q"], ["street_number", "q"]]], ["createJourney", "post", "/v1/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourney", "put", "/v1/journey/configuration", null, 1], ["patchUpdateJourney", "patch", "/v1/journey/configuration", null, 1], ["searchJourneys", "post", "/v1/journey/configuration/search", null, 1], ["generateDocument", "post", "/v1/journey/document:generate", null, 1], ["createJourneyV2", "post", "/v2/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourneyV2", "put", "/v2/journey/configuration", null, 1], ["patchUpdateJourneyV2", "patch", "/v2/journey/configuration", null, 1], ["getJourneyV2", "get", "/v2/journey/configuration/{id}", [["id", "p", true], ["version", "q"]]], ["removeJourneyV2", "delete", "/v2/journey/configuration/{id}", [["id", "p", true]]], ["getSettingsForJourney", "get", "/v1/journey/{id}/settings", [["id", "p", true]]], ["getButtonOptions", "get", "/v1/journey/button-options", [["fileId", "q", true]]]], v: "3.0.0" };
-  }
-});
-
-
-
-exports.require_journey_runtime = require_journey_runtime;

package/dist/chunk-EEKJGTAS.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/event-catalog-runtime.json
-var require_event_catalog_runtime = __commonJS({
-  "src/definitions/event-catalog-runtime.json"(exports, module) {
-    module.exports = { s: "https://event-catalog.sls.epilot.io", o: [["listEvents", "get", "/v1/events"], ["createCustomEvent", "post", "/v1/events", null, 1], ["getEvent", "get", "/v1/events/{event_name}", [["event_name", "p", true]]], ["patchEvent", "patch", "/v1/events/{event_name}", [["event_name", "p", true]], 1], ["deprecateCustomEvent", "delete", "/v1/events/{event_name}", [["event_name", "p", true]]], ["previewCustomEvent", "post", "/v1/events/{event_name}:preview", [["event_name", "p", true]], 1], ["publishCustomEventDefinition", "post", "/v1/events/{event_name}:publish", [["event_name", "p", true]], 1], ["getEventJSONSchema", "get", "/v1/events/{event_name}/json_schema", [["event_name", "p", true], ["Epilot-Event-Version", "h"]]], ["getEventExample", "get", "/v1/events/{event_name}/example", [["event_name", "p", true], ["Epilot-Event-Version", "h"]]], ["listEventVersions", "get", "/v1/events/{event_name}/versions", [["event_name", "p", true]]], ["searchEventHistory", "post", "/v1/events/{event_name}:history", [["event_name", "p", true]], 1], ["searchEventHistoryV2", "post", "/v2/events/{event_name}:history", [["event_name", "p", true]], 1], ["getHistoricalEvent", "get", "/v2/events/{event_name}/history/{event_id}", [["event_name", "p", true], ["event_id", "p", true]]], ["triggerEvent", "post", "/v1/events/{event_name}:trigger", [["event_name", "p", true]], 1]], v: "3.0.0" };
-  }
-});
-
-export {
-  require_event_catalog_runtime
-};

package/dist/chunk-IBMGFLXF.js

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

package/dist/chunk-MPZICOVZ.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/event-catalog-runtime.json
-var require_event_catalog_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/event-catalog-runtime.json"(exports, module) {
-    module.exports = { s: "https://event-catalog.sls.epilot.io", o: [["listEvents", "get", "/v1/events"], ["createCustomEvent", "post", "/v1/events", null, 1], ["getEvent", "get", "/v1/events/{event_name}", [["event_name", "p", true]]], ["patchEvent", "patch", "/v1/events/{event_name}", [["event_name", "p", true]], 1], ["deprecateCustomEvent", "delete", "/v1/events/{event_name}", [["event_name", "p", true]]], ["previewCustomEvent", "post", "/v1/events/{event_name}:preview", [["event_name", "p", true]], 1], ["publishCustomEventDefinition", "post", "/v1/events/{event_name}:publish", [["event_name", "p", true]], 1], ["getEventJSONSchema", "get", "/v1/events/{event_name}/json_schema", [["event_name", "p", true], ["Epilot-Event-Version", "h"]]], ["getEventExample", "get", "/v1/events/{event_name}/example", [["event_name", "p", true], ["Epilot-Event-Version", "h"]]], ["listEventVersions", "get", "/v1/events/{event_name}/versions", [["event_name", "p", true]]], ["searchEventHistory", "post", "/v1/events/{event_name}:history", [["event_name", "p", true]], 1], ["searchEventHistoryV2", "post", "/v2/events/{event_name}:history", [["event_name", "p", true]], 1], ["getHistoricalEvent", "get", "/v2/events/{event_name}/history/{event_id}", [["event_name", "p", true], ["event_id", "p", true]]], ["triggerEvent", "post", "/v1/events/{event_name}:trigger", [["event_name", "p", true]], 1]], v: "3.0.0" };
-  }
-});
-
-
-
-exports.require_event_catalog_runtime = require_event_catalog_runtime;

package/dist/chunk-XJUB5BYM.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/journey-runtime.json
-var require_journey_runtime = __commonJS({
-  "src/definitions/journey-runtime.json"(exports, module) {
-    module.exports = { s: "https://journey-config.sls.epilot.io", o: [["getJourneysByOrgId", "get", "/v1/journey/organization/{id}", [["id", "p", true], ["hydrate", "q"]]], ["getJourney", "get", "/v1/journey/configuration/{id}", [["id", "p", true], ["version", "q"], ["source", "q"], ["orgId", "q"]]], ["removeJourney", "delete", "/v1/journey/configuration/{id}", [["id", "p", true]]], ["getJourneyEnvironment", "get", "/v1/journey/configuration/{id}/environment", [["id", "p", true]]], ["getJourneyEnvironmentVariables", "get", "/v1/journey/environment-variables"], ["getJourneyProducts", "get", "/v1/journey/products/{id}", [["id", "p", true], ["source", "q"], ["postal_code", "q"], ["city", "q"], ["street", "q"], ["street_number", "q"]]], ["createJourney", "post", "/v1/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourney", "put", "/v1/journey/configuration", null, 1], ["patchUpdateJourney", "patch", "/v1/journey/configuration", null, 1], ["searchJourneys", "post", "/v1/journey/configuration/search", null, 1], ["generateDocument", "post", "/v1/journey/document:generate", null, 1], ["createJourneyV2", "post", "/v2/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourneyV2", "put", "/v2/journey/configuration", null, 1], ["patchUpdateJourneyV2", "patch", "/v2/journey/configuration", null, 1], ["getJourneyV2", "get", "/v2/journey/configuration/{id}", [["id", "p", true], ["version", "q"]]], ["removeJourneyV2", "delete", "/v2/journey/configuration/{id}", [["id", "p", true]]], ["getSettingsForJourney", "get", "/v1/journey/{id}/settings", [["id", "p", true]]], ["getButtonOptions", "get", "/v1/journey/button-options", [["fileId", "q", true]]]], v: "3.0.0" };
-  }
-});
-
-export {
-  require_journey_runtime
-};

package/dist/event-catalog-4FVQZ65M.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/event-catalog.json
-var event_catalog_default = '# Event Catalog API\n\n- **Base URL:** `https://event-catalog.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/event-catalog](https://docs.epilot.io/api/event-catalog)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.eventCatalog.listEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/event-catalog\'\n\nconst eventCatalogClient = getClient()\nauthorize(eventCatalogClient, () => \'<token>\')\nconst { data } = await eventCatalogClient.listEvents(...)\n```\n\n## Operations\n\n**Event Catalog**\n- [`listEvents`](#listevents)\n- [`createCustomEvent`](#createcustomevent)\n- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\n- [`deprecateCustomEvent`](#deprecatecustomevent)\n- [`previewCustomEvent`](#previewcustomevent)\n- [`publishCustomEventDefinition`](#publishcustomeventdefinition)\n- [`getEventJSONSchema`](#geteventjsonschema)\n- [`getEventExample`](#geteventexample)\n- [`listEventVersions`](#listeventversions)\n- [`searchEventHistory`](#searcheventhistory)\n- [`searchEventHistoryV2`](#searcheventhistoryv2)\n- [`getHistoricalEvent`](#gethistoricalevent)\n- [`triggerEvent`](#triggerevent)\n\n**Schemas**\n- [`EventConfigBase`](#eventconfigbase)\n- [`EventConfig`](#eventconfig)\n- [`CreateCustomEventPayload`](#createcustomeventpayload)\n- [`EventMapping`](#eventmapping)\n- [`CustomEventLineage`](#customeventlineage)\n- [`PurposeFilterSnapshot`](#purposefiltersnapshot)\n- [`PublishCustomEventPayload`](#publishcustomeventpayload)\n- [`ValidationIssue`](#validationissue)\n- [`PreviewEventResponse`](#previeweventresponse)\n- [`UpdateEventPayload`](#updateeventpayload)\n- [`PrimitiveField`](#primitivefield)\n- [`ContextEntity`](#contextentity)\n- [`AttachmentField`](#attachmentfield)\n- [`CustomSchemaField`](#customschemafield)\n- [`SchemaField`](#schemafield)\n- [`SuccessCriterion`](#successcriterion)\n- [`CommonEventMetadata`](#commoneventmetadata)\n- [`EventJsonSchema`](#eventjsonschema)\n- [`InlineDowngradeStep`](#inlinedowngradestep)\n- [`Event`](#event)\n- [`EventSummary`](#eventsummary)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`EntityOperationTrigger`](#entityoperationtrigger)\n- [`SearchOptions`](#searchoptions)\n- [`SearchOptionsV2`](#searchoptionsv2)\n- [`FieldsParam`](#fieldsparam)\n- [`TriggerEventPayload`](#triggereventpayload)\n- [`TriggerEventResponse`](#triggereventresponse)\n- [`EventAttachment`](#eventattachment)\n- [`FieldChange`](#fieldchange)\n- [`VersionMeta`](#versionmeta)\n- [`EventVersionRegistrySummary`](#eventversionregistrysummary)\n\n### `listEvents`\n\nRetrieve list of available business events\n\n`GET /v1/events`\n\n```ts\nconst { data } = await client.listEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "event_name": "AddMeterReading",\n      "event_title": "Add Meter Reading",\n      "event_description": "Triggered when a new meter reading is added",\n      "event_version": "1.0",\n      "event_status": "active",\n      "event_tags": ["builtin", "metering", "erp"],\n      "schema_fields": {},\n      "entity_graph": {\n        "nodes": [\n          {\n            "id": "contact",\n            "schema": "contact",\n            "cardinality": "one",\n            "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n          }\n        ],\n        "edges": [\n          {\n            "from": "contact",\n            "to": "billing_account"\n          }\n        ]\n      },\n      "entity_operation": {\n        "operation": ["createEntity", "updateEntity"],\n        "schema": ["contact", "contract", "order"],\n        "attribute": ["email", "phone", "status"],\n        "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n        "purpose_filters": [\n          {\n            "id": "string",\n            "display_name": "string"\n          }\n        ]\n      },\n      "enabled": true,\n      "auto_trigger": true,\n      "automation_trigger": true,\n      "automation_trigger_only": true,\n      "automation_trigger_seed_node": "ticket",\n      "event_origin": "builtin",\n      "mapping": {\n        "mode": "guided",\n        "jsonata": "string"\n      },\n      "lineage": {\n        "base_event_name": "string",\n        "base_event_version": "string"\n      },\n      "success_criteria": [\n        {\n          "entity_schema": "contract",\n          "attribute": "installment_amount"\n        },\n        {\n          "entity_schema": "billing_account",\n          "attribute": "due_date"\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createCustomEvent`\n\nReserve an org-scoped custom event name and persist its immutable v1.0 draft definition.\n\n`POST /v1/events`\n\n```ts\nconst { data } = await client.createCustomEvent(\n  null,\n  {\n    event_name: \'string\',\n    event_title: \'string\',\n    event_description: \'string\',\n    event_tags: [\'string\'],\n    schema_fields: {},\n    entity_graph: {\n      nodes: [\n        {\n          id: \'contact\',\n          schema: \'contact\',\n          cardinality: \'one\',\n          fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n        }\n      ],\n      edges: [\n        {\n          from: \'contact\',\n          to: \'billing_account\'\n        }\n      ]\n    },\n    entity_operation: {\n      operation: [\'createEntity\', \'updateEntity\'],\n      schema: [\'contact\', \'contract\', \'order\'],\n      attribute: [\'email\', \'phone\', \'status\'],\n      purpose: [\'K\xFCndigung\', \'Umzug/Auszug\'],\n      purpose_filters: [\n        {\n          id: \'string\',\n          display_name: \'string\'\n        }\n      ]\n    },\n    automation_trigger: true,\n    mapping: {\n      mode: \'guided\',\n      jsonata: \'string\'\n    },\n    lineage: {\n      base_event_name: \'string\',\n      base_event_version: \'string\'\n    },\n    example: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getEvent`\n\nRetrieve the configuration of a specific business event\n\n`GET /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.getEvent({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `patchEvent`\n\nUpdate the configuration of a specific business event for the organization\n\n`PATCH /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.patchEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    enabled: true,\n    auto_trigger: true,\n    success_criteria: [\n      {\n        entity_schema: \'contract\',\n        attribute: \'installment_amount\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `deprecateCustomEvent`\n\nSoft-deprecate an org-scoped custom event. Definitions and v1.0 history remain readable.\n\n`DELETE /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.deprecateCustomEvent({\n  event_name: \'example\',\n})\n```\n\n---\n\n### `previewCustomEvent`\n\nAssemble and fully validate a persisted custom-event draft without publishing it.\n\n`POST /v1/events/{event_name}:preview`\n\n```ts\nconst { data } = await client.previewCustomEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    seed: {\n      entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n      node_id: \'ticket\'\n    },\n    _trigger_source_type: \'automation\',\n    _trigger_source: \'execution-id/action-id\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "payload": {},\n  "errors": [\n    {\n      "path": "string",\n      "message": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `publishCustomEventDefinition`\n\nConditionally activate an immutable custom-event v1.0 definition.\n\n`POST /v1/events/{event_name}:publish`\n\n```ts\nconst { data } = await client.publishCustomEventDefinition(\n  {\n    event_name: \'example\',\n  },\n  {\n    enabled: true,\n    auto_trigger: true,\n    base_auto_trigger_enabled: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getEventJSONSchema`\n\nRetrieve the JSON Schema of a specific business event. Pass an optional\n`Epilot-Event-Version` header to retrieve a specific version\'s schema;\nwhen omitted, the event\'s latest version is returned.\n\n`GET /v1/events/{event_name}/json_schema`\n\n```ts\nconst { data } = await client.getEventJSONSchema({\n  event_name: \'example\',\n  Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "object",\n  "properties": {\n    "_org_id": {\n      "type": "string",\n      "description": "epilot tenant/organization ID"\n    },\n    "_event_time": {\n      "type": "string",\n      "format": "date-time",\n      "description": "ISO 8601 timestamp when event occurred"\n    },\n    "_event_id": {\n      "type": "string",\n      "description": "Unique event identifier (ULID)"\n    },\n    "_event_name": {\n      "type": "string",\n      "description": "Event name from catalog"\n    },\n    "_event_version": {\n      "type": "string",\n      "description": "Event payload version (MAJOR.MINOR)"\n    },\n    "_event_source": {\n      "type": "string",\n      "description": "Source that triggered the event"\n    },\n    "reading_value": {\n      "type": "number",\n      "description": "The meter reading value"\n    },\n    "reading_date": {\n      "type": "string",\n      "format": "date-time",\n      "description": "ISO 8601 timestamp when reading was taken"\n    },\n    "read_by": {\n      "type": "string",\n      "description": "Name or identifier of who submitted the reading"\n    },\n    "reason": {\n      "type": "string",\n      "enum": ["regular", "move-in", "move-out", "supplier-change", "correction", "final"],\n      "description": "Reason for the meter reading"\n    },\n    "direction": {\n      "type": "string",\n      "enum": ["feed-in", "feed-out"],\n      "description": "Direction of energy flow"\n    },\n    "source": {\n      "type": "string",\n      "enum": ["portal", "360", "api", "automation"],\n      "description": "Source system where reading was submitted"\n    },\n    "meter_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the meter"\n    },\n    "counter_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the meter counter"\n    },\n    "meter_number": {\n      "type": "string",\n      "description": "Human-readable meter number"\n    },\n    "obis_number": {\n      "type": "string",\n      "description": "OBIS code of the counter"\n    },\n    "unit": {\n      "type": "string",\n      "description": "Unit of measurement (e.g., kWh, m3)"\n    },\n    "customer_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the customer"\n    },\n    "contract_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the contract"\n    },\n    "user_id": {\n      "type": "string",\n      "description": "ID of the user who submitted the reading"\n    },\n    "user_email": {\n      "type": "string",\n      "format": "email",\n      "description": "Email of the user who submitted the reading"\n    }\n  },\n  "required": ["_org_id", "_event_time", "_event_id", "_event_name", "_event_version", "_event_source", "reading_value", "reading_date", "read_by", "reason", "direction", "source", "meter_id", "counter_id", "meter_number", "obis_number", "unit", "customer_id", "contract_id"]\n}\n```\n\n</details>\n\n---\n\n### `getEventExample`\n\nGenerate a sample event payload based on the event\'s JSON Schema. Pass an\noptional `Epilot-Event-Version` header to generate the example for a\nspecific version; when omitted, the event\'s latest versio\n\n`GET /v1/events/{event_name}/example`\n\n```ts\nconst { data } = await client.getEventExample({\n  event_name: \'example\',\n  Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `listEventVersions`\n\nList every known version of an event, along with the `latest`\nand the set of currently `active` versions. See \xA73.2 of the\nEvent Payload Versioning RFC.\n\n`GET /v1/events/{event_name}/versions`\n\n```ts\nconst { data } = await client.listEventVersions({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "MeterReadingAdded",\n  "latest": "1.0",\n  "versions": [\n    {\n      "version": "1.0",\n      "released_at": "2025-11-15",\n      "change_summary": "string",\n      "change_notes": "string",\n      "changes": [\n        {\n          "field": "reading",\n          "op": "added",\n          "type_old": "string",\n          "type_new": "string"\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistory`\n\nPaginated history of events\n\n`POST /v1/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistory(\n  {\n    event_name: \'example\',\n  },\n  {\n    limit: 10,\n    cursor: {\n      event_time: \'2025-10-31 12:34:56\',\n      event_id: \'evt_1234567890abcdef\'\n    },\n    timestamp: {\n      from: \'2025-10-01T00:00:00Z\',\n      to: \'2025-10-31T23:59:59Z\'\n    },\n    event_id: \'evt_1234567890abcdef\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_org_id": "org_123456",\n      "_event_time": "2024-01-01T12:00:00Z",\n      "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n      "_event_name": "MeterReading",\n      "_event_version": "1.0",\n      "_event_source": "api",\n      "_trigger_source_type": "api",\n      "_trigger_source": "user_123456",\n      "reading_value": 123.45,\n      "reading_date": "2024-01-01T11:59:00Z",\n      "read_by": "John Doe",\n      "reason": "regular",\n      "direction": "feed-out",\n      "source": "portal",\n      "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n      "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n      "meter_number": "MT123456789",\n      "obis_number": "1-0:1.8.0",\n      "unit": "kWh",\n      "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n      "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n    }\n  ],\n  "next_cursor": {\n    "event_time": "2025-10-31T12:34:56Z",\n    "event_id": "evt_1234567890abcdef"\n  }\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistoryV2`\n\nPaginated history of events with projected/lightweight payload (v2).\n\n`POST /v2/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistoryV2(\n  {\n    event_name: \'example\',\n  },\n  {\n    limit: 10,\n    cursor: {\n      event_time: \'2025-10-31 12:34:56\',\n      event_id: \'evt_1234567890abcdef\'\n    },\n    timestamp: {\n      from: \'2025-10-01T00:00:00Z\',\n      to: \'2025-10-31T23:59:59Z\'\n    },\n    event_id: \'evt_1234567890abcdef\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_org_id": "string",\n      "_event_time": "1970-01-01T00:00:00.000Z",\n      "_event_id": "string",\n      "_event_name": "string",\n      "_event_version": "1.0",\n      "_event_source": "string",\n      "_trigger_source_type": "api",\n      "_trigger_source": "string",\n      "_ack_id": "string"\n    }\n  ],\n  "next_cursor": {\n    "event_time": "2025-10-31T12:34:56Z",\n    "event_id": "evt_1234567890abcdef"\n  }\n}\n```\n\n</details>\n\n---\n\n### `getHistoricalEvent`\n\nFetch a single historical event by id with full hydration\n\n`GET /v2/events/{event_name}/history/{event_id}`\n\n```ts\nconst { data } = await client.getHistoricalEvent({\n  event_name: \'example\',\n  event_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_org_id": "org_123456",\n  "_event_time": "2024-01-01T12:00:00Z",\n  "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n  "_event_name": "MeterReading",\n  "_event_version": "1.0",\n  "_event_source": "api",\n  "_trigger_source_type": "api",\n  "_trigger_source": "user_123456",\n  "reading_value": 123.45,\n  "reading_date": "2024-01-01T11:59:00Z",\n  "read_by": "John Doe",\n  "reason": "regular",\n  "direction": "feed-out",\n  "source": "portal",\n  "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n  "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n  "meter_number": "MT123456789",\n  "obis_number": "1-0:1.8.0",\n  "unit": "kWh",\n  "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n  "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n}\n```\n\n</details>\n\n---\n\n### `triggerEvent`\n\nExplicitly trigger an event by providing input field values and an optional entity seed\nfor graph hydration. The event must be enabled for the organization.\n\n`POST /v1/events/{event_name}:trigger`\n\n```ts\nconst { data } = await client.triggerEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    seed: {\n      entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n      node_id: \'ticket\'\n    },\n    _trigger_source_type: \'automation\',\n    _trigger_source: \'execution-id/action-id\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true,\n  "event_id": "string",\n  "event_bridge_event_id": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EventConfigBase`\n\nBase properties shared between EventConfig and UpdateEventPayload\n\n```ts\ntype EventConfigBase = {\n  event_name?: string\n  event_title?: string\n  event_description?: string\n  event_version?: string\n  event_status?: "active" | "deprecated" | "draft" | "disabled"\n  event_tags?: string[]\n  schema_fields?: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  } | {\n    items: {\n      entity_id: { ... }\n      filename?: { ... }\n      mime_type?: { ... }\n      size_bytes?: { ... }\n      s3ref?: { ... }\n      version_index: { ... }\n      readable_size?: { ... }\n    }\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  automation_trigger_only?: boolean\n  automation_trigger_seed_node?: string\n  event_origin?: "builtin" | "custom"\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `EventConfig`\n\nEvent configuration with required fields\n\n```ts\ntype EventConfig = {\n  event_name: string\n  event_title?: string\n  event_description?: string\n  event_version: string\n  event_status?: "active" | "deprecated" | "draft" | "disabled"\n  event_tags?: string[]\n  schema_fields: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  } | {\n    items: {\n      entity_id: { ... }\n      filename?: { ... }\n      mime_type?: { ... }\n      size_bytes?: { ... }\n      s3ref?: { ... }\n      version_index: { ... }\n      readable_size?: { ... }\n    }\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  automation_trigger_only?: boolean\n  automation_trigger_seed_node?: string\n  event_origin?: "builtin" | "custom"\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `CreateCustomEventPayload`\n\nComplete immutable custom-event v1.0 definition. Publication is a separate conditional action.\n\n```ts\ntype CreateCustomEventPayload = {\n  event_name: string\n  event_title: string\n  event_description?: string\n  event_tags?: string[]\n  schema_fields: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  automation_trigger?: boolean\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  example?: Record<string, unknown>\n}\n```\n\n### `EventMapping`\n\nGuided mappings use schema_fields graph_source expressions; raw mode evaluates one JSONata object transform.\n\n```ts\ntype EventMapping = {\n  mode: "guided" | "jsonata"\n  jsonata?: string\n}\n```\n\n### `CustomEventLineage`\n\nOptional catalog lineage to a separately named base event. It does not replace the base event.\n\n```ts\ntype CustomEventLineage = {\n  base_event_name: string\n  base_event_version: string\n}\n```\n\n### `PurposeFilterSnapshot`\n\n```ts\ntype PurposeFilterSnapshot = {\n  id: string\n  display_name: string\n}\n```\n\n### `PublishCustomEventPayload`\n\n```ts\ntype PublishCustomEventPayload = {\n  enabled?: boolean\n  auto_trigger?: boolean\n  base_auto_trigger_enabled?: boolean\n}\n```\n\n### `ValidationIssue`\n\n```ts\ntype ValidationIssue = {\n  path: string\n  message: string\n}\n```\n\n### `PreviewEventResponse`\n\n```ts\ntype PreviewEventResponse = {\n  payload: Record<string, unknown>\n  errors: Array<{\n    path: string\n    message: string\n  }>\n}\n```\n\n### `UpdateEventPayload`\n\nMutable org activation overlay. Immutable event definition fields are not accepted.\n\n```ts\ntype UpdateEventPayload = {\n  enabled?: boolean\n  auto_trigger?: boolean\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `PrimitiveField`\n\nA primitive JSON Schema field definition\n\n```ts\ntype PrimitiveField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n}\n```\n\n### `ContextEntity`\n\n```ts\ntype ContextEntity = {\n  entity_schema: string\n  required?: boolean\n}\n```\n\n### `AttachmentField`\n\nA schema field representing file attachments associated with the event.\nPresent in schema_fields for events tagged with "attachment".\n\n\n```ts\ntype AttachmentField = {\n  items: {\n    entity_id: string // uuid\n    filename?: string\n    mime_type?: string\n    size_bytes?: number\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n    version_index: number\n    readable_size?: string\n  }\n  required?: boolean\n}\n```\n\n### `CustomSchemaField`\n\nCustom v1 fields support JSON Schema values and context entities; attachment semantics are built-in-only.\n\n```ts\ntype CustomSchemaField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n} | {\n  entity_schema: string\n  required?: boolean\n}\n```\n\n### `SchemaField`\n\n```ts\ntype SchemaField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n} | {\n  entity_schema: string\n  required?: boolean\n} | {\n  items: {\n    entity_id: string // uuid\n    filename?: string\n    mime_type?: string\n    size_bytes?: number\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n    version_index: number\n    readable_size?: string\n  }\n  required?: boolean\n}\n```\n\n### `SuccessCriterion`\n\nA single org-defined success criterion: an entity attribute that must be captured\nfor this event\'s change request to be considered complete.\n\nIdentity is the entity schema plus the attribute name \u2014 mirroring the\nEntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both\n`attribut\n\n```ts\ntype SuccessCriterion = {\n  entity_schema: string\n  attribute: string\n}\n```\n\n### `CommonEventMetadata`\n\nCommon metadata fields present in all event payloads\n\n```ts\ntype CommonEventMetadata = object\n```\n\n### `EventJsonSchema`\n\nJSON Schema declaring the event payload structure\n\n```ts\ntype EventJsonSchema = object\n```\n\n### `InlineDowngradeStep`\n\nOne step of an event\'s inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.\n\n```ts\ntype InlineDowngradeStep = {\n  to: string\n  jsonata: string\n}\n```\n\n### `Event`\n\nAn event instance in the event history\n\n```ts\ntype Event = {\n  _org_id: string\n  _event_time: string // date-time\n  _event_id: string\n  _event_name: string\n  _event_version: string\n  _event_source: string\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _ack_id?: string\n  _downgrades?: Array<{\n    to: string\n    jsonata: string\n  }>\n  _automation_chain?: string[]\n}\n```\n\n### `EventSummary`\n\nA lightweight event summary returned by the v2 history endpoint.\n\nIncludes the standard `_*` metadata fields plus a projected subset of the\nevent payload. Hydrated entity objects (values carrying `_schema` or `_id`)\n\u2014 and arrays of such objects \u2014 are reduced to reference stubs\n`{_schema, _id, _title\n\n```ts\ntype EventSummary = {\n  _org_id: string\n  _event_time: string // date-time\n  _event_id: string\n  _event_name: string\n  _event_version: string\n  _event_source: string\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _ack_id?: string\n}\n```\n\n### `GraphDefinition`\n\nEntity graph definition for resolving related entities\n\n```ts\ntype GraphDefinition = {\n  nodes: Array<{\n    id: string\n    schema: string\n    cardinality?: "one" | "many"\n    fields?: object\n  }>\n  edges: Array<{\n    from: string\n    to: string\n  }>\n}\n```\n\n### `GraphNode`\n\nA node in the entity graph\n\n```ts\ntype GraphNode = {\n  id: string\n  schema: string\n  cardinality?: "one" | "many"\n  fields?: object\n}\n```\n\n### `GraphEdge`\n\nAn edge connecting two nodes in the graph\n\n```ts\ntype GraphEdge = {\n  from: string\n  to: string\n}\n```\n\n### `EntityOperationTrigger`\n\nConfiguration for triggering an event based on entity operations.\n\nWhen an entity operation matches the configured criteria, the event will be triggered.\n- On createEntity: the attribute must be present in the entity payload\n- On updateEntity: the attribute must be in diff.added, diff.updated, or di\n\n```ts\ntype EntityOperationTrigger = {\n  operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n  schema: string[]\n  attribute?: string[]\n  purpose?: string[]\n  purpose_filters?: Array<{\n    id: string\n    display_name: string\n  }>\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n  limit?: number\n  cursor?: {\n    event_time?: string\n    event_id?: string\n  }\n  timestamp?: {\n    from?: string // date-time\n    to?: string // date-time\n  }\n  event_id?: string\n}\n```\n\n### `SearchOptionsV2`\n\nSearch options for the v2 history endpoint.\n\nExtends `SearchOptions` with an optional `fields` projection. When `fields`\nis omitted, the response includes all `_*` metadata plus all scalar payload\nfields (and primitive arrays / empty objects/arrays) after entity stripping.\nWhen `fields` is provided,\n\n```ts\ntype SearchOptionsV2 = {\n  limit?: number\n  cursor?: {\n    event_time?: string\n    event_id?: string\n  }\n  timestamp?: {\n    from?: string // date-time\n    to?: string // date-time\n  }\n  event_id?: string\n  fields?: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `TriggerEventPayload`\n\nPayload for explicitly triggering an event via API\n\n```ts\ntype TriggerEventPayload = {\n  seed?: {\n    entity_id: string // uuid\n    node_id: string\n  }\n  fields?: Record<string, unknown>\n  skip_hydration?: string[]\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _automation_chain?: string[]\n}\n```\n\n### `TriggerEventResponse`\n\nResponse from triggering an event\n\n```ts\ntype TriggerEventResponse = {\n  success: boolean\n  event_id: string\n  event_bridge_event_id?: string\n}\n```\n\n### `EventAttachment`\n\nA file attachment associated with an event\n\n```ts\ntype EventAttachment = {\n  entity_id: string // uuid\n  filename?: string\n  mime_type?: string\n  size_bytes?: number\n  s3ref?: {\n    bucket: string\n    key: string\n  }\n  version_index: number\n  readable_size?: string\n}\n```\n\n### `FieldChange`\n\nA field-level change descriptor. Powers the declarative half of the\nversion DSL.\n\n\n```ts\ntype FieldChange = {\n  field: string\n  op: "added" | "removed" | "type-changed"\n  type_old?: string\n  type_new?: string\n}\n```\n\n### `VersionMeta`\n\nOne entry of an event\'s version timeline.\n\n```ts\ntype VersionMeta = {\n  version: string\n  released_at: string\n  change_summary: string\n  change_notes?: string\n  changes: Array<{\n    field: string\n    op: "added" | "removed" | "type-changed"\n    type_old?: string\n    type_new?: string\n  }>\n}\n```\n\n### `EventVersionRegistrySummary`\n\nSummary of an event\'s version timeline returned by\n`GET /v1/events/{event_name}/versions`.\n\n\n```ts\ntype EventVersionRegistrySummary = {\n  event_name: string\n  latest: string\n  versions: Array<{\n    version: string\n    released_at: string\n    change_summary: string\n    change_notes?: string\n    changes: Array<{\n      field: { ... }\n      op: { ... }\n      type_old?: { ... }\n      type_new?: { ... }\n    }>\n  }>\n}\n```\n';
-
-
-exports.default = event_catalog_default;

package/dist/event-catalog-PEOHXUJO.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/event-catalog.json
-var event_catalog_default = '# Event Catalog API\n\n- **Base URL:** `https://event-catalog.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/event-catalog](https://docs.epilot.io/api/event-catalog)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.eventCatalog.listEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/event-catalog\'\n\nconst eventCatalogClient = getClient()\nauthorize(eventCatalogClient, () => \'<token>\')\nconst { data } = await eventCatalogClient.listEvents(...)\n```\n\n## Operations\n\n**Event Catalog**\n- [`listEvents`](#listevents)\n- [`createCustomEvent`](#createcustomevent)\n- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\n- [`deprecateCustomEvent`](#deprecatecustomevent)\n- [`previewCustomEvent`](#previewcustomevent)\n- [`publishCustomEventDefinition`](#publishcustomeventdefinition)\n- [`getEventJSONSchema`](#geteventjsonschema)\n- [`getEventExample`](#geteventexample)\n- [`listEventVersions`](#listeventversions)\n- [`searchEventHistory`](#searcheventhistory)\n- [`searchEventHistoryV2`](#searcheventhistoryv2)\n- [`getHistoricalEvent`](#gethistoricalevent)\n- [`triggerEvent`](#triggerevent)\n\n**Schemas**\n- [`EventConfigBase`](#eventconfigbase)\n- [`EventConfig`](#eventconfig)\n- [`CreateCustomEventPayload`](#createcustomeventpayload)\n- [`EventMapping`](#eventmapping)\n- [`CustomEventLineage`](#customeventlineage)\n- [`PurposeFilterSnapshot`](#purposefiltersnapshot)\n- [`PublishCustomEventPayload`](#publishcustomeventpayload)\n- [`ValidationIssue`](#validationissue)\n- [`PreviewEventResponse`](#previeweventresponse)\n- [`UpdateEventPayload`](#updateeventpayload)\n- [`PrimitiveField`](#primitivefield)\n- [`ContextEntity`](#contextentity)\n- [`AttachmentField`](#attachmentfield)\n- [`CustomSchemaField`](#customschemafield)\n- [`SchemaField`](#schemafield)\n- [`SuccessCriterion`](#successcriterion)\n- [`CommonEventMetadata`](#commoneventmetadata)\n- [`EventJsonSchema`](#eventjsonschema)\n- [`InlineDowngradeStep`](#inlinedowngradestep)\n- [`Event`](#event)\n- [`EventSummary`](#eventsummary)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`EntityOperationTrigger`](#entityoperationtrigger)\n- [`SearchOptions`](#searchoptions)\n- [`SearchOptionsV2`](#searchoptionsv2)\n- [`FieldsParam`](#fieldsparam)\n- [`TriggerEventPayload`](#triggereventpayload)\n- [`TriggerEventResponse`](#triggereventresponse)\n- [`EventAttachment`](#eventattachment)\n- [`FieldChange`](#fieldchange)\n- [`VersionMeta`](#versionmeta)\n- [`EventVersionRegistrySummary`](#eventversionregistrysummary)\n\n### `listEvents`\n\nRetrieve list of available business events\n\n`GET /v1/events`\n\n```ts\nconst { data } = await client.listEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "event_name": "AddMeterReading",\n      "event_title": "Add Meter Reading",\n      "event_description": "Triggered when a new meter reading is added",\n      "event_version": "1.0",\n      "event_status": "active",\n      "event_tags": ["builtin", "metering", "erp"],\n      "schema_fields": {},\n      "entity_graph": {\n        "nodes": [\n          {\n            "id": "contact",\n            "schema": "contact",\n            "cardinality": "one",\n            "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n          }\n        ],\n        "edges": [\n          {\n            "from": "contact",\n            "to": "billing_account"\n          }\n        ]\n      },\n      "entity_operation": {\n        "operation": ["createEntity", "updateEntity"],\n        "schema": ["contact", "contract", "order"],\n        "attribute": ["email", "phone", "status"],\n        "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n        "purpose_filters": [\n          {\n            "id": "string",\n            "display_name": "string"\n          }\n        ]\n      },\n      "enabled": true,\n      "auto_trigger": true,\n      "automation_trigger": true,\n      "automation_trigger_only": true,\n      "automation_trigger_seed_node": "ticket",\n      "event_origin": "builtin",\n      "mapping": {\n        "mode": "guided",\n        "jsonata": "string"\n      },\n      "lineage": {\n        "base_event_name": "string",\n        "base_event_version": "string"\n      },\n      "success_criteria": [\n        {\n          "entity_schema": "contract",\n          "attribute": "installment_amount"\n        },\n        {\n          "entity_schema": "billing_account",\n          "attribute": "due_date"\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createCustomEvent`\n\nReserve an org-scoped custom event name and persist its immutable v1.0 draft definition.\n\n`POST /v1/events`\n\n```ts\nconst { data } = await client.createCustomEvent(\n  null,\n  {\n    event_name: \'string\',\n    event_title: \'string\',\n    event_description: \'string\',\n    event_tags: [\'string\'],\n    schema_fields: {},\n    entity_graph: {\n      nodes: [\n        {\n          id: \'contact\',\n          schema: \'contact\',\n          cardinality: \'one\',\n          fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n        }\n      ],\n      edges: [\n        {\n          from: \'contact\',\n          to: \'billing_account\'\n        }\n      ]\n    },\n    entity_operation: {\n      operation: [\'createEntity\', \'updateEntity\'],\n      schema: [\'contact\', \'contract\', \'order\'],\n      attribute: [\'email\', \'phone\', \'status\'],\n      purpose: [\'K\xFCndigung\', \'Umzug/Auszug\'],\n      purpose_filters: [\n        {\n          id: \'string\',\n          display_name: \'string\'\n        }\n      ]\n    },\n    automation_trigger: true,\n    mapping: {\n      mode: \'guided\',\n      jsonata: \'string\'\n    },\n    lineage: {\n      base_event_name: \'string\',\n      base_event_version: \'string\'\n    },\n    example: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getEvent`\n\nRetrieve the configuration of a specific business event\n\n`GET /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.getEvent({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `patchEvent`\n\nUpdate the configuration of a specific business event for the organization\n\n`PATCH /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.patchEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    enabled: true,\n    auto_trigger: true,\n    success_criteria: [\n      {\n        entity_schema: \'contract\',\n        attribute: \'installment_amount\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `deprecateCustomEvent`\n\nSoft-deprecate an org-scoped custom event. Definitions and v1.0 history remain readable.\n\n`DELETE /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.deprecateCustomEvent({\n  event_name: \'example\',\n})\n```\n\n---\n\n### `previewCustomEvent`\n\nAssemble and fully validate a persisted custom-event draft without publishing it.\n\n`POST /v1/events/{event_name}:preview`\n\n```ts\nconst { data } = await client.previewCustomEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    seed: {\n      entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n      node_id: \'ticket\'\n    },\n    _trigger_source_type: \'automation\',\n    _trigger_source: \'execution-id/action-id\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "payload": {},\n  "errors": [\n    {\n      "path": "string",\n      "message": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `publishCustomEventDefinition`\n\nConditionally activate an immutable custom-event v1.0 definition.\n\n`POST /v1/events/{event_name}:publish`\n\n```ts\nconst { data } = await client.publishCustomEventDefinition(\n  {\n    event_name: \'example\',\n  },\n  {\n    enabled: true,\n    auto_trigger: true,\n    base_auto_trigger_enabled: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "AddMeterReading",\n  "event_title": "Add Meter Reading",\n  "event_description": "Triggered when a new meter reading is added",\n  "event_version": "1.0",\n  "event_status": "active",\n  "event_tags": ["builtin", "metering", "erp"],\n  "schema_fields": {},\n  "entity_graph": {\n    "nodes": [\n      {\n        "id": "contact",\n        "schema": "contact",\n        "cardinality": "one",\n        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n      }\n    ],\n    "edges": [\n      {\n        "from": "contact",\n        "to": "billing_account"\n      }\n    ]\n  },\n  "entity_operation": {\n    "operation": ["createEntity", "updateEntity"],\n    "schema": ["contact", "contract", "order"],\n    "attribute": ["email", "phone", "status"],\n    "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n    "purpose_filters": [\n      {\n        "id": "string",\n        "display_name": "string"\n      }\n    ]\n  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\n  "automation_trigger_only": true,\n  "automation_trigger_seed_node": "ticket",\n  "event_origin": "builtin",\n  "mapping": {\n    "mode": "guided",\n    "jsonata": "string"\n  },\n  "lineage": {\n    "base_event_name": "string",\n    "base_event_version": "string"\n  },\n  "success_criteria": [\n    {\n      "entity_schema": "contract",\n      "attribute": "installment_amount"\n    },\n    {\n      "entity_schema": "billing_account",\n      "attribute": "due_date"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getEventJSONSchema`\n\nRetrieve the JSON Schema of a specific business event. Pass an optional\n`Epilot-Event-Version` header to retrieve a specific version\'s schema;\nwhen omitted, the event\'s latest version is returned.\n\n`GET /v1/events/{event_name}/json_schema`\n\n```ts\nconst { data } = await client.getEventJSONSchema({\n  event_name: \'example\',\n  Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "object",\n  "properties": {\n    "_org_id": {\n      "type": "string",\n      "description": "epilot tenant/organization ID"\n    },\n    "_event_time": {\n      "type": "string",\n      "format": "date-time",\n      "description": "ISO 8601 timestamp when event occurred"\n    },\n    "_event_id": {\n      "type": "string",\n      "description": "Unique event identifier (ULID)"\n    },\n    "_event_name": {\n      "type": "string",\n      "description": "Event name from catalog"\n    },\n    "_event_version": {\n      "type": "string",\n      "description": "Event payload version (MAJOR.MINOR)"\n    },\n    "_event_source": {\n      "type": "string",\n      "description": "Source that triggered the event"\n    },\n    "reading_value": {\n      "type": "number",\n      "description": "The meter reading value"\n    },\n    "reading_date": {\n      "type": "string",\n      "format": "date-time",\n      "description": "ISO 8601 timestamp when reading was taken"\n    },\n    "read_by": {\n      "type": "string",\n      "description": "Name or identifier of who submitted the reading"\n    },\n    "reason": {\n      "type": "string",\n      "enum": ["regular", "move-in", "move-out", "supplier-change", "correction", "final"],\n      "description": "Reason for the meter reading"\n    },\n    "direction": {\n      "type": "string",\n      "enum": ["feed-in", "feed-out"],\n      "description": "Direction of energy flow"\n    },\n    "source": {\n      "type": "string",\n      "enum": ["portal", "360", "api", "automation"],\n      "description": "Source system where reading was submitted"\n    },\n    "meter_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the meter"\n    },\n    "counter_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the meter counter"\n    },\n    "meter_number": {\n      "type": "string",\n      "description": "Human-readable meter number"\n    },\n    "obis_number": {\n      "type": "string",\n      "description": "OBIS code of the counter"\n    },\n    "unit": {\n      "type": "string",\n      "description": "Unit of measurement (e.g., kWh, m3)"\n    },\n    "customer_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the customer"\n    },\n    "contract_id": {\n      "type": "string",\n      "format": "uuid",\n      "description": "Entity ID of the contract"\n    },\n    "user_id": {\n      "type": "string",\n      "description": "ID of the user who submitted the reading"\n    },\n    "user_email": {\n      "type": "string",\n      "format": "email",\n      "description": "Email of the user who submitted the reading"\n    }\n  },\n  "required": ["_org_id", "_event_time", "_event_id", "_event_name", "_event_version", "_event_source", "reading_value", "reading_date", "read_by", "reason", "direction", "source", "meter_id", "counter_id", "meter_number", "obis_number", "unit", "customer_id", "contract_id"]\n}\n```\n\n</details>\n\n---\n\n### `getEventExample`\n\nGenerate a sample event payload based on the event\'s JSON Schema. Pass an\noptional `Epilot-Event-Version` header to generate the example for a\nspecific version; when omitted, the event\'s latest versio\n\n`GET /v1/events/{event_name}/example`\n\n```ts\nconst { data } = await client.getEventExample({\n  event_name: \'example\',\n  Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `listEventVersions`\n\nList every known version of an event, along with the `latest`\nand the set of currently `active` versions. See \xA73.2 of the\nEvent Payload Versioning RFC.\n\n`GET /v1/events/{event_name}/versions`\n\n```ts\nconst { data } = await client.listEventVersions({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_name": "MeterReadingAdded",\n  "latest": "1.0",\n  "versions": [\n    {\n      "version": "1.0",\n      "released_at": "2025-11-15",\n      "change_summary": "string",\n      "change_notes": "string",\n      "changes": [\n        {\n          "field": "reading",\n          "op": "added",\n          "type_old": "string",\n          "type_new": "string"\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistory`\n\nPaginated history of events\n\n`POST /v1/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistory(\n  {\n    event_name: \'example\',\n  },\n  {\n    limit: 10,\n    cursor: {\n      event_time: \'2025-10-31 12:34:56\',\n      event_id: \'evt_1234567890abcdef\'\n    },\n    timestamp: {\n      from: \'2025-10-01T00:00:00Z\',\n      to: \'2025-10-31T23:59:59Z\'\n    },\n    event_id: \'evt_1234567890abcdef\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_org_id": "org_123456",\n      "_event_time": "2024-01-01T12:00:00Z",\n      "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n      "_event_name": "MeterReading",\n      "_event_version": "1.0",\n      "_event_source": "api",\n      "_trigger_source_type": "api",\n      "_trigger_source": "user_123456",\n      "reading_value": 123.45,\n      "reading_date": "2024-01-01T11:59:00Z",\n      "read_by": "John Doe",\n      "reason": "regular",\n      "direction": "feed-out",\n      "source": "portal",\n      "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n      "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n      "meter_number": "MT123456789",\n      "obis_number": "1-0:1.8.0",\n      "unit": "kWh",\n      "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n      "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n    }\n  ],\n  "next_cursor": {\n    "event_time": "2025-10-31T12:34:56Z",\n    "event_id": "evt_1234567890abcdef"\n  }\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistoryV2`\n\nPaginated history of events with projected/lightweight payload (v2).\n\n`POST /v2/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistoryV2(\n  {\n    event_name: \'example\',\n  },\n  {\n    limit: 10,\n    cursor: {\n      event_time: \'2025-10-31 12:34:56\',\n      event_id: \'evt_1234567890abcdef\'\n    },\n    timestamp: {\n      from: \'2025-10-01T00:00:00Z\',\n      to: \'2025-10-31T23:59:59Z\'\n    },\n    event_id: \'evt_1234567890abcdef\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_org_id": "string",\n      "_event_time": "1970-01-01T00:00:00.000Z",\n      "_event_id": "string",\n      "_event_name": "string",\n      "_event_version": "1.0",\n      "_event_source": "string",\n      "_trigger_source_type": "api",\n      "_trigger_source": "string",\n      "_ack_id": "string"\n    }\n  ],\n  "next_cursor": {\n    "event_time": "2025-10-31T12:34:56Z",\n    "event_id": "evt_1234567890abcdef"\n  }\n}\n```\n\n</details>\n\n---\n\n### `getHistoricalEvent`\n\nFetch a single historical event by id with full hydration\n\n`GET /v2/events/{event_name}/history/{event_id}`\n\n```ts\nconst { data } = await client.getHistoricalEvent({\n  event_name: \'example\',\n  event_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_org_id": "org_123456",\n  "_event_time": "2024-01-01T12:00:00Z",\n  "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n  "_event_name": "MeterReading",\n  "_event_version": "1.0",\n  "_event_source": "api",\n  "_trigger_source_type": "api",\n  "_trigger_source": "user_123456",\n  "reading_value": 123.45,\n  "reading_date": "2024-01-01T11:59:00Z",\n  "read_by": "John Doe",\n  "reason": "regular",\n  "direction": "feed-out",\n  "source": "portal",\n  "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n  "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n  "meter_number": "MT123456789",\n  "obis_number": "1-0:1.8.0",\n  "unit": "kWh",\n  "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n  "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n}\n```\n\n</details>\n\n---\n\n### `triggerEvent`\n\nExplicitly trigger an event by providing input field values and an optional entity seed\nfor graph hydration. The event must be enabled for the organization.\n\n`POST /v1/events/{event_name}:trigger`\n\n```ts\nconst { data } = await client.triggerEvent(\n  {\n    event_name: \'example\',\n  },\n  {\n    seed: {\n      entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n      node_id: \'ticket\'\n    },\n    _trigger_source_type: \'automation\',\n    _trigger_source: \'execution-id/action-id\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true,\n  "event_id": "string",\n  "event_bridge_event_id": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EventConfigBase`\n\nBase properties shared between EventConfig and UpdateEventPayload\n\n```ts\ntype EventConfigBase = {\n  event_name?: string\n  event_title?: string\n  event_description?: string\n  event_version?: string\n  event_status?: "active" | "deprecated" | "draft" | "disabled"\n  event_tags?: string[]\n  schema_fields?: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  } | {\n    items: {\n      entity_id: { ... }\n      filename?: { ... }\n      mime_type?: { ... }\n      size_bytes?: { ... }\n      s3ref?: { ... }\n      version_index: { ... }\n      readable_size?: { ... }\n    }\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  automation_trigger_only?: boolean\n  automation_trigger_seed_node?: string\n  event_origin?: "builtin" | "custom"\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `EventConfig`\n\nEvent configuration with required fields\n\n```ts\ntype EventConfig = {\n  event_name: string\n  event_title?: string\n  event_description?: string\n  event_version: string\n  event_status?: "active" | "deprecated" | "draft" | "disabled"\n  event_tags?: string[]\n  schema_fields: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  } | {\n    items: {\n      entity_id: { ... }\n      filename?: { ... }\n      mime_type?: { ... }\n      size_bytes?: { ... }\n      s3ref?: { ... }\n      version_index: { ... }\n      readable_size?: { ... }\n    }\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  automation_trigger_only?: boolean\n  automation_trigger_seed_node?: string\n  event_origin?: "builtin" | "custom"\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `CreateCustomEventPayload`\n\nComplete immutable custom-event v1.0 definition. Publication is a separate conditional action.\n\n```ts\ntype CreateCustomEventPayload = {\n  event_name: string\n  event_title: string\n  event_description?: string\n  event_tags?: string[]\n  schema_fields: Record<string, {\n    json_schema: object\n    required?: boolean\n    graph_source?: string\n  } | {\n    entity_schema: string\n    required?: boolean\n  }>\n  entity_graph?: {\n    nodes: Array<{\n      id: { ... }\n      schema: { ... }\n      cardinality?: { ... }\n      fields?: { ... }\n    }>\n    edges: Array<{\n      from: { ... }\n      to: { ... }\n    }>\n  }\n  entity_operation?: {\n    operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n    schema: string[]\n    attribute?: string[]\n    purpose?: string[]\n    purpose_filters?: Array<{\n      id: { ... }\n      display_name: { ... }\n    }>\n  }\n  automation_trigger?: boolean\n  mapping?: {\n    mode: "guided" | "jsonata"\n    jsonata?: string\n  }\n  lineage?: {\n    base_event_name: string\n    base_event_version: string\n  }\n  example?: Record<string, unknown>\n}\n```\n\n### `EventMapping`\n\nGuided mappings use schema_fields graph_source expressions; raw mode evaluates one JSONata object transform.\n\n```ts\ntype EventMapping = {\n  mode: "guided" | "jsonata"\n  jsonata?: string\n}\n```\n\n### `CustomEventLineage`\n\nOptional catalog lineage to a separately named base event. It does not replace the base event.\n\n```ts\ntype CustomEventLineage = {\n  base_event_name: string\n  base_event_version: string\n}\n```\n\n### `PurposeFilterSnapshot`\n\n```ts\ntype PurposeFilterSnapshot = {\n  id: string\n  display_name: string\n}\n```\n\n### `PublishCustomEventPayload`\n\n```ts\ntype PublishCustomEventPayload = {\n  enabled?: boolean\n  auto_trigger?: boolean\n  base_auto_trigger_enabled?: boolean\n}\n```\n\n### `ValidationIssue`\n\n```ts\ntype ValidationIssue = {\n  path: string\n  message: string\n}\n```\n\n### `PreviewEventResponse`\n\n```ts\ntype PreviewEventResponse = {\n  payload: Record<string, unknown>\n  errors: Array<{\n    path: string\n    message: string\n  }>\n}\n```\n\n### `UpdateEventPayload`\n\nMutable org activation overlay. Immutable event definition fields are not accepted.\n\n```ts\ntype UpdateEventPayload = {\n  enabled?: boolean\n  auto_trigger?: boolean\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `PrimitiveField`\n\nA primitive JSON Schema field definition\n\n```ts\ntype PrimitiveField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n}\n```\n\n### `ContextEntity`\n\n```ts\ntype ContextEntity = {\n  entity_schema: string\n  required?: boolean\n}\n```\n\n### `AttachmentField`\n\nA schema field representing file attachments associated with the event.\nPresent in schema_fields for events tagged with "attachment".\n\n\n```ts\ntype AttachmentField = {\n  items: {\n    entity_id: string // uuid\n    filename?: string\n    mime_type?: string\n    size_bytes?: number\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n    version_index: number\n    readable_size?: string\n  }\n  required?: boolean\n}\n```\n\n### `CustomSchemaField`\n\nCustom v1 fields support JSON Schema values and context entities; attachment semantics are built-in-only.\n\n```ts\ntype CustomSchemaField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n} | {\n  entity_schema: string\n  required?: boolean\n}\n```\n\n### `SchemaField`\n\n```ts\ntype SchemaField = {\n  json_schema: object\n  required?: boolean\n  graph_source?: string\n} | {\n  entity_schema: string\n  required?: boolean\n} | {\n  items: {\n    entity_id: string // uuid\n    filename?: string\n    mime_type?: string\n    size_bytes?: number\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n    version_index: number\n    readable_size?: string\n  }\n  required?: boolean\n}\n```\n\n### `SuccessCriterion`\n\nA single org-defined success criterion: an entity attribute that must be captured\nfor this event\'s change request to be considered complete.\n\nIdentity is the entity schema plus the attribute name \u2014 mirroring the\nEntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both\n`attribut\n\n```ts\ntype SuccessCriterion = {\n  entity_schema: string\n  attribute: string\n}\n```\n\n### `CommonEventMetadata`\n\nCommon metadata fields present in all event payloads\n\n```ts\ntype CommonEventMetadata = object\n```\n\n### `EventJsonSchema`\n\nJSON Schema declaring the event payload structure\n\n```ts\ntype EventJsonSchema = object\n```\n\n### `InlineDowngradeStep`\n\nOne step of an event\'s inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.\n\n```ts\ntype InlineDowngradeStep = {\n  to: string\n  jsonata: string\n}\n```\n\n### `Event`\n\nAn event instance in the event history\n\n```ts\ntype Event = {\n  _org_id: string\n  _event_time: string // date-time\n  _event_id: string\n  _event_name: string\n  _event_version: string\n  _event_source: string\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _ack_id?: string\n  _downgrades?: Array<{\n    to: string\n    jsonata: string\n  }>\n  _automation_chain?: string[]\n}\n```\n\n### `EventSummary`\n\nA lightweight event summary returned by the v2 history endpoint.\n\nIncludes the standard `_*` metadata fields plus a projected subset of the\nevent payload. Hydrated entity objects (values carrying `_schema` or `_id`)\n\u2014 and arrays of such objects \u2014 are reduced to reference stubs\n`{_schema, _id, _title\n\n```ts\ntype EventSummary = {\n  _org_id: string\n  _event_time: string // date-time\n  _event_id: string\n  _event_name: string\n  _event_version: string\n  _event_source: string\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _ack_id?: string\n}\n```\n\n### `GraphDefinition`\n\nEntity graph definition for resolving related entities\n\n```ts\ntype GraphDefinition = {\n  nodes: Array<{\n    id: string\n    schema: string\n    cardinality?: "one" | "many"\n    fields?: object\n  }>\n  edges: Array<{\n    from: string\n    to: string\n  }>\n}\n```\n\n### `GraphNode`\n\nA node in the entity graph\n\n```ts\ntype GraphNode = {\n  id: string\n  schema: string\n  cardinality?: "one" | "many"\n  fields?: object\n}\n```\n\n### `GraphEdge`\n\nAn edge connecting two nodes in the graph\n\n```ts\ntype GraphEdge = {\n  from: string\n  to: string\n}\n```\n\n### `EntityOperationTrigger`\n\nConfiguration for triggering an event based on entity operations.\n\nWhen an entity operation matches the configured criteria, the event will be triggered.\n- On createEntity: the attribute must be present in the entity payload\n- On updateEntity: the attribute must be in diff.added, diff.updated, or di\n\n```ts\ntype EntityOperationTrigger = {\n  operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n  schema: string[]\n  attribute?: string[]\n  purpose?: string[]\n  purpose_filters?: Array<{\n    id: string\n    display_name: string\n  }>\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n  limit?: number\n  cursor?: {\n    event_time?: string\n    event_id?: string\n  }\n  timestamp?: {\n    from?: string // date-time\n    to?: string // date-time\n  }\n  event_id?: string\n}\n```\n\n### `SearchOptionsV2`\n\nSearch options for the v2 history endpoint.\n\nExtends `SearchOptions` with an optional `fields` projection. When `fields`\nis omitted, the response includes all `_*` metadata plus all scalar payload\nfields (and primitive arrays / empty objects/arrays) after entity stripping.\nWhen `fields` is provided,\n\n```ts\ntype SearchOptionsV2 = {\n  limit?: number\n  cursor?: {\n    event_time?: string\n    event_id?: string\n  }\n  timestamp?: {\n    from?: string // date-time\n    to?: string // date-time\n  }\n  event_id?: string\n  fields?: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `TriggerEventPayload`\n\nPayload for explicitly triggering an event via API\n\n```ts\ntype TriggerEventPayload = {\n  seed?: {\n    entity_id: string // uuid\n    node_id: string\n  }\n  fields?: Record<string, unknown>\n  skip_hydration?: string[]\n  _trigger_source_type?: string\n  _trigger_source?: string\n  _automation_chain?: string[]\n}\n```\n\n### `TriggerEventResponse`\n\nResponse from triggering an event\n\n```ts\ntype TriggerEventResponse = {\n  success: boolean\n  event_id: string\n  event_bridge_event_id?: string\n}\n```\n\n### `EventAttachment`\n\nA file attachment associated with an event\n\n```ts\ntype EventAttachment = {\n  entity_id: string // uuid\n  filename?: string\n  mime_type?: string\n  size_bytes?: number\n  s3ref?: {\n    bucket: string\n    key: string\n  }\n  version_index: number\n  readable_size?: string\n}\n```\n\n### `FieldChange`\n\nA field-level change descriptor. Powers the declarative half of the\nversion DSL.\n\n\n```ts\ntype FieldChange = {\n  field: string\n  op: "added" | "removed" | "type-changed"\n  type_old?: string\n  type_new?: string\n}\n```\n\n### `VersionMeta`\n\nOne entry of an event\'s version timeline.\n\n```ts\ntype VersionMeta = {\n  version: string\n  released_at: string\n  change_summary: string\n  change_notes?: string\n  changes: Array<{\n    field: string\n    op: "added" | "removed" | "type-changed"\n    type_old?: string\n    type_new?: string\n  }>\n}\n```\n\n### `EventVersionRegistrySummary`\n\nSummary of an event\'s version timeline returned by\n`GET /v1/events/{event_name}/versions`.\n\n\n```ts\ntype EventVersionRegistrySummary = {\n  event_name: string\n  latest: string\n  versions: Array<{\n    version: string\n    released_at: string\n    change_summary: string\n    change_notes?: string\n    changes: Array<{\n      field: { ... }\n      op: { ... }\n      type_old?: { ... }\n      type_new?: { ... }\n    }>\n  }>\n}\n```\n';
-export {
-  event_catalog_default as default
-};

package/dist/file-M5HNKOPG.cjs

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