@epilot/sdk 2.20.33 → 2.20.35

package/dist/{metering.d-DomHYl06.d.cts → metering.d-BP04w-gR.d.cts}

@@ -850,7 +850,9 @@ declare namespace Components {
              */
             counter_id?: EntityId /* uuid */;
             /**
-             * The direction of the reading (feed-in or feed-out)
+             * The direction of the reading. Optional, but **strongly recommended**: readings are keyed by direction in storage, so every reading is stored with one.
+             * Resolution order: the value sent here, else the `direction` of the reading's counter, else a value derived from the counter's `obis_number` — `2.x.x` on an electricity counter is `feed-in`, and everything else (including heat, gas and water, which have no meaningful direction) is `feed-out`.
+             * Relying on the derived fallback is fine for single-flow media. For electricity, set `direction` on the reading or on the counter: an electricity export counter that carries neither, and whose OBIS code does not say `2.x.x`, will be stored as `feed-out`.
              */
             direction?: Direction;
             /**
@@ -1836,6 +1838,7 @@ declare namespace Paths {
             export type $400 = Components.Responses.InvalidRequest;
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
+            export type $413 = Components.Schemas.ErrorResp;
             export type $500 = Components.Responses.InternalServerError;
         }
     }
@@ -2150,7 +2153,10 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
   /**
-   * getReadingChangesets - List pending reading changesets for a counter
+   * getReadingChangesets - getReadingChangesets
+   * 
+   * Lists the pending reading changesets for a counter.
+   * 
    */
   'getReadingChangesets'(
     parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2158,9 +2164,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetReadingChangesets.Responses.$200>
   /**
-   * applyReadingChangeset - Apply (approve) a pending reading changeset
+   * applyReadingChangeset - applyReadingChangeset
    * 
-   * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+   * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2171,9 +2177,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ApplyReadingChangeset.Responses.$200>
   /**
-   * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+   * dismissReadingChangeset - dismissReadingChangeset
    * 
-   * Removes the pending changeset without applying it. The reading value remains unchanged.
+   * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2184,9 +2190,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DismissReadingChangeset.Responses.$200>
   /**
-   * updateReadingChangeset - Edit a pending reading changeset
+   * updateReadingChangeset - updateReadingChangeset
    * 
-   * Updates the proposed value of a pending changeset without going through the normal write path.
+   * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
    * 
    */
   'updateReadingChangeset'(
@@ -2459,7 +2465,10 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets']: {
     /**
-     * getReadingChangesets - List pending reading changesets for a counter
+     * getReadingChangesets - getReadingChangesets
+     * 
+     * Lists the pending reading changesets for a counter.
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2469,9 +2478,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:apply']: {
     /**
-     * applyReadingChangeset - Apply (approve) a pending reading changeset
+     * applyReadingChangeset - applyReadingChangeset
      * 
-     * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+     * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2484,9 +2493,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:dismiss']: {
     /**
-     * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+     * dismissReadingChangeset - dismissReadingChangeset
      * 
-     * Removes the pending changeset without applying it. The reading value remains unchanged.
+     * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2499,9 +2508,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}']: {
     /**
-     * updateReadingChangeset - Edit a pending reading changeset
+     * updateReadingChangeset - updateReadingChangeset
      * 
-     * Updates the proposed value of a pending changeset without going through the normal write path.
+     * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
      * 
      */
     'patch'(

package/dist/{metering.d-DomHYl06.d.ts → metering.d-BP04w-gR.d.ts}

@@ -850,7 +850,9 @@ declare namespace Components {
              */
             counter_id?: EntityId /* uuid */;
             /**
-             * The direction of the reading (feed-in or feed-out)
+             * The direction of the reading. Optional, but **strongly recommended**: readings are keyed by direction in storage, so every reading is stored with one.
+             * Resolution order: the value sent here, else the `direction` of the reading's counter, else a value derived from the counter's `obis_number` — `2.x.x` on an electricity counter is `feed-in`, and everything else (including heat, gas and water, which have no meaningful direction) is `feed-out`.
+             * Relying on the derived fallback is fine for single-flow media. For electricity, set `direction` on the reading or on the counter: an electricity export counter that carries neither, and whose OBIS code does not say `2.x.x`, will be stored as `feed-out`.
              */
             direction?: Direction;
             /**
@@ -1836,6 +1838,7 @@ declare namespace Paths {
             export type $400 = Components.Responses.InvalidRequest;
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
+            export type $413 = Components.Schemas.ErrorResp;
             export type $500 = Components.Responses.InternalServerError;
         }
     }
@@ -2150,7 +2153,10 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
   /**
-   * getReadingChangesets - List pending reading changesets for a counter
+   * getReadingChangesets - getReadingChangesets
+   * 
+   * Lists the pending reading changesets for a counter.
+   * 
    */
   'getReadingChangesets'(
     parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2158,9 +2164,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetReadingChangesets.Responses.$200>
   /**
-   * applyReadingChangeset - Apply (approve) a pending reading changeset
+   * applyReadingChangeset - applyReadingChangeset
    * 
-   * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+   * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2171,9 +2177,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ApplyReadingChangeset.Responses.$200>
   /**
-   * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+   * dismissReadingChangeset - dismissReadingChangeset
    * 
-   * Removes the pending changeset without applying it. The reading value remains unchanged.
+   * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2184,9 +2190,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DismissReadingChangeset.Responses.$200>
   /**
-   * updateReadingChangeset - Edit a pending reading changeset
+   * updateReadingChangeset - updateReadingChangeset
    * 
-   * Updates the proposed value of a pending changeset without going through the normal write path.
+   * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
    * 
    */
   'updateReadingChangeset'(
@@ -2459,7 +2465,10 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets']: {
     /**
-     * getReadingChangesets - List pending reading changesets for a counter
+     * getReadingChangesets - getReadingChangesets
+     * 
+     * Lists the pending reading changesets for a counter.
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2469,9 +2478,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:apply']: {
     /**
-     * applyReadingChangeset - Apply (approve) a pending reading changeset
+     * applyReadingChangeset - applyReadingChangeset
      * 
-     * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+     * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2484,9 +2493,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:dismiss']: {
     /**
-     * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+     * dismissReadingChangeset - dismissReadingChangeset
      * 
-     * Removes the pending changeset without applying it. The reading value remains unchanged.
+     * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2499,9 +2508,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}']: {
     /**
-     * updateReadingChangeset - Edit a pending reading changeset
+     * updateReadingChangeset - updateReadingChangeset
      * 
-     * Updates the proposed value of a pending changeset without going through the normal write path.
+     * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
      * 
      */
     'patch'(

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