@epilot/sdk 2.15.4 → 2.15.5

package/dist/index.cjs

@@ -123,7 +123,7 @@ var _chunkMOLFG5L4cjs = require('./chunk-MOLFG5L4.cjs');
 var _chunkBM6NCHPLcjs = require('./chunk-BM6NCHPL.cjs');
 
 
-var _chunkIZ52TBS7cjs = require('./chunk-IZ52TBS7.cjs');
+var _chunkLKV3RKOPcjs = require('./chunk-LKV3RKOP.cjs');
 
 
 var _chunkM2UDF7PYcjs = require('./chunk-M2UDF7PY.cjs');
@@ -158,7 +158,7 @@ var _chunkDVM27A7Ecjs = require('./chunk-DVM27A7E.cjs');
 
 
 
-var _chunkE7FFVRBQcjs = require('./chunk-E7FFVRBQ.cjs');
+var _chunkFZPSCUHJcjs = require('./chunk-FZPSCUHJ.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkE7FFVRBQcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkFZPSCUHJcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkE7FFVRBQcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkFZPSCUHJcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -323,7 +323,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "customerPortal",
-    loader: () => expandDef(_chunkIZ52TBS7cjs.require_customer_portal_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkLKV3RKOPcjs.require_customer_portal_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -601,9 +601,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkE7FFVRBQcjs.createApiHandle.call(void 0, {
+    return _chunkFZPSCUHJcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkE7FFVRBQcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkFZPSCUHJcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -651,9 +651,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkE7FFVRBQcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkFZPSCUHJcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkE7FFVRBQcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkFZPSCUHJcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -683,4 +683,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkE7FFVRBQcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkE7FFVRBQcjs.help; exports.openapi = _chunkE7FFVRBQcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkFZPSCUHJcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkFZPSCUHJcjs.help; exports.openapi = _chunkFZPSCUHJcjs.openapi;

package/dist/index.d.cts

@@ -15,7 +15,7 @@ import { C as Client$8 } from './blueprint-manifest.d-D2I9nhZa.cjs';
 import { C as Client$9 } from './calendar.d-BEjLDagH.cjs';
 import { C as Client$a } from './configuration-hub.d-CbSJDa7k.cjs';
 import { C as Client$b } from './consent.d-C2PROHhX.cjs';
-import { C as Client$c } from './customer-portal.d-DsB3qJro.cjs';
+import { C as Client$c } from './customer-portal.d-JVkJjm_e.cjs';
 import { C as Client$d } from './dashboard.d-CsGcA74I.cjs';
 import { C as Client$e } from './data-governance.d-BbZ466j5.cjs';
 import { C as Client$f } from './deduplication.d-D5GYddVu.cjs';

package/dist/index.d.ts

@@ -15,7 +15,7 @@ import { C as Client$8 } from './blueprint-manifest.d-D2I9nhZa.js';
 import { C as Client$9 } from './calendar.d-BEjLDagH.js';
 import { C as Client$a } from './configuration-hub.d-CbSJDa7k.js';
 import { C as Client$b } from './consent.d-C2PROHhX.js';
-import { C as Client$c } from './customer-portal.d-DsB3qJro.js';
+import { C as Client$c } from './customer-portal.d-JVkJjm_e.js';
 import { C as Client$d } from './dashboard.d-CsGcA74I.js';
 import { C as Client$e } from './data-governance.d-BbZ466j5.js';
 import { C as Client$f } from './deduplication.d-D5GYddVu.js';

package/dist/index.js

@@ -123,7 +123,7 @@ import {
 } from "./chunk-2BPBDRRO.js";
 import {
   require_customer_portal_runtime
-} from "./chunk-L4XLUNUO.js";
+} from "./chunk-EPDH37RS.js";
 import {
   require_dashboard_runtime
 } from "./chunk-SZMCMLOQ.js";
@@ -158,7 +158,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-7LWNOS5V.js";
+} from "./chunk-Y3RQQ4SE.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

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)
@@ -6442,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
@@ -11940,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.

package/package.json

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