@epilot/sdk 2.6.0 → 2.7.1

package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts}

@@ -34,6 +34,22 @@ declare namespace Components {
         export type UpdateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
     }
     namespace Schemas {
+        /**
+         * Feature flags selecting which Microsoft Graph scopes to request.
+         * At least one flag must be true. Passing a superset of previously
+         * granted features triggers incremental consent for the delta only.
+         *
+         */
+        export interface ConnectOutlookRequest {
+            /**
+             * Request 'mail' specific scopes.
+             */
+            mail?: boolean;
+            /**
+             * Request 'calendar' specific scopes.
+             */
+            calendar?: boolean;
+        }
         /**
          * Mapping between an Outlook email and its Outlook Connection.
          * This tracks which provider/tenant provisions each Outlook email.
@@ -340,14 +356,24 @@ declare namespace Components {
              */
             status: "connected" | "expired" | "pending_auth" | "not_connected";
             /**
-             * Action for UI to take (all call GET /outlook/connect):
+             * Action for UI to take (all call POST /outlook/connect):
              * - connect: No connection, initiate OAuth
              * - authorize: Admin consent done, complete OAuth
-             * - reconnect: Re-authenticate expired session
+             * - reconnect: Re-authenticate expired session or approve updated permissions
              * - none: Fully connected, no action needed
              *
              */
             action: "connect" | "authorize" | "reconnect" | "none";
+            /**
+             * Discriminates the cause when `action` is `reconnect`:
+             * - expired: Stored tokens are no longer valid; user must re-authenticate
+             * - permission_update: Token is valid, but the granted scopes do not cover the
+             *   scopes required by the configured Outlook integrations (currently `mail`).
+             *   The user must reconnect to grant the additional permissions; Microsoft's
+             *   incremental-consent flow will only prompt for the delta.
+             *
+             */
+            action_reason?: "expired" | "permission_update";
             /**
              * Display name of user who connected
              */
@@ -787,10 +813,18 @@ declare namespace Paths {
         }
     }
     namespace ConnectOutlook {
+        export type RequestBody = /**
+         * Feature flags selecting which Microsoft Graph scopes to request.
+         * At least one flag must be true. Passing a superset of previously
+         * granted features triggers incremental consent for the delta only.
+         *
+         */
+        Components.Schemas.ConnectOutlookRequest;
         namespace Responses {
             export interface $200 {
-                authorization_url?: string;
+                authorization_url: string;
             }
+            export type $400 = Components.Responses.OutlookErrorResponse;
             export type $403 = Components.Responses.OutlookErrorResponse;
         }
     }
