@epilot/sdk 2.3.2 → 2.3.5

package/dist/query-RJ4M25PA.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/query.json
+var query_default = '# Query API\n\n- **Base URL:** `https://query.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/query](https://docs.epilot.io/api/query)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.query.createOrUpdateView(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/query\'\n\nconst queryClient = getClient()\nauthorize(queryClient, () => \'<token>\')\nconst { data } = await queryClient.createOrUpdateView(...)\n```\n\n## Operations\n\n**Datalake V2**\n- [`createOrUpdateView`](#createorupdateview)\n- [`getAllViews`](#getallviews)\n- [`getView`](#getview)\n- [`createOrUpdateRelationship`](#createorupdaterelationship)\n- [`getAllRelationships`](#getallrelationships)\n\n**Datasets**\n- [`listAvailableDatasetsV2`](#listavailabledatasetsv2)\n\n**Query**\n- [`executeEntitiesQuery`](#executeentitiesquery)\n- [`executeWorkflowsQuery`](#executeworkflowsquery)\n- [`executeAutomationQuery`](#executeautomationquery)\n- [`listWorkflowPhasesByDefinitionId`](#listworkflowphasesbydefinitionid)\n- [`listWorkflowDefinitions`](#listworkflowdefinitions)\n- [`listPhaseNames`](#listphasenames)\n\n**V1**\n- [`listDatasets`](#listdatasets)\n- [`executeQuery`](#executequery)\n\n**CredentialsV2**\n- [`generateCredentialsV2`](#generatecredentialsv2)\n- [`listCredentialsV2`](#listcredentialsv2)\n- [`revokeCredentialsV2`](#revokecredentialsv2)\n\n**V2**\n- [`executeQueryV2`](#executequeryv2)\n- [`getSemanticModel`](#getsemanticmodel)\n- [`autocomplete`](#autocomplete)\n- [`workflowsAutocomplete`](#workflowsautocomplete)\n\n**Schemas**\n- [`ErrorResponse`](#errorresponse)\n- [`ViewRequest`](#viewrequest)\n- [`CurrentEntitiesViewRequest`](#currententitiesviewrequest)\n- [`TaxonomiesViewRequest`](#taxonomiesviewrequest)\n- [`WorkflowExecutionsViewRequest`](#workflowexecutionsviewrequest)\n- [`ViewResponse`](#viewresponse)\n- [`ViewsListResponse`](#viewslistresponse)\n- [`RelationshipRequest`](#relationshiprequest)\n- [`RelationshipResponse`](#relationshipresponse)\n- [`RelationshipsListResponse`](#relationshipslistresponse)\n- [`NoCache`](#nocache)\n- [`CacheExpiration`](#cacheexpiration)\n- [`UserId`](#userid)\n- [`DatasetDomain`](#datasetdomain)\n- [`Dataset`](#dataset)\n- [`DatalakeQueryOptions`](#datalakequeryoptions)\n- [`DatalakeQuery`](#datalakequery)\n- [`AutomationQueryOptions`](#automationqueryoptions)\n- [`DatasetOptions.AutomationExecutionsOverview`](#datasetoptions.automationexecutionsoverview)\n- [`DatasetOptions.ListAutomationDefinitions`](#datasetoptions.listautomationdefinitions)\n- [`WorkflowsQueryOptions`](#workflowsqueryoptions)\n- [`DatasetOptions.TotalCountOfWorkflowExecutions`](#datasetoptions.totalcountofworkflowexecutions)\n- [`DatasetOptions.WorkflowExecutionTimeSeries`](#datasetoptions.workflowexecutiontimeseries)\n- [`DatasetOptions.CumulativeSumOfWorkflows`](#datasetoptions.cumulativesumofworkflows)\n- [`DatasetOptions.CancellationReasons`](#datasetoptions.cancellationreasons)\n- [`DatasetOptions.WorkflowTasksOverview`](#datasetoptions.workflowtasksoverview)\n- [`Response.WorkflowTaskOverview`](#response.workflowtaskoverview)\n- [`ECPDetails`](#ecpdetails)\n- [`WorkflowContext`](#workflowcontext)\n- [`WorkflowStatus`](#workflowstatus)\n- [`AutomationConfig`](#automationconfig)\n- [`DynamicDueDate`](#dynamicduedate)\n- [`TaskStatus`](#taskstatus)\n- [`TaskRequirement`](#taskrequirement)\n- [`TaskType`](#tasktype)\n- [`Task`](#task)\n- [`WorkflowsQueryOptions.WorkflowDefinitionIDs`](#workflowsqueryoptions.workflowdefinitionids)\n- [`WorkflowsQueryOptions.EntitySchema`](#workflowsqueryoptions.entityschema)\n- [`WorkflowsQueryOptions.RelativeTimeRange`](#workflowsqueryoptions.relativetimerange)\n- [`WorkflowsQueryOptions.TimeRangeFrom`](#workflowsqueryoptions.timerangefrom)\n- [`WorkflowsQueryOptions.TimeRangeTo`](#workflowsqueryoptions.timerangeto)\n- [`WorkflowsQueryOptions.GroupTimeBy`](#workflowsqueryoptions.grouptimeby)\n- [`WorkflowsQueryOptions.WorkflowStates`](#workflowsqueryoptions.workflowstates)\n- [`DatasetName`](#datasetname)\n- [`EntityDataset`](#entitydataset)\n- [`AutomationExecutionDataset`](#automationexecutiondataset)\n- [`WorkflowDataset`](#workflowdataset)\n- [`WorkflowStates`](#workflowstates)\n- [`PhaseStates`](#phasestates)\n- [`TaskStates`](#taskstates)\n- [`SortBy`](#sortby)\n- [`TimeGroups`](#timegroups)\n- [`RelativeTimeRange`](#relativetimerange)\n- [`WorkflowsQueryResult`](#workflowsqueryresult)\n- [`AutomationExecutionResponse`](#automationexecutionresponse)\n- [`ListAutomationDefinitionsResponse`](#listautomationdefinitionsresponse)\n- [`SemanticModel`](#semanticmodel)\n- [`QueryResults`](#queryresults)\n- [`TimeSeriesSettings`](#timeseriessettings)\n- [`NameDurationSettings`](#namedurationsettings)\n\n### `createOrUpdateView`\n\nCreate or update a materialized SQL view in the epilot data lake.\n\n`POST /datalake/views`\n\n```ts\nconst { data } = await client.createOrUpdateView(\n  null,\n  {\n    view_name: \'some_view\',\n    source_dataset: \'current_entities\',\n    config: {\n      schema: \'some_schema\',\n      include_purpose_view: true,\n      include_label_view: true,\n      include_relation_view: true,\n      relationship_attribute: [\'some_relationship_attribute\']\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "view_name": "some_view",\n  "source_dataset": "current_entities",\n  "attributes": [\n    {\n      "name": "some_attribute",\n      "type": "string",\n      "description": "some description"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getAllViews`\n\nRetrieve all materialized data lake views configured for the organization.\n\n`GET /datalake/views`\n\n```ts\nconst { data } = await client.getAllViews()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "views": [\n    {\n      "view_name": "some_view",\n      "source_dataset": "current_entities",\n      "view_slug": "some_view",\n      "attributes": [\n        {\n          "name": "some_attribute",\n          "type": "string",\n          "description": "some description"\n        }\n      ]\n    },\n    {\n      "view_name": "another_view",\n      "source_dataset": "taxonomies",\n      "view_slug": "another_view",\n      "attributes": [\n        {\n          "name": "taxonomy_attribute",\n          "type": "string",\n          "description": "taxonomy attribute description"\n        }\n      ]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getView`\n\nRetrieve the definition and attributes of a specific data lake view by its slug.\n\n`GET /datalake/views/{view_slug}`\n\n```ts\nconst { data } = await client.getView({\n  view_slug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "view_name": "some_view",\n  "source_dataset": "current_entities",\n  "attributes": [\n    {\n      "name": "some_attribute",\n      "type": "string",\n      "description": "some description"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createOrUpdateRelationship`\n\nDefine or update a relationship between two tables in the data lake.\n\n`POST /datalake/relationships`\n\n```ts\nconst { data } = await client.createOrUpdateRelationship(\n  null,\n  {\n    relationship_name: \'some_relationship\',\n    from_table: \'some_table\',\n    to_table: \'some_table\',\n    from_column: \'some_column\',\n    to_column: \'some_column\',\n    type: \'one_to_many\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "relationship_name": "some_relationship",\n  "from_table": "some_table",\n  "to_table": "some_table",\n  "from_column": "some_column",\n  "to_column": "some_column",\n  "type": "one_to_many"\n}\n```\n\n</details>\n\n---\n\n### `getAllRelationships`\n\nRetrieve all table relationships configured for the organization\'s data lake.\n\n`GET /datalake/relationships`\n\n```ts\nconst { data } = await client.getAllRelationships()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "relationships": [\n    {\n      "relationship_name": "some_relationship",\n      "from_table": "some_table",\n      "to_table": "some_table",\n      "from_column": "some_column",\n      "to_column": "some_column",\n      "type": "one_to_many"\n    },\n    {\n      "relationship_name": "another_relationship",\n      "from_table": "table_a",\n      "to_table": "table_b",\n      "from_column": "column_a",\n      "to_column": "column_b",\n      "type": "many_to_many"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAvailableDatasetsV2`\n\nLists all available datasets grouped by domain\n\n`GET /v2/query/datasets`\n\n```ts\nconst { data } = await client.listAvailableDatasetsV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "domain": "entities",\n      "dataset": "entity_operations",\n      "endpoint": "/v2/query/domain/entities:execute"\n    },\n    {\n      "domain": "workflows",\n      "dataset": "workflow_execution_time_series",\n      "endpoint": "/v2/query/domain/workflows:execute"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `executeEntitiesQuery`\n\nExecute queries against entities datasets.\n\n`POST /v2/query/domain/entities:execute`\n\n```ts\nconst { data } = await client.executeEntitiesQuery(\n  {\n    cache_expiration: \'example\',\n    no_cache: true,\n  },\n  {\n    query: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "FINISHED",\n  "timestamp": "1715621496068",\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `executeWorkflowsQuery`\n\nQuery Workflow Analytics Datasets.\n\n`POST /v2/query/domain/workflows:execute`\n\n```ts\nconst { data } = await client.executeWorkflowsQuery(\n  {\n    mock: true,\n    cache_expiration: \'example\',\n    no_cache: true,\n  },\n  {\n    dataset: \'total_count_of_workflow_executions\',\n    workflow_definition_ids: [\'string\'],\n    entity_schemas: [\'string\'],\n    states: [\'string\'],\n    group_time_by: \'M\',\n    relative_time_range: \'string\',\n    time_range_from: \'string\',\n    time_range_to: \'string\',\n    duration_threshold: 0\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [0, 1],\n  "labels": ["label1", "label2"],\n  "timestamp": "1715621496068"\n}\n```\n\n</details>\n\n---\n\n### `executeAutomationQuery`\n\nQuery Automation Analytics Datasets.\n\n`POST /v2/query/domain/automations:execute`\n\n```ts\nconst { data } = await client.executeAutomationQuery(\n  {\n    from: 1,\n    size: 1,\n  },\n  {\n    dataset: \'automation_executions_overview\',\n    flow_ids: [\'string\'],\n    execution_states: [\'success\', \'failed\', \'scheduled\'],\n    relative_time_range: \'all_time\',\n    time_range_from: \'string\',\n    time_range_to: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 100,\n  "results": [\n    {\n      "flow_id": "1234567890",\n      "flow_name": "flow_name",\n      "execution_id": "execution_id",\n      "execution_status": "execution_status",\n      "entity_schema": "opportunity",\n      "entity_id": "entity_id",\n      "created_at": "execution_created_at",\n      "updated_at": "execution_updated_at",\n      "error": {\n        "message": "error_message",\n        "error_code": "error_code"\n      },\n      "trigger_event": {\n        "type": "EntityOperation",\n        "trigger_type": "createEntity"\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listWorkflowPhasesByDefinitionId`\n\nRetrieves the workflow phases associated with a given workflow definition ID.\n\n`GET /v2/query/domain/workflows/definitions/{workflowDefinitionId}/phases`\n\n```ts\nconst { data } = await client.listWorkflowPhasesByDefinitionId({\n  workflowDefinitionId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "y0UdVCOI",\n    "name": "Initial Phase"\n  }\n]\n```\n\n</details>\n\n---\n\n### `listWorkflowDefinitions`\n\nLists available worflow definitions with their ids, names and start times\n\n`GET /v2/query/domain/workflows/definitions`\n\n```ts\nconst { data } = await client.listWorkflowDefinitions({\n  mock: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "y0UdVCOI",\n      "name": "PV Kauf",\n      "max_date": "2023-05-31T00:00:00.000Z",\n      "min_date": "2023-01-00T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listPhaseNames`\n\nLists phase names of an org.\n\n`GET /v2/query/domain/workflows/phases`\n\n```ts\nconst { data } = await client.listPhaseNames({\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "id": "y0UdVCOI",\n      "name": "PV Kauf",\n      "max_date": "2023-05-31T00:00:00.000Z",\n      "min_date": "2023-01-00T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listDatasets`\n\nGet list of available datasets\n\n`GET /v1/query/datasets`\n\n```ts\nconst { data } = await client.listDatasets()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "dataset": "entity_operations"\n    },\n    {\n      "dataset": "entities_timemachine"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `executeQuery`\n\nExecute queries against datasets.\n\n`POST /v1/query:execute`\n\n```ts\nconst { data } = await client.executeQuery(\n  {\n    cache_expiration: \'example\',\n    no_cache: true,\n  },\n  {\n    query: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "FINISHED",\n  "timestamp": "1715621496068",\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `generateCredentialsV2`\n\nGenerate credentials for the epilot datalake for connecting other BI tools with ClickHouse\n\n`POST /v2/query/credentials:generate`\n\n```ts\nconst { data } = await client.generateCredentialsV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "username": "datalakeuser_sfsdfs_66",\n  "password": "***",\n  "endpoints": {\n    "host": "qjjcxsy87t.eu-central-1.aws.clickhouse.cloud",\n    "port": 8443\n  },\n  "database": "datawarehouse"\n}\n```\n\n</details>\n\n---\n\n### `listCredentialsV2`\n\nList all the credentialof Clickhouse for the organization here\n\n`GET /v2/query/credentials:list`\n\n```ts\nconst { data } = await client.listCredentialsV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "users": [\n    {\n      "user_id": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `revokeCredentialsV2`\n\nRevoke credentials for the epilot datalake for connecting other BI tools with Clickhouse\n\n`POST /v2/query/credentials:revoke`\n\n```ts\nconst { data } = await client.revokeCredentialsV2({\n  user_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true\n}\n```\n\n</details>\n\n---\n\n### `executeQueryV2`\n\nExecute queries against datasets.\n\n`POST /v2/query:execute`\n\n```ts\nconst { data } = await client.executeQueryV2(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "FINISHED",\n  "timestamp": "1715621496068",\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getSemanticModel`\n\nGet the semantic model for agent/tool consumption.\n\n`GET /v2/query/semantic-model`\n\n```ts\nconst { data } = await client.getSemanticModel()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entities": [\n    {\n      "name": "current_contacts",\n      "displayName": "Contacts",\n      "schema": "entity"\n    }\n  ],\n  "relationships": [\n    {\n      "from": "current_contacts",\n      "to": "opportunity_account_contact_relation",\n      "relationship": "hasMany",\n      "displayName": "Contact has many Opportunities"\n    }\n  ],\n  "capabilities": {\n    "aggregations": ["count", "count_distinct", "sum", "average", "min", "max", "median"],\n    "calculationTypes": [\n      {\n        "type": "string",\n        "description": "string",\n        "parameters": {}\n      }\n    ],\n    "granularities": ["day", "week", "month", "quarter", "year"],\n    "filterOperators": [\n      {\n        "operator": "string",\n        "description": "string"\n      }\n    ]\n  }\n}\n```\n\n</details>\n\n---\n\n### `autocomplete`\n\nGeneric autocomplete endpoint for querying distinct values across datasets.\nUse the dataset parameter to specify which data category to query.\n\n`GET /v2/query/autocomplete`\n\n```ts\nconst { data } = await client.autocomplete({\n  dataset: \'example\',\n  input: \'example\',\n  attribute: \'example\',\n  size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": ["value"]\n}\n```\n\n</details>\n\n---\n\n### `workflowsAutocomplete`\n\nAutocomplete Workflows data\n\n`GET /v2/query/workflows:autocomplete`\n\n```ts\nconst { data } = await client.workflowsAutocomplete({\n  input: \'example\',\n  attribute: \'example\',\n  size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": ["value"]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResponse`\n\nStandard error response body\n\n```ts\ntype ErrorResponse = {\n  status?: number\n  error?: string\n  message?: string\n}\n```\n\n### `ViewRequest`\n\n```ts\ntype ViewRequest = {\n  view_name?: string\n  source_dataset: "current_entities"\n  config: {\n    schema: string\n    include_purpose_view?: boolean\n    include_label_view?: boolean\n    include_relation_view?: boolean\n    relationship_attribute?: string[]\n  }\n} | {\n  view_name?: string\n  source_dataset: "taxonomies"\n} | {\n  view_name?: string\n  source_dataset: "workflow_executions"\n}\n```\n\n### `CurrentEntitiesViewRequest`\n\n```ts\ntype CurrentEntitiesViewRequest = {\n  view_name?: string\n  source_dataset: "current_entities"\n  config: {\n    schema: string\n    include_purpose_view?: boolean\n    include_label_view?: boolean\n    include_relation_view?: boolean\n    relationship_attribute?: string[]\n  }\n}\n```\n\n### `TaxonomiesViewRequest`\n\n```ts\ntype TaxonomiesViewRequest = {\n  view_name?: string\n  source_dataset: "taxonomies"\n}\n```\n\n### `WorkflowExecutionsViewRequest`\n\n```ts\ntype WorkflowExecutionsViewRequest = {\n  view_name?: string\n  source_dataset: "workflow_executions"\n}\n```\n\n### `ViewResponse`\n\n```ts\ntype ViewResponse = {\n  view_name: string\n  source_dataset: "current_entities" | "taxonomies" | "workflow_executions"\n  attributes: Array<{\n    name: string\n    type: string\n    description?: string\n  }>\n}\n```\n\n### `ViewsListResponse`\n\n```ts\ntype ViewsListResponse = {\n  views?: Array<{\n    view_name: string\n    source_dataset: "current_entities" | "taxonomies" | "workflow_executions"\n    view_slug?: string\n    attributes: Array<{\n      name: { ... }\n      type: { ... }\n      description?: { ... }\n    }>\n  }>\n}\n```\n\n### `RelationshipRequest`\n\n```ts\ntype RelationshipRequest = {\n  relationship_name: string\n  from_table: string\n  to_table: string\n  from_column: string\n  to_column: string\n  type: "one_to_many" | "many_to_many" | "many_to_one" | "one_to_one"\n}\n```\n\n### `RelationshipResponse`\n\n```ts\ntype RelationshipResponse = {\n  relationship_name?: string\n  from_table?: string\n  to_table?: string\n  from_column?: string\n  to_column?: string\n  type?: "one_to_many" | "many_to_many" | "many_to_one" | "one_to_one"\n}\n```\n\n### `RelationshipsListResponse`\n\n```ts\ntype RelationshipsListResponse = {\n  relationships?: Array<{\n    relationship_name?: string\n    from_table?: string\n    to_table?: string\n    from_column?: string\n    to_column?: string\n    type?: "one_to_many" | "many_to_many" | "many_to_one" | "one_to_one"\n  }>\n}\n```\n\n### `NoCache`\n\n```ts\ntype NoCache = boolean\n```\n\n### `CacheExpiration`\n\nCache Expiration timestamp\n\n```ts\ntype CacheExpiration = string // timestamp\n```\n\n### `UserId`\n\nExecution Id for the query\n\n```ts\ntype UserId = string\n```\n\n### `DatasetDomain`\n\n```ts\ntype DatasetDomain = "entities" | "workflows"\n```\n\n### `Dataset`\n\n```ts\ntype Dataset = {\n  dataset?: string\n  domain?: "entities" | "workflows"\n  endpoint?: string\n}\n```\n\n### `DatalakeQueryOptions`\n\n```ts\ntype DatalakeQueryOptions = {\n  dataset?: string\n  measure?: string\n  dimensions?: Record<string, unknown>[]\n  filters?: Record<string, unknown>[]\n  exclude_deleted?: boolean\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  exclude_deleted?: boolean\n}\n```\n\n### `AutomationQueryOptions`\n\n```ts\ntype AutomationQueryOptions = {\n  dataset: "automation_executions_overview" | "list_automation_definitions"\n}\n```\n\n### `DatasetOptions.AutomationExecutionsOverview`\n\n```ts\ntype DatasetOptions.AutomationExecutionsOverview = {\n  dataset: "automation_executions_overview" | "list_automation_definitions"\n  flow_ids?: string[]\n  execution_states?: string[]\n  relative_time_range?: "all_time" | "this_week" | "last_week" | "last_7_days" | "this_month" | "last_month" | "last_30_days" | "last_3_months" | "last_6_months" | "this_year" | "last_year"\n  time_range_from?: string\n  time_range_to?: string\n}\n```\n\n### `DatasetOptions.ListAutomationDefinitions`\n\n```ts\ntype DatasetOptions.ListAutomationDefinitions = {\n  dataset: "automation_executions_overview" | "list_automation_definitions"\n  search?: string\n}\n```\n\n### `WorkflowsQueryOptions`\n\nSettings for the data of the chart that is being queried.\n\n```ts\ntype WorkflowsQueryOptions = {\n  dataset?: "total_count_of_workflow_executions" | "workflow_execution_time_series" | "cumulative_sum_of_workflows" | "cancellation_reasons" | "phases_count" | "phases_duration" | "tasks_duration" | "task_duration" | "workflow_tasks_overview"\n  workflow_definition_ids?: string[]\n  entity_schemas?: string[]\n  states?: string[]\n  group_time_by?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n  duration_threshold?: number\n}\n```\n\n### `DatasetOptions.TotalCountOfWorkflowExecutions`\n\nSee the total of workflow executions in a pie chart.\n\n```ts\ntype DatasetOptions.TotalCountOfWorkflowExecutions = {\n  workflow_definition_ids?: string[]\n  entity_schema?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n}\n```\n\n### `DatasetOptions.WorkflowExecutionTimeSeries`\n\n```ts\ntype DatasetOptions.WorkflowExecutionTimeSeries = {\n  workflow_definition_ids?: string[]\n  entity_schema?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n  workflow_states?: string[]\n  group_time_by?: string\n}\n```\n\n### `DatasetOptions.CumulativeSumOfWorkflows`\n\n```ts\ntype DatasetOptions.CumulativeSumOfWorkflows = {\n  workflow_definition_ids?: string[]\n  entity_schema?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n  workflow_states?: string[]\n  group_time_by?: string\n}\n```\n\n### `DatasetOptions.CancellationReasons`\n\nSee the cancellation reasons of workflows in a pie chart.\n\n```ts\ntype DatasetOptions.CancellationReasons = {\n  workflow_definition_ids?: string[]\n  entity_schema?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n}\n```\n\n### `DatasetOptions.WorkflowTasksOverview`\n\nGet a list of tasks to help organize executing users their day.\n\n```ts\ntype DatasetOptions.WorkflowTasksOverview = {\n  dataset: "total_count_of_workflow_executions" | "workflow_execution_time_series" | "cumulative_sum_of_workflows" | "cancellation_reasons" | "phases_count" | "phases_duration" | "tasks_duration" | "task_duration" | "workflow_tasks_overview"\n  workflow_definition_ids?: string[]\n  entity_schema?: string\n  relative_time_range?: string\n  time_range_from?: string\n  time_range_to?: string\n  assignee_ids?: string[]\n  include_unassigned?: boolean\n  due_date_from?: string\n  due_date_to?: string\n  sort_by?: string\n  page_number?: number\n  page_size?: number\n}\n```\n\n### `Response.WorkflowTaskOverview`\n\n```ts\ntype Response.WorkflowTaskOverview = {\n  results?: Array<{\n    orgId?: string\n    id?: string\n    definitionId?: string\n    phaseId?: string\n    entityRefId?: string\n    name?: string\n    type?: "MANUAL" | "AUTOMATION"\n    ecp?: {\n      label?: { ... }\n    }\n    requirements?: Array<{\n      definitionId?: { ... }\n      type?: { ... }\n      condition?: { ... }\n    }>\n    executionType?: "MANUAL" | "AUTOMATION"\n    executionId?: string\n    assignedTo?: string[]\n    assignedToInProgress?: string\n    status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS"\n    executionStatus?: "STARTED" | "DONE" | "CLOSED"\n    created?: string\n    lastUpdated?: string\n    dueDate?: string\n    dynamicDueDate?: {\n      numberOfUnits: { ... }\n      timePeriod: { ... }\n      actionTypeCondition?: { ... }\n      stepId?: { ... }\n    }\n    manuallyCreated?: boolean\n    enabled?: boolean\n    automationConfig?: {\n      flowId: { ... }\n      executionId?: { ... }\n      executionStatus?: { ... }\n    }\n    executionName?: string\n    contexts?: Array<{\n      id: { ... }\n      title: { ... }\n      schema: { ... }\n    }>\n  }>\n  hits?: number\n}\n```\n\n### `ECPDetails`\n\nDetails regarding ECP for the workflow step\n\n```ts\ntype ECPDetails = {\n  label?: string\n}\n```\n\n### `WorkflowContext`\n\n```ts\ntype WorkflowContext = {\n  id: string\n  title: string\n  schema: string\n}\n```\n\n### `WorkflowStatus`\n\n```ts\ntype WorkflowStatus = "STARTED" | "DONE" | "CLOSED"\n```\n\n### `AutomationConfig`\n\nConfiguration for automation execution to run\n\n```ts\ntype AutomationConfig = {\n  flowId: string\n  executionId?: string\n  executionStatus?: string\n}\n```\n\n### `DynamicDueDate`\n\nset a Duedate for a step then a specific\n\n```ts\ntype DynamicDueDate = {\n  numberOfUnits: number\n  timePeriod: "days" | "weeks" | "months"\n  actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED"\n  stepId?: string\n}\n```\n\n### `TaskStatus`\n\n```ts\ntype TaskStatus = "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS"\n```\n\n### `TaskRequirement`\n\ndescribe the requirement for step enablement\n\n```ts\ntype TaskRequirement = {\n  definitionId?: string\n  type?: "STEP"\n  condition?: "CLOSED"\n}\n```\n\n### `TaskType`\n\n```ts\ntype TaskType = "MANUAL" | "AUTOMATION"\n```\n\n### `Task`\n\n```ts\ntype Task = {\n  orgId?: string\n  id?: string\n  definitionId?: string\n  phaseId?: string\n  entityRefId?: string\n  name?: string\n  type?: "MANUAL" | "AUTOMATION"\n  ecp?: {\n    label?: string\n  }\n  requirements?: Array<{\n    definitionId?: string\n    type?: "STEP"\n    condition?: "CLOSED"\n  }>\n  executionType?: "MANUAL" | "AUTOMATION"\n  executionId?: string\n  assignedTo?: string[]\n  assignedToInProgress?: string\n  status?: "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS"\n  executionStatus?: "STARTED" | "DONE" | "CLOSED"\n  created?: string\n  lastUpdated?: string\n  dueDate?: string\n  dynamicDueDate?: {\n    numberOfUnits: number\n    timePeriod: "days" | "weeks" | "months"\n    actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED"\n    stepId?: string\n  }\n  manuallyCreated?: boolean\n  enabled?: boolean\n  automationConfig?: {\n    flowId: string\n    executionId?: string\n    executionStatus?: string\n  }\n  executionName?: string\n  contexts?: Array<{\n    id: string\n    title: string\n    schema: string\n  }>\n}\n```\n\n### `WorkflowsQueryOptions.WorkflowDefinitionIDs`\n\nFilter by specific workflows by passing a list of workflow definition ids.\n\n```ts\ntype WorkflowsQueryOptions.WorkflowDefinitionIDs = string[]\n```\n\n### `WorkflowsQueryOptions.EntitySchema`\n\nWorkflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.\nYou can choose to limit your results to workflow executions to specific entity schemas / types.\n\n\n```ts\ntype WorkflowsQueryOptions.EntitySchema = string\n```\n\n### `WorkflowsQueryOptions.RelativeTimeRange`\n\nA combination of two worde that describe a time range, e.g. "this year" or "last month"\n\n```ts\ntype WorkflowsQueryOptions.RelativeTimeRange = string\n```\n\n### `WorkflowsQueryOptions.TimeRangeFrom`\n\nSet a specific start of a time range, e.g. "2023-01-01"\n\n```ts\ntype WorkflowsQueryOptions.TimeRangeFrom = string\n```\n\n### `WorkflowsQueryOptions.TimeRangeTo`\n\nSet a specific end of a time range, e.g. "2023-06-30"\n\n```ts\ntype WorkflowsQueryOptions.TimeRangeTo = string\n```\n\n### `WorkflowsQueryOptions.GroupTimeBy`\n\nIf chosen a time series, this parameter sets by which time the data is grouped, e.g. quarterly, monthly or weekly.  Available values: "D","W","M","Q","Y"\n\n```ts\ntype WorkflowsQueryOptions.GroupTimeBy = string\n```\n\n### `WorkflowsQueryOptions.WorkflowStates`\n\nFilter by the states of the workflow executions.\n\n```ts\ntype WorkflowsQueryOptions.WorkflowStates = string[]\n```\n\n### `DatasetName`\n\n```ts\ntype DatasetName = string\n```\n\n### `EntityDataset`\n\n```ts\ntype EntityDataset = "entity_operations" | "entities_timemachine" | "datalake_raw_sql"\n```\n\n### `AutomationExecutionDataset`\n\n```ts\ntype AutomationExecutionDataset = "automation_executions_overview" | "list_automation_definitions"\n```\n\n### `WorkflowDataset`\n\n```ts\ntype WorkflowDataset = "total_count_of_workflow_executions" | "workflow_execution_time_series" | "cumulative_sum_of_workflows" | "cancellation_reasons" | "phases_count" | "phases_duration" | "tasks_duration" | "task_duration" | "workflow_tasks_overview"\n```\n\n### `WorkflowStates`\n\n```ts\ntype WorkflowStates = "STARTED" | "CLOSED" | "DONE"\n```\n\n### `PhaseStates`\n\n```ts\ntype PhaseStates = "OPEN" | "COMPLETED" | "IN_PROGRESS"\n```\n\n### `TaskStates`\n\n```ts\ntype TaskStates = "OPEN" | "COMPLETED" | "IN_PROGRESS"\n```\n\n### `SortBy`\n\n```ts\ntype SortBy = "due_date_ascending" | "due_date_descending" | "creation_date_ascending" | "creation_date_descending"\n```\n\n### `TimeGroups`\n\n```ts\ntype TimeGroups = "Y" | "Q" | "M" | "W" | "D"\n```\n\n### `RelativeTimeRange`\n\n```ts\ntype RelativeTimeRange = "all_time" | "this_week" | "last_week" | "last_7_days" | "this_month" | "last_month" | "last_30_days" | "last_3_months" | "last_6_months" | "this_year" | "last_year"\n```\n\n### `WorkflowsQueryResult`\n\n```ts\ntype WorkflowsQueryResult = {\n  data?: string | number | Record<string, unknown> | Record<string, unknown>[][] | Record<string, unknown> | string | number\n  labels?: string[]\n  timestamp?: string\n}\n```\n\n### `AutomationExecutionResponse`\n\n```ts\ntype AutomationExecutionResponse = {\n  hits?: number\n  results?: Array<{\n    flow_id: string\n    flow_name?: string\n    execution_id: string\n    execution_status: string\n    entity_schema?: string\n    entity_id?: string\n    created_at: string\n    updated_at?: string\n    error?: {\n      message?: { ... }\n      error_code?: { ... }\n    }\n    trigger_event?: {\n      type?: { ... }\n      trigger_type?: { ... }\n    }\n  }>\n}\n```\n\n### `ListAutomationDefinitionsResponse`\n\n```ts\ntype ListAutomationDefinitionsResponse = {\n  hits?: number\n  results?: Array<{\n    flow_id: string\n    flow_name: string\n    entity_schema?: string\n  }>\n}\n```\n\n### `SemanticModel`\n\nThe semantic model exposing entities, relationships, and query capabilities\n\n```ts\ntype SemanticModel = {\n  entities?: Array<{\n    name?: string\n    displayName?: string\n    schema?: string\n  }>\n  relationships?: Array<{\n    from?: string\n    to?: string\n    relationship?: "hasMany" | "belongsTo" | "hasOne"\n    displayName?: string\n  }>\n  capabilities?: {\n    aggregations?: string[]\n    calculationTypes?: Array<{\n      type?: { ... }\n      description?: { ... }\n      parameters?: { ... }\n    }>\n    granularities?: string[]\n    filterOperators?: Array<{\n      operator?: { ... }\n      description?: { ... }\n    }>\n  }\n}\n```\n\n### `QueryResults`\n\n```ts\ntype QueryResults = {\n  status?: string\n  timestamp?: string\n  results?: Record<string, unknown>[]\n}\n```\n\n### `TimeSeriesSettings`\n\n```ts\ntype TimeSeriesSettings = {\n  dataset?: "time_series"\n  from?: string // date-time\n  to?: string // date-time\n  time_grouper?: string\n  workflow_names?: string[]\n}\n```\n\n### `NameDurationSettings`\n\n```ts\ntype NameDurationSettings = {\n  dataset?: "name_duration"\n  from?: string // date-time\n  to?: string // date-time\n  workflow_name?: string\n}\n```\n';
+export {
+  query_default as default
+};

package/dist/query-runtime-NLOSMDAJ.cjs

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

package/dist/query-runtime-SYJTDUNG.js

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