@epilot/sdk 2.19.14 → 2.20.2

package/dist/chunk-ADSWGLIV.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/automation-runtime.json
-var require_automation_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/automation-runtime.json"(exports, module) {
-    module.exports = { s: "https://automation.sls.epilot.io", o: [["searchFlows", "get", "/v1/automation/flows", [["schema", "q"], ["size", "q"], ["from", "q"], ["trigger_source_id", "q"], ["target_workflow", "q"], ["include_flows", "q"]]], ["createFlow", "post", "/v1/automation/flows", null, 1], ["batchGetFlows", "post", "/v1/automation/flows:batchGet", null, 1], ["getFlow", "get", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]]], ["putFlow", "put", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]], 1], ["deleteFlow", "delete", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]]], ["getExecutions", "get", "/v1/automation/executions", [["entity_id", "q"], ["size", "q"], ["from", "q"], ["include_flows", "q"]]], ["startExecution", "post", "/v1/automation/executions", null, 1], ["searchExecutions", "post", "/v1/automation/executions:search", null, 1], ["bulkTriggerExecutions", "post", "/v1/automation/executions/bulk-jobs", null, 1], ["getBulkJob", "get", "/v1/automation/executions/bulk-jobs/{job_id}", [["job_id", "p", true]]], ["patchBulkJob", "patch", "/v1/automation/executions/bulk-jobs/{job_id}", [["job_id", "p", true]], 1], ["getExecution", "get", "/v1/automation/executions/{execution_id}", [["execution_id", "p", true]]], ["cancelExecution", "delete", "/v1/automation/executions/{execution_id}", [["execution_id", "p", true]]], ["retriggerAction", "post", "/v1/automation/executions/{execution_id}/{action_id}/retrigger", [["execution_id", "p", true], ["action_id", "p", true]], 1], ["resumeExecutionWithToken", "post", "/v1/automation/public/executions:resume", null, 1], ["cancelSchedule", "delete", "/v1/automation/executions/{execution_id}/schedules/{schedule_id}", [["execution_id", "p", true], ["schedule_id", "p", true]]]], v: "3.0.3" };
-  }
-});
-
-
-
-exports.require_automation_runtime = require_automation_runtime;

package/dist/chunk-FDS727SL.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"], ["getEvent", "get", "/v1/events/{event_name}", [["event_name", "p", true]]], ["patchEvent", "patch", "/v1/events/{event_name}", [["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-LCE7N4ZL.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/automation-runtime.json
-var require_automation_runtime = __commonJS({
-  "src/definitions/automation-runtime.json"(exports, module) {
-    module.exports = { s: "https://automation.sls.epilot.io", o: [["searchFlows", "get", "/v1/automation/flows", [["schema", "q"], ["size", "q"], ["from", "q"], ["trigger_source_id", "q"], ["target_workflow", "q"], ["include_flows", "q"]]], ["createFlow", "post", "/v1/automation/flows", null, 1], ["batchGetFlows", "post", "/v1/automation/flows:batchGet", null, 1], ["getFlow", "get", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]]], ["putFlow", "put", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]], 1], ["deleteFlow", "delete", "/v1/automation/flows/{flow_id}", [["flow_id", "p", true]]], ["getExecutions", "get", "/v1/automation/executions", [["entity_id", "q"], ["size", "q"], ["from", "q"], ["include_flows", "q"]]], ["startExecution", "post", "/v1/automation/executions", null, 1], ["searchExecutions", "post", "/v1/automation/executions:search", null, 1], ["bulkTriggerExecutions", "post", "/v1/automation/executions/bulk-jobs", null, 1], ["getBulkJob", "get", "/v1/automation/executions/bulk-jobs/{job_id}", [["job_id", "p", true]]], ["patchBulkJob", "patch", "/v1/automation/executions/bulk-jobs/{job_id}", [["job_id", "p", true]], 1], ["getExecution", "get", "/v1/automation/executions/{execution_id}", [["execution_id", "p", true]]], ["cancelExecution", "delete", "/v1/automation/executions/{execution_id}", [["execution_id", "p", true]]], ["retriggerAction", "post", "/v1/automation/executions/{execution_id}/{action_id}/retrigger", [["execution_id", "p", true], ["action_id", "p", true]], 1], ["resumeExecutionWithToken", "post", "/v1/automation/public/executions:resume", null, 1], ["cancelSchedule", "delete", "/v1/automation/executions/{execution_id}/schedules/{schedule_id}", [["execution_id", "p", true], ["schedule_id", "p", true]]]], v: "3.0.3" };
-  }
-});
-
-export {
-  require_automation_runtime
-};

