@epilot/sdk 2.1.0-rc.1 → 2.1.1

package/dist/dashboard-UDL26RGG.js

@@ -0,0 +1,483 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/definitions/dashboard.json
+var openapi = "3.0.0";
+var info = {
+  title: "Dashboard API",
+  version: "0.0.1",
+  description: "API to store the dashboard configuration for the epilot 360 dashboard\n"
+};
+var security = [
+  {
+    EpilotAuth: []
+  },
+  {
+    EpilotOrg: []
+  }
+];
+var tags = [
+  {
+    name: "Dashboards"
+  },
+  {
+    name: "Visualisations"
+  },
+  {
+    name: "Examples"
+  }
+];
+var paths = {
+  "/v1/dashboard/dashboards": {
+    get: {
+      operationId: "listDashboards",
+      summary: "listDashboards",
+      description: "List dashboards available to the user",
+      tags: ["Dashboards"],
+      responses: {
+        "200": {
+          description: "List of dashboards available to the user",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  results: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/Dashboard"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    post: {
+      operationId: "createDashboard",
+      summary: "createDashboard",
+      description: "Create new dashboard",
+      tags: ["Dashboards"],
+      requestBody: {
+        description: "The dashboard to create",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/Dashboard"
+            }
+          }
+        }
+      },
+      responses: {
+        "201": {
+          description: "The created dashboard",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/Dashboard"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/dashboard/dashboards/{id}": {
+    parameters: [
+      {
+        name: "id",
+        in: "path",
+        required: true,
+        schema: {
+          $ref: "#/components/schemas/DashboardID"
+        }
+      }
+    ],
+    get: {
+      operationId: "getDashboard",
+      summary: "getDashboard",
+      description: "Get dashboard by ID",
+      tags: ["Dashboards"],
+      responses: {
+        "200": {
+          description: "The dashboard with the passed ID",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/Dashboard"
+              }
+            }
+          }
+        }
+      }
+    },
+    put: {
+      operationId: "putDashboard",
+      summary: "putDashboard",
+      description: "Update a dashboard by ID",
+      tags: ["Dashboards"],
+      requestBody: {
+        description: "The updated dashboard",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/Dashboard"
+            }
+          }
+        }
+      },
+      responses: {
+        "200": {
+          description: "The dashboard with the passed ID",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/Dashboard"
+              }
+            }
+          }
+        }
+      }
+    },
+    delete: {
+      operationId: "deleteDashboard",
+      summary: "deleteDashboard",
+      description: "Delete a dashboard by ID",
+      tags: ["Dashboards"],
+      responses: {
+        "200": {
+          description: "The deleted dashboard",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/Dashboard"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/dashboard/visualisations": {
+    get: {
+      operationId: "listAvailableVisualisations",
+      summary: "listAvailableVisualisations",
+      description: "Returns list of available Visualisations to configure new dashboard tiles",
+      tags: ["Visualisations"],
+      responses: {
+        "200": {
+          description: "List of available Visualisations to configure new dashboard tiles",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  results: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/Visualisation"
+                    },
+                    example: [
+                      {
+                        visualisation: "timechart",
+                        title: "Time Series Visualisation",
+                        description: "Visualise your metrics with respect to time series",
+                        package_name: "@epilot360/highcharts"
+                      },
+                      {
+                        visualisation: "kpi",
+                        title: "KPI Visualisation",
+                        description: "Visualise your key performance indicators",
+                        package_name: "@epilot360/kpi"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/dashboard/examples": {
+    get: {
+      operationId: "listAvailableExamples",
+      summary: "listAvailableExamples",
+      description: "Returns list of available exampless for visualisations to configure new dashboard tiles",
+      tags: ["Examples"],
+      responses: {
+        "200": {
+          description: "List of available exampless for visualisations to configure new dashboard tiles",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  results: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/Example"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var components = {
+  schemas: {
+    DashboardID: {
+      description: "Unique identifier for dashboard",
+      type: "string",
+      format: "uuid",
+      example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+    },
+    Dashboard: {
+      type: "object",
+      description: "Adashboard configuration with tiles",
+      properties: {
+        id: {
+          $ref: "#/components/schemas/DashboardID"
+        },
+        title: {
+          type: "string",
+          example: "Employee Dashboard"
+        },
+        tiles: {
+          type: "array",
+          items: {
+            $ref: "#/components/schemas/DashboardTile"
+          },
+          example: [
+            {
+              id: "e4af1297-1fd6-440f-9846-f475f580d40f",
+              coordinates: {},
+              visualisation: "timechart",
+              visualisation_config: {
+                query: {
+                  dataset: "entity_operations",
+                  measure: "count_operations",
+                  filters: [
+                    {
+                      operation: ["createEntity"]
+                    },
+                    {
+                      entity_schema: ["opportunity"]
+                    }
+                  ],
+                  dimensions: [
+                    {
+                      time_with_granularity: "month"
+                    },
+                    {
+                      entity_attribute: "source.title"
+                    }
+                  ]
+                },
+                options: {
+                  type: "line"
+                }
+              }
+            }
+          ]
+        }
+      },
+      required: ["title", "tiles"]
+    },
+    DashboardTileID: {
+      description: "Unique identifier for a tile in a dashboard",
+      type: "string",
+      format: "uuid",
+      example: "e4af1297-1fd6-440f-9846-f475f580d40f"
+    },
+    DashboardTile: {
+      type: "object",
+      properties: {
+        id: {
+          $ref: "#/components/schemas/DashboardTileID"
+        },
+        coordinates: {
+          type: "object"
+        },
+        title: {
+          type: "string",
+          example: "Number of opportunities created by journeys every month"
+        },
+        visualisation_id: {
+          $ref: "#/components/schemas/VisualisationId"
+        },
+        visualisation_config: {
+          $ref: "#/components/schemas/VisualisationConfig"
+        }
+      }
+    },
+    VisualisationConfig: {
+      anyOf: [
+        {
+          $ref: "#/components/schemas/timechartVisualisationConfig"
+        }
+      ]
+    },
+    timechartVisualisationConfig: {
+      type: "object",
+      properties: {
+        query: {
+          $ref: "#/components/schemas/DatalakeQuery"
+        },
+        options: {
+          type: "object",
+          additionalProperties: true,
+          example: {
+            type: "bar"
+          }
+        }
+      }
+    },
+    ExampleID: {
+      description: "Unique identifier for a visualisation examples for tiles in a dashboard",
+      type: "string",
+      format: "uuid",
+      example: "e4af1297-1fd6-440f-9846-f475f580d40f"
+    },
+    Example: {
+      type: "object",
+      properties: {
+        id: {
+          $ref: "#/components/schemas/ExampleID"
+        },
+        title: {
+          type: "string",
+          example: "Number of opportunities created by journeys every month"
+        },
+        visualisation: {
+          $ref: "#/components/schemas/VisualisationId"
+        },
+        query: {
+          $ref: "#/components/schemas/DatalakeQuery"
+        }
+      }
+    },
+    DatalakeQuery: {
+      type: "object",
+      properties: {
+        dataset: {
+          type: "string",
+          example: "entity_operations"
+        },
+        measure: {
+          type: "string",
+          example: "count_operations"
+        },
+        dimensions: {
+          type: "array",
+          items: {
+            type: "object",
+            additionalProperties: true,
+            example: {
+              time_with_granularity: "year-month"
+            }
+          }
+        },
+        filters: {
+          type: "array",
+          items: {
+            type: "object",
+            additionalProperties: true,
+            example: {
+              entity_schema: "opportunity"
+            }
+          }
+        }
+      },
+      additionalProperties: true
+    },
+    VisualisationId: {
+      description: "Unique identifier for a Visualisation",
+      type: "string",
+      example: "timechart",
+      enum: [
+        "kpi",
+        "funnel",
+        "toplist",
+        "timechart",
+        "pie",
+        "bar",
+        "entity_list",
+        "markdown",
+        "news_feed",
+        "workflow"
+      ]
+    },
+    Visualisation: {
+      type: "object",
+      description: "A Visualisation that can be used to configure tiles in dashboards",
+      properties: {
+        visualisation: {
+          $ref: "#/components/schemas/VisualisationId"
+        },
+        title: {
+          type: "string",
+          example: "Time Series Visualisation"
+        },
+        description: {
+          type: "string"
+        },
+        package_name: {
+          type: "string",
+          description: "Package name of the Visualisation MFE bundle to import",
+          example: "@epilot360/highcharts"
+        },
+        import_url: {
+          type: "string",
+          format: "uri",
+          description: "URL to Visualisation MFE bundle to import",
+          example: "https://epilot-dashboard-visualisations.epilot.io/epilot360-datalake-visualisation/bundle.js?version=1650592827"
+        }
+      }
+    }
+  },
+  securitySchemes: {
+    EpilotAuth: {
+      type: "http",
+      scheme: "bearer",
+      description: "Authorization header with epilot OAuth2 bearer token",
+      bearerFormat: "JWT"
+    },
+    EpilotOrg: {
+      description: "Overrides the target organization to allow shared tenantaccess",
+      name: "x-epilot-org-id",
+      in: "header",
+      type: "apiKey"
+    }
+  }
+};
+var servers = [
+  {
+    url: "https://dashboard.sls.epilot.io"
+  }
+];
+var dashboard_default = {
+  openapi,
+  info,
+  security,
+  tags,
+  paths,
+  components,
+  servers
+};
+export {
+  components,
+  dashboard_default as default,
+  info,
+  openapi,
+  paths,
+  security,
+  servers,
+  tags
+};

package/dist/dashboard-UHYR5RTY.cjs

@@ -0,0 +1,7 @@
+"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

@@ -0,0 +1,7 @@
+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
+};

package/dist/dashboard-runtime-EXP2AM44.cjs

@@ -0,0 +1,5 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkM2UDF7PYcjs = require('./chunk-M2UDF7PY.cjs');
+require('./chunk-NJK5F5TF.cjs');
+exports. default = _chunkM2UDF7PYcjs.require_dashboard_runtime.call(void 0, );

package/dist/dashboard-runtime-PSKSGLCF.js

@@ -0,0 +1,5 @@
+import {
+  require_dashboard_runtime
+} from "./chunk-SZMCMLOQ.js";
+import "./chunk-YPSWSI3M.js";
+export default require_dashboard_runtime();

package/dist/data-management-QH2IJ5QV.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/data-management.json
+var data_management_default = '# Data Management API\n\n- **Base URL:** `https://data-management.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataManagement.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-management\'\n\nconst dataManagementClient = getClient()\nauthorize(dataManagementClient, () => \'<token>\')\nconst { data } = await dataManagementClient.queryEntities(...)\n```\n\n## Operations\n\n**Data Management**\n- [`queryEntities`](#queryentities)\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`getConfig`](#getconfig)\n- [`createJobForConfig`](#createjobforconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n- [`listJobs`](#listjobs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities using a saved view with additional data filters\n\n`POST /data-management/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    saved_view_id: \'string\',\n    include_deleted: \'true\',\n    filters: [\n      {\n        type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n        related_entity_schemas: [\'string\'],\n        lookback_period_days: 0,\n        message_type: [\'SENT\']\n      }\n    ],\n    from: 0,\n    size: 0,\n    hydrate: true,\n    fields: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-management/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    config_id: \'string\',\n    scheduled_for: \'1970-01-01\',\n    status: \'in_progress\',\n    started_at: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "1970-01-01",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-management/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n  {\n    entity_schema: \'example\',\n    job_id: \'example\',\n  },\n  {\n    status: \'in_progress\',\n    details: {},\n    completed_at: \'1970-01-01T00:00:00.000Z\',\n    error: \'string\',\n    report: {\n      bucket: \'string\',\n      key: \'string\',\n      format: \'csv\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "1970-01-01",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by id\n\n`GET /data-management/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "1970-01-01",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-management/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "url": "string",\n  "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by id\n\n`GET /data-management/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "1970-01-01",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-management/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "1970-01-01",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nUpsert config\n\n`POST /data-management/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    query: {\n      saved_view_id: \'string\',\n      include_deleted: \'true\',\n      filters: [\n        {\n          type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n          related_entity_schemas: [\'string\'],\n          lookback_period_days: 0,\n          message_type: [\'SENT\']\n        }\n      ]\n    },\n    schedule: {\n      frequency: \'interval\',\n      interval_days: 1,\n      start_date: \'1970-01-01\',\n      end_date: \'1970-01-01\'\n    },\n    relations_for_deletion: [\'contact\'],\n    enabled: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "1970-01-01",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList configs\n\n`GET /data-management/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  next_run_at: \'example\',\n  enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "configs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "entity_schema": "string",\n      "query": {\n        "saved_view_id": "string",\n        "include_deleted": "true",\n        "filters": [\n          {\n            "type": "entity_workflows_only_in_closed_or_cancelled_status",\n            "related_entity_schemas": ["string"],\n            "lookback_period_days": 0,\n            "message_type": ["SENT"]\n          }\n        ]\n      },\n      "schedule": {\n        "frequency": "interval",\n        "interval_days": 1,\n        "start_date": "1970-01-01",\n        "end_date": "1970-01-01"\n      },\n      "enabled": true,\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "next_run_at": "1970-01-01",\n      "relations_for_deletion": ["contact"],\n      "last_run_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList jobs\n\n`GET /data-management/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  status: \'example\',\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "jobs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "config_id": "string",\n      "entity_schema": "string",\n      "scheduled_for": "1970-01-01",\n      "status": "in_progress",\n      "details": {},\n      "started_at": "1970-01-01T00:00:00.000Z",\n      "completed_at": "1970-01-01T00:00:00.000Z",\n      "error": "string",\n      "report": {\n        "bucket": "string",\n        "key": "string",\n        "format": "csv"\n      },\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "trigger": "schedule",\n      "triggered_by": "string"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nType of configuration (e.g. deletion)\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\n```ts\ntype JobReport = {\n  bucket?: string\n  key?: string\n  format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\n```ts\ntype CreateJobRequest = {\n  type: "deletion"\n  config_id: string\n  scheduled_for: string // date\n  status?: "in_progress" | "success" | "failed"\n  started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nGeneric, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\n```ts\ntype UpdateJobRequest = {\n  status?: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n}\n```\n\n### `Job`\n\n```ts\ntype Job = {\n  id: string\n  type: "deletion"\n  config_id: string\n  entity_schema: string\n  scheduled_for: string // date\n  status: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  started_at?: string // date-time\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n  created_at: string // date-time\n  last_updated_at: string // date-time\n  trigger?: "schedule" | "manual"\n  triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\n```ts\ntype ListJobsResponse = {\n  jobs?: Array<{\n    id: string\n    type: "deletion"\n    config_id: string\n    entity_schema: string\n    scheduled_for: string // date\n    status: "in_progress" | "success" | "failed"\n    details?: Record<string, unknown>\n    started_at?: string // date-time\n    completed_at?: string // date-time\n    error?: string\n    report?: {\n      bucket?: { ... }\n      key?: { ... }\n      format?: { ... }\n    }\n    created_at: string // date-time\n    last_updated_at: string // date-time\n    trigger?: "schedule" | "manual"\n    triggered_by?: string\n  }>\n  cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\n```ts\ntype JobReportUrlResponse = {\n  url?: string\n  expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\n```ts\ntype QueryFilter = {\n  type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n  related_entity_schemas?: string[]\n  lookback_period_days?: number\n  message_type?: "SENT" | "RECEIVED"[]\n}\n```\n\n### `QueryConfig`\n\n```ts\ntype QueryConfig = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n  }>\n}\n```\n\n### `QueryEntitiesRequest`\n\n```ts\ntype QueryEntitiesRequest = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n  }>\n  from?: number\n  size?: number\n  hydrate?: boolean\n  fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\n```ts\ntype QueryEntitiesResult = {\n  hits?: number\n  results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\n```ts\ntype ConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\n```ts\ntype IntervalConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\n```ts\ntype UpsertConfigRequest = {\n  type: "deletion"\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n    }>\n  }\n  schedule: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  enabled?: boolean\n}\n```\n\n### `Config`\n\n```ts\ntype Config = {\n  id: string\n  type: "deletion"\n  entity_schema: string\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n    }>\n  }\n  schedule?: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  enabled?: boolean\n  created_at?: string // date-time\n  last_updated_at?: string // date-time\n  next_run_at?: string // date\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\n```ts\ntype ListConfigsResponse = {\n  configs?: Array<{\n    id: string\n    type: "deletion"\n    entity_schema: string\n    query: {\n      saved_view_id: { ... }\n      include_deleted?: { ... }\n      filters?: { ... }\n    }\n    schedule?: {\n      frequency: { ... }\n      interval_days: { ... }\n      start_date?: { ... }\n      end_date?: { ... }\n    }\n    enabled?: boolean\n    created_at?: string // date-time\n    last_updated_at?: string // date-time\n    next_run_at?: string // date\n    relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n    last_run_at?: string // date-time\n  }>\n  cursor?: string\n}\n```\n';
+export {
+  data_management_default as default
+};