@epilot/sdk 2.18.4 → 2.18.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/dashboard-runtime.json +1 -1
- package/definitions/dashboard.json +919 -48
- package/definitions/email-settings-runtime.json +1 -1
- package/definitions/email-settings.json +50 -10
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +8 -8
- package/dist/apis/dashboard.d.cts +2 -2
- package/dist/apis/dashboard.d.ts +2 -2
- package/dist/apis/dashboard.js +2 -2
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-KHKNOPEX.js → chunk-7HQ3GMYQ.js} +1 -1
- package/dist/{chunk-YNJPE3SS.cjs → chunk-AWJHA3GG.cjs} +1 -1
- package/dist/{chunk-HUDTRI32.cjs → chunk-MIKSJIFK.cjs} +4 -4
- package/dist/{chunk-3FHDY3R5.js → chunk-TAQOJW6T.js} +4 -4
- package/dist/chunk-TIRWWTDP.js +14 -0
- package/dist/chunk-VMCF5R6R.cjs +14 -0
- package/dist/dashboard-7QJ46I7N.cjs +7 -0
- package/dist/dashboard-ILXUFFF2.js +7 -0
- package/dist/{dashboard-runtime-EXP2AM44.cjs → dashboard-runtime-2LOASQPB.cjs} +2 -2
- package/dist/{dashboard-runtime-PSKSGLCF.js → dashboard-runtime-YMFNQP3M.js} +1 -1
- package/dist/dashboard.d-BSevFHjf.d.cts +1405 -0
- package/dist/dashboard.d-BSevFHjf.d.ts +1405 -0
- package/dist/email-settings-U753HXGA.js +7 -0
- package/dist/email-settings-Z5EBAELW.cjs +7 -0
- package/dist/{email-settings-runtime-J7JLYDMU.cjs → email-settings-runtime-IW2AT2RB.cjs} +2 -2
- package/dist/{email-settings-runtime-4BT72ADN.js → email-settings-runtime-YJYEC5AH.js} +1 -1
- package/dist/{email-settings.d-CR4lORuR.d.cts → email-settings.d-DViLYaOl.d.cts} +56 -14
- package/dist/{email-settings.d-CR4lORuR.d.ts → email-settings.d-DViLYaOl.d.ts} +56 -14
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/docs/dashboard.md +1044 -180
- package/docs/email-settings.md +17 -13
- package/package.json +1 -1
- package/dist/chunk-M2UDF7PY.cjs +0 -14
- package/dist/chunk-SZMCMLOQ.js +0 -14
- package/dist/dashboard-UHYR5RTY.cjs +0 -7
- package/dist/dashboard-UTPGXFW5.js +0 -7
- package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
- package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
- package/dist/email-settings-ECSU7KWC.js +0 -7
- package/dist/email-settings-RHMYC2KT.cjs +0 -7
package/docs/email-settings.md
CHANGED
|
@@ -1045,7 +1045,7 @@ const { data } = await client.listSmtpConnections()
|
|
|
1045
1045
|
{
|
|
1046
1046
|
"connection_id": "string",
|
|
1047
1047
|
"smtp_host": "string",
|
|
1048
|
-
"smtp_port":
|
|
1048
|
+
"smtp_port": "string",
|
|
1049
1049
|
"smtp_secure": "tls",
|
|
1050
1050
|
"smtp_username": "string",
|
|
1051
1051
|
"smtp_password": "string",
|
|
@@ -1070,17 +1070,19 @@ const { data } = await client.listSmtpConnections()
|
|
|
1070
1070
|
### `createSmtpConnection`
|
|
1071
1071
|
|
|
1072
1072
|
Creates a new custom SMTP connection. Runs a live verify against the SMTP server
|
|
1073
|
-
before persisting; on failure the request is rejected and nothing is saved.
|
|
1074
|
-
|
|
1073
|
+
before persisting; on failure the request is rejected and nothing is saved. Pass
|
|
1074
|
+
`skip_test=true` to store the configur
|
|
1075
1075
|
|
|
1076
1076
|
`POST /v2/smtp/connections`
|
|
1077
1077
|
|
|
1078
1078
|
```ts
|
|
1079
1079
|
const { data } = await client.createSmtpConnection(
|
|
1080
|
-
|
|
1080
|
+
{
|
|
1081
|
+
skip_test: true,
|
|
1082
|
+
},
|
|
1081
1083
|
{
|
|
1082
1084
|
smtp_host: 'string',
|
|
1083
|
-
smtp_port:
|
|
1085
|
+
smtp_port: 'string',
|
|
1084
1086
|
smtp_secure: 'tls',
|
|
1085
1087
|
smtp_username: 'string',
|
|
1086
1088
|
smtp_password: '{{ env.smtp_password }}'
|
|
@@ -1095,7 +1097,7 @@ const { data } = await client.createSmtpConnection(
|
|
|
1095
1097
|
{
|
|
1096
1098
|
"connection_id": "string",
|
|
1097
1099
|
"smtp_host": "string",
|
|
1098
|
-
"smtp_port":
|
|
1100
|
+
"smtp_port": "string",
|
|
1099
1101
|
"smtp_secure": "tls",
|
|
1100
1102
|
"smtp_username": "string",
|
|
1101
1103
|
"smtp_password": "string",
|
|
@@ -1133,7 +1135,7 @@ const { data } = await client.getSmtpConnection({
|
|
|
1133
1135
|
{
|
|
1134
1136
|
"connection_id": "string",
|
|
1135
1137
|
"smtp_host": "string",
|
|
1136
|
-
"smtp_port":
|
|
1138
|
+
"smtp_port": "string",
|
|
1137
1139
|
"smtp_secure": "tls",
|
|
1138
1140
|
"smtp_username": "string",
|
|
1139
1141
|
"smtp_password": "string",
|
|
@@ -1155,7 +1157,8 @@ const { data } = await client.getSmtpConnection({
|
|
|
1155
1157
|
### `updateSmtpConnection`
|
|
1156
1158
|
|
|
1157
1159
|
Partial update; omitted fields keep their existing values. The merged
|
|
1158
|
-
configuration is verified against the SMTP server before persisting.
|
|
1160
|
+
configuration is verified against the SMTP server before persisting. Pass
|
|
1161
|
+
`skip_test=true` to store it untested instead, which als
|
|
1159
1162
|
|
|
1160
1163
|
`PUT /v2/smtp/connections/{connectionId}`
|
|
1161
1164
|
|
|
@@ -1163,10 +1166,11 @@ configuration is verified against the SMTP server before persisting.
|
|
|
1163
1166
|
const { data } = await client.updateSmtpConnection(
|
|
1164
1167
|
{
|
|
1165
1168
|
connectionId: 'example',
|
|
1169
|
+
skip_test: true,
|
|
1166
1170
|
},
|
|
1167
1171
|
{
|
|
1168
1172
|
smtp_host: 'string',
|
|
1169
|
-
smtp_port:
|
|
1173
|
+
smtp_port: 'string',
|
|
1170
1174
|
smtp_secure: 'tls',
|
|
1171
1175
|
smtp_username: 'string',
|
|
1172
1176
|
smtp_password: 'string'
|
|
@@ -1181,7 +1185,7 @@ const { data } = await client.updateSmtpConnection(
|
|
|
1181
1185
|
{
|
|
1182
1186
|
"connection_id": "string",
|
|
1183
1187
|
"smtp_host": "string",
|
|
1184
|
-
"smtp_port":
|
|
1188
|
+
"smtp_port": "string",
|
|
1185
1189
|
"smtp_secure": "tls",
|
|
1186
1190
|
"smtp_username": "string",
|
|
1187
1191
|
"smtp_password": "string",
|
|
@@ -2118,7 +2122,7 @@ type OutlookConnectionStatus = {
|
|
|
2118
2122
|
type SmtpConnection = {
|
|
2119
2123
|
connection_id: string
|
|
2120
2124
|
smtp_host: string
|
|
2121
|
-
smtp_port:
|
|
2125
|
+
smtp_port: string
|
|
2122
2126
|
smtp_secure: "tls" | "starttls"
|
|
2123
2127
|
smtp_username: string
|
|
2124
2128
|
smtp_password?: string
|
|
@@ -2138,7 +2142,7 @@ type SmtpConnection = {
|
|
|
2138
2142
|
```ts
|
|
2139
2143
|
type CreateSmtpConnectionRequest = {
|
|
2140
2144
|
smtp_host: string
|
|
2141
|
-
smtp_port: number
|
|
2145
|
+
smtp_port: string | number
|
|
2142
2146
|
smtp_secure: "tls" | "starttls"
|
|
2143
2147
|
smtp_username: string
|
|
2144
2148
|
smtp_password: string
|
|
@@ -2152,7 +2156,7 @@ Partial update; omitted fields keep their existing values.
|
|
|
2152
2156
|
```ts
|
|
2153
2157
|
type UpdateSmtpConnectionRequest = {
|
|
2154
2158
|
smtp_host?: string
|
|
2155
|
-
smtp_port?: number
|
|
2159
|
+
smtp_port?: string | number
|
|
2156
2160
|
smtp_secure?: "tls" | "starttls"
|
|
2157
2161
|
smtp_username?: string
|
|
2158
2162
|
smtp_password?: string
|
package/package.json
CHANGED
package/dist/chunk-M2UDF7PY.cjs
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
4
|
-
|
|
5
|
-
// src/definitions/dashboard-runtime.json
|
|
6
|
-
var require_dashboard_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
|
-
"src/definitions/dashboard-runtime.json"(exports, module) {
|
|
8
|
-
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]] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
exports.require_dashboard_runtime = require_dashboard_runtime;
|
package/dist/chunk-SZMCMLOQ.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
__commonJS
|
|
3
|
-
} from "./chunk-YPSWSI3M.js";
|
|
4
|
-
|
|
5
|
-
// src/definitions/dashboard-runtime.json
|
|
6
|
-
var require_dashboard_runtime = __commonJS({
|
|
7
|
-
"src/definitions/dashboard-runtime.json"(exports, module) {
|
|
8
|
-
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]] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export {
|
|
13
|
-
require_dashboard_runtime
|
|
14
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/dashboard.json
|
|
4
|
-
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';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = dashboard_default;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/dashboard.json
|
|
4
|
-
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';
|
|
5
|
-
export {
|
|
6
|
-
dashboard_default as default
|
|
7
|
-
};
|
|
@@ -1,440 +0,0 @@
|
|
|
1
|
-
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
-
|
|
3
|
-
/* Auto-copied from dashboard-client */
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
declare namespace Components {
|
|
7
|
-
namespace Schemas {
|
|
8
|
-
/**
|
|
9
|
-
* Adashboard configuration with tiles
|
|
10
|
-
*/
|
|
11
|
-
export interface Dashboard {
|
|
12
|
-
id?: /**
|
|
13
|
-
* Unique identifier for dashboard
|
|
14
|
-
* example:
|
|
15
|
-
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
|
|
16
|
-
*/
|
|
17
|
-
DashboardID /* uuid */;
|
|
18
|
-
/**
|
|
19
|
-
* example:
|
|
20
|
-
* Employee Dashboard
|
|
21
|
-
*/
|
|
22
|
-
title: string;
|
|
23
|
-
/**
|
|
24
|
-
* example:
|
|
25
|
-
* [
|
|
26
|
-
* {
|
|
27
|
-
* "id": "e4af1297-1fd6-440f-9846-f475f580d40f",
|
|
28
|
-
* "coordinates": {},
|
|
29
|
-
* "visualisation": "timechart",
|
|
30
|
-
* "visualisation_config": {
|
|
31
|
-
* "query": {
|
|
32
|
-
* "dataset": "entity_operations",
|
|
33
|
-
* "measure": "count_operations",
|
|
34
|
-
* "filters": [
|
|
35
|
-
* {
|
|
36
|
-
* "operation": [
|
|
37
|
-
* "createEntity"
|
|
38
|
-
* ]
|
|
39
|
-
* },
|
|
40
|
-
* {
|
|
41
|
-
* "entity_schema": [
|
|
42
|
-
* "opportunity"
|
|
43
|
-
* ]
|
|
44
|
-
* }
|
|
45
|
-
* ],
|
|
46
|
-
* "dimensions": [
|
|
47
|
-
* {
|
|
48
|
-
* "time_with_granularity": "month"
|
|
49
|
-
* },
|
|
50
|
-
* {
|
|
51
|
-
* "entity_attribute": "source.title"
|
|
52
|
-
* }
|
|
53
|
-
* ]
|
|
54
|
-
* },
|
|
55
|
-
* "options": {
|
|
56
|
-
* "type": "line"
|
|
57
|
-
* }
|
|
58
|
-
* }
|
|
59
|
-
* }
|
|
60
|
-
* ]
|
|
61
|
-
*/
|
|
62
|
-
tiles: DashboardTile[];
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Unique identifier for dashboard
|
|
66
|
-
* example:
|
|
67
|
-
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
|
|
68
|
-
*/
|
|
69
|
-
export type DashboardID = string; // uuid
|
|
70
|
-
export interface DashboardTile {
|
|
71
|
-
id?: /**
|
|
72
|
-
* Unique identifier for a tile in a dashboard
|
|
73
|
-
* example:
|
|
74
|
-
* e4af1297-1fd6-440f-9846-f475f580d40f
|
|
75
|
-
*/
|
|
76
|
-
DashboardTileID /* uuid */;
|
|
77
|
-
coordinates?: {
|
|
78
|
-
[key: string]: any;
|
|
79
|
-
};
|
|
80
|
-
/**
|
|
81
|
-
* example:
|
|
82
|
-
* Number of opportunities created by journeys every month
|
|
83
|
-
*/
|
|
84
|
-
title?: string;
|
|
85
|
-
visualisation_id?: /**
|
|
86
|
-
* Unique identifier for a Visualisation
|
|
87
|
-
* example:
|
|
88
|
-
* timechart
|
|
89
|
-
*/
|
|
90
|
-
VisualisationId;
|
|
91
|
-
visualisation_config?: VisualisationConfig;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* Unique identifier for a tile in a dashboard
|
|
95
|
-
* example:
|
|
96
|
-
* e4af1297-1fd6-440f-9846-f475f580d40f
|
|
97
|
-
*/
|
|
98
|
-
export type DashboardTileID = string; // uuid
|
|
99
|
-
export interface DatalakeQuery {
|
|
100
|
-
[name: string]: any;
|
|
101
|
-
/**
|
|
102
|
-
* example:
|
|
103
|
-
* entity_operations
|
|
104
|
-
*/
|
|
105
|
-
dataset?: string;
|
|
106
|
-
/**
|
|
107
|
-
* example:
|
|
108
|
-
* count_operations
|
|
109
|
-
*/
|
|
110
|
-
measure?: string;
|
|
111
|
-
dimensions?: {
|
|
112
|
-
[name: string]: any;
|
|
113
|
-
}[];
|
|
114
|
-
filters?: {
|
|
115
|
-
[name: string]: any;
|
|
116
|
-
}[];
|
|
117
|
-
}
|
|
118
|
-
export interface Example {
|
|
119
|
-
id?: /**
|
|
120
|
-
* Unique identifier for a visualisation examples for tiles in a dashboard
|
|
121
|
-
* example:
|
|
122
|
-
* e4af1297-1fd6-440f-9846-f475f580d40f
|
|
123
|
-
*/
|
|
124
|
-
ExampleID /* uuid */;
|
|
125
|
-
/**
|
|
126
|
-
* example:
|
|
127
|
-
* Number of opportunities created by journeys every month
|
|
128
|
-
*/
|
|
129
|
-
title?: string;
|
|
130
|
-
visualisation?: /**
|
|
131
|
-
* Unique identifier for a Visualisation
|
|
132
|
-
* example:
|
|
133
|
-
* timechart
|
|
134
|
-
*/
|
|
135
|
-
VisualisationId;
|
|
136
|
-
query?: DatalakeQuery;
|
|
137
|
-
}
|
|
138
|
-
/**
|
|
139
|
-
* Unique identifier for a visualisation examples for tiles in a dashboard
|
|
140
|
-
* example:
|
|
141
|
-
* e4af1297-1fd6-440f-9846-f475f580d40f
|
|
142
|
-
*/
|
|
143
|
-
export type ExampleID = string; // uuid
|
|
144
|
-
export interface TimechartVisualisationConfig {
|
|
145
|
-
query?: DatalakeQuery;
|
|
146
|
-
/**
|
|
147
|
-
* example:
|
|
148
|
-
* {
|
|
149
|
-
* "type": "bar"
|
|
150
|
-
* }
|
|
151
|
-
*/
|
|
152
|
-
options?: {
|
|
153
|
-
[name: string]: any;
|
|
154
|
-
};
|
|
155
|
-
}
|
|
156
|
-
/**
|
|
157
|
-
* A Visualisation that can be used to configure tiles in dashboards
|
|
158
|
-
*/
|
|
159
|
-
export interface Visualisation {
|
|
160
|
-
visualisation?: /**
|
|
161
|
-
* Unique identifier for a Visualisation
|
|
162
|
-
* example:
|
|
163
|
-
* timechart
|
|
164
|
-
*/
|
|
165
|
-
VisualisationId;
|
|
166
|
-
/**
|
|
167
|
-
* example:
|
|
168
|
-
* Time Series Visualisation
|
|
169
|
-
*/
|
|
170
|
-
title?: string;
|
|
171
|
-
description?: string;
|
|
172
|
-
/**
|
|
173
|
-
* Package name of the Visualisation MFE bundle to import
|
|
174
|
-
* example:
|
|
175
|
-
* @epilot360/highcharts
|
|
176
|
-
*/
|
|
177
|
-
package_name?: string;
|
|
178
|
-
/**
|
|
179
|
-
* URL to Visualisation MFE bundle to import
|
|
180
|
-
* example:
|
|
181
|
-
* https://epilot-dashboard-visualisations.epilot.io/epilot360-datalake-visualisation/bundle.js?version=1650592827
|
|
182
|
-
*/
|
|
183
|
-
import_url?: string; // uri
|
|
184
|
-
}
|
|
185
|
-
export type VisualisationConfig = TimechartVisualisationConfig;
|
|
186
|
-
/**
|
|
187
|
-
* Unique identifier for a Visualisation
|
|
188
|
-
* example:
|
|
189
|
-
* timechart
|
|
190
|
-
*/
|
|
191
|
-
export type VisualisationId = "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow";
|
|
192
|
-
}
|
|
193
|
-
}
|
|
194
|
-
declare namespace Paths {
|
|
195
|
-
namespace CreateDashboard {
|
|
196
|
-
export type RequestBody = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
197
|
-
namespace Responses {
|
|
198
|
-
export type $201 = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
199
|
-
}
|
|
200
|
-
}
|
|
201
|
-
namespace DeleteDashboard {
|
|
202
|
-
namespace Responses {
|
|
203
|
-
export type $200 = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
204
|
-
}
|
|
205
|
-
}
|
|
206
|
-
namespace GetDashboard {
|
|
207
|
-
namespace Responses {
|
|
208
|
-
export type $200 = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
namespace ListAvailableExamples {
|
|
212
|
-
namespace Responses {
|
|
213
|
-
export interface $200 {
|
|
214
|
-
results?: Components.Schemas.Example[];
|
|
215
|
-
}
|
|
216
|
-
}
|
|
217
|
-
}
|
|
218
|
-
namespace ListAvailableVisualisations {
|
|
219
|
-
namespace Responses {
|
|
220
|
-
export interface $200 {
|
|
221
|
-
/**
|
|
222
|
-
* example:
|
|
223
|
-
* [
|
|
224
|
-
* {
|
|
225
|
-
* "visualisation": "timechart",
|
|
226
|
-
* "title": "Time Series Visualisation",
|
|
227
|
-
* "description": "Visualise your metrics with respect to time series",
|
|
228
|
-
* "package_name": "@epilot360/highcharts"
|
|
229
|
-
* },
|
|
230
|
-
* {
|
|
231
|
-
* "visualisation": "kpi",
|
|
232
|
-
* "title": "KPI Visualisation",
|
|
233
|
-
* "description": "Visualise your key performance indicators",
|
|
234
|
-
* "package_name": "@epilot360/kpi"
|
|
235
|
-
* }
|
|
236
|
-
* ]
|
|
237
|
-
*/
|
|
238
|
-
results?: /* A Visualisation that can be used to configure tiles in dashboards */ Components.Schemas.Visualisation[];
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
namespace ListDashboards {
|
|
243
|
-
namespace Responses {
|
|
244
|
-
export interface $200 {
|
|
245
|
-
results?: /* Adashboard configuration with tiles */ Components.Schemas.Dashboard[];
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
|
-
}
|
|
249
|
-
namespace PutDashboard {
|
|
250
|
-
export type RequestBody = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
251
|
-
namespace Responses {
|
|
252
|
-
export type $200 = /* Adashboard configuration with tiles */ Components.Schemas.Dashboard;
|
|
253
|
-
}
|
|
254
|
-
}
|
|
255
|
-
namespace V1DashboardDashboards$Id {
|
|
256
|
-
namespace Parameters {
|
|
257
|
-
export type Id = /**
|
|
258
|
-
* Unique identifier for dashboard
|
|
259
|
-
* example:
|
|
260
|
-
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
|
|
261
|
-
*/
|
|
262
|
-
Components.Schemas.DashboardID /* uuid */;
|
|
263
|
-
}
|
|
264
|
-
export interface PathParameters {
|
|
265
|
-
id: Parameters.Id;
|
|
266
|
-
}
|
|
267
|
-
}
|
|
268
|
-
}
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
interface OperationMethods {
|
|
272
|
-
/**
|
|
273
|
-
* listDashboards - listDashboards
|
|
274
|
-
*
|
|
275
|
-
* List dashboards available to the user
|
|
276
|
-
*/
|
|
277
|
-
'listDashboards'(
|
|
278
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
279
|
-
data?: any,
|
|
280
|
-
config?: AxiosRequestConfig
|
|
281
|
-
): OperationResponse<Paths.ListDashboards.Responses.$200>
|
|
282
|
-
/**
|
|
283
|
-
* createDashboard - createDashboard
|
|
284
|
-
*
|
|
285
|
-
* Create new dashboard
|
|
286
|
-
*/
|
|
287
|
-
'createDashboard'(
|
|
288
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
289
|
-
data?: Paths.CreateDashboard.RequestBody,
|
|
290
|
-
config?: AxiosRequestConfig
|
|
291
|
-
): OperationResponse<Paths.CreateDashboard.Responses.$201>
|
|
292
|
-
/**
|
|
293
|
-
* getDashboard - getDashboard
|
|
294
|
-
*
|
|
295
|
-
* Get dashboard by ID
|
|
296
|
-
*/
|
|
297
|
-
'getDashboard'(
|
|
298
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
299
|
-
data?: any,
|
|
300
|
-
config?: AxiosRequestConfig
|
|
301
|
-
): OperationResponse<Paths.GetDashboard.Responses.$200>
|
|
302
|
-
/**
|
|
303
|
-
* putDashboard - putDashboard
|
|
304
|
-
*
|
|
305
|
-
* Update a dashboard by ID
|
|
306
|
-
*/
|
|
307
|
-
'putDashboard'(
|
|
308
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
309
|
-
data?: Paths.PutDashboard.RequestBody,
|
|
310
|
-
config?: AxiosRequestConfig
|
|
311
|
-
): OperationResponse<Paths.PutDashboard.Responses.$200>
|
|
312
|
-
/**
|
|
313
|
-
* deleteDashboard - deleteDashboard
|
|
314
|
-
*
|
|
315
|
-
* Delete a dashboard by ID
|
|
316
|
-
*/
|
|
317
|
-
'deleteDashboard'(
|
|
318
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
319
|
-
data?: any,
|
|
320
|
-
config?: AxiosRequestConfig
|
|
321
|
-
): OperationResponse<Paths.DeleteDashboard.Responses.$200>
|
|
322
|
-
/**
|
|
323
|
-
* listAvailableVisualisations - listAvailableVisualisations
|
|
324
|
-
*
|
|
325
|
-
* Returns list of available Visualisations to configure new dashboard tiles
|
|
326
|
-
*/
|
|
327
|
-
'listAvailableVisualisations'(
|
|
328
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
329
|
-
data?: any,
|
|
330
|
-
config?: AxiosRequestConfig
|
|
331
|
-
): OperationResponse<Paths.ListAvailableVisualisations.Responses.$200>
|
|
332
|
-
/**
|
|
333
|
-
* listAvailableExamples - listAvailableExamples
|
|
334
|
-
*
|
|
335
|
-
* Returns list of available exampless for visualisations to configure new dashboard tiles
|
|
336
|
-
*/
|
|
337
|
-
'listAvailableExamples'(
|
|
338
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
339
|
-
data?: any,
|
|
340
|
-
config?: AxiosRequestConfig
|
|
341
|
-
): OperationResponse<Paths.ListAvailableExamples.Responses.$200>
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
interface PathsDictionary {
|
|
345
|
-
['/v1/dashboard/dashboards']: {
|
|
346
|
-
/**
|
|
347
|
-
* listDashboards - listDashboards
|
|
348
|
-
*
|
|
349
|
-
* List dashboards available to the user
|
|
350
|
-
*/
|
|
351
|
-
'get'(
|
|
352
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
353
|
-
data?: any,
|
|
354
|
-
config?: AxiosRequestConfig
|
|
355
|
-
): OperationResponse<Paths.ListDashboards.Responses.$200>
|
|
356
|
-
/**
|
|
357
|
-
* createDashboard - createDashboard
|
|
358
|
-
*
|
|
359
|
-
* Create new dashboard
|
|
360
|
-
*/
|
|
361
|
-
'post'(
|
|
362
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
363
|
-
data?: Paths.CreateDashboard.RequestBody,
|
|
364
|
-
config?: AxiosRequestConfig
|
|
365
|
-
): OperationResponse<Paths.CreateDashboard.Responses.$201>
|
|
366
|
-
}
|
|
367
|
-
['/v1/dashboard/dashboards/{id}']: {
|
|
368
|
-
/**
|
|
369
|
-
* getDashboard - getDashboard
|
|
370
|
-
*
|
|
371
|
-
* Get dashboard by ID
|
|
372
|
-
*/
|
|
373
|
-
'get'(
|
|
374
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
375
|
-
data?: any,
|
|
376
|
-
config?: AxiosRequestConfig
|
|
377
|
-
): OperationResponse<Paths.GetDashboard.Responses.$200>
|
|
378
|
-
/**
|
|
379
|
-
* putDashboard - putDashboard
|
|
380
|
-
*
|
|
381
|
-
* Update a dashboard by ID
|
|
382
|
-
*/
|
|
383
|
-
'put'(
|
|
384
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
385
|
-
data?: Paths.PutDashboard.RequestBody,
|
|
386
|
-
config?: AxiosRequestConfig
|
|
387
|
-
): OperationResponse<Paths.PutDashboard.Responses.$200>
|
|
388
|
-
/**
|
|
389
|
-
* deleteDashboard - deleteDashboard
|
|
390
|
-
*
|
|
391
|
-
* Delete a dashboard by ID
|
|
392
|
-
*/
|
|
393
|
-
'delete'(
|
|
394
|
-
parameters?: Parameters<Paths.V1DashboardDashboards$Id.PathParameters> | null,
|
|
395
|
-
data?: any,
|
|
396
|
-
config?: AxiosRequestConfig
|
|
397
|
-
): OperationResponse<Paths.DeleteDashboard.Responses.$200>
|
|
398
|
-
}
|
|
399
|
-
['/v1/dashboard/visualisations']: {
|
|
400
|
-
/**
|
|
401
|
-
* listAvailableVisualisations - listAvailableVisualisations
|
|
402
|
-
*
|
|
403
|
-
* Returns list of available Visualisations to configure new dashboard tiles
|
|
404
|
-
*/
|
|
405
|
-
'get'(
|
|
406
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
407
|
-
data?: any,
|
|
408
|
-
config?: AxiosRequestConfig
|
|
409
|
-
): OperationResponse<Paths.ListAvailableVisualisations.Responses.$200>
|
|
410
|
-
}
|
|
411
|
-
['/v1/dashboard/examples']: {
|
|
412
|
-
/**
|
|
413
|
-
* listAvailableExamples - listAvailableExamples
|
|
414
|
-
*
|
|
415
|
-
* Returns list of available exampless for visualisations to configure new dashboard tiles
|
|
416
|
-
*/
|
|
417
|
-
'get'(
|
|
418
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
419
|
-
data?: any,
|
|
420
|
-
config?: AxiosRequestConfig
|
|
421
|
-
): OperationResponse<Paths.ListAvailableExamples.Responses.$200>
|
|
422
|
-
}
|
|
423
|
-
}
|
|
424
|
-
|
|
425
|
-
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
type Dashboard = Components.Schemas.Dashboard;
|
|
429
|
-
type DashboardID = Components.Schemas.DashboardID;
|
|
430
|
-
type DashboardTile = Components.Schemas.DashboardTile;
|
|
431
|
-
type DashboardTileID = Components.Schemas.DashboardTileID;
|
|
432
|
-
type DatalakeQuery = Components.Schemas.DatalakeQuery;
|
|
433
|
-
type Example = Components.Schemas.Example;
|
|
434
|
-
type ExampleID = Components.Schemas.ExampleID;
|
|
435
|
-
type timechartVisualisationConfig = Components.Schemas.TimechartVisualisationConfig;
|
|
436
|
-
type Visualisation = Components.Schemas.Visualisation;
|
|
437
|
-
type VisualisationConfig = Components.Schemas.VisualisationConfig;
|
|
438
|
-
type VisualisationId = Components.Schemas.VisualisationId;
|
|
439
|
-
|
|
440
|
-
export { type Client as C, type Dashboard as D, type Example as E, type OperationMethods as O, Paths as P, type Visualisation as V, Components as a, type PathsDictionary as b, type DashboardID as c, type DashboardTile as d, type DashboardTileID as e, type DatalakeQuery as f, type ExampleID as g, type VisualisationConfig as h, type VisualisationId as i, type timechartVisualisationConfig as t };
|