@epilot/sdk 2.18.3 → 2.18.5

package/docs/entity.md

@@ -487,7 +487,11 @@ const { data } = await client.getSchema({
       "columns": 0,
       "cells": [0]
     },
-    "widget_order": ["string"]
+    "widget_order": ["string"],
+    "widget_visibility": {
+      "next_best_action": true,
+      "address_map": false
+    }
   },
   "capabilities": [
     {
@@ -495,6 +499,7 @@ const { data } = await client.getSchema({
       "name": "customer_messaging",
       "title": "Messaging",
       "attributes": [],
+      "variant_overridable": false,
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -640,7 +645,11 @@ const { data } = await client.putSchema(
         columns: 0,
         cells: [0]
       },
-      widget_order: ['string']
+      widget_order: ['string'],
+      widget_visibility: {
+        next_best_action: true,
+        address_map: false
+      }
     },
     capabilities: [
       {
@@ -648,6 +657,7 @@ const { data } = await client.putSchema(
         name: 'customer_messaging',
         title: 'Messaging',
         attributes: [ /* ... */ ],
+        variant_overridable: false,
         _purpose: ['taxonomy-slug:classification-slug'],
         _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
         app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -793,7 +803,11 @@ const { data } = await client.putSchema(
       "columns": 0,
       "cells": [0]
     },
-    "widget_order": ["string"]
+    "widget_order": ["string"],
+    "widget_visibility": {
+      "next_best_action": true,
+      "address_map": false
+    }
   },
   "capabilities": [
     {
@@ -801,6 +815,7 @@ const { data } = await client.putSchema(
       "name": "customer_messaging",
       "title": "Messaging",
       "attributes": [],
+      "variant_overridable": false,
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -1238,7 +1253,11 @@ const { data } = await client.freezeSchema(
       "columns": 0,
       "cells": [0]
     },
-    "widget_order": ["string"]
+    "widget_order": ["string"],
+    "widget_visibility": {
+      "next_best_action": true,
+      "address_map": false
+    }
   },
   "capabilities": [
     {
@@ -1246,6 +1265,7 @@ const { data } = await client.freezeSchema(
       "name": "customer_messaging",
       "title": "Messaging",
       "attributes": [],
+      "variant_overridable": false,
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -1405,7 +1425,11 @@ const { data } = await client.unfreezeSchema({
       "columns": 0,
       "cells": [0]
     },
-    "widget_order": ["string"]
+    "widget_order": ["string"],
+    "widget_visibility": {
+      "next_best_action": true,
+      "address_map": false
+    }
   },
   "capabilities": [
     {
@@ -1413,6 +1437,7 @@ const { data } = await client.unfreezeSchema({
       "name": "customer_messaging",
       "title": "Messaging",
       "attributes": [],
+      "variant_overridable": false,
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -1518,6 +1543,7 @@ const { data } = await client.listAvailableCapabilities({
       "name": "customer_messaging",
       "title": "Messaging",
       "attributes": [],
+      "variant_overridable": false,
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5164,6 +5190,7 @@ const { data } = await client.createSchemaCapability(
       },
       /* ... 33 more */
     ],
+    variant_overridable: false,
     _purpose: ['taxonomy-slug:classification-slug'],
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
     app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -5186,7 +5213,9 @@ const { data } = await client.createSchemaCapability(
         icon: 'email',
         disabled: true,
         header: true,
-        requiredPermission: { /* ... */ }
+        requiredPermission: { /* ... */ },
+        default_visible: false,
+        pricing_tier_setting: 'entity_address_maps'
       }
     ],
     feature_flag: 'FF_MY_FEATURE_FLAG',
@@ -5296,6 +5325,7 @@ const { data } = await client.createSchemaCapability(
       "type": "link"
     }
   ],
+  "variant_overridable": false,
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5318,7 +5348,9 @@ const { data } = await client.createSchemaCapability(
       "icon": "email",
       "disabled": true,
       "header": true,
-      "requiredPermission": {}
+      "requiredPermission": {},
+      "default_visible": false,
+      "pricing_tier_setting": "entity_address_maps"
     }
   ],
   "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -5443,6 +5475,7 @@ const { data } = await client.getSchemaCapability({
       "type": "link"
     }
   ],
+  "variant_overridable": false,
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5465,7 +5498,9 @@ const { data } = await client.getSchemaCapability({
       "icon": "email",
       "disabled": true,
       "header": true,
-      "requiredPermission": {}
+      "requiredPermission": {},
+      "default_visible": false,
+      "pricing_tier_setting": "entity_address_maps"
     }
   ],
   "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -5586,6 +5621,7 @@ const { data } = await client.putSchemaCapability(
       },
       /* ... 33 more */
     ],
+    variant_overridable: false,
     _purpose: ['taxonomy-slug:classification-slug'],
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
     app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -5608,7 +5644,9 @@ const { data } = await client.putSchemaCapability(
         icon: 'email',
         disabled: true,
         header: true,
-        requiredPermission: { /* ... */ }
+        requiredPermission: { /* ... */ },
+        default_visible: false,
+        pricing_tier_setting: 'entity_address_maps'
       }
     ],
     feature_flag: 'FF_MY_FEATURE_FLAG',
@@ -5718,6 +5756,7 @@ const { data } = await client.putSchemaCapability(
       "type": "link"
     }
   ],
+  "variant_overridable": false,
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5740,7 +5779,9 @@ const { data } = await client.putSchemaCapability(
       "icon": "email",
       "disabled": true,
       "header": true,
-      "requiredPermission": {}
+      "requiredPermission": {},
+      "default_visible": false,
+      "pricing_tier_setting": "entity_address_maps"
     }
   ],
   "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -5865,6 +5906,7 @@ const { data } = await client.deleteSchemaCapability({
       "type": "link"
     }
   ],
+  "variant_overridable": false,
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5887,7 +5929,9 @@ const { data } = await client.deleteSchemaCapability({
       "icon": "email",
       "disabled": true,
       "header": true,
-      "requiredPermission": {}
+      "requiredPermission": {},
+      "default_visible": false,
+      "pricing_tier_setting": "entity_address_maps"
     }
   ],
   "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -6423,6 +6467,7 @@ type EntitySchema = {
       cells?: { ... }
     }
     widget_order?: string[]
+    widget_visibility?: Record<string, boolean>
   }
   capabilities: Array<{
     id?: string
@@ -6451,7 +6496,6 @@ type EntitySchema = {
       _purpose?: { ... }
       _manifest?: { ... }
       constraints?: { ... }
-      feature_flag?: { ... }
   // ...
 }
 ```
@@ -6541,6 +6585,7 @@ type EntitySchemaItem = {
       cells?: { ... }
     }
     widget_order?: string[]
+    widget_visibility?: Record<string, boolean>
   }
   capabilities: Array<{
     id?: string
@@ -6558,7 +6603,6 @@ type EntitySchemaItem = {
       readonly?: { ... }
       deprecated?: { ... }
       variant_overridable?: { ... }
-      default_value?: { ... }
   // ...
 }
 ```

package/package.json

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

package/dist/chunk-M2UDF7PY.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/dashboard-runtime.json
-var require_dashboard_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/dashboard-runtime.json"(exports, module) {
-    module.exports = { s: "https://dashboard.sls.epilot.io", o: [["listDashboards", "get", "/v1/dashboard/dashboards"], ["createDashboard", "post", "/v1/dashboard/dashboards", null, 1], ["getDashboard", "get", "/v1/dashboard/dashboards/{id}"], ["putDashboard", "put", "/v1/dashboard/dashboards/{id}", null, 1], ["deleteDashboard", "delete", "/v1/dashboard/dashboards/{id}"], ["listAvailableVisualisations", "get", "/v1/dashboard/visualisations"], ["listAvailableExamples", "get", "/v1/dashboard/examples"]], v: "3.0.0", pp: { "/v1/dashboard/dashboards/{id}": [["id", "p", true]] } };
-  }
-});
-
-
-
-exports.require_dashboard_runtime = require_dashboard_runtime;

