@epilot/sdk 2.4.4-alpha.0 → 2.4.4

package/dist/event-catalog.d-ENw6HO-w.d.ts

@@ -0,0 +1,1511 @@
+import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
+
+/* Auto-copied from event-catalog-client */
+/* eslint-disable */
+
+
+
+declare namespace Components {
+    namespace Schemas {
+        /**
+         * Common metadata fields present in all event payloads
+         * example:
+         * {
+         *   "_org_id": {
+         *     "type": "string",
+         *     "description": "epilot tenant/organization ID"
+         *   },
+         *   "_event_time": {
+         *     "type": "string",
+         *     "format": "date-time",
+         *     "description": "ISO 8601 timestamp when event occurred"
+         *   },
+         *   "_event_id": {
+         *     "type": "string",
+         *     "description": "Unique event identifier (ULID)"
+         *   },
+         *   "_event_name": {
+         *     "type": "string",
+         *     "description": "Event name from catalog"
+         *   },
+         *   "_event_version": {
+         *     "type": "string",
+         *     "description": "Schema version number"
+         *   },
+         *   "_event_source": {
+         *     "type": "string",
+         *     "description": "Source that triggered the event"
+         *   },
+         *   "_ack_id": {
+         *     "type": "string",
+         *     "description": "Unique acknowledgment tracking ID for the event"
+         *   }
+         * }
+         */
+        export interface CommonEventMetadata {
+        }
+        export interface ContextEntity {
+            /**
+             * Schema slug of the context entity
+             * example:
+             * meter
+             */
+            entity_schema: string;
+            /**
+             * Whether this field is required in the event payload
+             */
+            required?: boolean;
+        }
+        /**
+         * Configuration for triggering an event based on entity operations.
+         *
+         * When an entity operation matches the configured criteria, the event will be triggered.
+         * - On createEntity: the attribute must be present in the entity payload
+         * - On updateEntity: the attribute must be in diff.added, diff.updated, or diff.deleted
+         * - On deleteEntity: the event triggers when the entity is deleted (attributes not checked)
+         *
+         */
+        export interface EntityOperationTrigger {
+            /**
+             * List of entity operations that can trigger this event
+             * example:
+             * [
+             *   "createEntity",
+             *   "updateEntity"
+             * ]
+             */
+            operation: ("createEntity" | "updateEntity" | "deleteEntity")[];
+            /**
+             * List of entity schema slugs that can trigger this event
+             * example:
+             * [
+             *   "contact",
+             *   "contract",
+             *   "order"
+             * ]
+             */
+            schema: string[];
+            /**
+             * Optional list of entity attributes to track for changes.
+             * If specified, the event only triggers when these attributes are affected.
+             * - On createEntity: attribute must be defined in the entity payload
+             * - On updateEntity: attribute must be in diff.added, diff.updated, or diff.deleted
+             * If not specified, all changes to matching entities will trigger the event.
+             *
+             * example:
+             * [
+             *   "email",
+             *   "phone",
+             *   "status"
+             * ]
+             */
+            attribute?: string[];
+            /**
+             * Optional list of purpose names to filter by.
+             * The entity must have at least one matching purpose in its _purpose array.
+             * Purpose names are matched against the taxonomy classification names (e.g., "Kündigung", "Umzug/Auszug").
+             * If not specified, the event triggers regardless of entity purpose.
+             *
+             * example:
+             * [
+             *   "Kündigung",
+             *   "Umzug/Auszug"
+             * ]
+             */
+            purpose?: string[];
+        }
+        /**
+         * An event instance in the event history
+         * example:
+         * {
+         *   "_org_id": "org_123456",
+         *   "_event_time": "2024-01-01T12:00:00Z",
+         *   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
+         *   "_event_name": "MeterReading",
+         *   "_event_version": "1.0.0",
+         *   "_event_source": "api",
+         *   "_trigger_source_type": "api",
+         *   "_trigger_source": "user_123456",
+         *   "reading_value": 123.45,
+         *   "reading_date": "2024-01-01T11:59:00Z",
+         *   "read_by": "John Doe",
+         *   "reason": "regular",
+         *   "direction": "feed-out",
+         *   "source": "portal",
+         *   "meter_id": "550e8400-e29b-41d4-a716-446655440000",
+         *   "counter_id": "660e8400-e29b-41d4-a716-446655440000",
+         *   "meter_number": "MT123456789",
+         *   "obis_number": "1-0:1.8.0",
+         *   "unit": "kWh",
+         *   "customer_id": "770e8400-e29b-41d4-a716-446655440000",
+         *   "contract_id": "880e8400-e29b-41d4-a716-446655440000"
+         * }
+         */
+        export interface Event {
+            [name: string]: any;
+            /**
+             * epilot tenant/organization ID
+             */
+            _org_id: string;
+            /**
+             * ISO 8601 timestamp when event occurred
+             */
+            _event_time: string; // date-time
+            /**
+             * Unique event identifier (ULID)
+             */
+            _event_id: string;
+            /**
+             * Event name from catalog
+             */
+            _event_name: string;
+            /**
+             * Event version (semver)
+             * example:
+             * 1.0.0
+             */
+            _event_version: string;
+            /**
+             * Source that triggered the event
+             */
+            _event_source: string;
+            /**
+             * The type of system that triggered the event.
+             * Common values: api, automation, operation, portal_user
+             *
+             * example:
+             * api
+             */
+            _trigger_source_type?: string;
+            /**
+             * Identifier of the specific trigger source.
+             * - For api: User ID or API key identifier
+             * - For automation: Automation execution ID
+             * - For operation: Activity ID from the entity operation
+             * - For portal_user: Portal user email
+             *
+             */
+            _trigger_source?: string;
+            /**
+             * Unique acknowledgment tracking ID for the event.
+             * Used to track event delivery and processing status.
+             *
+             */
+            _ack_id?: string;
+        }
+        /**
+         * Event configuration with required fields
+         */
+        export interface EventConfig {
+            /**
+             * Unique human readable name of the event
+             * example:
+             * AddMeterReading
+             */
+            event_name: string;
+            /**
+             * Human-friendly title for the event
+             * example:
+             * Add Meter Reading
+             */
+            event_title?: string;
+            /**
+             * Description of when the event is triggered
+             * example:
+             * Triggered when a new meter reading is added
+             */
+            event_description?: string;
+            /**
+             * Event version (semver)
+             * example:
+             * 1.0.0
+             */
+            event_version: string;
+            /**
+             * Status of the event
+             * example:
+             * active
+             */
+            event_status?: "active" | "deprecated" | "draft" | "disabled";
+            /**
+             * Tags associated with the event for categorization and filtering
+             *
+             * The "builtin" tag indicates events that are built into the epilot system.
+             *
+             * example:
+             * [
+             *   "builtin",
+             *   "metering",
+             *   "erp"
+             * ]
+             */
+            event_tags?: string[];
+            /**
+             * Fields that define the event schema
+             */
+            schema_fields: {
+                [name: string]: SchemaField;
+            };
+            /**
+             * Optional entity graph definition for resolving related entities
+             */
+            entity_graph?: {
+                /**
+                 * List of node definitions in the graph
+                 */
+                nodes: /* A node in the entity graph */ GraphNode[];
+                /**
+                 * List of edge definitions connecting nodes
+                 */
+                edges: /* An edge connecting two nodes in the graph */ GraphEdge[];
+            };
+            /**
+             * Optional configuration for triggering this event based on entity operations
+             */
+            entity_operation?: {
+                /**
+                 * List of entity operations that can trigger this event
+                 * example:
+                 * [
+                 *   "createEntity",
+                 *   "updateEntity"
+                 * ]
+                 */
+                operation: ("createEntity" | "updateEntity" | "deleteEntity")[];
+                /**
+                 * List of entity schema slugs that can trigger this event
+                 * example:
+                 * [
+                 *   "contact",
+                 *   "contract",
+                 *   "order"
+                 * ]
+                 */
+                schema: string[];
+                /**
+                 * Optional list of entity attributes to track for changes.
+                 * If specified, the event only triggers when these attributes are affected.
+                 * - On createEntity: attribute must be defined in the entity payload
+                 * - On updateEntity: attribute must be in diff.added, diff.updated, or diff.deleted
+                 * If not specified, all changes to matching entities will trigger the event.
+                 *
+                 * example:
+                 * [
+                 *   "email",
+                 *   "phone",
+                 *   "status"
+                 * ]
+                 */
+                attribute?: string[];
+                /**
+                 * Optional list of purpose names to filter by.
+                 * The entity must have at least one matching purpose in its _purpose array.
+                 * Purpose names are matched against the taxonomy classification names (e.g., "Kündigung", "Umzug/Auszug").
+                 * If not specified, the event triggers regardless of entity purpose.
+                 *
+                 * example:
+                 * [
+                 *   "Kündigung",
+                 *   "Umzug/Auszug"
+                 * ]
+                 */
+                purpose?: string[];
+            };
+            /**
+             * Whether this event is enabled for the organization.
+             * When disabled, the event will not be triggered by any means
+             * (automatic, API, or automation).
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            enabled?: boolean;
+            /**
+             * Whether the event should be triggered automatically by built-in logic
+             * (e.g., portal submissions, entity mutations, EventBridge rules).
+             * When false, the event can still be triggered manually via API or automations.
+             * Only meaningful for builtin events that have automatic trigger sources.
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            auto_trigger?: boolean;
+            /**
+             * Whether this event can be explicitly triggered by automations.
+             * When true, the event will appear in the automation builder as a
+             * "Trigger Event" action option.
+             * Defaults to false if not specified.
+             *
+             * example:
+             * true
+             */
+            automation_trigger?: boolean;
+        }
+        /**
+         * Base properties shared between EventConfig and UpdateEventPayload
+         */
+        export interface EventConfigBase {
+            /**
+             * Unique human readable name of the event
+             * example:
+             * AddMeterReading
+             */
+            event_name?: string;
+            /**
+             * Human-friendly title for the event
+             * example:
+             * Add Meter Reading
+             */
+            event_title?: string;
+            /**
+             * Description of when the event is triggered
+             * example:
+             * Triggered when a new meter reading is added
+             */
+            event_description?: string;
+            /**
+             * Event version (semver)
+             * example:
+             * 1.0.0
+             */
+            event_version?: string;
+            /**
+             * Status of the event
+             * example:
+             * active
+             */
+            event_status?: "active" | "deprecated" | "draft" | "disabled";
+            /**
+             * Tags associated with the event for categorization and filtering
+             *
+             * The "builtin" tag indicates events that are built into the epilot system.
+             *
+             * example:
+             * [
+             *   "builtin",
+             *   "metering",
+             *   "erp"
+             * ]
+             */
+            event_tags?: string[];
+            /**
+             * Fields that define the event schema
+             */
+            schema_fields?: {
+                [name: string]: SchemaField;
+            };
+            /**
+             * Optional entity graph definition for resolving related entities
+             */
+            entity_graph?: {
+                /**
+                 * List of node definitions in the graph
+                 */
+                nodes: /* A node in the entity graph */ GraphNode[];
+                /**
+                 * List of edge definitions connecting nodes
+                 */
+                edges: /* An edge connecting two nodes in the graph */ GraphEdge[];
+            };
+            /**
+             * Optional configuration for triggering this event based on entity operations
+             */
+            entity_operation?: {
+                /**
+                 * List of entity operations that can trigger this event
+                 * example:
+                 * [
+                 *   "createEntity",
+                 *   "updateEntity"
+                 * ]
+                 */
+                operation: ("createEntity" | "updateEntity" | "deleteEntity")[];
+                /**
+                 * List of entity schema slugs that can trigger this event
+                 * example:
+                 * [
+                 *   "contact",
+                 *   "contract",
+                 *   "order"
+                 * ]
+                 */
+                schema: string[];
+                /**
+                 * Optional list of entity attributes to track for changes.
+                 * If specified, the event only triggers when these attributes are affected.
+                 * - On createEntity: attribute must be defined in the entity payload
+                 * - On updateEntity: attribute must be in diff.added, diff.updated, or diff.deleted
+                 * If not specified, all changes to matching entities will trigger the event.
+                 *
+                 * example:
+                 * [
+                 *   "email",
+                 *   "phone",
+                 *   "status"
+                 * ]
+                 */
+                attribute?: string[];
+                /**
+                 * Optional list of purpose names to filter by.
+                 * The entity must have at least one matching purpose in its _purpose array.
+                 * Purpose names are matched against the taxonomy classification names (e.g., "Kündigung", "Umzug/Auszug").
+                 * If not specified, the event triggers regardless of entity purpose.
+                 *
+                 * example:
+                 * [
+                 *   "Kündigung",
+                 *   "Umzug/Auszug"
+                 * ]
+                 */
+                purpose?: string[];
+            };
+            /**
+             * Whether this event is enabled for the organization.
+             * When disabled, the event will not be triggered by any means
+             * (automatic, API, or automation).
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            enabled?: boolean;
+            /**
+             * Whether the event should be triggered automatically by built-in logic
+             * (e.g., portal submissions, entity mutations, EventBridge rules).
+             * When false, the event can still be triggered manually via API or automations.
+             * Only meaningful for builtin events that have automatic trigger sources.
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            auto_trigger?: boolean;
+            /**
+             * Whether this event can be explicitly triggered by automations.
+             * When true, the event will appear in the automation builder as a
+             * "Trigger Event" action option.
+             * Defaults to false if not specified.
+             *
+             * example:
+             * true
+             */
+            automation_trigger?: boolean;
+        }
+        /**
+         * JSON Schema declaring the event payload structure
+         * example:
+         * {
+         *   "type": "object",
+         *   "properties": {
+         *     "_org_id": {
+         *       "type": "string",
+         *       "description": "epilot tenant/organization ID"
+         *     },
+         *     "_event_time": {
+         *       "type": "string",
+         *       "format": "date-time",
+         *       "description": "ISO 8601 timestamp when event occurred"
+         *     },
+         *     "_event_id": {
+         *       "type": "string",
+         *       "description": "Unique event identifier (ULID)"
+         *     },
+         *     "_event_name": {
+         *       "type": "string",
+         *       "description": "Event name from catalog"
+         *     },
+         *     "_event_version": {
+         *       "type": "string",
+         *       "description": "Event version (semver)"
+         *     },
+         *     "_event_source": {
+         *       "type": "string",
+         *       "description": "Source that triggered the event"
+         *     },
+         *     "reading_value": {
+         *       "type": "number",
+         *       "description": "The meter reading value"
+         *     },
+         *     "reading_date": {
+         *       "type": "string",
+         *       "format": "date-time",
+         *       "description": "ISO 8601 timestamp when reading was taken"
+         *     },
+         *     "read_by": {
+         *       "type": "string",
+         *       "description": "Name or identifier of who submitted the reading"
+         *     },
+         *     "reason": {
+         *       "type": "string",
+         *       "enum": [
+         *         "regular",
+         *         "move-in",
+         *         "move-out",
+         *         "supplier-change",
+         *         "correction",
+         *         "final"
+         *       ],
+         *       "description": "Reason for the meter reading"
+         *     },
+         *     "direction": {
+         *       "type": "string",
+         *       "enum": [
+         *         "feed-in",
+         *         "feed-out"
+         *       ],
+         *       "description": "Direction of energy flow"
+         *     },
+         *     "source": {
+         *       "type": "string",
+         *       "enum": [
+         *         "portal",
+         *         "360",
+         *         "api",
+         *         "automation"
+         *       ],
+         *       "description": "Source system where reading was submitted"
+         *     },
+         *     "meter_id": {
+         *       "type": "string",
+         *       "format": "uuid",
+         *       "description": "Entity ID of the meter"
+         *     },
+         *     "counter_id": {
+         *       "type": "string",
+         *       "format": "uuid",
+         *       "description": "Entity ID of the meter counter"
+         *     },
+         *     "meter_number": {
+         *       "type": "string",
+         *       "description": "Human-readable meter number"
+         *     },
+         *     "obis_number": {
+         *       "type": "string",
+         *       "description": "OBIS code of the counter"
+         *     },
+         *     "unit": {
+         *       "type": "string",
+         *       "description": "Unit of measurement (e.g., kWh, m3)"
+         *     },
+         *     "customer_id": {
+         *       "type": "string",
+         *       "format": "uuid",
+         *       "description": "Entity ID of the customer"
+         *     },
+         *     "contract_id": {
+         *       "type": "string",
+         *       "format": "uuid",
+         *       "description": "Entity ID of the contract"
+         *     },
+         *     "user_id": {
+         *       "type": "string",
+         *       "description": "ID of the user who submitted the reading"
+         *     },
+         *     "user_email": {
+         *       "type": "string",
+         *       "format": "email",
+         *       "description": "Email of the user who submitted the reading"
+         *     }
+         *   },
+         *   "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"
+         *   ]
+         * }
+         */
+        export interface EventJsonSchema {
+        }
+        /**
+         * List of entity fields to include or exclude in the response
+         *
+         * Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
+         *
+         * Globbing and globstart (**) is supported for nested fields.
+         *
+         * example:
+         * [
+         *   "_id",
+         *   "_title",
+         *   "first_name",
+         *   "account",
+         *   "!account.*._files",
+         *   "**._product"
+         * ]
+         */
+        export type FieldsParam = string[];
+        /**
+         * Entity graph definition for resolving related entities
+         */
+        export interface GraphDefinition {
+            /**
+             * List of node definitions in the graph
+             */
+            nodes: /* A node in the entity graph */ GraphNode[];
+            /**
+             * List of edge definitions connecting nodes
+             */
+            edges: /* An edge connecting two nodes in the graph */ GraphEdge[];
+        }
+        /**
+         * An edge connecting two nodes in the graph
+         */
+        export interface GraphEdge {
+            /**
+             * Source node ID
+             * example:
+             * contact
+             */
+            from: string;
+            /**
+             * Target node ID
+             * example:
+             * billing_account
+             */
+            to: string;
+        }
+        /**
+         * A node in the entity graph
+         */
+        export interface GraphNode {
+            /**
+             * Unique identifier for this node in the graph definition
+             * example:
+             * contact
+             */
+            id: string;
+            /**
+             * Entity schema slug for this node
+             * example:
+             * contact
+             */
+            schema: string;
+            /**
+             * Cardinality for this node when hydrated:
+             * - "one": Node can only contain one entity, returns single Entity object
+             * - "many": Node can contain multiple entities, returns array of Entity objects
+             * If not specified, defaults to "many" (returns array)
+             *
+             * example:
+             * one
+             */
+            cardinality?: "one" | "many";
+            /**
+             * Optional array of field names to include in the hydrated entity response for this node.
+             * When specified, only the requested fields plus required internal fields (_id, _schema, _org) will be returned.
+             * Only applies when hydrate=true.
+             *
+             * example:
+             * [
+             *   "_id",
+             *   "_title",
+             *   "first_name",
+             *   "account",
+             *   "!account.*._files",
+             *   "**._product"
+             * ]
+             */
+            fields?: string[];
+        }
+        /**
+         * A primitive JSON Schema field definition
+         */
+        export interface PrimitiveField {
+            /**
+             * JSON Schema definition of the field
+             * example:
+             * {
+             *   "type": "string",
+             *   "format": "date-time",
+             *   "description": "ISO 8601 timestamp when reading was taken"
+             * }
+             */
+            json_schema: {
+                [key: string]: any;
+            };
+            /**
+             * Whether this field is required in the event payload
+             */
+            required?: boolean;
+            /**
+             * Optional JSONata expression to extract the field value from the hydrated entity graph.
+             *
+             * The expression has access to all hydrated graph nodes by their node ID.
+             * If not specified, the field value must be provided as input when triggering the event.
+             *
+             * Examples:
+             *   - "ticket.meter_reading_value" (simple path)
+             *   - "contact.email[0].email" (nested/array access)
+             *   - "ticket.reading_timestamp ?? $now()" (with fallback)
+             *   - "$number(meter_counter.reading_value)" (type coercion)
+             *
+             * example:
+             * ticket.meter_reading_value
+             */
+            graph_source?: string;
+        }
+        export type SchemaField = /* A primitive JSON Schema field definition */ PrimitiveField | ContextEntity;
+        export interface SearchOptions {
+            /**
+             * Maximum number of results to return
+             */
+            limit?: number;
+            /**
+             * Cursor for pagination. Use the next_cursor from the previous response to get the next page.
+             */
+            cursor?: {
+                /**
+                 * Timestamp from the last event in the previous page
+                 * example:
+                 * 2025-10-31 12:34:56
+                 */
+                event_time?: string;
+                /**
+                 * Event ID from the last event in the previous page
+                 * example:
+                 * evt_1234567890abcdef
+                 */
+                event_id?: string;
+            };
+            /**
+             * Filter events by timestamp range
+             */
+            timestamp?: {
+                /**
+                 * Start timestamp in ISO 8601 format
+                 * example:
+                 * 2025-10-01T00:00:00Z
+                 */
+                from?: string; // date-time
+                /**
+                 * End timestamp in ISO 8601 format
+                 * example:
+                 * 2025-10-31T23:59:59Z
+                 */
+                to?: string; // date-time
+            };
+            /**
+             * Filter by specific event ID
+             * example:
+             * evt_1234567890abcdef
+             */
+            event_id?: string;
+        }
+        /**
+         * Payload for explicitly triggering an event via API
+         */
+        export interface TriggerEventPayload {
+            /**
+             * Entity seed for graph hydration. Required for events that have an entity_graph defined.
+             * Specifies which entity to start graph traversal from.
+             *
+             */
+            seed?: {
+                /**
+                 * Entity ID to seed the graph hydration
+                 */
+                entity_id: string; // uuid
+                /**
+                 * Node ID from the event's entity_graph definition that matches
+                 * the seed entity. Must be a valid node in the event's graph.
+                 *
+                 */
+                node_id: string;
+            };
+            /**
+             * Input field values for the event. Keys must match the event's
+             * schema_fields definitions. Values are validated against each
+             * field's JSON Schema.
+             *
+             */
+            fields?: {
+                [name: string]: any;
+            };
+            /**
+             * Optional list of node IDs to skip during entity graph hydration.
+             * These nodes will be null/undefined in the event payload.
+             *
+             */
+            skip_hydration?: string[];
+            /**
+             * The type of system that triggered the event.
+             * Examples: api, automation, operation, portal_user
+             * Defaults to "api" if not specified.
+             *
+             */
+            _trigger_source_type?: string;
+            /**
+             * Identifier of the specific trigger source.
+             * Examples: user ID, automation execution ID, activity ID, portal user email
+             * Defaults to the calling user ID if not specified.
+             *
+             */
+            _trigger_source?: string;
+        }
+        /**
+         * Response from triggering an event
+         */
+        export interface TriggerEventResponse {
+            /**
+             * Whether the event was triggered successfully
+             */
+            success: boolean;
+            /**
+             * The unique event ID (ULID) assigned to this event
+             */
+            event_id: string;
+            /**
+             * EventBridge event ID from publishing
+             */
+            event_bridge_event_id?: string;
+        }
+        /**
+         * Payload for updating an event configuration.
+         * Accepts the same fields as EventConfig (all optional for PATCH).
+         * Currently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.
+         *
+         */
+        export interface UpdateEventPayload {
+            /**
+             * Unique human readable name of the event
+             * example:
+             * AddMeterReading
+             */
+            event_name?: string;
+            /**
+             * Human-friendly title for the event
+             * example:
+             * Add Meter Reading
+             */
+            event_title?: string;
+            /**
+             * Description of when the event is triggered
+             * example:
+             * Triggered when a new meter reading is added
+             */
+            event_description?: string;
+            /**
+             * Event version (semver)
+             * example:
+             * 1.0.0
+             */
+            event_version?: string;
+            /**
+             * Status of the event
+             * example:
+             * active
+             */
+            event_status?: "active" | "deprecated" | "draft" | "disabled";
+            /**
+             * Tags associated with the event for categorization and filtering
+             *
+             * The "builtin" tag indicates events that are built into the epilot system.
+             *
+             * example:
+             * [
+             *   "builtin",
+             *   "metering",
+             *   "erp"
+             * ]
+             */
+            event_tags?: string[];
+            /**
+             * Fields that define the event schema
+             */
+            schema_fields?: {
+                [name: string]: SchemaField;
+            };
+            /**
+             * Optional entity graph definition for resolving related entities
+             */
+            entity_graph?: {
+                /**
+                 * List of node definitions in the graph
+                 */
+                nodes: /* A node in the entity graph */ GraphNode[];
+                /**
+                 * List of edge definitions connecting nodes
+                 */
+                edges: /* An edge connecting two nodes in the graph */ GraphEdge[];
+            };
+            /**
+             * Optional configuration for triggering this event based on entity operations
+             */
+            entity_operation?: {
+                /**
+                 * List of entity operations that can trigger this event
+                 * example:
+                 * [
+                 *   "createEntity",
+                 *   "updateEntity"
+                 * ]
+                 */
+                operation: ("createEntity" | "updateEntity" | "deleteEntity")[];
+                /**
+                 * List of entity schema slugs that can trigger this event
+                 * example:
+                 * [
+                 *   "contact",
+                 *   "contract",
+                 *   "order"
+                 * ]
+                 */
+                schema: string[];
+                /**
+                 * Optional list of entity attributes to track for changes.
+                 * If specified, the event only triggers when these attributes are affected.
+                 * - On createEntity: attribute must be defined in the entity payload
+                 * - On updateEntity: attribute must be in diff.added, diff.updated, or diff.deleted
+                 * If not specified, all changes to matching entities will trigger the event.
+                 *
+                 * example:
+                 * [
+                 *   "email",
+                 *   "phone",
+                 *   "status"
+                 * ]
+                 */
+                attribute?: string[];
+                /**
+                 * Optional list of purpose names to filter by.
+                 * The entity must have at least one matching purpose in its _purpose array.
+                 * Purpose names are matched against the taxonomy classification names (e.g., "Kündigung", "Umzug/Auszug").
+                 * If not specified, the event triggers regardless of entity purpose.
+                 *
+                 * example:
+                 * [
+                 *   "Kündigung",
+                 *   "Umzug/Auszug"
+                 * ]
+                 */
+                purpose?: string[];
+            };
+            /**
+             * Whether this event is enabled for the organization.
+             * When disabled, the event will not be triggered by any means
+             * (automatic, API, or automation).
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            enabled?: boolean;
+            /**
+             * Whether the event should be triggered automatically by built-in logic
+             * (e.g., portal submissions, entity mutations, EventBridge rules).
+             * When false, the event can still be triggered manually via API or automations.
+             * Only meaningful for builtin events that have automatic trigger sources.
+             * Defaults to true if not specified.
+             *
+             * example:
+             * true
+             */
+            auto_trigger?: boolean;
+            /**
+             * Whether this event can be explicitly triggered by automations.
+             * When true, the event will appear in the automation builder as a
+             * "Trigger Event" action option.
+             * Defaults to false if not specified.
+             *
+             * example:
+             * true
+             */
+            automation_trigger?: boolean;
+        }
+    }
+}
+declare namespace Paths {
+    namespace GetEvent {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        namespace Responses {
+            export type $200 = /* Event configuration with required fields */ Components.Schemas.EventConfig;
+        }
+    }
+    namespace GetEventExample {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        namespace Responses {
+            /**
+             * A sample event payload generated from the JSON Schema
+             */
+            export interface $200 {
+            }
+        }
+    }
+    namespace GetEventJSONSchema {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        namespace Responses {
+            export type $200 = /**
+             * JSON Schema declaring the event payload structure
+             * example:
+             * {
+             *   "type": "object",
+             *   "properties": {
+             *     "_org_id": {
+             *       "type": "string",
+             *       "description": "epilot tenant/organization ID"
+             *     },
+             *     "_event_time": {
+             *       "type": "string",
+             *       "format": "date-time",
+             *       "description": "ISO 8601 timestamp when event occurred"
+             *     },
+             *     "_event_id": {
+             *       "type": "string",
+             *       "description": "Unique event identifier (ULID)"
+             *     },
+             *     "_event_name": {
+             *       "type": "string",
+             *       "description": "Event name from catalog"
+             *     },
+             *     "_event_version": {
+             *       "type": "string",
+             *       "description": "Event version (semver)"
+             *     },
+             *     "_event_source": {
+             *       "type": "string",
+             *       "description": "Source that triggered the event"
+             *     },
+             *     "reading_value": {
+             *       "type": "number",
+             *       "description": "The meter reading value"
+             *     },
+             *     "reading_date": {
+             *       "type": "string",
+             *       "format": "date-time",
+             *       "description": "ISO 8601 timestamp when reading was taken"
+             *     },
+             *     "read_by": {
+             *       "type": "string",
+             *       "description": "Name or identifier of who submitted the reading"
+             *     },
+             *     "reason": {
+             *       "type": "string",
+             *       "enum": [
+             *         "regular",
+             *         "move-in",
+             *         "move-out",
+             *         "supplier-change",
+             *         "correction",
+             *         "final"
+             *       ],
+             *       "description": "Reason for the meter reading"
+             *     },
+             *     "direction": {
+             *       "type": "string",
+             *       "enum": [
+             *         "feed-in",
+             *         "feed-out"
+             *       ],
+             *       "description": "Direction of energy flow"
+             *     },
+             *     "source": {
+             *       "type": "string",
+             *       "enum": [
+             *         "portal",
+             *         "360",
+             *         "api",
+             *         "automation"
+             *       ],
+             *       "description": "Source system where reading was submitted"
+             *     },
+             *     "meter_id": {
+             *       "type": "string",
+             *       "format": "uuid",
+             *       "description": "Entity ID of the meter"
+             *     },
+             *     "counter_id": {
+             *       "type": "string",
+             *       "format": "uuid",
+             *       "description": "Entity ID of the meter counter"
+             *     },
+             *     "meter_number": {
+             *       "type": "string",
+             *       "description": "Human-readable meter number"
+             *     },
+             *     "obis_number": {
+             *       "type": "string",
+             *       "description": "OBIS code of the counter"
+             *     },
+             *     "unit": {
+             *       "type": "string",
+             *       "description": "Unit of measurement (e.g., kWh, m3)"
+             *     },
+             *     "customer_id": {
+             *       "type": "string",
+             *       "format": "uuid",
+             *       "description": "Entity ID of the customer"
+             *     },
+             *     "contract_id": {
+             *       "type": "string",
+             *       "format": "uuid",
+             *       "description": "Entity ID of the contract"
+             *     },
+             *     "user_id": {
+             *       "type": "string",
+             *       "description": "ID of the user who submitted the reading"
+             *     },
+             *     "user_email": {
+             *       "type": "string",
+             *       "format": "email",
+             *       "description": "Email of the user who submitted the reading"
+             *     }
+             *   },
+             *   "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"
+             *   ]
+             * }
+             */
+            Components.Schemas.EventJsonSchema;
+        }
+    }
+    namespace ListEvents {
+        namespace Responses {
+            export interface $200 {
+                results?: /* Event configuration with required fields */ Components.Schemas.EventConfig[];
+            }
+        }
+    }
+    namespace PatchEvent {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        export type RequestBody = /**
+         * Payload for updating an event configuration.
+         * Accepts the same fields as EventConfig (all optional for PATCH).
+         * Currently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.
+         *
+         */
+        Components.Schemas.UpdateEventPayload;
+        namespace Responses {
+            export type $200 = /* Event configuration with required fields */ Components.Schemas.EventConfig;
+            export interface $404 {
+            }
+        }
+    }
+    namespace SearchEventHistory {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        export type RequestBody = Components.Schemas.SearchOptions;
+        namespace Responses {
+            export interface $200 {
+                results?: /**
+                 * An event instance in the event history
+                 * example:
+                 * {
+                 *   "_org_id": "org_123456",
+                 *   "_event_time": "2024-01-01T12:00:00Z",
+                 *   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
+                 *   "_event_name": "MeterReading",
+                 *   "_event_version": "1.0.0",
+                 *   "_event_source": "api",
+                 *   "_trigger_source_type": "api",
+                 *   "_trigger_source": "user_123456",
+                 *   "reading_value": 123.45,
+                 *   "reading_date": "2024-01-01T11:59:00Z",
+                 *   "read_by": "John Doe",
+                 *   "reason": "regular",
+                 *   "direction": "feed-out",
+                 *   "source": "portal",
+                 *   "meter_id": "550e8400-e29b-41d4-a716-446655440000",
+                 *   "counter_id": "660e8400-e29b-41d4-a716-446655440000",
+                 *   "meter_number": "MT123456789",
+                 *   "obis_number": "1-0:1.8.0",
+                 *   "unit": "kWh",
+                 *   "customer_id": "770e8400-e29b-41d4-a716-446655440000",
+                 *   "contract_id": "880e8400-e29b-41d4-a716-446655440000"
+                 * }
+                 */
+                Components.Schemas.Event[];
+                /**
+                 * Cursor for pagination. Use this to get the next page of results.
+                 */
+                next_cursor?: {
+                    /**
+                     * Timestamp from the last event in the current page
+                     * example:
+                     * 2025-10-31T12:34:56Z
+                     */
+                    event_time?: string;
+                    /**
+                     * Event ID from the last event in the current page
+                     * example:
+                     * evt_1234567890abcdef
+                     */
+                    event_id?: string;
+                } | null;
+            }
+        }
+    }
+    namespace TriggerEvent {
+        namespace Parameters {
+            export type EventName = string;
+        }
+        export interface PathParameters {
+            event_name: Parameters.EventName;
+        }
+        export type RequestBody = /* Payload for explicitly triggering an event via API */ Components.Schemas.TriggerEventPayload;
+        namespace Responses {
+            export type $200 = /* Response from triggering an event */ Components.Schemas.TriggerEventResponse;
+            export interface $400 {
+            }
+            export interface $403 {
+            }
+            export interface $404 {
+            }
+        }
+    }
+}
+
+
+interface OperationMethods {
+  /**
+   * listEvents - listEvents
+   * 
+   * Retrieve list of available business events
+   */
+  'listEvents'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListEvents.Responses.$200>
+  /**
+   * getEvent - getEvent
+   * 
+   * Retrieve the configuration of a specific business event
+   */
+  'getEvent'(
+    parameters?: Parameters<Paths.GetEvent.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetEvent.Responses.$200>
+  /**
+   * patchEvent - patchEvent
+   * 
+   * Update the configuration of a specific business event for the organization
+   */
+  'patchEvent'(
+    parameters?: Parameters<Paths.PatchEvent.PathParameters> | null,
+    data?: Paths.PatchEvent.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchEvent.Responses.$200>
+  /**
+   * getEventJSONSchema - getEventJSONSchema
+   * 
+   * Retrieve the JSON Schema of a specific business event
+   */
+  'getEventJSONSchema'(
+    parameters?: Parameters<Paths.GetEventJSONSchema.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetEventJSONSchema.Responses.$200>
+  /**
+   * getEventExample - getEventExample
+   * 
+   * Generate a sample event payload based on the event's JSON Schema
+   */
+  'getEventExample'(
+    parameters?: Parameters<Paths.GetEventExample.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetEventExample.Responses.$200>
+  /**
+   * searchEventHistory - searchEventHistory
+   * 
+   * Paginated history of events
+   */
+  'searchEventHistory'(
+    parameters?: Parameters<Paths.SearchEventHistory.PathParameters> | null,
+    data?: Paths.SearchEventHistory.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SearchEventHistory.Responses.$200>
+  /**
+   * triggerEvent - triggerEvent
+   * 
+   * Explicitly trigger an event by providing input field values and an optional entity seed
+   * for graph hydration. The event must be enabled for the organization.
+   * 
+   * - For events with an entity_graph, a seed (entity_id + node_id) is required
+   * - For events without an entity_graph, only fields are needed
+   * - Entity operation context fields (operation, trigger_entity, activity_id, activity_type)
+   *   are not included when triggering via API
+   * 
+   */
+  'triggerEvent'(
+    parameters?: Parameters<Paths.TriggerEvent.PathParameters> | null,
+    data?: Paths.TriggerEvent.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.TriggerEvent.Responses.$200>
+}
+
+interface PathsDictionary {
+  ['/v1/events']: {
+    /**
+     * listEvents - listEvents
+     * 
+     * Retrieve list of available business events
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListEvents.Responses.$200>
+  }
+  ['/v1/events/{event_name}']: {
+    /**
+     * getEvent - getEvent
+     * 
+     * Retrieve the configuration of a specific business event
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetEvent.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetEvent.Responses.$200>
+    /**
+     * patchEvent - patchEvent
+     * 
+     * Update the configuration of a specific business event for the organization
+     */
+    'patch'(
+      parameters?: Parameters<Paths.PatchEvent.PathParameters> | null,
+      data?: Paths.PatchEvent.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchEvent.Responses.$200>
+  }
+  ['/v1/events/{event_name}/json_schema']: {
+    /**
+     * getEventJSONSchema - getEventJSONSchema
+     * 
+     * Retrieve the JSON Schema of a specific business event
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetEventJSONSchema.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetEventJSONSchema.Responses.$200>
+  }
+  ['/v1/events/{event_name}/example']: {
+    /**
+     * getEventExample - getEventExample
+     * 
+     * Generate a sample event payload based on the event's JSON Schema
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetEventExample.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetEventExample.Responses.$200>
+  }
+  ['/v1/events/{event_name}:history']: {
+    /**
+     * searchEventHistory - searchEventHistory
+     * 
+     * Paginated history of events
+     */
+    'post'(
+      parameters?: Parameters<Paths.SearchEventHistory.PathParameters> | null,
+      data?: Paths.SearchEventHistory.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SearchEventHistory.Responses.$200>
+  }
+  ['/v1/events/{event_name}:trigger']: {
+    /**
+     * triggerEvent - triggerEvent
+     * 
+     * Explicitly trigger an event by providing input field values and an optional entity seed
+     * for graph hydration. The event must be enabled for the organization.
+     * 
+     * - For events with an entity_graph, a seed (entity_id + node_id) is required
+     * - For events without an entity_graph, only fields are needed
+     * - Entity operation context fields (operation, trigger_entity, activity_id, activity_type)
+     *   are not included when triggering via API
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.TriggerEvent.PathParameters> | null,
+      data?: Paths.TriggerEvent.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.TriggerEvent.Responses.$200>
+  }
+}
+
+type Client = OpenAPIClient<OperationMethods, PathsDictionary>
+
+
+type CommonEventMetadata = Components.Schemas.CommonEventMetadata;
+type ContextEntity = Components.Schemas.ContextEntity;
+type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
+type Event = Components.Schemas.Event;
+type EventConfig = Components.Schemas.EventConfig;
+type EventConfigBase = Components.Schemas.EventConfigBase;
+type EventJsonSchema = Components.Schemas.EventJsonSchema;
+type FieldsParam = Components.Schemas.FieldsParam;
+type GraphDefinition = Components.Schemas.GraphDefinition;
+type GraphEdge = Components.Schemas.GraphEdge;
+type GraphNode = Components.Schemas.GraphNode;
+type PrimitiveField = Components.Schemas.PrimitiveField;
+type SchemaField = Components.Schemas.SchemaField;
+type SearchOptions = Components.Schemas.SearchOptions;
+type TriggerEventPayload = Components.Schemas.TriggerEventPayload;
+type TriggerEventResponse = Components.Schemas.TriggerEventResponse;
+type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
+
+export { type Client as C, type EntityOperationTrigger as E, type FieldsParam as F, type GraphDefinition as G, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventConfig as f, type EventConfigBase as g, type EventJsonSchema as h, type GraphEdge as i, type GraphNode as j, type PrimitiveField as k, type SearchOptions as l, type TriggerEventResponse as m };