package/dist/chunk-M4FO2MI4.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"], ["getEvent", "get", "/v1/events/{event_name}", [["event_name", "p", true]]], ["patchEvent", "patch", "/v1/events/{event_name}", [["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/event-catalog-6ZSSF5JU.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- [`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

@@ -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- [`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/validation-rules-B2KQKMLO.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/validation-rules.json
-var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n- [`ComparisonRuleType`](#comparisonruletype)\n- [`Condition`](#condition)\n- [`Operator`](#operator)\n- [`ConditionValue`](#conditionvalue)\n- [`ScalarValue`](#scalarvalue)\n- [`StaticValue`](#staticvalue)\n- [`ContextValue`](#contextvalue)\n- [`ValueAdjustment`](#valueadjustment)\n- [`RelativeDateValue`](#relativedatevalue)\n- [`RangeValue`](#rangevalue)\n- [`NoValue`](#novalue)\n- [`AppliesWhen`](#applieswhen)\n- [`ContextRequirement`](#contextrequirement)\n\n### `getValidationRules`\n\nReturns all validation rules belonging to the authenticated user\'s organization.\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "title": "string",\n      "placeholder": "string",\n      "used_by": [\n        {\n          "type": "journey",\n          "source_id": "journey-xyz789"\n        }\n      ],\n      "rule": {\n        "type": "regex",\n        "conditions": {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            },\n            {\n              "all": [\n                {\n                  "fact": "inputValue",\n                  "operator": "regexMatch",\n                  "value": "string",\n                  "params": {\n                    "errorMessage": "string"\n                  }\n                }\n              ]\n            }\n          ]\n        }\n      },\n      "contexts": [\n        {\n          "schema": "contract"\n        }\n      ],\n      "_schema_version": "string",\n      "_id": "string",\n      "_organization_id": "string",\n      "created_at": "string",\n      "updated_at": "string",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreates a new validation rule for the authenticated organization.\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n  null,\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nRetrieves a specific validation rule by its unique ID.\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n  ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nPartially updates an existing validation rule by ID. Only the fields provided in the request body are updated.\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n  {\n    ruleId: \'example\',\n  },\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nPermanently deletes a validation rule by ID. Any journeys or entity attributes referencing this rule should be updated before deletion.\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n  ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdds a single `used_by` reference to an existing validation rule.\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemoves a specific `used_by` reference from an existing validation rule.\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\nResponse envelope for listing all validation rules within an organization.\n\n```ts\ntype GetValidationRulesResponse = {\n  results?: Array<{\n    _schema_version: string\n    _id: string\n    _organization_id: string\n    created_at: string\n    updated_at: string\n    created_by: string\n    updated_by: string\n  }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n  _schema_version: string\n  _id: string\n  _organization_id: string\n  created_at: string\n  updated_at: string\n  created_by: string\n  updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied. Used to track associations between rules and the journeys or entity schemas that reference them.\n\n```ts\ntype UsedBy = {\n  type: "journey" | "entity"\n  schema_slug?: string\n  source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n  type: "regex"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n  type: "pattern"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n  type: "numeric"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n  fact: "inputValue"\n  operator: "regexMatch"\n  value: string\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n  // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n  // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n  fact: "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check" | "total-length"\n  operator: "exactlyNDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "in" | "notIn" | "contains" | "doesNotContain"\n  value: string[]\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "equal" | "notEqual"\n  value: string\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n  // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n  fact: "numeric-value" | "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "integer-digits-count"\n  operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    allowLeadingZeroes?: boolean\n  }\n} | {\n  fact: "decimal-digits-count"\n  operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "has-leading-zeroes"\n  operator: "equal" | "notAllowed"\n  value: boolean\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `ComparisonRuleType`\n\nDeclarative validation rule (schema version v2). Supports predefined comparison operators\nover number, date and text inputs, with static, dynamic (context path) and relative-date\ncomparison values.\n\n\n```ts\ntype ComparisonRuleType = {\n  input_type: "number" | "date" | "text"\n  conditions: Array<{\n    id: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    }\n    error_message: string\n    applies_when?: {\n      path: { ... }\n      operator: { ... }\n      value?: { ... }\n    }\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `Condition`\n\nA single comparison the input value must satisfy.\n\n```ts\ntype Condition = {\n  id: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    }\n    max: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    }\n  } | {\n    source: "none"\n  }\n  error_message: string\n  applies_when?: {\n    path: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n    value?: number | string | boolean\n  }\n  allow_failure?: boolean\n}\n```\n\n### `Operator`\n\nPredefined comparison operator. Compatibility (enforced at write time):\n- number: equal, notEqual, greaterThan, greaterThanInclusive, lessThan, lessThanInclusive, between, regexMatch,\n  maxDigits, maxDecimals\n- date: dateBefore, dateOnOrBefore, dateAfter, dateOnOrAfter, dateBetween, notInFuture, not\n\n```ts\ntype Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n```\n\n### `ConditionValue`\n\nThe comparison value of a condition - a scalar, a range of scalars, or nothing (unary operators).\n\n```ts\ntype ConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n} | {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n} | {\n  source: "none"\n}\n```\n\n### `ScalarValue`\n\nA single comparison value - static, resolved from context, or a relative date.\n\n```ts\ntype ScalarValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n}\n```\n\n### `StaticValue`\n\nA fixed comparison value.\n\n```ts\ntype StaticValue = {\n  source: "static"\n  data: number | string | boolean\n}\n```\n\n### `ContextValue`\n\nA dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`\nor `previous_reading.value`. The first path segment must match the `name` of a declared\ncontext requirement.\n\n\n```ts\ntype ContextValue = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ValueAdjustment`\n\nAdjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".\nUsed to express tolerance bands such as "at most 10% above the current instalment amount".\n\n\n```ts\ntype ValueAdjustment = {\n  type: "percent" | "absolute"\n  value: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  direction: "increase" | "decrease"\n  rounding?: "up" | "down"\n}\n```\n\n### `RelativeDateValue`\n\nA date relative to the evaluation moment, e.g. "today minus 30 days". Only valid for date rules.\n\n```ts\ntype RelativeDateValue = {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n}\n```\n\n### `RangeValue`\n\nA lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive.\n\n```ts\ntype RangeValue = {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n}\n```\n\n### `NoValue`\n\nNo comparison value - used by unary operators such as notInFuture / notInPast.\n\n```ts\ntype NoValue = {\n  source: "none"\n}\n```\n\n### `AppliesWhen`\n\nOptional precondition on a condition: the condition only takes part in the\nvalidation when this comparison over context holds. Examples: apply the\ndual-tariff reference only when `contract.htnt` is not empty, or run a\nplausibility check only when a context value reaches a threshold.\n\n\n```ts\ntype AppliesWhen = {\n  path: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n  value?: number | string | boolean\n}\n```\n\n### `ContextRequirement`\n\nAn entity context source the rule needs at evaluation time, referenced by `context`\nvalue paths via the schema slug as their first segment (e.g. `contract.installment_amount`).\nHow the source is resolved (which entity instance) is decided by the consuming surface,\nnot by the rule. Meter reading comp\n\n```ts\ntype ContextRequirement = {\n  schema: string\n}\n```\n';
-export {
-  validation_rules_default as default
-};

package/dist/validation-rules-GR2IVLGJ.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/validation-rules.json
-var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n- [`ComparisonRuleType`](#comparisonruletype)\n- [`Condition`](#condition)\n- [`Operator`](#operator)\n- [`ConditionValue`](#conditionvalue)\n- [`ScalarValue`](#scalarvalue)\n- [`StaticValue`](#staticvalue)\n- [`ContextValue`](#contextvalue)\n- [`ValueAdjustment`](#valueadjustment)\n- [`RelativeDateValue`](#relativedatevalue)\n- [`RangeValue`](#rangevalue)\n- [`NoValue`](#novalue)\n- [`AppliesWhen`](#applieswhen)\n- [`ContextRequirement`](#contextrequirement)\n\n### `getValidationRules`\n\nReturns all validation rules belonging to the authenticated user\'s organization.\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "title": "string",\n      "placeholder": "string",\n      "used_by": [\n        {\n          "type": "journey",\n          "source_id": "journey-xyz789"\n        }\n      ],\n      "rule": {\n        "type": "regex",\n        "conditions": {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            },\n            {\n              "all": [\n                {\n                  "fact": "inputValue",\n                  "operator": "regexMatch",\n                  "value": "string",\n                  "params": {\n                    "errorMessage": "string"\n                  }\n                }\n              ]\n            }\n          ]\n        }\n      },\n      "contexts": [\n        {\n          "schema": "contract"\n        }\n      ],\n      "_schema_version": "string",\n      "_id": "string",\n      "_organization_id": "string",\n      "created_at": "string",\n      "updated_at": "string",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreates a new validation rule for the authenticated organization.\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n  null,\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nRetrieves a specific validation rule by its unique ID.\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n  ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nPartially updates an existing validation rule by ID. Only the fields provided in the request body are updated.\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n  {\n    ruleId: \'example\',\n  },\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nPermanently deletes a validation rule by ID. Any journeys or entity attributes referencing this rule should be updated before deletion.\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n  ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdds a single `used_by` reference to an existing validation rule.\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemoves a specific `used_by` reference from an existing validation rule.\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\nResponse envelope for listing all validation rules within an organization.\n\n```ts\ntype GetValidationRulesResponse = {\n  results?: Array<{\n    _schema_version: string\n    _id: string\n    _organization_id: string\n    created_at: string\n    updated_at: string\n    created_by: string\n    updated_by: string\n  }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n  _schema_version: string\n  _id: string\n  _organization_id: string\n  created_at: string\n  updated_at: string\n  created_by: string\n  updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied. Used to track associations between rules and the journeys or entity schemas that reference them.\n\n```ts\ntype UsedBy = {\n  type: "journey" | "entity"\n  schema_slug?: string\n  source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n  type: "regex"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n  type: "pattern"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n  type: "numeric"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n  fact: "inputValue"\n  operator: "regexMatch"\n  value: string\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n  // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n  // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n  fact: "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check" | "total-length"\n  operator: "exactlyNDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "in" | "notIn" | "contains" | "doesNotContain"\n  value: string[]\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "equal" | "notEqual"\n  value: string\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n  // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n  fact: "numeric-value" | "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "integer-digits-count"\n  operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    allowLeadingZeroes?: boolean\n  }\n} | {\n  fact: "decimal-digits-count"\n  operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "has-leading-zeroes"\n  operator: "equal" | "notAllowed"\n  value: boolean\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `ComparisonRuleType`\n\nDeclarative validation rule (schema version v2). Supports predefined comparison operators\nover number, date and text inputs, with static, dynamic (context path) and relative-date\ncomparison values.\n\n\n```ts\ntype ComparisonRuleType = {\n  input_type: "number" | "date" | "text"\n  conditions: Array<{\n    id: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    }\n    error_message: string\n    applies_when?: {\n      path: { ... }\n      operator: { ... }\n      value?: { ... }\n    }\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `Condition`\n\nA single comparison the input value must satisfy.\n\n```ts\ntype Condition = {\n  id: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    }\n    max: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    }\n  } | {\n    source: "none"\n  }\n  error_message: string\n  applies_when?: {\n    path: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n    value?: number | string | boolean\n  }\n  allow_failure?: boolean\n}\n```\n\n### `Operator`\n\nPredefined comparison operator. Compatibility (enforced at write time):\n- number: equal, notEqual, greaterThan, greaterThanInclusive, lessThan, lessThanInclusive, between, regexMatch,\n  maxDigits, maxDecimals\n- date: dateBefore, dateOnOrBefore, dateAfter, dateOnOrAfter, dateBetween, notInFuture, not\n\n```ts\ntype Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n```\n\n### `ConditionValue`\n\nThe comparison value of a condition - a scalar, a range of scalars, or nothing (unary operators).\n\n```ts\ntype ConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n} | {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n} | {\n  source: "none"\n}\n```\n\n### `ScalarValue`\n\nA single comparison value - static, resolved from context, or a relative date.\n\n```ts\ntype ScalarValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n}\n```\n\n### `StaticValue`\n\nA fixed comparison value.\n\n```ts\ntype StaticValue = {\n  source: "static"\n  data: number | string | boolean\n}\n```\n\n### `ContextValue`\n\nA dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`\nor `previous_reading.value`. The first path segment must match the `name` of a declared\ncontext requirement.\n\n\n```ts\ntype ContextValue = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ValueAdjustment`\n\nAdjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".\nUsed to express tolerance bands such as "at most 10% above the current instalment amount".\n\n\n```ts\ntype ValueAdjustment = {\n  type: "percent" | "absolute"\n  value: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  direction: "increase" | "decrease"\n  rounding?: "up" | "down"\n}\n```\n\n### `RelativeDateValue`\n\nA date relative to the evaluation moment, e.g. "today minus 30 days". Only valid for date rules.\n\n```ts\ntype RelativeDateValue = {\n  source: "relative_date"\n  offset: number\n  unit: "days" | "months" | "years"\n  anchor?: "today"\n}\n```\n\n### `RangeValue`\n\nA lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive.\n\n```ts\ntype RangeValue = {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number\n    unit: "days" | "months" | "years"\n    anchor?: "today"\n  }\n}\n```\n\n### `NoValue`\n\nNo comparison value - used by unary operators such as notInFuture / notInPast.\n\n```ts\ntype NoValue = {\n  source: "none"\n}\n```\n\n### `AppliesWhen`\n\nOptional precondition on a condition: the condition only takes part in the\nvalidation when this comparison over context holds. Examples: apply the\ndual-tariff reference only when `contract.htnt` is not empty, or run a\nplausibility check only when a context value reaches a threshold.\n\n\n```ts\ntype AppliesWhen = {\n  path: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n  value?: number | string | boolean\n}\n```\n\n### `ContextRequirement`\n\nAn entity context source the rule needs at evaluation time, referenced by `context`\nvalue paths via the schema slug as their first segment (e.g. `contract.installment_amount`).\nHow the source is resolved (which entity instance) is decided by the consuming surface,\nnot by the rule. Meter reading comp\n\n```ts\ntype ContextRequirement = {\n  schema: string\n}\n```\n';
-
-
-exports.default = validation_rules_default;