package/dist/chunk-SZMCMLOQ.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/dashboard-runtime.json
-var require_dashboard_runtime = __commonJS({
-  "src/definitions/dashboard-runtime.json"(exports, module) {
-    module.exports = { s: "https://dashboard.sls.epilot.io", o: [["listDashboards", "get", "/v1/dashboard/dashboards"], ["createDashboard", "post", "/v1/dashboard/dashboards", null, 1], ["getDashboard", "get", "/v1/dashboard/dashboards/{id}"], ["putDashboard", "put", "/v1/dashboard/dashboards/{id}", null, 1], ["deleteDashboard", "delete", "/v1/dashboard/dashboards/{id}"], ["listAvailableVisualisations", "get", "/v1/dashboard/visualisations"], ["listAvailableExamples", "get", "/v1/dashboard/examples"]], v: "3.0.0", pp: { "/v1/dashboard/dashboards/{id}": [["id", "p", true]] } };
-  }
-});
-
-export {
-  require_dashboard_runtime
-};

package/dist/dashboard-UHYR5RTY.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/dashboard.json
-var dashboard_default = '# Dashboard API\n\n- **Base URL:** `https://dashboard.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/dashboard](https://docs.epilot.io/api/dashboard)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dashboard.listDashboards(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/dashboard\'\n\nconst dashboardClient = getClient()\nauthorize(dashboardClient, () => \'<token>\')\nconst { data } = await dashboardClient.listDashboards(...)\n```\n\n## Operations\n\n**Dashboards**\n- [`listDashboards`](#listdashboards)\n- [`createDashboard`](#createdashboard)\n- [`getDashboard`](#getdashboard)\n- [`putDashboard`](#putdashboard)\n- [`deleteDashboard`](#deletedashboard)\n\n**Visualisations**\n- [`listAvailableVisualisations`](#listavailablevisualisations)\n\n**Examples**\n- [`listAvailableExamples`](#listavailableexamples)\n\n**Schemas**\n- [`DashboardID`](#dashboardid)\n- [`Dashboard`](#dashboard)\n- [`DashboardTileID`](#dashboardtileid)\n- [`DashboardTile`](#dashboardtile)\n- [`VisualisationConfig`](#visualisationconfig)\n- [`timechartVisualisationConfig`](#timechartvisualisationconfig)\n- [`ExampleID`](#exampleid)\n- [`Example`](#example)\n- [`DatalakeQuery`](#datalakequery)\n- [`VisualisationId`](#visualisationid)\n- [`Visualisation`](#visualisation)\n\n### `listDashboards`\n\nList dashboards available to the user\n\n`GET /v1/dashboard/dashboards`\n\n```ts\nconst { data } = await client.listDashboards()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "title": "Employee Dashboard",\n      "tiles": [\n        {\n          "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n          "coordinates": {},\n          "visualisation": "timechart",\n          "visualisation_config": {\n            "query": {\n              "dataset": "entity_operations",\n              "measure": "count_operations",\n              "filters": [\n                {\n                  "operation": ["createEntity"]\n                },\n                {\n                  "entity_schema": ["opportunity"]\n                }\n              ],\n              "dimensions": [\n                {\n                  "time_with_granularity": "month"\n                },\n                {\n                  "entity_attribute": "source.title"\n                }\n              ]\n            },\n            "options": {\n              "type": "line"\n            }\n          }\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createDashboard`\n\nCreate new dashboard\n\n`POST /v1/dashboard/dashboards`\n\n```ts\nconst { data } = await client.createDashboard(\n  null,\n  {\n    id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    title: \'Employee Dashboard\',\n    tiles: [\n      {\n        id: \'e4af1297-1fd6-440f-9846-f475f580d40f\',\n        coordinates: {},\n        visualisation: \'timechart\',\n        visualisation_config: {\n          query: {\n            dataset: \'entity_operations\',\n            measure: \'count_operations\',\n            filters: [\n              {\n                operation: [\'createEntity\']\n              },\n              {\n                entity_schema: [\'opportunity\']\n              }\n            ],\n            dimensions: [\n              {\n                time_with_granularity: \'month\'\n              },\n              {\n                entity_attribute: \'source.title\'\n              }\n            ]\n          },\n          options: {\n            type: \'line\'\n          }\n        }\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getDashboard`\n\nGet dashboard by ID\n\n`GET /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.getDashboard({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `putDashboard`\n\nUpdate a dashboard by ID\n\n`PUT /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.putDashboard(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    title: \'Employee Dashboard\',\n    tiles: [\n      {\n        id: \'e4af1297-1fd6-440f-9846-f475f580d40f\',\n        coordinates: {},\n        visualisation: \'timechart\',\n        visualisation_config: {\n          query: {\n            dataset: \'entity_operations\',\n            measure: \'count_operations\',\n            filters: [\n              {\n                operation: [\'createEntity\']\n              },\n              {\n                entity_schema: [\'opportunity\']\n              }\n            ],\n            dimensions: [\n              {\n                time_with_granularity: \'month\'\n              },\n              {\n                entity_attribute: \'source.title\'\n              }\n            ]\n          },\n          options: {\n            type: \'line\'\n          }\n        }\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `deleteDashboard`\n\nDelete a dashboard by ID\n\n`DELETE /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.deleteDashboard({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAvailableVisualisations`\n\nReturns list of available Visualisations to configure new dashboard tiles\n\n`GET /v1/dashboard/visualisations`\n\n```ts\nconst { data } = await client.listAvailableVisualisations()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "visualisation": "timechart",\n      "title": "Time Series Visualisation",\n      "description": "Visualise your metrics with respect to time series",\n      "package_name": "@epilot360/highcharts"\n    },\n    {\n      "visualisation": "kpi",\n      "title": "KPI Visualisation",\n      "description": "Visualise your key performance indicators",\n      "package_name": "@epilot360/kpi"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAvailableExamples`\n\nReturns list of available exampless for visualisations to configure new dashboard tiles\n\n`GET /v1/dashboard/examples`\n\n```ts\nconst { data } = await client.listAvailableExamples()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "title": "Number of opportunities created by journeys every month",\n      "visualisation": "timechart",\n      "query": {\n        "dataset": "entity_operations",\n        "measure": "count_operations",\n        "dimensions": [\n          {\n            "time_with_granularity": "year-month"\n          }\n        ],\n        "filters": [\n          {\n            "entity_schema": "opportunity"\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DashboardID`\n\nUnique identifier for dashboard\n\n```ts\ntype DashboardID = string // uuid\n```\n\n### `Dashboard`\n\nAdashboard configuration with tiles\n\n```ts\ntype Dashboard = {\n  id?: string // uuid\n  title: string\n  tiles: Array<{\n    id?: string // uuid\n    coordinates?: object\n    title?: string\n    visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n    visualisation_config?: {\n      query?: { ... }\n      options?: { ... }\n    }\n  }>\n}\n```\n\n### `DashboardTileID`\n\nUnique identifier for a tile in a dashboard\n\n```ts\ntype DashboardTileID = string // uuid\n```\n\n### `DashboardTile`\n\n```ts\ntype DashboardTile = {\n  id?: string // uuid\n  coordinates?: object\n  title?: string\n  visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  visualisation_config?: {\n    query?: {\n      dataset?: { ... }\n      measure?: { ... }\n      dimensions?: { ... }\n      filters?: { ... }\n    }\n    options?: Record<string, unknown>\n  }\n}\n```\n\n### `VisualisationConfig`\n\n```ts\ntype VisualisationConfig = {\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n  options?: Record<string, unknown>\n}\n```\n\n### `timechartVisualisationConfig`\n\n```ts\ntype timechartVisualisationConfig = {\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n  options?: Record<string, unknown>\n}\n```\n\n### `ExampleID`\n\nUnique identifier for a visualisation examples for tiles in a dashboard\n\n```ts\ntype ExampleID = string // uuid\n```\n\n### `Example`\n\n```ts\ntype Example = {\n  id?: string // uuid\n  title?: string\n  visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n}\n```\n\n### `DatalakeQuery`\n\n```ts\ntype DatalakeQuery = {\n  dataset?: string\n  measure?: string\n  dimensions?: Record<string, unknown>[]\n  filters?: Record<string, unknown>[]\n}\n```\n\n### `VisualisationId`\n\nUnique identifier for a Visualisation\n\n```ts\ntype VisualisationId = "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n```\n\n### `Visualisation`\n\nA Visualisation that can be used to configure tiles in dashboards\n\n```ts\ntype Visualisation = {\n  visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  title?: string\n  description?: string\n  package_name?: string\n  import_url?: string // uri\n}\n```\n';
-
-
-exports.default = dashboard_default;

