@epilot/sdk 2.20.10 → 2.20.12

package/docs/customer-portal.md

@@ -355,6 +355,11 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`SwappableConfig`](#swappableconfig)
 - [`PortalUserRegistrationStatus`](#portaluserregistrationstatus)
 - [`BusinessPartnerItem`](#businesspartneritem)
+- [`SupportReportType`](#supportreporttype)
+- [`SupportRequestAttachment`](#supportrequestattachment)
+- [`CleverPvContext`](#cleverpvcontext)
+- [`CreateSupportRequest`](#createsupportrequest)
+- [`SupportRequestResult`](#supportrequestresult)
 
 ### `upsertPortal`
 
@@ -459,7 +464,9 @@ const { data } = await client.upsertPortal(
       start_page: true,
       billing: true,
       change_due_date: true,
-      new_design: true
+      new_design: true,
+      mcp_enabled: true,
+      mcp_grant_version: 0
     },
     accessToken: 'string',
     advanced_mfa: {
@@ -696,7 +703,9 @@ const { data } = await client.upsertPortal(
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -1070,7 +1079,9 @@ const { data } = await client.getPortalConfigByDomain({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -1347,7 +1358,9 @@ const { data } = await client.getPortalConfig({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -2136,6 +2149,10 @@ const { data } = await client.getConsumption({
       "label": {
         "en": "Billing period 1",
         "de": "Abrechnungszeitraum 1"
+      },
+      "period": {
+        "from": "2024-01-03T00:00:00.000Z",
+        "to": "2025-01-05T00:00:00.000Z"
       }
     }
   ]
@@ -2513,7 +2530,9 @@ const { data } = await client.getPublicPortalConfig({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -2790,7 +2809,9 @@ const { data } = await client.getOrgPortalConfig({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -3076,7 +3097,9 @@ const { data } = await client.getPublicPortalConfigV3({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -3353,7 +3376,9 @@ const { data } = await client.getOrgPortalConfigV3({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -8291,7 +8316,9 @@ const { data } = await client.createPortalConfig(
       start_page: true,
       billing: true,
       change_due_date: true,
-      new_design: true
+      new_design: true,
+      mcp_enabled: true,
+      mcp_grant_version: 0
     },
     accessToken: 'string',
     advanced_mfa: {
@@ -8570,7 +8597,9 @@ const { data } = await client.createPortalConfig(
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -8884,7 +8913,9 @@ const { data } = await client.getPortalConfigV3({
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -9194,7 +9225,9 @@ const { data } = await client.putPortalConfig(
       start_page: true,
       billing: true,
       change_due_date: true,
-      new_design: true
+      new_design: true,
+      mcp_enabled: true,
+      mcp_grant_version: 0
     },
     accessToken: 'string',
     advanced_mfa: {
@@ -9494,7 +9527,9 @@ const { data } = await client.putPortalConfig(
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -9934,7 +9969,9 @@ const { data } = await client.clonePortalConfig(
     "start_page": true,
     "billing": true,
     "change_due_date": true,
-    "new_design": true
+    "new_design": true,
+    "mcp_enabled": true,
+    "mcp_grant_version": 0
   },
   "accessToken": "string",
   "advanced_mfa": {
@@ -10992,6 +11029,8 @@ type CommonConfigAttributes = {
     billing?: boolean
     change_due_date?: boolean
     new_design?: boolean
+    mcp_enabled?: boolean
+    mcp_grant_version?: number
   }
   accessToken?: string
   advanced_mfa?: {
@@ -11030,8 +11069,6 @@ type CommonConfigAttributes = {
       password_history_size?: { ... }
     }
   }
-  config?: string
-  contact_identifiers?: string[]
   // ...
 }
 ```
@@ -11217,6 +11254,8 @@ type PortalConfig = {
     billing?: boolean
     change_due_date?: boolean
     new_design?: boolean
+    mcp_enabled?: boolean
+    mcp_grant_version?: number
   }
   accessToken?: string
   advanced_mfa?: {
@@ -11255,8 +11294,6 @@ type PortalConfig = {
       password_history_size?: { ... }
     }
   }
-  config?: string
-  contact_identifiers?: string[]
   // ...
 }
 ```
@@ -13175,7 +13212,7 @@ type VisualizationMetadata = {
     color?: "primary" | "slate" | "mauve" | "orange" | "red" | "tomato" | "amber" | "green" | "blue"
     precision?: number
   }>
-  intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y"[]
+  intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom"[]
   data_range?: {
     from?: string // date-time
     to?: string // date-time
@@ -14403,6 +14440,8 @@ type CommonConfigAttributesV3 = {
     billing?: boolean
     change_due_date?: boolean
     new_design?: boolean
+    mcp_enabled?: boolean
+    mcp_grant_version?: number
   }
   accessToken?: string
   advanced_mfa?: {
@@ -14441,8 +14480,6 @@ type CommonConfigAttributesV3 = {
       password_history_size?: { ... }
     }
   }
-  config?: string
-  contact_identifiers?: string[]
   // ...
 }
 ```
@@ -14693,6 +14730,7 @@ type PortalConfigV3 = {
 type JuiceSettings = {
   is_dummy?: boolean
   is_canary?: boolean
+  is_legacy_design?: boolean
   redirect_to?: string
 }
 ```
@@ -14725,3 +14763,80 @@ type BusinessPartnerItem = {
   access_status?: boolean
 }
 ```
+
+### `SupportReportType`
+
+```ts
+type SupportReportType = "bug" | "feedback"
+```
+
+### `SupportRequestAttachment`
+
+```ts
+type SupportRequestAttachment = {
+  filename: string
+  mime_type: string
+  contents: string
+}
+```
+
+### `CleverPvContext`
+
+```ts
+type CleverPvContext = {
+  screen?: string
+  version?: string
+  connection_state?: string
+  locale?: string
+  timezone?: string
+  firmware_version?: string
+  build?: string
+  trace_id?: string
+  device?: Record<string, unknown>
+  vendor?: {
+    id?: string
+    name?: string
+  }
+}
+```
+
+### `CreateSupportRequest`
+
+```ts
+type CreateSupportRequest = {
+  report_type: "bug" | "feedback"
+  description: string
+  submission_id: string
+  site_id?: string // uuid
+  device_id?: string // uuid
+  clever_pv?: {
+    screen?: string
+    version?: string
+    connection_state?: string
+    locale?: string
+    timezone?: string
+    firmware_version?: string
+    build?: string
+    trace_id?: string
+    device?: Record<string, unknown>
+    vendor?: {
+      id?: { ... }
+      name?: { ... }
+    }
+  }
+  attachments?: Array<{
+    filename: string
+    mime_type: string
+    contents: string
+  }>
+}
+```
+
+### `SupportRequestResult`
+
+```ts
+type SupportRequestResult = {
+  reference: string
+  status: string
+}
+```

package/docs/event-catalog.md

@@ -29,6 +29,7 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`createCustomEvent`](#createcustomevent)
 - [`getEvent`](#getevent)
 - [`patchEvent`](#patchevent)
+- [`replaceCustomEventDraft`](#replacecustomeventdraft)
 - [`deprecateCustomEvent`](#deprecatecustomevent)
 - [`previewCustomEvent`](#previewcustomevent)
 - [`publishCustomEventDefinition`](#publishcustomeventdefinition)
@@ -131,6 +132,7 @@ const { data } = await client.listEvents()
       "enabled": true,
       "auto_trigger": true,
       "automation_trigger": true,
+      "api_trigger": true,
       "automation_trigger_only": true,
       "automation_trigger_seed_node": "ticket",
       "event_origin": "builtin",
@@ -163,7 +165,7 @@ const { data } = await client.listEvents()
 
 ### `createCustomEvent`
 
-Reserve an org-scoped custom event name and persist its immutable v1.0 draft definition.
+Reserve an org-scoped custom event name and persist its immutable v1.0 draft definition. Custom events are always projected from an entity graph: entity_graph is required and, in guided mapping mode, 
 
 `POST /v1/events`
 
@@ -205,6 +207,9 @@ const { data } = await client.createCustomEvent(
       ]
     },
     automation_trigger: true,
+    api_trigger: true,
+    automation_trigger_only: false,
+    automation_trigger_seed_node: 'string',
     mapping: {
       mode: 'guided',
       jsonata: 'string'
@@ -261,6 +266,7 @@ const { data } = await client.createCustomEvent(
   "enabled": true,
   "auto_trigger": true,
   "automation_trigger": true,
+  "api_trigger": true,
   "automation_trigger_only": true,
   "automation_trigger_seed_node": "ticket",
   "event_origin": "builtin",
@@ -344,6 +350,7 @@ const { data } = await client.getEvent({
   "enabled": true,
   "auto_trigger": true,
   "automation_trigger": true,
+  "api_trigger": true,
   "automation_trigger_only": true,
   "automation_trigger_seed_node": "ticket",
   "event_origin": "builtin",
@@ -439,6 +446,143 @@ const { data } = await client.patchEvent(
   "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>
+
+---
+
+### `replaceCustomEventDraft`
+
+Replace the complete v1.0 definition of an org-scoped custom event while it is still an
+unpublished draft. Drafts have no consumers, so their definition is not yet immutable;
+the event name is the ide
+
+`PUT /v1/events/{event_name}`
+
+```ts
+const { data } = await client.replaceCustomEventDraft(
+  {
+    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
+{
+  "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",
@@ -584,6 +728,7 @@ const { data } = await client.publishCustomEventDefinition(
   "enabled": true,
   "auto_trigger": true,
   "automation_trigger": true,
+  "api_trigger": true,
   "automation_trigger_only": true,
   "automation_trigger_seed_node": "ticket",
   "event_origin": "builtin",
@@ -1072,6 +1217,7 @@ type EventConfigBase = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  api_trigger?: boolean
   automation_trigger_only?: boolean
   automation_trigger_seed_node?: string
   event_origin?: "builtin" | "custom"
@@ -1146,6 +1292,7 @@ type EventConfig = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  api_trigger?: boolean
   automation_trigger_only?: boolean
   automation_trigger_seed_node?: string
   event_origin?: "builtin" | "custom"
@@ -1166,7 +1313,7 @@ type EventConfig = {
 
 ### `CreateCustomEventPayload`
 
-Complete immutable custom-event v1.0 definition. Publication is a separate conditional action.
+Complete immutable custom-event v1.0 definition projected from a required entity graph. Publication is a separate conditional action.
 
 ```ts
 type CreateCustomEventPayload = {
@@ -1182,7 +1329,7 @@ type CreateCustomEventPayload = {
     entity_schema: string
     required?: boolean
   }>
-  entity_graph?: {
+  entity_graph: {
     nodes: Array<{
       id: { ... }
       schema: { ... }
@@ -1205,6 +1352,9 @@ type CreateCustomEventPayload = {
     }>
   }
   automation_trigger?: boolean
+  api_trigger?: boolean
+  automation_trigger_only?: boolean
+  automation_trigger_seed_node?: string
   mapping?: {
     mode: "guided" | "jsonata"
     jsonata?: string
@@ -1230,7 +1380,7 @@ type EventMapping = {
 
 ### `CustomEventLineage`
 
-Optional catalog lineage to a separately named base event. It does not replace the base event.
+Optional catalog lineage to a separately named base event. Built-in inheritance is validated against this exact registered version; its trigger restrictions cannot be removed or replaced. It does not replace the base event.
 
 ```ts
 type CustomEventLineage = {
@@ -1341,7 +1491,7 @@ type AttachmentField = {
 
 ### `CustomSchemaField`
 
-Custom v1 fields support JSON Schema values and context entities; attachment semantics are built-in-only.
+Custom v1 fields support graph-projected JSON Schema values and context entities; attachment semantics are built-in-only.
 
 ```ts
 type CustomSchemaField = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.10",
+  "version": "2.20.12",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chunk-EEKJGTAS.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], ["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
-};

package/dist/chunk-MPZICOVZ.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], ["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;