@epilot/sdk 2.20.33 → 2.20.34

package/docs/event-catalog.md

@@ -33,6 +33,10 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`deprecateCustomEvent`](#deprecatecustomevent)
 - [`previewCustomEvent`](#previewcustomevent)
 - [`publishCustomEventDefinition`](#publishcustomeventdefinition)
+- [`getCustomEventVersionDraft`](#getcustomeventversiondraft)
+- [`putCustomEventVersionDraft`](#putcustomeventversiondraft)
+- [`deleteCustomEventVersionDraft`](#deletecustomeventversiondraft)
+- [`publishCustomEventVersion`](#publishcustomeventversion)
 - [`getEventJSONSchema`](#geteventjsonschema)
 - [`getEventExample`](#geteventexample)
 - [`listEventVersions`](#listeventversions)
@@ -49,6 +53,8 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`CustomEventLineage`](#customeventlineage)
 - [`PurposeFilterSnapshot`](#purposefiltersnapshot)
 - [`PublishCustomEventPayload`](#publishcustomeventpayload)
+- [`CustomEventVersionDraft`](#customeventversiondraft)
+- [`PublishCustomEventVersionPayload`](#publishcustomeventversionpayload)
 - [`ValidationIssue`](#validationissue)
 - [`PreviewEventResponse`](#previeweventresponse)
 - [`UpdateEventPayload`](#updateeventpayload)
@@ -757,6 +763,360 @@ const { data } = await client.publishCustomEventDefinition(
 
 ---
 
+### `getCustomEventVersionDraft`
+
+Read the in-progress successor of a published custom event, together with the version it
+would be published as. The live version keeps firing while the successor is authored.
+
+`GET /v1/events/{event_name}/version_draft`
+
+```ts
+const { data } = await client.getCustomEventVersionDraft({
+  event_name: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "config": {
+    "event_name": "AddMeterReading",
+    "event_title": "Add Meter Reading",
+    "event_description": "Triggered when a new meter reading is added",
+    "event_version": "1.0",
+    "event_status": "active",
+    "event_tags": ["builtin", "metering", "erp"],
+    "schema_fields": {},
+    "entity_graph": {
+      "nodes": [
+        {
+          "id": "contact",
+          "schema": "contact",
+          "cardinality": "one",
+          "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]
+        }
+      ],
+      "edges": [
+        {
+          "from": "contact",
+          "to": "billing_account"
+        }
+      ]
+    },
+    "entity_operation": {
+      "operation": ["createEntity", "updateEntity"],
+      "schema": ["contact", "contract", "order"],
+      "attribute": ["email", "phone", "status"],
+      "purpose": ["Kündigung", "Umzug/Auszug"],
+      "purpose_filters": [
+        {
+          "id": "string",
+          "display_name": "string"
+        }
+      ]
+    },
+    "enabled": true,
+    "auto_trigger": true,
+    "automation_trigger": true,
+    "api_trigger": true,
+    "automation_trigger_only": true,
+    "automation_trigger_seed_node": "ticket",
+    "event_origin": "builtin",
+    "mapping": {
+      "mode": "guided",
+      "jsonata": "string"
+    },
+    "lineage": {
+      "base_event_name": "string",
+      "base_event_version": "string"
+    },
+    "success_criteria": [
+      {
+        "entity_schema": "contract",
+        "attribute": "installment_amount"
+      },
+      {
+        "entity_schema": "billing_account",
+        "attribute": "due_date"
+      }
+    ]
+  },
+  "change_class": "none",
+  "next_version": "1.1",
+  "changes": [
+    {
+      "field": "reading",
+      "op": "added",
+      "type_old": "string",
+      "type_new": "string"
+    }
+  ],
+  "remapped_fields": ["string"],
+  "added_nodes": ["string"],
+  "blocked_reason": "string"
+}
+```
+
+</details>
+
+---
+
+### `putCustomEventVersionDraft`
+
+Create or replace the successor of a published custom event. The published definition stays
+immutable and keeps firing; only publishing the draft promotes it.
+
+`PUT /v1/events/{event_name}/version_draft`
+
+```ts
+const { data } = await client.putCustomEventVersionDraft(
+  {
+    event_name: 'example',
+  },
+  {
+    event_name: 'string',
+    event_title: 'string',
+    event_description: 'string',
+    event_tags: ['string'],
+    schema_fields: {},
+    entity_graph: {
+      nodes: [
+        {
+          id: 'contact',
+          schema: 'contact',
+          cardinality: 'one',
+          fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product']
+        }
+      ],
+      edges: [
+        {
+          from: 'contact',
+          to: 'billing_account'
+        }
+      ]
+    },
+    entity_operation: {
+      operation: ['createEntity', 'updateEntity'],
+      schema: ['contact', 'contract', 'order'],
+      attribute: ['email', 'phone', 'status'],
+      purpose: ['Kündigung', 'Umzug/Auszug'],
+      purpose_filters: [
+        {
+          id: 'string',
+          display_name: 'string'
+        }
+      ]
+    },
+    automation_trigger: true,
+    api_trigger: true,
+    automation_trigger_only: false,
+    automation_trigger_seed_node: 'string',
+    mapping: {
+      mode: 'guided',
+      jsonata: 'string'
+    },
+    lineage: {
+      base_event_name: 'string',
+      base_event_version: 'string'
+    },
+    example: {}
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "config": {
+    "event_name": "AddMeterReading",
+    "event_title": "Add Meter Reading",
+    "event_description": "Triggered when a new meter reading is added",
+    "event_version": "1.0",
+    "event_status": "active",
+    "event_tags": ["builtin", "metering", "erp"],
+    "schema_fields": {},
+    "entity_graph": {
+      "nodes": [
+        {
+          "id": "contact",
+          "schema": "contact",
+          "cardinality": "one",
+          "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]
+        }
+      ],
+      "edges": [
+        {
+          "from": "contact",
+          "to": "billing_account"
+        }
+      ]
+    },
+    "entity_operation": {
+      "operation": ["createEntity", "updateEntity"],
+      "schema": ["contact", "contract", "order"],
+      "attribute": ["email", "phone", "status"],
+      "purpose": ["Kündigung", "Umzug/Auszug"],
+      "purpose_filters": [
+        {
+          "id": "string",
+          "display_name": "string"
+        }
+      ]
+    },
+    "enabled": true,
+    "auto_trigger": true,
+    "automation_trigger": true,
+    "api_trigger": true,
+    "automation_trigger_only": true,
+    "automation_trigger_seed_node": "ticket",
+    "event_origin": "builtin",
+    "mapping": {
+      "mode": "guided",
+      "jsonata": "string"
+    },
+    "lineage": {
+      "base_event_name": "string",
+      "base_event_version": "string"
+    },
+    "success_criteria": [
+      {
+        "entity_schema": "contract",
+        "attribute": "installment_amount"
+      },
+      {
+        "entity_schema": "billing_account",
+        "attribute": "due_date"
+      }
+    ]
+  },
+  "change_class": "none",
+  "next_version": "1.1",
+  "changes": [
+    {
+      "field": "reading",
+      "op": "added",
+      "type_old": "string",
+      "type_new": "string"
+    }
+  ],
+  "remapped_fields": ["string"],
+  "added_nodes": ["string"],
+  "blocked_reason": "string"
+}
+```
+
+</details>
+
+---
+
+### `deleteCustomEventVersionDraft`
+
+Discard the next-version draft. The published version is untouched.
+
+`DELETE /v1/events/{event_name}/version_draft`
+
+```ts
+const { data } = await client.deleteCustomEventVersionDraft({
+  event_name: 'example',
+})
+```
+
+---
+
+### `publishCustomEventVersion`
+
+Publish the next-version draft as the event's new live version.
+
+`POST /v1/events/{event_name}/version_draft:publish`
+
+```ts
+const { data } = await client.publishCustomEventVersion(
+  {
+    event_name: 'example',
+  },
+  {
+    change_summary: 'string',
+    change_notes: 'string'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "event_name": "AddMeterReading",
+  "event_title": "Add Meter Reading",
+  "event_description": "Triggered when a new meter reading is added",
+  "event_version": "1.0",
+  "event_status": "active",
+  "event_tags": ["builtin", "metering", "erp"],
+  "schema_fields": {},
+  "entity_graph": {
+    "nodes": [
+      {
+        "id": "contact",
+        "schema": "contact",
+        "cardinality": "one",
+        "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]
+      }
+    ],
+    "edges": [
+      {
+        "from": "contact",
+        "to": "billing_account"
+      }
+    ]
+  },
+  "entity_operation": {
+    "operation": ["createEntity", "updateEntity"],
+    "schema": ["contact", "contract", "order"],
+    "attribute": ["email", "phone", "status"],
+    "purpose": ["Kündigung", "Umzug/Auszug"],
+    "purpose_filters": [
+      {
+        "id": "string",
+        "display_name": "string"
+      }
+    ]
+  },
+  "enabled": true,
+  "auto_trigger": true,
+  "automation_trigger": true,
+  "api_trigger": true,
+  "automation_trigger_only": true,
+  "automation_trigger_seed_node": "ticket",
+  "event_origin": "builtin",
+  "mapping": {
+    "mode": "guided",
+    "jsonata": "string"
+  },
+  "lineage": {
+    "base_event_name": "string",
+    "base_event_version": "string"
+  },
+  "success_criteria": [
+    {
+      "entity_schema": "contract",
+      "attribute": "installment_amount"
+    },
+    {
+      "entity_schema": "billing_account",
+      "attribute": "due_date"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `getEventJSONSchema`
 
 Retrieve the JSON Schema of a specific business event. Pass an optional
@@ -1408,6 +1768,85 @@ type PublishCustomEventPayload = {
 }
 ```
 
+### `CustomEventVersionDraft`
+
+A pending successor to a published custom event, with the version it would become.
+
+
+```ts
+type CustomEventVersionDraft = {
+  config: {
+    event_name: string
+    event_title?: string
+    event_description?: string
+    event_version: string
+    event_status?: "active" | "deprecated" | "draft" | "disabled"
+    event_tags?: string[]
+    schema_fields: Record<string, {
+      json_schema: { ... }
+      required?: { ... }
+      graph_source?: { ... }
+    } | {
+      entity_schema: { ... }
+      required?: { ... }
+    } | {
+      items: { ... }
+      required?: { ... }
+    }>
+    entity_graph?: {
+      nodes: { ... }
+      edges: { ... }
+    }
+    entity_operation?: {
+      operation: { ... }
+      schema: { ... }
+      attribute?: { ... }
+      purpose?: { ... }
+      purpose_filters?: { ... }
+    }
+    enabled?: boolean
+    auto_trigger?: boolean
+    automation_trigger?: boolean
+    api_trigger?: boolean
+    automation_trigger_only?: boolean
+    automation_trigger_seed_node?: string
+    event_origin?: "builtin" | "custom"
+    mapping?: {
+      mode: { ... }
+      jsonata?: { ... }
+    }
+    lineage?: {
+      base_event_name: { ... }
+      base_event_version: { ... }
+    }
+    success_criteria?: Array<{
+      entity_schema: { ... }
+      attribute: { ... }
+    }>
+  }
+  change_class: "none" | "minor" | "major" | "blocked"
+  next_version?: string
+  changes: Array<{
+    field: string
+    op: "added" | "removed" | "type-changed"
+    type_old?: string
+    type_new?: string
+  }>
+  remapped_fields: string[]
+  added_nodes: string[]
+  blocked_reason?: string
+}
+```
+
+### `PublishCustomEventVersionPayload`
+
+```ts
+type PublishCustomEventVersionPayload = {
+  change_summary?: string
+  change_notes?: string
+}
+```
+
 ### `ValidationIssue`
 
 ```ts

package/docs/metering.md

@@ -1131,7 +1131,7 @@ const { data } = await client.deleteMeterReading({
 
 ### `getReadingChangesets`
 
-List pending reading changesets for a counter
+Lists the pending reading changesets for a counter.
 
 `GET /v1/metering/reading/{meter_id}/{counter_id}/changesets`
 
@@ -1198,7 +1198,7 @@ const { data } = await client.getReadingChangesets({
 
 ### `applyReadingChangeset`
 
-Apply (approve) a pending reading changeset
+Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
 
 `POST /v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:apply`
 
@@ -1283,7 +1283,7 @@ const { data } = await client.applyReadingChangeset({
 
 ### `dismissReadingChangeset`
 
-Dismiss (reject) a pending reading changeset
+Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
 
 `POST /v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:dismiss`
 
@@ -1352,7 +1352,7 @@ const { data } = await client.dismissReadingChangeset(
 
 ### `updateReadingChangeset`
 
-Edit a pending reading changeset
+Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
 
 `PATCH /v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.33",
+  "version": "2.20.34",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -328,6 +328,16 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "epilot",
     "sdk",
@@ -524,14 +534,5 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
-  },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix"
   }
-}
+}

package/dist/chunk-2Q6CNXJ2.cjs

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

package/dist/chunk-LTCN52JS.js

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