package/dist/dashboard-UTPGXFW5.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/dashboard.json
-var dashboard_default = '# Dashboard API\n\n- **Base URL:** `https://dashboard.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/dashboard](https://docs.epilot.io/api/dashboard)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dashboard.listDashboards(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/dashboard\'\n\nconst dashboardClient = getClient()\nauthorize(dashboardClient, () => \'<token>\')\nconst { data } = await dashboardClient.listDashboards(...)\n```\n\n## Operations\n\n**Dashboards**\n- [`listDashboards`](#listdashboards)\n- [`createDashboard`](#createdashboard)\n- [`getDashboard`](#getdashboard)\n- [`putDashboard`](#putdashboard)\n- [`deleteDashboard`](#deletedashboard)\n\n**Visualisations**\n- [`listAvailableVisualisations`](#listavailablevisualisations)\n\n**Examples**\n- [`listAvailableExamples`](#listavailableexamples)\n\n**Schemas**\n- [`DashboardID`](#dashboardid)\n- [`Dashboard`](#dashboard)\n- [`DashboardTileID`](#dashboardtileid)\n- [`DashboardTile`](#dashboardtile)\n- [`VisualisationConfig`](#visualisationconfig)\n- [`timechartVisualisationConfig`](#timechartvisualisationconfig)\n- [`ExampleID`](#exampleid)\n- [`Example`](#example)\n- [`DatalakeQuery`](#datalakequery)\n- [`VisualisationId`](#visualisationid)\n- [`Visualisation`](#visualisation)\n\n### `listDashboards`\n\nList dashboards available to the user\n\n`GET /v1/dashboard/dashboards`\n\n```ts\nconst { data } = await client.listDashboards()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "title": "Employee Dashboard",\n      "tiles": [\n        {\n          "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n          "coordinates": {},\n          "visualisation": "timechart",\n          "visualisation_config": {\n            "query": {\n              "dataset": "entity_operations",\n              "measure": "count_operations",\n              "filters": [\n                {\n                  "operation": ["createEntity"]\n                },\n                {\n                  "entity_schema": ["opportunity"]\n                }\n              ],\n              "dimensions": [\n                {\n                  "time_with_granularity": "month"\n                },\n                {\n                  "entity_attribute": "source.title"\n                }\n              ]\n            },\n            "options": {\n              "type": "line"\n            }\n          }\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createDashboard`\n\nCreate new dashboard\n\n`POST /v1/dashboard/dashboards`\n\n```ts\nconst { data } = await client.createDashboard(\n  null,\n  {\n    id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    title: \'Employee Dashboard\',\n    tiles: [\n      {\n        id: \'e4af1297-1fd6-440f-9846-f475f580d40f\',\n        coordinates: {},\n        visualisation: \'timechart\',\n        visualisation_config: {\n          query: {\n            dataset: \'entity_operations\',\n            measure: \'count_operations\',\n            filters: [\n              {\n                operation: [\'createEntity\']\n              },\n              {\n                entity_schema: [\'opportunity\']\n              }\n            ],\n            dimensions: [\n              {\n                time_with_granularity: \'month\'\n              },\n              {\n                entity_attribute: \'source.title\'\n              }\n            ]\n          },\n          options: {\n            type: \'line\'\n          }\n        }\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getDashboard`\n\nGet dashboard by ID\n\n`GET /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.getDashboard({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `putDashboard`\n\nUpdate a dashboard by ID\n\n`PUT /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.putDashboard(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    title: \'Employee Dashboard\',\n    tiles: [\n      {\n        id: \'e4af1297-1fd6-440f-9846-f475f580d40f\',\n        coordinates: {},\n        visualisation: \'timechart\',\n        visualisation_config: {\n          query: {\n            dataset: \'entity_operations\',\n            measure: \'count_operations\',\n            filters: [\n              {\n                operation: [\'createEntity\']\n              },\n              {\n                entity_schema: [\'opportunity\']\n              }\n            ],\n            dimensions: [\n              {\n                time_with_granularity: \'month\'\n              },\n              {\n                entity_attribute: \'source.title\'\n              }\n            ]\n          },\n          options: {\n            type: \'line\'\n          }\n        }\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `deleteDashboard`\n\nDelete a dashboard by ID\n\n`DELETE /v1/dashboard/dashboards/{id}`\n\n```ts\nconst { data } = await client.deleteDashboard({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "Employee Dashboard",\n  "tiles": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "coordinates": {},\n      "visualisation": "timechart",\n      "visualisation_config": {\n        "query": {\n          "dataset": "entity_operations",\n          "measure": "count_operations",\n          "filters": [\n            {\n              "operation": ["createEntity"]\n            },\n            {\n              "entity_schema": ["opportunity"]\n            }\n          ],\n          "dimensions": [\n            {\n              "time_with_granularity": "month"\n            },\n            {\n              "entity_attribute": "source.title"\n            }\n          ]\n        },\n        "options": {\n          "type": "line"\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAvailableVisualisations`\n\nReturns list of available Visualisations to configure new dashboard tiles\n\n`GET /v1/dashboard/visualisations`\n\n```ts\nconst { data } = await client.listAvailableVisualisations()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "visualisation": "timechart",\n      "title": "Time Series Visualisation",\n      "description": "Visualise your metrics with respect to time series",\n      "package_name": "@epilot360/highcharts"\n    },\n    {\n      "visualisation": "kpi",\n      "title": "KPI Visualisation",\n      "description": "Visualise your key performance indicators",\n      "package_name": "@epilot360/kpi"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAvailableExamples`\n\nReturns list of available exampless for visualisations to configure new dashboard tiles\n\n`GET /v1/dashboard/examples`\n\n```ts\nconst { data } = await client.listAvailableExamples()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",\n      "title": "Number of opportunities created by journeys every month",\n      "visualisation": "timechart",\n      "query": {\n        "dataset": "entity_operations",\n        "measure": "count_operations",\n        "dimensions": [\n          {\n            "time_with_granularity": "year-month"\n          }\n        ],\n        "filters": [\n          {\n            "entity_schema": "opportunity"\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DashboardID`\n\nUnique identifier for dashboard\n\n```ts\ntype DashboardID = string // uuid\n```\n\n### `Dashboard`\n\nAdashboard configuration with tiles\n\n```ts\ntype Dashboard = {\n  id?: string // uuid\n  title: string\n  tiles: Array<{\n    id?: string // uuid\n    coordinates?: object\n    title?: string\n    visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n    visualisation_config?: {\n      query?: { ... }\n      options?: { ... }\n    }\n  }>\n}\n```\n\n### `DashboardTileID`\n\nUnique identifier for a tile in a dashboard\n\n```ts\ntype DashboardTileID = string // uuid\n```\n\n### `DashboardTile`\n\n```ts\ntype DashboardTile = {\n  id?: string // uuid\n  coordinates?: object\n  title?: string\n  visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  visualisation_config?: {\n    query?: {\n      dataset?: { ... }\n      measure?: { ... }\n      dimensions?: { ... }\n      filters?: { ... }\n    }\n    options?: Record<string, unknown>\n  }\n}\n```\n\n### `VisualisationConfig`\n\n```ts\ntype VisualisationConfig = {\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n  options?: Record<string, unknown>\n}\n```\n\n### `timechartVisualisationConfig`\n\n```ts\ntype timechartVisualisationConfig = {\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n  options?: Record<string, unknown>\n}\n```\n\n### `ExampleID`\n\nUnique identifier for a visualisation examples for tiles in a dashboard\n\n```ts\ntype ExampleID = string // uuid\n```\n\n### `Example`\n\n```ts\ntype Example = {\n  id?: string // uuid\n  title?: string\n  visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  query?: {\n    dataset?: string\n    measure?: string\n    dimensions?: Record<string, unknown>[]\n    filters?: Record<string, unknown>[]\n  }\n}\n```\n\n### `DatalakeQuery`\n\n```ts\ntype DatalakeQuery = {\n  dataset?: string\n  measure?: string\n  dimensions?: Record<string, unknown>[]\n  filters?: Record<string, unknown>[]\n}\n```\n\n### `VisualisationId`\n\nUnique identifier for a Visualisation\n\n```ts\ntype VisualisationId = "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n```\n\n### `Visualisation`\n\nA Visualisation that can be used to configure tiles in dashboards\n\n```ts\ntype Visualisation = {\n  visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"\n  title?: string\n  description?: string\n  package_name?: string\n  import_url?: string // uri\n}\n```\n';
-export {
-  dashboard_default as default
-};