@epilot/sdk 2.12.0 → 2.12.1

package/dist/apis/workflow-definition.cjs

@@ -6,25 +6,25 @@ var _chunkCYS6QBW6cjs = require('../chunk-CYS6QBW6.cjs');
 
 
 
-var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
+var _chunkAJDY36Y6cjs = require('../chunk-AJDY36Y6.cjs');
 require('../chunk-NJK5F5TF.cjs');
 
 // src/apis/workflow-definition.ts
 var loadDefinition = () => {
   const mod = _chunkCYS6QBW6cjs.require_workflow_definition_runtime.call(void 0, );
-  return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+  return _chunkAJDY36Y6cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 };
 var _instance = null;
 var resolve = () => {
   if (!_instance) {
     const def = loadDefinition();
-    _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "workflowDefinition" });
+    _instance = _chunkAJDY36Y6cjs.createApiClient.call(void 0, { definition: def, apiName: "workflowDefinition" });
   }
   return _instance;
 };
-var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
+var _handle = _chunkAJDY36Y6cjs.createApiHandle.call(void 0, {
   resolveClient: resolve,
-  createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "workflowDefinition" }),
+  createClient: () => _chunkAJDY36Y6cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "workflowDefinition" }),
   apiName: "workflowDefinition"
 });
 var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var workflowDefinition = _handle;
 
 
 
-exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient; exports.workflowDefinition = workflowDefinition;
+exports.authorize = _chunkAJDY36Y6cjs.authorize; exports.createClient = createClient; exports.getClient = getClient; exports.workflowDefinition = workflowDefinition;

package/dist/apis/workflow-definition.js

@@ -6,7 +6,7 @@ import {
   createApiClient,
   createApiHandle,
   expand
-} from "../chunk-FOGUF2AK.js";
+} from "../chunk-L3UZLJPQ.js";
 import "../chunk-YPSWSI3M.js";
 
 // src/apis/workflow-definition.ts

package/dist/apis/workflow.cjs

@@ -6,25 +6,25 @@ var _chunkPM25LLETcjs = require('../chunk-PM25LLET.cjs');
 
 
 
-var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
+var _chunkAJDY36Y6cjs = require('../chunk-AJDY36Y6.cjs');
 require('../chunk-NJK5F5TF.cjs');
 
 // src/apis/workflow.ts
 var loadDefinition = () => {
   const mod = _chunkPM25LLETcjs.require_workflow_runtime.call(void 0, );
-  return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+  return _chunkAJDY36Y6cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 };
 var _instance = null;
 var resolve = () => {
   if (!_instance) {
     const def = loadDefinition();
-    _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "workflow" });
+    _instance = _chunkAJDY36Y6cjs.createApiClient.call(void 0, { definition: def, apiName: "workflow" });
   }
   return _instance;
 };
-var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
+var _handle = _chunkAJDY36Y6cjs.createApiHandle.call(void 0, {
   resolveClient: resolve,
-  createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "workflow" }),
+  createClient: () => _chunkAJDY36Y6cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "workflow" }),
   apiName: "workflow"
 });
 var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var workflow = _handle;
 
 
 
-exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient; exports.workflow = workflow;
+exports.authorize = _chunkAJDY36Y6cjs.authorize; exports.createClient = createClient; exports.getClient = getClient; exports.workflow = workflow;

package/dist/apis/workflow.js

@@ -6,7 +6,7 @@ import {
   createApiClient,
   createApiHandle,
   expand
-} from "../chunk-FOGUF2AK.js";
+} from "../chunk-L3UZLJPQ.js";
 import "../chunk-YPSWSI3M.js";
 
 // src/apis/workflow.ts

package/dist/{chunk-XGCTJYBW.cjs → chunk-AJDY36Y6.cjs}

@@ -53,7 +53,7 @@ var globImport_docs = _chunkNJK5F5TFcjs.__glob.call(void 0, {
   "./docs/entity.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./entity-SS36LQO6.cjs"))),
   "./docs/environments.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./environments-QJ4UMJ5C.cjs"))),
   "./docs/erp-integration.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./erp-integration-PAVHSUDM.cjs"))),
