@epilot/sdk 2.15.3 → 2.15.5

package/docs/customer-portal.md

@@ -140,6 +140,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`getAutomationContext`](#getautomationcontext)
 - [`updateWorkflowStepAsDone`](#updateworkflowstepasdone)
 - [`getEntityWorkflows`](#getentityworkflows)
+- [`getEntityPortalWorkflows`](#getentityportalworkflows)
 - [`uploadMeterReadingPhoto`](#uploadmeterreadingphoto)
 - [`createMeterReading`](#createmeterreading)
 - [`getAllowedMeterReadingRange`](#getallowedmeterreadingrange)
@@ -253,6 +254,9 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`ExternalLink`](#externallink)
 - [`WorkflowExecution`](#workflowexecution)
 - [`WorkflowStep`](#workflowstep)
+- [`PortalWorkflow`](#portalworkflow)
+- [`PortalWorkflowTask`](#portalworkflowtask)
+- [`PortalTaskConfig`](#portaltaskconfig)
 - [`BaseBillingEvent`](#basebillingevent)
 - [`InstallmentEvent`](#installmentevent)
 - [`ReimbursementEvent`](#reimbursementevent)
@@ -1774,6 +1778,7 @@ const { data } = await client.getPublicPortalExtensionDetails({
     },
     "hook": {
       "id": "string",
+      "change_mode": "asynchronous",
       "require_password_confirmation": true,
       "explanation": {}
     }
@@ -2008,6 +2013,7 @@ const { data } = await client.getPublicPortalExtensionDetailsV3({
     },
     "hook": {
       "id": "string",
+      "change_mode": "asynchronous",
       "require_password_confirmation": true,
       "explanation": {}
     }
@@ -6440,6 +6446,95 @@ const { data } = await client.getEntityWorkflows({
 
 ---
 
+### `getEntityPortalWorkflows`
+
+Get linearized workflows for an entity
+
+`GET /v2/portal/entity/{slug}/{id}/workflows/linearized`
+
+```ts
+const { data } = await client.getEntityPortalWorkflows({
+  slug: 'example',
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "portal_workflows": [
+    {
+      "id": "string",
+      "definition_id": "string",
+      "name": "string",
+      "status": "STARTED",
+      "version": 2,
+      "created_at": "string",
+      "updated_at": "string",
+      "completed_at": "string",
+      "due_date": "string",
+      "assigned_to": ["string"],
+      "contexts": [
+        {
+          "entity_id": "string",
+          "entity_schema": "string",
+          "is_primary": true
+        }
+      ],
+      "is_path_complete": true,
+      "tasks": [
+        {
+          "id": "string",
+          "name": "string",
+          "order": 0,
+          "status": "COMPLETED",
+          "is_active": true,
+          "ecp": {
+            "enabled": true,
+            "label": "string",
+            "description": "string",
+            "journey": {
+              "id": "string",
+              "journeyId": "string",
+              "name": "string",
+              "complete_task_automatically": true
+            }
+          },
+          "installer": {
+            "enabled": true,
+            "label": "string",
+            "description": "string",
+            "journey": {
+              "id": "string",
+              "journeyId": "string",
+              "name": "string",
+              "complete_task_automatically": true
+            }
+          },
+          "journey": {
+            "id": "string",
+            "journeyId": "string",
+            "name": "string",
+            "complete_task_automatically": true
+          },
+          "assigned_to": ["string"],
+          "phase_id": "string",
+          "phase_name": "string",
+          "completed_at": "string",
+          "updated_at": "string"
+        }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `uploadMeterReadingPhoto`
 
 Upload Meter Reading Photo
@@ -11938,6 +12033,129 @@ type WorkflowExecution = Record<string, unknown>
 type WorkflowStep = Record<string, unknown>
 ```
 
+### `PortalWorkflow`
+
+A portal-facing projection of a workflow execution (V1 or V2), with the execution
+graph already linearized by the Workflows API into a flat, ordered list of
+portal-visible tasks.
+
+
+```ts
+type PortalWorkflow = {
+  id: string
+  definition_id?: string
+  name: string
+  status: "STARTED" | "DONE" | "CLOSED"
+  version: 2 | 3
+  created_at?: string
+  updated_at?: string
+  completed_at?: string
+  due_date?: string
+  assigned_to?: string[]
+  contexts?: Array<{
+    entity_id?: string
+    entity_schema?: string
+    is_primary?: boolean
+  }>
+  is_path_complete: boolean
+  tasks: Array<{
+    id: string
+    name: string
+    order: number
+    status: "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "PENDING"
+    is_active: boolean
+    ecp?: {
+      enabled?: { ... }
+      label?: { ... }
+      description?: { ... }
+      journey?: { ... }
+    }
+    installer?: {
+      enabled?: { ... }
+      label?: { ... }
+      description?: { ... }
+      journey?: { ... }
+    }
+    journey?: {
+      id?: { ... }
+      journeyId?: { ... }
+      name?: { ... }
+      complete_task_automatically?: { ... }
+    }
+    assigned_to?: string[]
+    phase_id?: string
+    phase_name?: string
+    completed_at?: string
+    updated_at?: string
+  }>
+}
+```
+
+### `PortalWorkflowTask`
+
+A single portal-visible task of a linearized workflow execution
+
+```ts
+type PortalWorkflowTask = {
+  id: string
+  name: string
+  order: number
+  status: "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "PENDING"
+  is_active: boolean
+  ecp?: {
+    enabled?: boolean
+    label?: string
+    description?: string
+    journey?: {
+      id?: { ... }
+      journeyId?: { ... }
+      name?: { ... }
+      complete_task_automatically?: { ... }
+    }
+  }
+  installer?: {
+    enabled?: boolean
+    label?: string
+    description?: string
+    journey?: {
+      id?: { ... }
+      journeyId?: { ... }
+      name?: { ... }
+      complete_task_automatically?: { ... }
+    }
+  }
+  journey?: {
+    id?: string
+    journeyId?: string
+    name?: string
+    complete_task_automatically?: boolean
+  }
+  assigned_to?: string[]
+  phase_id?: string
+  phase_name?: string
+  completed_at?: string
+  updated_at?: string
+}
+```
+
+### `PortalTaskConfig`
+
+Portal-specific (ECP / installer) display config of a workflow task
+
+```ts
+type PortalTaskConfig = {
+  enabled?: boolean
+  label?: string
+  description?: string
+  journey?: {
+    id?: string
+    journeyId?: string
+    name?: string
+    complete_task_automatically?: boolean
+  }
+}
+```
+
 ### `BaseBillingEvent`
 
 A base billing event to be inherited by all billing events.
@@ -12302,8 +12520,8 @@ type PublicExtensionCapabilities = {
     }
     hook?: {
       id?: { ... }
+      change_mode?: { ... }
       require_password_confirmation?: { ... }
-      explanation?: { ... }
   // ...
 }
 ```
@@ -12323,6 +12541,7 @@ type PublicSelfManagementExplanation = {
 ```ts
 type PublicChangeEmailDetails = {
   id?: string
+  change_mode?: "synchronous" | "asynchronous"
   require_password_confirmation?: boolean
   explanation?: {
     en: string
@@ -12907,11 +13126,13 @@ type ExtensionHookCostDataRetrieval = {
 
 ### `ExtensionHookChangeEmail`
 
-Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not change the user's login email itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change (most likely by sending the user instr
+Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
+The `change_mode` controls what the portal d
 
 ```ts
 type ExtensionHookChangeEmail = {
   type: "changeEmail"
+  change_mode?: "synchronous" | "asynchronous"
   require_password_confirmation?: boolean
   explanation?: {
     en: string
@@ -12992,6 +13213,7 @@ The `deletion_mode` controls what the portal does aft
 type ExtensionHookDeleteAccount = {
   type: "deleteAccount"
   deletion_mode?: "synchronous" | "asynchronous"
+  delete_contact?: "none" | "soft" | "hard"
   explanation?: {
     en: string
   }

package/package.json

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