@epilot/sdk 2.12.0 → 2.12.2

package/dist/index.js

@@ -123,7 +123,7 @@ import {
 } from "./chunk-2BPBDRRO.js";
 import {
   require_customer_portal_runtime
-} from "./chunk-COASF7ZR.js";
+} from "./chunk-6HJ2Y7DZ.js";
 import {
   require_dashboard_runtime
 } from "./chunk-SZMCMLOQ.js";
@@ -158,7 +158,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-FOGUF2AK.js";
+} from "./chunk-ZALT2KZ3.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/docs/customer-portal.md

@@ -330,6 +330,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`Page`](#page)
 - [`CommonConfigAttributesV3`](#commonconfigattributesv3)
 - [`PortalId`](#portalid)
+- [`PortalDataExportColumn`](#portaldataexportcolumn)
 - [`UpsertPortalConfigV3`](#upsertportalconfigv3)
 - [`PortalConfigV3`](#portalconfigv3)
 - [`JuiceSettings`](#juicesettings)
@@ -475,7 +476,8 @@ const { data } = await client.upsertPortal(
         require_lowercase: true,
         require_uppercase: true,
         require_numbers: true,
-        require_symbols: true
+        require_symbols: true,
+        password_history_size: 3
       }
     },
     config: 'string',
@@ -702,7 +704,8 @@ const { data } = await client.upsertPortal(
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -1066,7 +1069,8 @@ const { data } = await client.getPortalConfigByDomain({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -1333,7 +1337,8 @@ const { data } = await client.getPortalConfig({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -1506,14 +1511,46 @@ const { data } = await client.deletePortal({
 
 ### `createExport`
 
-Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.
+Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.
 
 `POST /v1/portal/exports`
 
 ```ts
-const { data } = await client.createExport({
-  language: 'example',
-})
+const { data } = await client.createExport(
+  null,
+  {
+    schema: 'string',
+    search: {
+      q: 'string',
+      q_fields: ['string'],
+      filters: [
+        {}
+      ],
+      filters_context: [
+        {}
+      ],
+      sort: {}
+    },
+    columns: [
+      {
+        key: 'vertragsnummer',
+        header: {
+          de: 'Vertragsnummer',
+          en: 'Contract number'
+        },
+        source: {
+          path: ['customer'],
+          attribute: 'customer_number',
+          address_field: 'full'
+        },
+        formatter: 'text',
+        enum_labels: {}
+      }
+    ],
+    expand_over: 'string',
+    language: 'de'
+  },
+)
 ```
 
 ---
@@ -2451,7 +2488,8 @@ const { data } = await client.getPublicPortalConfig({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -2718,7 +2756,8 @@ const { data } = await client.getOrgPortalConfig({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -2994,7 +3033,8 @@ const { data } = await client.getPublicPortalConfigV3({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -3261,7 +3301,8 @@ const { data } = await client.getOrgPortalConfigV3({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -7668,7 +7709,8 @@ const { data } = await client.createPortalConfig(
         require_lowercase: true,
         require_uppercase: true,
         require_numbers: true,
-        require_symbols: true
+        require_symbols: true,
+        password_history_size: 3
       }
     },
     config: 'string',
@@ -7946,7 +7988,8 @@ const { data } = await client.createPortalConfig(
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -8259,7 +8302,8 @@ const { data } = await client.getPortalConfigV3({
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -8568,7 +8612,8 @@ const { data } = await client.putPortalConfig(
         require_lowercase: true,
         require_uppercase: true,
         require_numbers: true,
-        require_symbols: true
+        require_symbols: true,
+        password_history_size: 3
       }
     },
     config: 'string',
@@ -8867,7 +8912,8 @@ const { data } = await client.putPortalConfig(
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -9306,7 +9352,8 @@ const { data } = await client.clonePortalConfig(
       "require_lowercase": true,
       "require_uppercase": true,
       "require_numbers": true,
-      "require_symbols": true
+      "require_symbols": true,
+      "password_history_size": 3
     }
   },
   "config": "string",
@@ -10340,11 +10387,11 @@ type CommonConfigAttributes = {
       require_uppercase?: { ... }
       require_numbers?: { ... }
       require_symbols?: { ... }
+      password_history_size?: { ... }
     }
   }
   config?: string
   contact_identifiers?: string[]
-  approval_state_attributes?: Record<string, string[]>
   // ...
 }
 ```
@@ -10554,11 +10601,11 @@ type PortalConfig = {
       require_uppercase?: { ... }
       require_numbers?: { ... }
       require_symbols?: { ... }
+      password_history_size?: { ... }
     }
   }
   config?: string
   contact_identifiers?: string[]
-  approval_state_attributes?: Record<string, string[]>
   // ...
 }
 ```
@@ -13505,11 +13552,11 @@ type CommonConfigAttributesV3 = {
       require_uppercase?: { ... }
       require_numbers?: { ... }
       require_symbols?: { ... }
+      password_history_size?: { ... }
     }
   }
   config?: string
   contact_identifiers?: string[]
-  approval_state_attributes?: Record<string, string[]>
   // ...
 }
 ```
@@ -13522,6 +13569,24 @@ ID of the portal
 type PortalId = string
 ```
 
+### `PortalDataExportColumn`
+
+One column of the portal data export CSV.
+
+```ts
+type PortalDataExportColumn = {
+  key: string
+  header: Record<string, string>
+  source: {
+    path?: string[]
+    attribute: string
+    address_field?: "full" | "street" | "street_number" | "postal_code" | "city" | "additional_info" | "country"
+  }
+  formatter?: "text" | "date" | "money_cents" | "enum" | "address"
+  enum_labels?: Record<string, Record<string, string>>
+}
+```
+
 ### `UpsertPortalConfigV3`
 
 ```ts

package/docs/event-catalog.md

@@ -44,8 +44,10 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`ContextEntity`](#contextentity)
 - [`AttachmentField`](#attachmentfield)
 - [`SchemaField`](#schemafield)
+- [`SuccessCriterion`](#successcriterion)
 - [`CommonEventMetadata`](#commoneventmetadata)
 - [`EventJsonSchema`](#eventjsonschema)
+- [`InlineDowngradeStep`](#inlinedowngradestep)
 - [`Event`](#event)
 - [`EventSummary`](#eventsummary)
 - [`GraphDefinition`](#graphdefinition)
@@ -110,7 +112,17 @@ const { data } = await client.listEvents()
       },
       "enabled": true,
       "auto_trigger": true,
-      "automation_trigger": true
+      "automation_trigger": true,
+      "success_criteria": [
+        {
+          "entity_schema": "contract",
+          "attribute": "installment_amount"
+        },
+        {
+          "entity_schema": "billing_account",
+          "attribute": "due_date"
+        }
+      ]
     }
   ]
 }
@@ -168,7 +180,17 @@ const { data } = await client.getEvent({
   },
   "enabled": true,
   "auto_trigger": true,
-  "automation_trigger": true
+  "automation_trigger": true,
+  "success_criteria": [
+    {
+      "entity_schema": "contract",
+      "attribute": "installment_amount"
+    },
+    {
+      "entity_schema": "billing_account",
+      "attribute": "due_date"
+    }
+  ]
 }
 ```
 
@@ -219,7 +241,17 @@ const { data } = await client.patchEvent(
     },
     enabled: true,
     auto_trigger: true,
-    automation_trigger: true
+    automation_trigger: true,
+    success_criteria: [
+      {
+        entity_schema: 'contract',
+        attribute: 'installment_amount'
+      },
+      {
+        entity_schema: 'billing_account',
+        attribute: 'due_date'
+      }
+    ]
   },
 )
 ```
@@ -260,7 +292,17 @@ const { data } = await client.patchEvent(
   },
   "enabled": true,
   "auto_trigger": true,
-  "automation_trigger": true
+  "automation_trigger": true,
+  "success_criteria": [
+    {
+      "entity_schema": "contract",
+      "attribute": "installment_amount"
+    },
+    {
+      "entity_schema": "billing_account",
+      "attribute": "due_date"
+    }
+  ]
 }
 ```
 
@@ -726,6 +768,10 @@ type EventConfigBase = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -781,6 +827,10 @@ type EventConfig = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -788,7 +838,7 @@ type EventConfig = {
 
 Payload for updating an event configuration.
 Accepts the same fields as EventConfig (all optional for PATCH).
-Currently `enabled` and `auto_trigger` fields are processed.
+Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
 
 
 ```ts
@@ -839,6 +889,10 @@ type UpdateEventPayload = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -914,6 +968,22 @@ type SchemaField = {
 }
 ```
 
+### `SuccessCriterion`
+
+A single org-defined success criterion: an entity attribute that must be captured
+for this event's change request to be considered complete.
+
+Identity is the entity schema plus the attribute name — mirroring the
+EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+`attribut
+
+```ts
+type SuccessCriterion = {
+  entity_schema: string
+  attribute: string
+}
+```
+
 ### `CommonEventMetadata`
 
 Common metadata fields present in all event payloads
@@ -930,6 +1000,17 @@ JSON Schema declaring the event payload structure
 type EventJsonSchema = object
 ```
 
+### `InlineDowngradeStep`
+
+One step of an event's inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.
+
+```ts
+type InlineDowngradeStep = {
+  to: string
+  jsonata: string
+}
+```
+
 ### `Event`
 
 An event instance in the event history
@@ -945,6 +1026,10 @@ type Event = {
   _trigger_source_type?: string
   _trigger_source?: string
   _ack_id?: string
+  _downgrades?: Array<{
+    to: string
+    jsonata: string
+  }>
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.12.0",
+  "version": "2.12.2",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -322,16 +322,6 @@
     },
     "./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",
@@ -525,5 +515,14 @@
         "./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/definitions/focus-pocus-runtime.json

@@ -1 +0,0 @@
-{"s":"https://focus-pocus.dev.sls.epilot.io","o":[["getHealth","get","/v1/health"],["listAchievements","get","/v1/achievements"],["getAchievement","get","/v1/achievements/{id}",[["AchievementOrChallengeId"]]],["getSuggestedChallenge","get","/v1/challenges/suggest",[["route","q"],["entity_type","q"],["category_hint","q"]]],["acceptChallenge","post","/v1/challenges/{id}/accept",[["ChallengeId"]]],["dismissChallenge","post","/v1/challenges/{id}/dismiss",[["ChallengeId"]]],["listActiveChallenges","get","/v1/challenges/active"],["postEvent","post","/v1/events",null,1]],"v":"3.0.3","cp":{"AchievementId":["id","p",true],"AchievementOrChallengeId":["id","p",true],"ChallengeId":["id","p",true],"Cursor":["cursor","q"],"Size":["size","q"]}}