-  "./docs/event-catalog.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./event-catalog-HLWUT7RM.cjs"))),
+  "./docs/event-catalog.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./event-catalog-6ZSSF5JU.cjs"))),
   "./docs/file.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./file-7CQXDQ3I.cjs"))),
   "./docs/iban.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./iban-24GHLFDB.cjs"))),
   "./docs/integration-toolkit.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./integration-toolkit-2BLX4CSH.cjs"))),

package/dist/{chunk-FOGUF2AK.js → chunk-L3UZLJPQ.js}

@@ -53,7 +53,7 @@ var globImport_docs = __glob({
   "./docs/entity.json": () => import("./entity-Z4YWKDVG.js"),
   "./docs/environments.json": () => import("./environments-PXJOTQVM.js"),
   "./docs/erp-integration.json": () => import("./erp-integration-SBQJ6HEG.js"),
-  "./docs/event-catalog.json": () => import("./event-catalog-3YOQ46ZW.js"),
+  "./docs/event-catalog.json": () => import("./event-catalog-RS4LJMY2.js"),
   "./docs/file.json": () => import("./file-O6ZD3HOU.js"),
   "./docs/iban.json": () => import("./iban-LDKYDVQV.js"),
   "./docs/integration-toolkit.json": () => import("./integration-toolkit-OLFKCTLY.js"),

package/dist/event-catalog-6ZSSF5JU.cjs

@@ -0,0 +1,7 @@
+"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- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\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- [`UpdateEventPayload`](#updateeventpayload)\n- [`PrimitiveField`](#primitivefield)\n- [`ContextEntity`](#contextentity)\n- [`AttachmentField`](#attachmentfield)\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      },\n      "enabled": true,\n      "auto_trigger": true,\n      "automation_trigger": true,\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### `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  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\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    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    },\n    enabled: true,\n    auto_trigger: true,\n    automation_trigger: true,\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<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  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\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: \'string\'\n    },\n    fields: {},\n    skip_hydration: [\'string\'],\n    _trigger_source_type: \'string\',\n    _trigger_source: \'string\'\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `UpdateEventPayload`\n\nPayload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled`, `auto_trigger` and `success_criteria` fields are processed.\n\n\n```ts\ntype UpdateEventPayload = {\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_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### `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}\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}\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}\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-RS4LJMY2.js

@@ -0,0 +1,7 @@
+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- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\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- [`UpdateEventPayload`](#updateeventpayload)\n- [`PrimitiveField`](#primitivefield)\n- [`ContextEntity`](#contextentity)\n- [`AttachmentField`](#attachmentfield)\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      },\n      "enabled": true,\n      "auto_trigger": true,\n      "automation_trigger": true,\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### `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  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\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    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    },\n    enabled: true,\n    auto_trigger: true,\n    automation_trigger: true,\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<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  },\n  "enabled": true,\n  "auto_trigger": true,\n  "automation_trigger": true,\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: \'string\'\n    },\n    fields: {},\n    skip_hydration: [\'string\'],\n    _trigger_source_type: \'string\',\n    _trigger_source: \'string\'\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_trigger?: boolean\n  success_criteria?: Array<{\n    entity_schema: string\n    attribute: string\n  }>\n}\n```\n\n### `UpdateEventPayload`\n\nPayload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled`, `auto_trigger` and `success_criteria` fields are processed.\n\n\n```ts\ntype UpdateEventPayload = {\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  }\n  enabled?: boolean\n  auto_trigger?: boolean\n  automation_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### `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}\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}\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}\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/{event-catalog.d-CXbUn8T1.d.cts → event-catalog.d-QIhhewVH.d.cts}

@@ -202,6 +202,10 @@ declare namespace Components {
              *
              */
             _ack_id?: string;
+            /**
+             * Inline downgrade chain stamped by Event Catalog at publish time, ordered newest-to-oldest. Present ONLY on multi-version events. Internal versioning transport: consumers (e.g. svc-webhooks) walk the payload back to a pinned version using these JSONata steps, then strip the field before delivery -- end customers never receive it.
+             */
+            _downgrades?: /* One 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. */ InlineDowngradeStep[];
         }
         /**
          * A file attachment associated with an event
@@ -394,6 +398,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * Base properties shared between EventConfig and UpdateEventPayload
@@ -544,6 +583,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * JSON Schema declaring the event payload structure
@@ -887,6 +961,19 @@ declare namespace Components {
              */
             fields?: string[];
         }
+        /**
+         * One 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.
+         */
+        export interface InlineDowngradeStep {
+            /**
+             * Version label this step downgrades to (the previous version).
+             */
+            to: string;
+            /**
+             * JSONata expression mapping the current-shape payload to the previous-shape payload.
+             */
+            jsonata: string;
+        }
         /**
          * A primitive JSON Schema field definition
          */
@@ -1051,6 +1138,32 @@ declare namespace Components {
              */
             FieldsParam;
         }
+        /**
+         * A single org-defined success criterion: an entity attribute that must be captured
+         * for this event's change request to be considered complete.
+         *
+         * Identity is the entity schema plus the attribute name — mirroring the
+         * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+         * `attribute` and `entity_schema` are required and `entity_schema` must match the
+         * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+         * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+         * never enforced when an event is triggered or published.
+         *
+         */
+        export interface SuccessCriterion {
+            /**
+             * Entity schema slug the attribute belongs to (matches a node schema in the event's entity_graph).
+             * example:
+             * contract
+             */
+            entity_schema: string;
+            /**
+             * Attribute name on the entity schema.
+             * example:
+             * installment_amount
+             */
+            attribute: string;
+        }
         /**
          * Payload for explicitly triggering an event via API
          */
@@ -1122,7 +1235,7 @@ declare namespace Components {
         /**
          * Payload for updating an event configuration.
          * Accepts the same fields as EventConfig (all optional for PATCH).
-         * Currently `enabled` and `auto_trigger` fields are processed.
+         * Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
          *
          */
         export interface UpdateEventPayload {
@@ -1271,6 +1384,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * One entry of an event's version timeline.
@@ -1574,7 +1722,7 @@ declare namespace Paths {
         export type RequestBody = /**
          * Payload for updating an event configuration.
          * Accepts the same fields as EventConfig (all optional for PATCH).
-         * Currently `enabled` and `auto_trigger` fields are processed.
+         * Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
          *
          */
         Components.Schemas.UpdateEventPayload;
@@ -2007,13 +2155,15 @@ type FieldsParam = Components.Schemas.FieldsParam;
 type GraphDefinition = Components.Schemas.GraphDefinition;
 type GraphEdge = Components.Schemas.GraphEdge;
 type GraphNode = Components.Schemas.GraphNode;
+type InlineDowngradeStep = Components.Schemas.InlineDowngradeStep;
 type PrimitiveField = Components.Schemas.PrimitiveField;
 type SchemaField = Components.Schemas.SchemaField;
 type SearchOptions = Components.Schemas.SearchOptions;
 type SearchOptionsV2 = Components.Schemas.SearchOptionsV2;
+type SuccessCriterion = Components.Schemas.SuccessCriterion;
 type TriggerEventPayload = Components.Schemas.TriggerEventPayload;
 type TriggerEventResponse = Components.Schemas.TriggerEventResponse;
 type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
 type VersionMeta = Components.Schemas.VersionMeta;
 
-export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type VersionMeta as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type EventVersionRegistrySummary as k, type FieldsParam as l, type GraphEdge as m, type GraphNode as n, type PrimitiveField as o, type SearchOptions as p, type SearchOptionsV2 as q, type TriggerEventResponse as r };
+export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type InlineDowngradeStep as I, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type VersionMeta as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type EventVersionRegistrySummary as k, type FieldsParam as l, type GraphEdge as m, type GraphNode as n, type PrimitiveField as o, type SearchOptions as p, type SearchOptionsV2 as q, type SuccessCriterion as r, type TriggerEventResponse as s };