@@ -1312,6 +1346,14 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace VerifyDnsRecords {
+        export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
+        namespace Responses {
+            export type $200 = Components.Schemas.SettingsResponse;
+            export type $403 = Components.Responses.Forbidden;
+            export type $404 = Components.Responses.NotFound;
+        }
+    }
     namespace VerifyDomain {
         export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
         namespace Responses {
@@ -1330,6 +1372,7 @@ declare namespace Paths {
     }
 }
 
+
 interface OperationMethods {
   /**
    * provisionEpilotEmailAddress - provisionEpilotEmailAddress
@@ -1529,11 +1572,18 @@ interface OperationMethods {
   /**
    * connectOutlook - connectOutlook
    * 
-   * Returns Microsoft authorization URL for Outlook OAuth.
+   * Returns the Microsoft authorization URL for Outlook OAuth.
+   * 
+   * The request body selects which features to request scopes for. Feature
+   * flags are additive; Microsoft OAuth scopes are cumulative. Calling this
+   * endpoint again with a superset of features (e.g. `mail` already connected,
+   * and `calendar` added) triggers Microsoft's incremental-consent flow —
+   * the user only sees a consent prompt for the new scopes.
+   * 
    */
   'connectOutlook'(
     parameters?: Parameters<UnknownParamsObject> | null,
-    data?: any,
+    data?: Paths.ConnectOutlook.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ConnectOutlook.Responses.$200>
   /**
@@ -1805,12 +1855,31 @@ interface OperationMethods {
    * 
    * Run this verification after configuring NS records in your DNS provider.
    * 
+   * **Deprecated**: Use `/domain/dns-records:verify` for new integrations.
+   * 
    */
   'verifyNameServers'(
     parameters?: Parameters<UnknownParamsObject> | null,
     data?: Paths.VerifyNameServers.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
+  /**
+   * verifyDnsRecords - verifyDnsRecords
+   * 
+   * Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured
+   * in the customer's DNS provider.
+   * 
+   * This check performs DNS lookups to confirm each required record is present
+   * before proceeding with full domain identity verification.
+   * 
+   * Run this verification after configuring all DNS records in your DNS provider.
+   * 
+   */
+  'verifyDnsRecords'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.VerifyDnsRecords.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.VerifyDnsRecords.Responses.$200>
   /**
    * verifyDomain - verifyDomain
    * 
@@ -2046,11 +2115,18 @@ interface PathsDictionary {
     /**
      * connectOutlook - connectOutlook
      * 
-     * Returns Microsoft authorization URL for Outlook OAuth.
+     * Returns the Microsoft authorization URL for Outlook OAuth.
+     * 
+     * The request body selects which features to request scopes for. Feature
+     * flags are additive; Microsoft OAuth scopes are cumulative. Calling this
+     * endpoint again with a superset of features (e.g. `mail` already connected,
+     * and `calendar` added) triggers Microsoft's incremental-consent flow —
+     * the user only sees a consent prompt for the new scopes.
+     * 
      */
-    'get'(
+    'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
-      data?: any,
+      data?: Paths.ConnectOutlook.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ConnectOutlook.Responses.$200>
   }
@@ -2354,6 +2430,8 @@ interface PathsDictionary {
      * 
      * Run this verification after configuring NS records in your DNS provider.
      * 
+     * **Deprecated**: Use `/domain/dns-records:verify` for new integrations.
+     * 
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -2361,6 +2439,25 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
   }
+  ['/v1/email-settings/domain/dns-records:verify']: {
+    /**
+     * verifyDnsRecords - verifyDnsRecords
+     * 
+     * Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured
+     * in the customer's DNS provider.
+     * 
+     * This check performs DNS lookups to confirm each required record is present
+     * before proceeding with full domain identity verification.
+     * 
+     * Run this verification after configuring all DNS records in your DNS provider.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.VerifyDnsRecords.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.VerifyDnsRecords.Responses.$200>
+  }
   ['/v1/email-settings/domain:verify']: {
     /**
      * verifyDomain - verifyDomain
@@ -2386,6 +2483,8 @@ interface PathsDictionary {
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+
+type ConnectOutlookRequest = Components.Schemas.ConnectOutlookRequest;
 type ConnectedOutlookEmail = Components.Schemas.ConnectedOutlookEmail;
 type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
 type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
@@ -2414,4 +2513,4 @@ type UpdateEmailAddressPayload = Components.Schemas.UpdateEmailAddressPayload;
 type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
 type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;
 
-export { type Client as C, type Domain as D, type EmailAddressResponse as E, type InboxBucketResponse as I, type MailboxSyncFolderStatuses as M, type OperationMethods as O, Paths as P, type RestrictDuplicatesWithinSetting as R, type SetEmailAddressPrimaryPayload as S, type UpdateEmailAddressPayload as U, type WhitelistEmailAddressSetting as W, Components as a, type PathsDictionary as b, type ConnectedOutlookEmail as c, type CreateEmailAddressPayload as d, type CreateSharedInboxPayload as e, type EmailAddressSetting as f, type EmailDomainSetting as g, type ErrorResponse as h, type MailboxSyncStatus as i, type MailboxSyncStatuses as j, type MailboxSyncTimeframePeriods as k, type OutlookConnectionError as l, type OutlookConnectionStatus as m, type ProvisionEpilotEmailAddressPayload as n, type Setting as o, type SettingMeta as p, type SettingType as q, type SettingsResponse as r, type SharedInboxResponse as s, type SignatureSetting as t, type UpdateSharedInboxPayload as u };
+export { type Client as C, type Domain as D, type EmailAddressResponse as E, type InboxBucketResponse as I, type MailboxSyncFolderStatuses as M, type OperationMethods as O, Paths as P, type RestrictDuplicatesWithinSetting as R, type SetEmailAddressPrimaryPayload as S, type UpdateEmailAddressPayload as U, type WhitelistEmailAddressSetting as W, Components as a, type PathsDictionary as b, type ConnectOutlookRequest as c, type ConnectedOutlookEmail as d, type CreateEmailAddressPayload as e, type CreateSharedInboxPayload as f, type EmailAddressSetting as g, type EmailDomainSetting as h, type ErrorResponse as i, type MailboxSyncStatus as j, type MailboxSyncStatuses as k, type MailboxSyncTimeframePeriods as l, type OutlookConnectionError as m, type OutlookConnectionStatus as n, type ProvisionEpilotEmailAddressPayload as o, type Setting as p, type SettingMeta as q, type SettingType as r, type SettingsResponse as s, type SharedInboxResponse as t, type SignatureSetting as u, type UpdateSharedInboxPayload as v };

package/dist/event-catalog-37B6JC7G.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/event-catalog.json
+var event_catalog_default = '# Event Catalog API\n\n- **Base URL:** `https://event-catalog.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/event-catalog](https://docs.epilot.io/api/event-catalog)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.eventCatalog.listEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/event-catalog\'\n\nconst eventCatalogClient = getClient()\nauthorize(eventCatalogClient, () => \'<token>\')\nconst { data } = await eventCatalogClient.listEvents(...)\n```\n\n## Operations\n\n**Event Catalog**\n- [`listEvents`](#listevents)\n- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\n- [`getEventJSONSchema`](#geteventjsonschema)\n- [`getEventExample`](#geteventexample)\n- [`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- [`CommonEventMetadata`](#commoneventmetadata)\n- [`EventJsonSchema`](#eventjsonschema)\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\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.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    }\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.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}\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.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  },\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.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}\n```\n\n</details>\n\n---\n\n### `getEventJSONSchema`\n\nRetrieve the JSON Schema of a specific business event\n\n`GET /v1/events/{event_name}/json_schema`\n\n```ts\nconst { data } = await client.getEventJSONSchema({\n  event_name: \'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 version (semver)"\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\n\n`GET /v1/events/{event_name}/example`\n\n```ts\nconst { data } = await client.getEventExample({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\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.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.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.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}\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}\n```\n\n### `UpdateEventPayload`\n\nPayload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled` and `auto_trigger` 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}\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### `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### `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}\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`\nand arrays of such objects) are stripped \u2014 fetch via\n`GET /v2/events/{event_name}/his\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';
+export {
+  event_catalog_default as default
+};

package/dist/event-catalog-5JBHJJ2I.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/event-catalog.json
+var event_catalog_default = '# Event Catalog API\n\n- **Base URL:** `https://event-catalog.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/event-catalog](https://docs.epilot.io/api/event-catalog)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.eventCatalog.listEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/event-catalog\'\n\nconst eventCatalogClient = getClient()\nauthorize(eventCatalogClient, () => \'<token>\')\nconst { data } = await eventCatalogClient.listEvents(...)\n```\n\n## Operations\n\n**Event Catalog**\n- [`listEvents`](#listevents)\n- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\n- [`getEventJSONSchema`](#geteventjsonschema)\n- [`getEventExample`](#geteventexample)\n- [`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- [`CommonEventMetadata`](#commoneventmetadata)\n- [`EventJsonSchema`](#eventjsonschema)\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\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.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    }\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.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}\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.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  },\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.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}\n```\n\n</details>\n\n---\n\n### `getEventJSONSchema`\n\nRetrieve the JSON Schema of a specific business event\n\n`GET /v1/events/{event_name}/json_schema`\n\n```ts\nconst { data } = await client.getEventJSONSchema({\n  event_name: \'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 version (semver)"\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\n\n`GET /v1/events/{event_name}/example`\n\n```ts\nconst { data } = await client.getEventExample({\n  event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\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.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.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.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}\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}\n```\n\n### `UpdateEventPayload`\n\nPayload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled` and `auto_trigger` 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}\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### `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### `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}\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`\nand arrays of such objects) are stripped \u2014 fetch via\n`GET /v2/events/{event_name}/his\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';
+
+
+exports.default = event_catalog_default;

package/dist/{event-catalog-runtime-5HQSAJVX.cjs → event-catalog-runtime-B2BPKQVG.cjs}

@@ -1,5 +1,5 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkBLNXQAMXcjs = require('./chunk-BLNXQAMX.cjs');
+var _chunkCBDKPGO5cjs = require('./chunk-CBDKPGO5.cjs');
 require('./chunk-NJK5F5TF.cjs');
-exports. default = _chunkBLNXQAMXcjs.require_event_catalog_runtime.call(void 0, );
+exports. default = _chunkCBDKPGO5cjs.require_event_catalog_runtime.call(void 0, );

package/dist/{event-catalog-runtime-6FA3SCRI.js → event-catalog-runtime-N262TQ3Y.js}

@@ -1,5 +1,5 @@
 import {
   require_event_catalog_runtime
-} from "./chunk-TME4YJNP.js";
+} from "./chunk-OCMIXJWC.js";
 import "./chunk-YPSWSI3M.js";
 export default require_event_catalog_runtime();