@epilot/sdk 2.3.1 → 2.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/definitions/data-management-runtime.json +1 -0
- package/definitions/data-management.json +972 -0
- package/definitions/environments-runtime.json +1 -1
- package/definitions/environments.json +183 -7
- package/definitions/erp-integration-runtime.json +1 -0
- package/definitions/erp-integration.json +6780 -0
- package/definitions/query-runtime.json +1 -0
- package/definitions/query.json +3178 -0
- package/definitions/target-runtime.json +1 -0
- package/definitions/target.json +609 -0
- package/dist/README-6UYTPMQO.cjs +7 -0
- package/dist/README-GS3DFP4W.js +7 -0
- package/dist/{_index-O7JDGRSE.cjs → _index-LZFTZV7Z.cjs} +4 -1
- package/dist/{_index-CLT2KTVS.js → _index-X3IADTN2.js} +3 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +8 -8
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- package/dist/apis/environments.js +2 -2
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +38 -0
- package/dist/apis/query.d.cts +18 -0
- package/dist/apis/query.d.ts +18 -0
- package/dist/apis/{erp-integration.js → query.js} +11 -11
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +38 -0
- package/dist/apis/target.d.cts +597 -0
- package/dist/apis/target.d.ts +597 -0
- package/dist/apis/target.js +38 -0
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/chunk-2LEEXRJX.js +14 -0
- package/dist/chunk-EYKEVZME.cjs +14 -0
- package/dist/{chunk-TXDVGTQD.cjs → chunk-I6DG26UJ.cjs} +1 -1
- package/dist/{chunk-TKTSGA7G.cjs → chunk-LS3ISLMD.cjs} +9 -5
- package/dist/chunk-MM5JDJFO.js +14 -0
- package/dist/chunk-RMP2HHCR.js +14 -0
- package/dist/chunk-XDZ2JKJ4.cjs +14 -0
- package/dist/{chunk-QSEIJWJW.js → chunk-YVN2SRSQ.js} +9 -5
- package/dist/environments-PXJOTQVM.js +7 -0
- package/dist/environments-QJ4UMJ5C.cjs +7 -0
- package/dist/{environments-runtime-BPR47PW7.js → environments-runtime-NKHLZJB3.js} +1 -1
- package/dist/{environments-runtime-L6TJCVW6.cjs → environments-runtime-QC2BUHBW.cjs} +2 -2
- package/dist/{environments.d-H3LK_KuH.d.cts → environments.d-BvqvN-PD.d.cts} +134 -5
- package/dist/{environments.d-H3LK_KuH.d.ts → environments.d-BvqvN-PD.d.ts} +134 -5
- package/dist/erp-integration-runtime-JGVGQ22V.js +13 -0
- package/dist/erp-integration-runtime-OZ4YSTQX.cjs +13 -0
- package/dist/index.cjs +26 -18
- package/dist/index.d.cts +23 -21
- package/dist/index.d.ts +23 -21
- package/dist/index.js +19 -11
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/dist/query-JSDB2F2U.cjs +7 -0
- package/dist/query-RJ4M25PA.js +7 -0
- package/dist/query-runtime-NLOSMDAJ.cjs +5 -0
- package/dist/query-runtime-SYJTDUNG.js +5 -0
- package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
- package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
- package/dist/target-3RS5BN2B.cjs +7 -0
- package/dist/target-5MKRXCHX.js +7 -0
- package/dist/target-runtime-BMJ7EARM.cjs +5 -0
- package/dist/target-runtime-PBF3WYL7.js +5 -0
- package/docs/environments.md +127 -3
- package/docs/query.md +1609 -0
- package/docs/target.md +741 -0
- package/package.json +10 -1
- package/dist/README-KX4XC2HB.js +0 -7
- package/dist/README-PTYV6PQI.cjs +0 -7
- package/dist/apis/erp-integration.cjs +0 -38
- package/dist/apis/erp-integration.d.cts +0 -5770
- package/dist/apis/erp-integration.d.ts +0 -5770
- package/dist/chunk-6OYECNL2.js +0 -14
- package/dist/chunk-MUNMUGB5.js +0 -14
- package/dist/chunk-TLH6XOTL.cjs +0 -14
- package/dist/environments-E3X6NYGX.js +0 -7
- package/dist/environments-P2JS4F5N.cjs +0 -7
- package/dist/erp-integration-runtime-BHHWMG4O.js +0 -5
- package/dist/erp-integration-runtime-Y6VWGQ3L.cjs +0 -5
|
@@ -0,0 +1,2375 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from query-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Responses {
|
|
8
|
+
export type BadRequestResponse = /* Standard error response body */ Schemas.ErrorResponse;
|
|
9
|
+
export type ForbiddenResponse = /* Standard error response body */ Schemas.ErrorResponse;
|
|
10
|
+
export type InternalServerErrorResponse = /* Standard error response body */ Schemas.ErrorResponse;
|
|
11
|
+
export type NotFoundResponse = /* Standard error response body */ Schemas.ErrorResponse;
|
|
12
|
+
export type UnauthorizedResponse = /* Standard error response body */ Schemas.ErrorResponse;
|
|
13
|
+
}
|
|
14
|
+
namespace Schemas {
|
|
15
|
+
/**
|
|
16
|
+
* Configuration for automation execution to run
|
|
17
|
+
*/
|
|
18
|
+
export interface AutomationConfig {
|
|
19
|
+
/**
|
|
20
|
+
* Id of the configured automation to run
|
|
21
|
+
*/
|
|
22
|
+
flowId: string;
|
|
23
|
+
/**
|
|
24
|
+
* Id of the automation execution which ran
|
|
25
|
+
*/
|
|
26
|
+
executionId?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Status of Automation Execution. Types can be found in Automation API
|
|
29
|
+
*/
|
|
30
|
+
executionStatus?: string;
|
|
31
|
+
}
|
|
32
|
+
export type AutomationExecutionDataset = "automation_executions_overview" | "list_automation_definitions";
|
|
33
|
+
export interface AutomationExecutionResponse {
|
|
34
|
+
/**
|
|
35
|
+
* Total number of execution records found
|
|
36
|
+
* example:
|
|
37
|
+
* 100
|
|
38
|
+
*/
|
|
39
|
+
hits?: number;
|
|
40
|
+
/**
|
|
41
|
+
* List of automation execution records
|
|
42
|
+
*/
|
|
43
|
+
results?: {
|
|
44
|
+
/**
|
|
45
|
+
* Unique identifier for the automation flow
|
|
46
|
+
* example:
|
|
47
|
+
* 1234567890
|
|
48
|
+
*/
|
|
49
|
+
flow_id: string;
|
|
50
|
+
/**
|
|
51
|
+
* Name of the automation flow
|
|
52
|
+
* example:
|
|
53
|
+
* flow_name
|
|
54
|
+
*/
|
|
55
|
+
flow_name?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Unique identifier for the execution instance
|
|
58
|
+
* example:
|
|
59
|
+
* execution_id
|
|
60
|
+
*/
|
|
61
|
+
execution_id: string;
|
|
62
|
+
/**
|
|
63
|
+
* Current status of the execution
|
|
64
|
+
* example:
|
|
65
|
+
* execution_status
|
|
66
|
+
*/
|
|
67
|
+
execution_status: string;
|
|
68
|
+
/**
|
|
69
|
+
* Entity schema associated with the flow
|
|
70
|
+
* example:
|
|
71
|
+
* opportunity
|
|
72
|
+
*/
|
|
73
|
+
entity_schema?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Identifier of the entity associated with the execution
|
|
76
|
+
* example:
|
|
77
|
+
* entity_id
|
|
78
|
+
*/
|
|
79
|
+
entity_id?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Timestamp when the execution was created
|
|
82
|
+
* example:
|
|
83
|
+
* execution_created_at
|
|
84
|
+
*/
|
|
85
|
+
created_at: string;
|
|
86
|
+
/**
|
|
87
|
+
* Timestamp when the execution was last updated
|
|
88
|
+
* example:
|
|
89
|
+
* execution_updated_at
|
|
90
|
+
*/
|
|
91
|
+
updated_at?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Error details if execution failed
|
|
94
|
+
*/
|
|
95
|
+
error?: {
|
|
96
|
+
/**
|
|
97
|
+
* Error message
|
|
98
|
+
* example:
|
|
99
|
+
* error_message
|
|
100
|
+
*/
|
|
101
|
+
message?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Error code
|
|
104
|
+
* example:
|
|
105
|
+
* error_code
|
|
106
|
+
*/
|
|
107
|
+
error_code?: string;
|
|
108
|
+
};
|
|
109
|
+
/**
|
|
110
|
+
* Event that triggered the automation
|
|
111
|
+
*/
|
|
112
|
+
trigger_event?: {
|
|
113
|
+
[name: string]: any;
|
|
114
|
+
/**
|
|
115
|
+
* Type of the trigger event
|
|
116
|
+
* example:
|
|
117
|
+
* EntityOperation
|
|
118
|
+
*/
|
|
119
|
+
type?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Type of operation trigger
|
|
122
|
+
* example:
|
|
123
|
+
* createEntity
|
|
124
|
+
*/
|
|
125
|
+
trigger_type?: string;
|
|
126
|
+
};
|
|
127
|
+
}[];
|
|
128
|
+
}
|
|
129
|
+
export interface AutomationQueryOptions {
|
|
130
|
+
[name: string]: any;
|
|
131
|
+
dataset: AutomationExecutionDataset;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Cache Expiration timestamp
|
|
135
|
+
* example:
|
|
136
|
+
* 1663308898789
|
|
137
|
+
*/
|
|
138
|
+
export type CacheExpiration = string; // timestamp
|
|
139
|
+
/**
|
|
140
|
+
* example:
|
|
141
|
+
* {
|
|
142
|
+
* "view_name": "some_view",
|
|
143
|
+
* "source_dataset": "current_entities",
|
|
144
|
+
* "config": {
|
|
145
|
+
* "schema": "some_schema",
|
|
146
|
+
* "include_purpose_view": true,
|
|
147
|
+
* "include_label_view": true,
|
|
148
|
+
* "include_relation_view": true,
|
|
149
|
+
* "relationship_attribute": [
|
|
150
|
+
* "some_relationship_attribute"
|
|
151
|
+
* ]
|
|
152
|
+
* }
|
|
153
|
+
* }
|
|
154
|
+
*/
|
|
155
|
+
export interface CurrentEntitiesViewRequest {
|
|
156
|
+
view_name?: string;
|
|
157
|
+
source_dataset: "current_entities";
|
|
158
|
+
config: {
|
|
159
|
+
schema: string;
|
|
160
|
+
include_purpose_view?: boolean;
|
|
161
|
+
include_label_view?: boolean;
|
|
162
|
+
include_relation_view?: boolean;
|
|
163
|
+
relationship_attribute?: string[];
|
|
164
|
+
};
|
|
165
|
+
}
|
|
166
|
+
export type DatalakeQuery = DatalakeQueryOptions;
|
|
167
|
+
export interface DatalakeQueryOptions {
|
|
168
|
+
[name: string]: any;
|
|
169
|
+
/**
|
|
170
|
+
* example:
|
|
171
|
+
* entity_operations
|
|
172
|
+
*/
|
|
173
|
+
dataset?: string;
|
|
174
|
+
/**
|
|
175
|
+
* example:
|
|
176
|
+
* count_operations
|
|
177
|
+
*/
|
|
178
|
+
measure?: string;
|
|
179
|
+
dimensions?: {
|
|
180
|
+
[name: string]: any;
|
|
181
|
+
}[];
|
|
182
|
+
filters?: {
|
|
183
|
+
[name: string]: any;
|
|
184
|
+
}[];
|
|
185
|
+
/**
|
|
186
|
+
* example:
|
|
187
|
+
* true
|
|
188
|
+
*/
|
|
189
|
+
exclude_deleted?: boolean;
|
|
190
|
+
}
|
|
191
|
+
export interface Dataset {
|
|
192
|
+
dataset?: /**
|
|
193
|
+
* example:
|
|
194
|
+
* entity_operations
|
|
195
|
+
*/
|
|
196
|
+
DatasetName;
|
|
197
|
+
domain?: DatasetDomain;
|
|
198
|
+
/**
|
|
199
|
+
* example:
|
|
200
|
+
* /v2/query/entities
|
|
201
|
+
*/
|
|
202
|
+
endpoint?: string;
|
|
203
|
+
}
|
|
204
|
+
export type DatasetDomain = "entities" | "workflows";
|
|
205
|
+
/**
|
|
206
|
+
* example:
|
|
207
|
+
* entity_operations
|
|
208
|
+
*/
|
|
209
|
+
export type DatasetName = string & (/**
|
|
210
|
+
* example:
|
|
211
|
+
* entity_operations
|
|
212
|
+
*/
|
|
213
|
+
EntityDataset | WorkflowDataset);
|
|
214
|
+
export interface DatasetOptionsAutomationExecutionsOverview {
|
|
215
|
+
[name: string]: any;
|
|
216
|
+
dataset: AutomationExecutionDataset;
|
|
217
|
+
/**
|
|
218
|
+
* Automation Flow IDs
|
|
219
|
+
* Filter by specific automation executions passing a list of automation flow ids.
|
|
220
|
+
*/
|
|
221
|
+
flow_ids?: string[];
|
|
222
|
+
/**
|
|
223
|
+
* Automation Execution State
|
|
224
|
+
* Filter by the states of the automation executions. Use "scheduled" to filter executions that have scheduled actions. Multiple states are combined with OR logic.
|
|
225
|
+
*
|
|
226
|
+
* example:
|
|
227
|
+
* [
|
|
228
|
+
* "success",
|
|
229
|
+
* "failed",
|
|
230
|
+
* "scheduled"
|
|
231
|
+
* ]
|
|
232
|
+
*/
|
|
233
|
+
execution_states?: string[];
|
|
234
|
+
relative_time_range?: RelativeTimeRange;
|
|
235
|
+
/**
|
|
236
|
+
* Start date in YYYY-MM-DD format
|
|
237
|
+
*/
|
|
238
|
+
time_range_from?: string;
|
|
239
|
+
/**
|
|
240
|
+
* End date in YYYY-MM-DD format
|
|
241
|
+
*/
|
|
242
|
+
time_range_to?: string;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Dataset Options: Cancellation Reasons
|
|
246
|
+
* See the cancellation reasons of workflows in a pie chart.
|
|
247
|
+
*/
|
|
248
|
+
export interface DatasetOptionsCancellationReasons {
|
|
249
|
+
workflow_definition_ids?: /**
|
|
250
|
+
* Workflow Definition IDs
|
|
251
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
252
|
+
*/
|
|
253
|
+
WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
254
|
+
entity_schema?: /**
|
|
255
|
+
* Entity Schema
|
|
256
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
257
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
258
|
+
*
|
|
259
|
+
* example:
|
|
260
|
+
* Opportunity
|
|
261
|
+
*/
|
|
262
|
+
WorkflowsQueryOptionsEntitySchema;
|
|
263
|
+
relative_time_range?: /**
|
|
264
|
+
* Relative Time Range
|
|
265
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
266
|
+
* example:
|
|
267
|
+
* this year
|
|
268
|
+
*/
|
|
269
|
+
WorkflowsQueryOptionsRelativeTimeRange;
|
|
270
|
+
time_range_from?: /**
|
|
271
|
+
* Time Range From
|
|
272
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
273
|
+
* example:
|
|
274
|
+
* 2023-01-01
|
|
275
|
+
*/
|
|
276
|
+
WorkflowsQueryOptionsTimeRangeFrom;
|
|
277
|
+
time_range_to?: /**
|
|
278
|
+
* Time Range To
|
|
279
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
280
|
+
* example:
|
|
281
|
+
* 2023-06-01
|
|
282
|
+
*/
|
|
283
|
+
WorkflowsQueryOptionsTimeRangeTo;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* Dataset Options: Cumulative Sum of Workflows
|
|
287
|
+
*/
|
|
288
|
+
export interface DatasetOptionsCumulativeSumOfWorkflows {
|
|
289
|
+
workflow_definition_ids?: /**
|
|
290
|
+
* Workflow Definition IDs
|
|
291
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
292
|
+
*/
|
|
293
|
+
WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
294
|
+
entity_schema?: /**
|
|
295
|
+
* Entity Schema
|
|
296
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
297
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
298
|
+
*
|
|
299
|
+
* example:
|
|
300
|
+
* Opportunity
|
|
301
|
+
*/
|
|
302
|
+
WorkflowsQueryOptionsEntitySchema;
|
|
303
|
+
relative_time_range?: /**
|
|
304
|
+
* Relative Time Range
|
|
305
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
306
|
+
* example:
|
|
307
|
+
* this year
|
|
308
|
+
*/
|
|
309
|
+
WorkflowsQueryOptionsRelativeTimeRange;
|
|
310
|
+
time_range_from?: /**
|
|
311
|
+
* Time Range From
|
|
312
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
313
|
+
* example:
|
|
314
|
+
* 2023-01-01
|
|
315
|
+
*/
|
|
316
|
+
WorkflowsQueryOptionsTimeRangeFrom;
|
|
317
|
+
time_range_to?: /**
|
|
318
|
+
* Time Range To
|
|
319
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
320
|
+
* example:
|
|
321
|
+
* 2023-06-01
|
|
322
|
+
*/
|
|
323
|
+
WorkflowsQueryOptionsTimeRangeTo;
|
|
324
|
+
workflow_states?: /**
|
|
325
|
+
* Workflow States
|
|
326
|
+
* Filter by the states of the workflow executions.
|
|
327
|
+
*/
|
|
328
|
+
WorkflowsQueryOptionsWorkflowStates;
|
|
329
|
+
group_time_by?: /**
|
|
330
|
+
* Group Time By
|
|
331
|
+
* If 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"
|
|
332
|
+
*/
|
|
333
|
+
WorkflowsQueryOptionsGroupTimeBy;
|
|
334
|
+
}
|
|
335
|
+
export interface DatasetOptionsListAutomationDefinitions {
|
|
336
|
+
[name: string]: any;
|
|
337
|
+
dataset: AutomationExecutionDataset;
|
|
338
|
+
/**
|
|
339
|
+
* Search term to filter automation definitions
|
|
340
|
+
*/
|
|
341
|
+
search?: string;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* Dataset Options: Total Count of Workflow Executions
|
|
345
|
+
* See the total of workflow executions in a pie chart.
|
|
346
|
+
*/
|
|
347
|
+
export interface DatasetOptionsTotalCountOfWorkflowExecutions {
|
|
348
|
+
workflow_definition_ids?: /**
|
|
349
|
+
* Workflow Definition IDs
|
|
350
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
351
|
+
*/
|
|
352
|
+
WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
353
|
+
entity_schema?: /**
|
|
354
|
+
* Entity Schema
|
|
355
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
356
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
357
|
+
*
|
|
358
|
+
* example:
|
|
359
|
+
* Opportunity
|
|
360
|
+
*/
|
|
361
|
+
WorkflowsQueryOptionsEntitySchema;
|
|
362
|
+
relative_time_range?: /**
|
|
363
|
+
* Relative Time Range
|
|
364
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
365
|
+
* example:
|
|
366
|
+
* this year
|
|
367
|
+
*/
|
|
368
|
+
WorkflowsQueryOptionsRelativeTimeRange;
|
|
369
|
+
time_range_from?: /**
|
|
370
|
+
* Time Range From
|
|
371
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
372
|
+
* example:
|
|
373
|
+
* 2023-01-01
|
|
374
|
+
*/
|
|
375
|
+
WorkflowsQueryOptionsTimeRangeFrom;
|
|
376
|
+
time_range_to?: /**
|
|
377
|
+
* Time Range To
|
|
378
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
379
|
+
* example:
|
|
380
|
+
* 2023-06-01
|
|
381
|
+
*/
|
|
382
|
+
WorkflowsQueryOptionsTimeRangeTo;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Dataset Options: Workflow Execution Time Series
|
|
386
|
+
*/
|
|
387
|
+
export interface DatasetOptionsWorkflowExecutionTimeSeries {
|
|
388
|
+
workflow_definition_ids?: /**
|
|
389
|
+
* Workflow Definition IDs
|
|
390
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
391
|
+
*/
|
|
392
|
+
WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
393
|
+
entity_schema?: /**
|
|
394
|
+
* Entity Schema
|
|
395
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
396
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
397
|
+
*
|
|
398
|
+
* example:
|
|
399
|
+
* Opportunity
|
|
400
|
+
*/
|
|
401
|
+
WorkflowsQueryOptionsEntitySchema;
|
|
402
|
+
relative_time_range?: /**
|
|
403
|
+
* Relative Time Range
|
|
404
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
405
|
+
* example:
|
|
406
|
+
* this year
|
|
407
|
+
*/
|
|
408
|
+
WorkflowsQueryOptionsRelativeTimeRange;
|
|
409
|
+
time_range_from?: /**
|
|
410
|
+
* Time Range From
|
|
411
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
412
|
+
* example:
|
|
413
|
+
* 2023-01-01
|
|
414
|
+
*/
|
|
415
|
+
WorkflowsQueryOptionsTimeRangeFrom;
|
|
416
|
+
time_range_to?: /**
|
|
417
|
+
* Time Range To
|
|
418
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
419
|
+
* example:
|
|
420
|
+
* 2023-06-01
|
|
421
|
+
*/
|
|
422
|
+
WorkflowsQueryOptionsTimeRangeTo;
|
|
423
|
+
workflow_states?: /**
|
|
424
|
+
* Workflow States
|
|
425
|
+
* Filter by the states of the workflow executions.
|
|
426
|
+
*/
|
|
427
|
+
WorkflowsQueryOptionsWorkflowStates;
|
|
428
|
+
group_time_by?: /**
|
|
429
|
+
* Group Time By
|
|
430
|
+
* If 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"
|
|
431
|
+
*/
|
|
432
|
+
WorkflowsQueryOptionsGroupTimeBy;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Dataset Options: Workflow Tasks Overview
|
|
436
|
+
* Get a list of tasks to help organize executing users their day.
|
|
437
|
+
*/
|
|
438
|
+
export interface DatasetOptionsWorkflowTasksOverview {
|
|
439
|
+
dataset: WorkflowDataset;
|
|
440
|
+
workflow_definition_ids?: /**
|
|
441
|
+
* Workflow Definition IDs
|
|
442
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
443
|
+
*/
|
|
444
|
+
WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
445
|
+
entity_schema?: /**
|
|
446
|
+
* Entity Schema
|
|
447
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
448
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
449
|
+
*
|
|
450
|
+
* example:
|
|
451
|
+
* Opportunity
|
|
452
|
+
*/
|
|
453
|
+
WorkflowsQueryOptionsEntitySchema;
|
|
454
|
+
relative_time_range?: /**
|
|
455
|
+
* Relative Time Range
|
|
456
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
457
|
+
* example:
|
|
458
|
+
* this year
|
|
459
|
+
*/
|
|
460
|
+
WorkflowsQueryOptionsRelativeTimeRange;
|
|
461
|
+
time_range_from?: /**
|
|
462
|
+
* Time Range From
|
|
463
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
464
|
+
* example:
|
|
465
|
+
* 2023-01-01
|
|
466
|
+
*/
|
|
467
|
+
WorkflowsQueryOptionsTimeRangeFrom;
|
|
468
|
+
time_range_to?: /**
|
|
469
|
+
* Time Range To
|
|
470
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
471
|
+
* example:
|
|
472
|
+
* 2023-06-01
|
|
473
|
+
*/
|
|
474
|
+
WorkflowsQueryOptionsTimeRangeTo;
|
|
475
|
+
/**
|
|
476
|
+
* Assignee ID
|
|
477
|
+
*
|
|
478
|
+
*/
|
|
479
|
+
assignee_ids?: string[];
|
|
480
|
+
/**
|
|
481
|
+
* Include Unassigned
|
|
482
|
+
*/
|
|
483
|
+
include_unassigned?: boolean;
|
|
484
|
+
/**
|
|
485
|
+
* Due Date From
|
|
486
|
+
* If chosen a time series, specify the start date in the format YYYY-MM-DD, e.g. 2023-01-01.
|
|
487
|
+
*/
|
|
488
|
+
due_date_from?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Due Date To
|
|
491
|
+
* If chosen a time series, specify the end date in the format YYYY-MM-DD, e.g. 2023-03-31.
|
|
492
|
+
*/
|
|
493
|
+
due_date_to?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Sort By
|
|
496
|
+
*/
|
|
497
|
+
sort_by?: string & (/* Sort By */ SortBy);
|
|
498
|
+
/**
|
|
499
|
+
* Page Number
|
|
500
|
+
* Pagination page number
|
|
501
|
+
*/
|
|
502
|
+
page_number?: number;
|
|
503
|
+
/**
|
|
504
|
+
* Page Size
|
|
505
|
+
* Number of tasks per page
|
|
506
|
+
*/
|
|
507
|
+
page_size?: number;
|
|
508
|
+
}
|
|
509
|
+
/**
|
|
510
|
+
* set a Duedate for a step then a specific
|
|
511
|
+
*/
|
|
512
|
+
export interface DynamicDueDate {
|
|
513
|
+
numberOfUnits: number;
|
|
514
|
+
timePeriod: "days" | "weeks" | "months";
|
|
515
|
+
actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED";
|
|
516
|
+
stepId?: string;
|
|
517
|
+
}
|
|
518
|
+
/**
|
|
519
|
+
* Details regarding ECP for the workflow step
|
|
520
|
+
*/
|
|
521
|
+
export interface ECPDetails {
|
|
522
|
+
label?: string;
|
|
523
|
+
}
|
|
524
|
+
export type EntityDataset = "entity_operations" | "entities_timemachine" | "datalake_raw_sql";
|
|
525
|
+
/**
|
|
526
|
+
* Standard error response body
|
|
527
|
+
*/
|
|
528
|
+
export interface ErrorResponse {
|
|
529
|
+
/**
|
|
530
|
+
* HTTP status code
|
|
531
|
+
* example:
|
|
532
|
+
* 400
|
|
533
|
+
*/
|
|
534
|
+
status?: number;
|
|
535
|
+
/**
|
|
536
|
+
* Short error label
|
|
537
|
+
* example:
|
|
538
|
+
* Bad Request
|
|
539
|
+
*/
|
|
540
|
+
error?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Human-readable description of the error
|
|
543
|
+
* example:
|
|
544
|
+
* Invalid query parameters provided
|
|
545
|
+
*/
|
|
546
|
+
message?: string;
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
* example:
|
|
550
|
+
* {
|
|
551
|
+
* "hits": 100,
|
|
552
|
+
* "results": [
|
|
553
|
+
* {
|
|
554
|
+
* "flow_id": "flow_123",
|
|
555
|
+
* "flow_name": "Email Notification Flow",
|
|
556
|
+
* "entity_schema": "opportunity"
|
|
557
|
+
* },
|
|
558
|
+
* {
|
|
559
|
+
* "flow_id": "flow_456",
|
|
560
|
+
* "flow_name": "SMS Alert Flow",
|
|
561
|
+
* "entity_schema": "customer"
|
|
562
|
+
* }
|
|
563
|
+
* ]
|
|
564
|
+
* }
|
|
565
|
+
*/
|
|
566
|
+
export interface ListAutomationDefinitionsResponse {
|
|
567
|
+
/**
|
|
568
|
+
* Total number of automation definitions found
|
|
569
|
+
* example:
|
|
570
|
+
* 100
|
|
571
|
+
*/
|
|
572
|
+
hits?: number;
|
|
573
|
+
/**
|
|
574
|
+
* List of automation definitions
|
|
575
|
+
*/
|
|
576
|
+
results?: {
|
|
577
|
+
/**
|
|
578
|
+
* Unique identifier for the automation flow
|
|
579
|
+
* example:
|
|
580
|
+
* flow_123
|
|
581
|
+
*/
|
|
582
|
+
flow_id: string;
|
|
583
|
+
/**
|
|
584
|
+
* Name of the automation flow
|
|
585
|
+
* example:
|
|
586
|
+
* Email Notification Flow
|
|
587
|
+
*/
|
|
588
|
+
flow_name: string;
|
|
589
|
+
/**
|
|
590
|
+
* Entity schema associated with the flow
|
|
591
|
+
* example:
|
|
592
|
+
* opportunity
|
|
593
|
+
*/
|
|
594
|
+
entity_schema?: string;
|
|
595
|
+
}[];
|
|
596
|
+
}
|
|
597
|
+
export interface NameDurationSettings {
|
|
598
|
+
dataset?: "name_duration";
|
|
599
|
+
from?: string; // date-time
|
|
600
|
+
to?: string; // date-time
|
|
601
|
+
workflow_name?: string;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* example:
|
|
605
|
+
* false
|
|
606
|
+
*/
|
|
607
|
+
export type NoCache = boolean;
|
|
608
|
+
export type PhaseStates = "OPEN" | "COMPLETED" | "IN_PROGRESS";
|
|
609
|
+
export interface QueryResults {
|
|
610
|
+
/**
|
|
611
|
+
* example:
|
|
612
|
+
* FINISHED
|
|
613
|
+
*/
|
|
614
|
+
status?: string;
|
|
615
|
+
/**
|
|
616
|
+
* example:
|
|
617
|
+
* 1715621496068
|
|
618
|
+
*/
|
|
619
|
+
timestamp?: string;
|
|
620
|
+
results?: {
|
|
621
|
+
[name: string]: any;
|
|
622
|
+
}[];
|
|
623
|
+
}
|
|
624
|
+
/**
|
|
625
|
+
* example:
|
|
626
|
+
* {
|
|
627
|
+
* "relationship_name": "some_relationship",
|
|
628
|
+
* "from_table": "some_table",
|
|
629
|
+
* "to_table": "some_table",
|
|
630
|
+
* "from_column": "some_column",
|
|
631
|
+
* "to_column": "some_column",
|
|
632
|
+
* "type": "one_to_many"
|
|
633
|
+
* }
|
|
634
|
+
*/
|
|
635
|
+
export interface RelationshipRequest {
|
|
636
|
+
/**
|
|
637
|
+
* Unique identifier for the relationship
|
|
638
|
+
*/
|
|
639
|
+
relationship_name: string;
|
|
640
|
+
/**
|
|
641
|
+
* Source table name
|
|
642
|
+
*/
|
|
643
|
+
from_table: string;
|
|
644
|
+
/**
|
|
645
|
+
* Target table name
|
|
646
|
+
*/
|
|
647
|
+
to_table: string;
|
|
648
|
+
/**
|
|
649
|
+
* Source column name
|
|
650
|
+
*/
|
|
651
|
+
from_column: string;
|
|
652
|
+
/**
|
|
653
|
+
* Target column name
|
|
654
|
+
*/
|
|
655
|
+
to_column: string;
|
|
656
|
+
type: "one_to_many" | "many_to_many" | "many_to_one" | "one_to_one";
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* example:
|
|
660
|
+
* {
|
|
661
|
+
* "relationship_name": "some_relationship",
|
|
662
|
+
* "from_table": "some_table",
|
|
663
|
+
* "to_table": "some_table",
|
|
664
|
+
* "from_column": "some_column",
|
|
665
|
+
* "to_column": "some_column",
|
|
666
|
+
* "type": "one_to_many"
|
|
667
|
+
* }
|
|
668
|
+
*/
|
|
669
|
+
export interface RelationshipResponse {
|
|
670
|
+
relationship_name?: string;
|
|
671
|
+
from_table?: string;
|
|
672
|
+
to_table?: string;
|
|
673
|
+
from_column?: string;
|
|
674
|
+
to_column?: string;
|
|
675
|
+
type?: "one_to_many" | "many_to_many" | "many_to_one" | "one_to_one";
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* example:
|
|
679
|
+
* {
|
|
680
|
+
* "relationships": [
|
|
681
|
+
* {
|
|
682
|
+
* "relationship_name": "some_relationship",
|
|
683
|
+
* "from_table": "some_table",
|
|
684
|
+
* "to_table": "some_table",
|
|
685
|
+
* "from_column": "some_column",
|
|
686
|
+
* "to_column": "some_column",
|
|
687
|
+
* "type": "one_to_many"
|
|
688
|
+
* },
|
|
689
|
+
* {
|
|
690
|
+
* "relationship_name": "another_relationship",
|
|
691
|
+
* "from_table": "table_a",
|
|
692
|
+
* "to_table": "table_b",
|
|
693
|
+
* "from_column": "column_a",
|
|
694
|
+
* "to_column": "column_b",
|
|
695
|
+
* "type": "many_to_many"
|
|
696
|
+
* }
|
|
697
|
+
* ]
|
|
698
|
+
* }
|
|
699
|
+
*/
|
|
700
|
+
export interface RelationshipsListResponse {
|
|
701
|
+
relationships?: /**
|
|
702
|
+
* example:
|
|
703
|
+
* {
|
|
704
|
+
* "relationship_name": "some_relationship",
|
|
705
|
+
* "from_table": "some_table",
|
|
706
|
+
* "to_table": "some_table",
|
|
707
|
+
* "from_column": "some_column",
|
|
708
|
+
* "to_column": "some_column",
|
|
709
|
+
* "type": "one_to_many"
|
|
710
|
+
* }
|
|
711
|
+
*/
|
|
712
|
+
RelationshipResponse[];
|
|
713
|
+
}
|
|
714
|
+
export type 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";
|
|
715
|
+
export interface ResponseWorkflowTaskOverview {
|
|
716
|
+
results?: Task[];
|
|
717
|
+
hits?: number;
|
|
718
|
+
}
|
|
719
|
+
/**
|
|
720
|
+
* The semantic model exposing entities, relationships, and query capabilities
|
|
721
|
+
*/
|
|
722
|
+
export interface SemanticModel {
|
|
723
|
+
/**
|
|
724
|
+
* Available entity tables that can be queried
|
|
725
|
+
*/
|
|
726
|
+
entities?: {
|
|
727
|
+
/**
|
|
728
|
+
* Table identifier used in queries
|
|
729
|
+
* example:
|
|
730
|
+
* current_contacts
|
|
731
|
+
*/
|
|
732
|
+
name?: string;
|
|
733
|
+
/**
|
|
734
|
+
* Human-readable name
|
|
735
|
+
* example:
|
|
736
|
+
* Contacts
|
|
737
|
+
*/
|
|
738
|
+
displayName?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Schema type (entity, workflow, purpose)
|
|
741
|
+
* example:
|
|
742
|
+
* entity
|
|
743
|
+
*/
|
|
744
|
+
schema?: string;
|
|
745
|
+
}[];
|
|
746
|
+
/**
|
|
747
|
+
* Relationships between entities for JOIN operations
|
|
748
|
+
*/
|
|
749
|
+
relationships?: {
|
|
750
|
+
/**
|
|
751
|
+
* example:
|
|
752
|
+
* current_contacts
|
|
753
|
+
*/
|
|
754
|
+
from?: string;
|
|
755
|
+
/**
|
|
756
|
+
* example:
|
|
757
|
+
* opportunity_account_contact_relation
|
|
758
|
+
*/
|
|
759
|
+
to?: string;
|
|
760
|
+
relationship?: "hasMany" | "belongsTo" | "hasOne";
|
|
761
|
+
/**
|
|
762
|
+
* example:
|
|
763
|
+
* Contact has many Opportunities
|
|
764
|
+
*/
|
|
765
|
+
displayName?: string;
|
|
766
|
+
}[];
|
|
767
|
+
/**
|
|
768
|
+
* Supported query capabilities
|
|
769
|
+
*/
|
|
770
|
+
capabilities?: {
|
|
771
|
+
/**
|
|
772
|
+
* example:
|
|
773
|
+
* [
|
|
774
|
+
* "count",
|
|
775
|
+
* "count_distinct",
|
|
776
|
+
* "sum",
|
|
777
|
+
* "average",
|
|
778
|
+
* "min",
|
|
779
|
+
* "max",
|
|
780
|
+
* "median"
|
|
781
|
+
* ]
|
|
782
|
+
*/
|
|
783
|
+
aggregations?: string[];
|
|
784
|
+
calculationTypes?: {
|
|
785
|
+
type?: string;
|
|
786
|
+
description?: string;
|
|
787
|
+
parameters?: {
|
|
788
|
+
[name: string]: string;
|
|
789
|
+
};
|
|
790
|
+
}[];
|
|
791
|
+
/**
|
|
792
|
+
* example:
|
|
793
|
+
* [
|
|
794
|
+
* "day",
|
|
795
|
+
* "week",
|
|
796
|
+
* "month",
|
|
797
|
+
* "quarter",
|
|
798
|
+
* "year"
|
|
799
|
+
* ]
|
|
800
|
+
*/
|
|
801
|
+
granularities?: string[];
|
|
802
|
+
filterOperators?: {
|
|
803
|
+
operator?: string;
|
|
804
|
+
description?: string;
|
|
805
|
+
}[];
|
|
806
|
+
};
|
|
807
|
+
}
|
|
808
|
+
export type SortBy = "due_date_ascending" | "due_date_descending" | "creation_date_ascending" | "creation_date_descending";
|
|
809
|
+
export interface Task {
|
|
810
|
+
orgId?: string;
|
|
811
|
+
id?: string;
|
|
812
|
+
definitionId?: string;
|
|
813
|
+
phaseId?: string;
|
|
814
|
+
entityRefId?: string;
|
|
815
|
+
name?: string;
|
|
816
|
+
type?: TaskType;
|
|
817
|
+
ecp?: /* Details regarding ECP for the workflow step */ ECPDetails;
|
|
818
|
+
requirements?: /* describe the requirement for step enablement */ TaskRequirement[];
|
|
819
|
+
/**
|
|
820
|
+
* Manual / Automation step
|
|
821
|
+
*/
|
|
822
|
+
executionType?: TaskType;
|
|
823
|
+
executionId?: string;
|
|
824
|
+
assignedTo?: string[];
|
|
825
|
+
/**
|
|
826
|
+
* The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task
|
|
827
|
+
*/
|
|
828
|
+
assignedToInProgress?: string;
|
|
829
|
+
status?: TaskStatus;
|
|
830
|
+
executionStatus?: WorkflowStatus;
|
|
831
|
+
created?: string;
|
|
832
|
+
lastUpdated?: string;
|
|
833
|
+
dueDate?: string;
|
|
834
|
+
dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
|
|
835
|
+
manuallyCreated?: boolean;
|
|
836
|
+
/**
|
|
837
|
+
* enabled flag results from calculating the requirements
|
|
838
|
+
*/
|
|
839
|
+
enabled?: boolean;
|
|
840
|
+
/**
|
|
841
|
+
* Configuration for automated steps
|
|
842
|
+
*/
|
|
843
|
+
automationConfig?: /* Configuration for automation execution to run */ AutomationConfig;
|
|
844
|
+
executionName?: string;
|
|
845
|
+
contexts?: {
|
|
846
|
+
id: string;
|
|
847
|
+
title: string;
|
|
848
|
+
schema: string;
|
|
849
|
+
}[];
|
|
850
|
+
}
|
|
851
|
+
/**
|
|
852
|
+
* describe the requirement for step enablement
|
|
853
|
+
*/
|
|
854
|
+
export interface TaskRequirement {
|
|
855
|
+
definitionId?: string;
|
|
856
|
+
type?: "STEP";
|
|
857
|
+
condition?: "CLOSED";
|
|
858
|
+
}
|
|
859
|
+
export type TaskStates = "OPEN" | "COMPLETED" | "IN_PROGRESS";
|
|
860
|
+
export type TaskStatus = "UNASSIGNED" | "ASSIGNED" | "COMPLETED" | "SKIPPED" | "IN_PROGRESS";
|
|
861
|
+
export type TaskType = "MANUAL" | "AUTOMATION";
|
|
862
|
+
/**
|
|
863
|
+
* example:
|
|
864
|
+
* {
|
|
865
|
+
* "view_name": "some_view",
|
|
866
|
+
* "source_dataset": "taxonomies"
|
|
867
|
+
* }
|
|
868
|
+
*/
|
|
869
|
+
export interface TaxonomiesViewRequest {
|
|
870
|
+
view_name?: string;
|
|
871
|
+
source_dataset: "taxonomies";
|
|
872
|
+
}
|
|
873
|
+
export type TimeGroups = "Y" | "Q" | "M" | "W" | "D";
|
|
874
|
+
export interface TimeSeriesSettings {
|
|
875
|
+
dataset?: "time_series";
|
|
876
|
+
from?: string; // date-time
|
|
877
|
+
to?: string; // date-time
|
|
878
|
+
time_grouper?: string;
|
|
879
|
+
workflow_names?: string[];
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* Execution Id for the query
|
|
883
|
+
*/
|
|
884
|
+
export type UserId = string;
|
|
885
|
+
export type ViewRequest = /**
|
|
886
|
+
* example:
|
|
887
|
+
* {
|
|
888
|
+
* "view_name": "some_view",
|
|
889
|
+
* "source_dataset": "current_entities",
|
|
890
|
+
* "config": {
|
|
891
|
+
* "schema": "some_schema",
|
|
892
|
+
* "include_purpose_view": true,
|
|
893
|
+
* "include_label_view": true,
|
|
894
|
+
* "include_relation_view": true,
|
|
895
|
+
* "relationship_attribute": [
|
|
896
|
+
* "some_relationship_attribute"
|
|
897
|
+
* ]
|
|
898
|
+
* }
|
|
899
|
+
* }
|
|
900
|
+
*/
|
|
901
|
+
CurrentEntitiesViewRequest | /**
|
|
902
|
+
* example:
|
|
903
|
+
* {
|
|
904
|
+
* "view_name": "some_view",
|
|
905
|
+
* "source_dataset": "taxonomies"
|
|
906
|
+
* }
|
|
907
|
+
*/
|
|
908
|
+
TaxonomiesViewRequest | /**
|
|
909
|
+
* example:
|
|
910
|
+
* {
|
|
911
|
+
* "view_name": "some_view",
|
|
912
|
+
* "source_dataset": "workflow_executions"
|
|
913
|
+
* }
|
|
914
|
+
*/
|
|
915
|
+
WorkflowExecutionsViewRequest;
|
|
916
|
+
/**
|
|
917
|
+
* example:
|
|
918
|
+
* {
|
|
919
|
+
* "view_name": "some_view",
|
|
920
|
+
* "source_dataset": "current_entities",
|
|
921
|
+
* "attributes": [
|
|
922
|
+
* {
|
|
923
|
+
* "name": "some_attribute",
|
|
924
|
+
* "type": "string",
|
|
925
|
+
* "description": "some description"
|
|
926
|
+
* }
|
|
927
|
+
* ]
|
|
928
|
+
* }
|
|
929
|
+
*/
|
|
930
|
+
export interface ViewResponse {
|
|
931
|
+
view_name: string;
|
|
932
|
+
source_dataset: "current_entities" | "taxonomies" | "workflow_executions";
|
|
933
|
+
attributes: {
|
|
934
|
+
/**
|
|
935
|
+
* Name of the attribute
|
|
936
|
+
*/
|
|
937
|
+
name: string;
|
|
938
|
+
/**
|
|
939
|
+
* Data type of the attribute
|
|
940
|
+
*/
|
|
941
|
+
type: string;
|
|
942
|
+
/**
|
|
943
|
+
* Description of the attribute
|
|
944
|
+
*/
|
|
945
|
+
description?: string;
|
|
946
|
+
}[];
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* example:
|
|
950
|
+
* {
|
|
951
|
+
* "views": [
|
|
952
|
+
* {
|
|
953
|
+
* "view_name": "some_view",
|
|
954
|
+
* "source_dataset": "current_entities",
|
|
955
|
+
* "view_slug": "some_view",
|
|
956
|
+
* "attributes": [
|
|
957
|
+
* {
|
|
958
|
+
* "name": "some_attribute",
|
|
959
|
+
* "type": "string",
|
|
960
|
+
* "description": "some description"
|
|
961
|
+
* }
|
|
962
|
+
* ]
|
|
963
|
+
* },
|
|
964
|
+
* {
|
|
965
|
+
* "view_name": "another_view",
|
|
966
|
+
* "source_dataset": "taxonomies",
|
|
967
|
+
* "view_slug": "another_view",
|
|
968
|
+
* "attributes": [
|
|
969
|
+
* {
|
|
970
|
+
* "name": "taxonomy_attribute",
|
|
971
|
+
* "type": "string",
|
|
972
|
+
* "description": "taxonomy attribute description"
|
|
973
|
+
* }
|
|
974
|
+
* ]
|
|
975
|
+
* }
|
|
976
|
+
* ]
|
|
977
|
+
* }
|
|
978
|
+
*/
|
|
979
|
+
export interface ViewsListResponse {
|
|
980
|
+
views?: {
|
|
981
|
+
view_name: string;
|
|
982
|
+
source_dataset: "current_entities" | "taxonomies" | "workflow_executions";
|
|
983
|
+
view_slug?: string;
|
|
984
|
+
attributes: {
|
|
985
|
+
/**
|
|
986
|
+
* Name of the attribute
|
|
987
|
+
*/
|
|
988
|
+
name: string;
|
|
989
|
+
/**
|
|
990
|
+
* Data type of the attribute
|
|
991
|
+
*/
|
|
992
|
+
type: string;
|
|
993
|
+
/**
|
|
994
|
+
* Description of the attribute
|
|
995
|
+
*/
|
|
996
|
+
description?: string;
|
|
997
|
+
}[];
|
|
998
|
+
}[];
|
|
999
|
+
}
|
|
1000
|
+
export interface WorkflowContext {
|
|
1001
|
+
id: string;
|
|
1002
|
+
title: string;
|
|
1003
|
+
schema: string;
|
|
1004
|
+
}
|
|
1005
|
+
export type 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";
|
|
1006
|
+
/**
|
|
1007
|
+
* example:
|
|
1008
|
+
* {
|
|
1009
|
+
* "view_name": "some_view",
|
|
1010
|
+
* "source_dataset": "workflow_executions"
|
|
1011
|
+
* }
|
|
1012
|
+
*/
|
|
1013
|
+
export interface WorkflowExecutionsViewRequest {
|
|
1014
|
+
view_name?: string;
|
|
1015
|
+
source_dataset: "workflow_executions";
|
|
1016
|
+
}
|
|
1017
|
+
export type WorkflowStates = "STARTED" | "CLOSED" | "DONE";
|
|
1018
|
+
export type WorkflowStatus = "STARTED" | "DONE" | "CLOSED";
|
|
1019
|
+
/**
|
|
1020
|
+
* Settings for the data of the chart that is being queried.
|
|
1021
|
+
*/
|
|
1022
|
+
export interface WorkflowsQueryOptions {
|
|
1023
|
+
dataset?: WorkflowDataset;
|
|
1024
|
+
/**
|
|
1025
|
+
* Workflow Definition IDs
|
|
1026
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
1027
|
+
*/
|
|
1028
|
+
workflow_definition_ids?: string[];
|
|
1029
|
+
/**
|
|
1030
|
+
* Entity Schemas
|
|
1031
|
+
* Filter by entity schema
|
|
1032
|
+
*/
|
|
1033
|
+
entity_schemas?: string[];
|
|
1034
|
+
/**
|
|
1035
|
+
* Workflow Definition IDs
|
|
1036
|
+
* Filter by the states of the executions, phases, or tasks.
|
|
1037
|
+
* examples:
|
|
1038
|
+
* - ["STARTED"]
|
|
1039
|
+
* - ["COMPLETED", "PARTIALLY_COMPLETED"]
|
|
1040
|
+
*
|
|
1041
|
+
*/
|
|
1042
|
+
states?: string[];
|
|
1043
|
+
/**
|
|
1044
|
+
* Group Time By
|
|
1045
|
+
* If 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"
|
|
1046
|
+
*/
|
|
1047
|
+
group_time_by?: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* Relative Time Range
|
|
1050
|
+
* If chosen a time series, this arg defines the time span, e.g. show data of the current month. Either this param or "time_range_from" and "time_range_to" must be set.
|
|
1051
|
+
*/
|
|
1052
|
+
relative_time_range?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Time Range From
|
|
1055
|
+
* If chosen a time series, specify the start date in the format YYYY-MM-DD, e.g. 2023-01-01.
|
|
1056
|
+
*/
|
|
1057
|
+
time_range_from?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Time Range To
|
|
1060
|
+
* If chosen a time series, specify the end date in the format YYYY-MM-DD, e.g. 2023-03-31.
|
|
1061
|
+
*/
|
|
1062
|
+
time_range_to?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* Duration Threshold
|
|
1065
|
+
* Certain datasets enable you to set a threshold of the duration. Example: We want to see total phase counts, phase counts less than threshold, phase counts more than threshold; threshold could be for example 45 days.
|
|
1066
|
+
*/
|
|
1067
|
+
duration_threshold?: number;
|
|
1068
|
+
}
|
|
1069
|
+
/**
|
|
1070
|
+
* Entity Schema
|
|
1071
|
+
* Workflows can be applied to different kinds of entities, e.g. on Opportunities or Orders.
|
|
1072
|
+
* You can choose to limit your results to workflow executions to specific entity schemas / types.
|
|
1073
|
+
*
|
|
1074
|
+
* example:
|
|
1075
|
+
* Opportunity
|
|
1076
|
+
*/
|
|
1077
|
+
export type WorkflowsQueryOptionsEntitySchema = string;
|
|
1078
|
+
/**
|
|
1079
|
+
* Group Time By
|
|
1080
|
+
* If 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"
|
|
1081
|
+
*/
|
|
1082
|
+
export type WorkflowsQueryOptionsGroupTimeBy = string;
|
|
1083
|
+
/**
|
|
1084
|
+
* Relative Time Range
|
|
1085
|
+
* A combination of two worde that describe a time range, e.g. "this year" or "last month"
|
|
1086
|
+
* example:
|
|
1087
|
+
* this year
|
|
1088
|
+
*/
|
|
1089
|
+
export type WorkflowsQueryOptionsRelativeTimeRange = string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Time Range From
|
|
1092
|
+
* Set a specific start of a time range, e.g. "2023-01-01"
|
|
1093
|
+
* example:
|
|
1094
|
+
* 2023-01-01
|
|
1095
|
+
*/
|
|
1096
|
+
export type WorkflowsQueryOptionsTimeRangeFrom = string;
|
|
1097
|
+
/**
|
|
1098
|
+
* Time Range To
|
|
1099
|
+
* Set a specific end of a time range, e.g. "2023-06-30"
|
|
1100
|
+
* example:
|
|
1101
|
+
* 2023-06-01
|
|
1102
|
+
*/
|
|
1103
|
+
export type WorkflowsQueryOptionsTimeRangeTo = string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Workflow Definition IDs
|
|
1106
|
+
* Filter by specific workflows by passing a list of workflow definition ids.
|
|
1107
|
+
*/
|
|
1108
|
+
export type WorkflowsQueryOptionsWorkflowDefinitionIDs = string[];
|
|
1109
|
+
/**
|
|
1110
|
+
* Workflow States
|
|
1111
|
+
* Filter by the states of the workflow executions.
|
|
1112
|
+
*/
|
|
1113
|
+
export type WorkflowsQueryOptionsWorkflowStates = string[];
|
|
1114
|
+
/**
|
|
1115
|
+
* example:
|
|
1116
|
+
* {
|
|
1117
|
+
* "data": [
|
|
1118
|
+
* 0,
|
|
1119
|
+
* 1
|
|
1120
|
+
* ],
|
|
1121
|
+
* "labels": [
|
|
1122
|
+
* "label1",
|
|
1123
|
+
* "label2"
|
|
1124
|
+
* ],
|
|
1125
|
+
* "timestamp": "1715621496068"
|
|
1126
|
+
* }
|
|
1127
|
+
*/
|
|
1128
|
+
export interface WorkflowsQueryResult {
|
|
1129
|
+
[name: string]: any;
|
|
1130
|
+
data?: (string | number | {
|
|
1131
|
+
[name: string]: any;
|
|
1132
|
+
} | {
|
|
1133
|
+
[name: string]: any;
|
|
1134
|
+
}[])[] | {
|
|
1135
|
+
[name: string]: any;
|
|
1136
|
+
} | string | number;
|
|
1137
|
+
labels?: string[];
|
|
1138
|
+
timestamp?: string;
|
|
1139
|
+
}
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
declare namespace Paths {
|
|
1143
|
+
namespace Autocomplete {
|
|
1144
|
+
namespace Parameters {
|
|
1145
|
+
/**
|
|
1146
|
+
* example:
|
|
1147
|
+
* current_purposes.name
|
|
1148
|
+
*/
|
|
1149
|
+
export type Attribute = string;
|
|
1150
|
+
export type Dataset = "workflows" | "purposes" | "sharing_configs" | "partners";
|
|
1151
|
+
export type Input = string;
|
|
1152
|
+
export type Size = number;
|
|
1153
|
+
}
|
|
1154
|
+
export interface QueryParameters {
|
|
1155
|
+
dataset: Parameters.Dataset;
|
|
1156
|
+
input?: Parameters.Input;
|
|
1157
|
+
attribute: /**
|
|
1158
|
+
* example:
|
|
1159
|
+
* current_purposes.name
|
|
1160
|
+
*/
|
|
1161
|
+
Parameters.Attribute;
|
|
1162
|
+
size?: Parameters.Size;
|
|
1163
|
+
}
|
|
1164
|
+
namespace Responses {
|
|
1165
|
+
export interface $200 {
|
|
1166
|
+
/**
|
|
1167
|
+
* example:
|
|
1168
|
+
* [
|
|
1169
|
+
* "value"
|
|
1170
|
+
* ]
|
|
1171
|
+
*/
|
|
1172
|
+
results?: (string | boolean | {
|
|
1173
|
+
[name: string]: any;
|
|
1174
|
+
})[];
|
|
1175
|
+
}
|
|
1176
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1177
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1178
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1179
|
+
}
|
|
1180
|
+
}
|
|
1181
|
+
namespace CreateOrUpdateRelationship {
|
|
1182
|
+
export type RequestBody = /**
|
|
1183
|
+
* example:
|
|
1184
|
+
* {
|
|
1185
|
+
* "relationship_name": "some_relationship",
|
|
1186
|
+
* "from_table": "some_table",
|
|
1187
|
+
* "to_table": "some_table",
|
|
1188
|
+
* "from_column": "some_column",
|
|
1189
|
+
* "to_column": "some_column",
|
|
1190
|
+
* "type": "one_to_many"
|
|
1191
|
+
* }
|
|
1192
|
+
*/
|
|
1193
|
+
Components.Schemas.RelationshipRequest;
|
|
1194
|
+
namespace Responses {
|
|
1195
|
+
export type $200 = /**
|
|
1196
|
+
* example:
|
|
1197
|
+
* {
|
|
1198
|
+
* "relationship_name": "some_relationship",
|
|
1199
|
+
* "from_table": "some_table",
|
|
1200
|
+
* "to_table": "some_table",
|
|
1201
|
+
* "from_column": "some_column",
|
|
1202
|
+
* "to_column": "some_column",
|
|
1203
|
+
* "type": "one_to_many"
|
|
1204
|
+
* }
|
|
1205
|
+
*/
|
|
1206
|
+
Components.Schemas.RelationshipResponse;
|
|
1207
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1208
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1209
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1210
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1211
|
+
}
|
|
1212
|
+
}
|
|
1213
|
+
namespace CreateOrUpdateView {
|
|
1214
|
+
export type RequestBody = Components.Schemas.ViewRequest;
|
|
1215
|
+
namespace Responses {
|
|
1216
|
+
export type $200 = /**
|
|
1217
|
+
* example:
|
|
1218
|
+
* {
|
|
1219
|
+
* "view_name": "some_view",
|
|
1220
|
+
* "source_dataset": "current_entities",
|
|
1221
|
+
* "attributes": [
|
|
1222
|
+
* {
|
|
1223
|
+
* "name": "some_attribute",
|
|
1224
|
+
* "type": "string",
|
|
1225
|
+
* "description": "some description"
|
|
1226
|
+
* }
|
|
1227
|
+
* ]
|
|
1228
|
+
* }
|
|
1229
|
+
*/
|
|
1230
|
+
Components.Schemas.ViewResponse;
|
|
1231
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1232
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1233
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1234
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1235
|
+
}
|
|
1236
|
+
}
|
|
1237
|
+
namespace ExecuteAutomationQuery {
|
|
1238
|
+
namespace Parameters {
|
|
1239
|
+
export type From = number;
|
|
1240
|
+
export type Size = number;
|
|
1241
|
+
}
|
|
1242
|
+
export interface QueryParameters {
|
|
1243
|
+
from?: Parameters.From;
|
|
1244
|
+
size?: Parameters.Size;
|
|
1245
|
+
}
|
|
1246
|
+
export type RequestBody = Components.Schemas.DatasetOptionsAutomationExecutionsOverview | Components.Schemas.DatasetOptionsListAutomationDefinitions;
|
|
1247
|
+
namespace Responses {
|
|
1248
|
+
export type $200 = Components.Schemas.AutomationExecutionResponse | /**
|
|
1249
|
+
* example:
|
|
1250
|
+
* {
|
|
1251
|
+
* "hits": 100,
|
|
1252
|
+
* "results": [
|
|
1253
|
+
* {
|
|
1254
|
+
* "flow_id": "flow_123",
|
|
1255
|
+
* "flow_name": "Email Notification Flow",
|
|
1256
|
+
* "entity_schema": "opportunity"
|
|
1257
|
+
* },
|
|
1258
|
+
* {
|
|
1259
|
+
* "flow_id": "flow_456",
|
|
1260
|
+
* "flow_name": "SMS Alert Flow",
|
|
1261
|
+
* "entity_schema": "customer"
|
|
1262
|
+
* }
|
|
1263
|
+
* ]
|
|
1264
|
+
* }
|
|
1265
|
+
*/
|
|
1266
|
+
Components.Schemas.ListAutomationDefinitionsResponse;
|
|
1267
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1268
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1269
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1270
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1271
|
+
}
|
|
1272
|
+
}
|
|
1273
|
+
namespace ExecuteEntitiesQuery {
|
|
1274
|
+
namespace Parameters {
|
|
1275
|
+
export type CacheExpiration = /**
|
|
1276
|
+
* Cache Expiration timestamp
|
|
1277
|
+
* example:
|
|
1278
|
+
* 1663308898789
|
|
1279
|
+
*/
|
|
1280
|
+
Components.Schemas.CacheExpiration /* timestamp */;
|
|
1281
|
+
export type NoCache = /**
|
|
1282
|
+
* example:
|
|
1283
|
+
* false
|
|
1284
|
+
*/
|
|
1285
|
+
Components.Schemas.NoCache;
|
|
1286
|
+
}
|
|
1287
|
+
export interface QueryParameters {
|
|
1288
|
+
cache_expiration?: Parameters.CacheExpiration;
|
|
1289
|
+
no_cache?: Parameters.NoCache;
|
|
1290
|
+
}
|
|
1291
|
+
export interface RequestBody {
|
|
1292
|
+
query?: Components.Schemas.DatalakeQuery;
|
|
1293
|
+
}
|
|
1294
|
+
namespace Responses {
|
|
1295
|
+
export type $200 = Components.Schemas.QueryResults;
|
|
1296
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1297
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1298
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1299
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1300
|
+
}
|
|
1301
|
+
}
|
|
1302
|
+
namespace ExecuteQuery {
|
|
1303
|
+
namespace Parameters {
|
|
1304
|
+
export type CacheExpiration = /**
|
|
1305
|
+
* Cache Expiration timestamp
|
|
1306
|
+
* example:
|
|
1307
|
+
* 1663308898789
|
|
1308
|
+
*/
|
|
1309
|
+
Components.Schemas.CacheExpiration /* timestamp */;
|
|
1310
|
+
export type NoCache = /**
|
|
1311
|
+
* example:
|
|
1312
|
+
* false
|
|
1313
|
+
*/
|
|
1314
|
+
Components.Schemas.NoCache;
|
|
1315
|
+
}
|
|
1316
|
+
export interface QueryParameters {
|
|
1317
|
+
cache_expiration?: Parameters.CacheExpiration;
|
|
1318
|
+
no_cache?: Parameters.NoCache;
|
|
1319
|
+
}
|
|
1320
|
+
export interface RequestBody {
|
|
1321
|
+
query?: Components.Schemas.DatalakeQuery;
|
|
1322
|
+
}
|
|
1323
|
+
namespace Responses {
|
|
1324
|
+
export type $200 = Components.Schemas.QueryResults;
|
|
1325
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1326
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1327
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1328
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1329
|
+
}
|
|
1330
|
+
}
|
|
1331
|
+
namespace ExecuteQueryV2 {
|
|
1332
|
+
export interface RequestBody {
|
|
1333
|
+
[name: string]: any;
|
|
1334
|
+
}
|
|
1335
|
+
namespace Responses {
|
|
1336
|
+
export type $200 = Components.Schemas.QueryResults;
|
|
1337
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1338
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1339
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1340
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1341
|
+
}
|
|
1342
|
+
}
|
|
1343
|
+
namespace ExecuteWorkflowsQuery {
|
|
1344
|
+
namespace Parameters {
|
|
1345
|
+
export type CacheExpiration = /**
|
|
1346
|
+
* Cache Expiration timestamp
|
|
1347
|
+
* example:
|
|
1348
|
+
* 1663308898789
|
|
1349
|
+
*/
|
|
1350
|
+
Components.Schemas.CacheExpiration /* timestamp */;
|
|
1351
|
+
export type Mock = boolean;
|
|
1352
|
+
export type NoCache = /**
|
|
1353
|
+
* example:
|
|
1354
|
+
* false
|
|
1355
|
+
*/
|
|
1356
|
+
Components.Schemas.NoCache;
|
|
1357
|
+
}
|
|
1358
|
+
export interface QueryParameters {
|
|
1359
|
+
mock?: Parameters.Mock;
|
|
1360
|
+
cache_expiration?: Parameters.CacheExpiration;
|
|
1361
|
+
no_cache?: Parameters.NoCache;
|
|
1362
|
+
}
|
|
1363
|
+
export type RequestBody = /* Settings for the data of the chart that is being queried. */ Components.Schemas.WorkflowsQueryOptions | /**
|
|
1364
|
+
* Dataset Options: Total Count of Workflow Executions
|
|
1365
|
+
* See the total of workflow executions in a pie chart.
|
|
1366
|
+
*/
|
|
1367
|
+
Components.Schemas.DatasetOptionsTotalCountOfWorkflowExecutions | /* Dataset Options: Workflow Execution Time Series */ Components.Schemas.DatasetOptionsWorkflowExecutionTimeSeries | /* Dataset Options: Cumulative Sum of Workflows */ Components.Schemas.DatasetOptionsCumulativeSumOfWorkflows | /**
|
|
1368
|
+
* Dataset Options: Cancellation Reasons
|
|
1369
|
+
* See the cancellation reasons of workflows in a pie chart.
|
|
1370
|
+
*/
|
|
1371
|
+
Components.Schemas.DatasetOptionsCancellationReasons | /**
|
|
1372
|
+
* Dataset Options: Workflow Tasks Overview
|
|
1373
|
+
* Get a list of tasks to help organize executing users their day.
|
|
1374
|
+
*/
|
|
1375
|
+
Components.Schemas.DatasetOptionsWorkflowTasksOverview;
|
|
1376
|
+
namespace Responses {
|
|
1377
|
+
export type $200 = /**
|
|
1378
|
+
* example:
|
|
1379
|
+
* {
|
|
1380
|
+
* "data": [
|
|
1381
|
+
* 0,
|
|
1382
|
+
* 1
|
|
1383
|
+
* ],
|
|
1384
|
+
* "labels": [
|
|
1385
|
+
* "label1",
|
|
1386
|
+
* "label2"
|
|
1387
|
+
* ],
|
|
1388
|
+
* "timestamp": "1715621496068"
|
|
1389
|
+
* }
|
|
1390
|
+
*/
|
|
1391
|
+
Components.Schemas.WorkflowsQueryResult;
|
|
1392
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1393
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1394
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1395
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1396
|
+
}
|
|
1397
|
+
}
|
|
1398
|
+
namespace GenerateCredentialsV2 {
|
|
1399
|
+
namespace Responses {
|
|
1400
|
+
export interface $200 {
|
|
1401
|
+
/**
|
|
1402
|
+
* example:
|
|
1403
|
+
* datalakeuser_sfsdfs_66
|
|
1404
|
+
*/
|
|
1405
|
+
username?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* example:
|
|
1408
|
+
* ***
|
|
1409
|
+
*/
|
|
1410
|
+
password?: string;
|
|
1411
|
+
endpoints?: {
|
|
1412
|
+
/**
|
|
1413
|
+
* example:
|
|
1414
|
+
* qjjcxsy87t.eu-central-1.aws.clickhouse.cloud
|
|
1415
|
+
*/
|
|
1416
|
+
host?: string;
|
|
1417
|
+
/**
|
|
1418
|
+
* example:
|
|
1419
|
+
* 8443
|
|
1420
|
+
*/
|
|
1421
|
+
port?: string;
|
|
1422
|
+
};
|
|
1423
|
+
/**
|
|
1424
|
+
* example:
|
|
1425
|
+
* datawarehouse
|
|
1426
|
+
*/
|
|
1427
|
+
database?: string;
|
|
1428
|
+
}
|
|
1429
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1430
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1431
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
namespace GetAllRelationships {
|
|
1435
|
+
namespace Responses {
|
|
1436
|
+
export type $200 = /**
|
|
1437
|
+
* example:
|
|
1438
|
+
* {
|
|
1439
|
+
* "relationships": [
|
|
1440
|
+
* {
|
|
1441
|
+
* "relationship_name": "some_relationship",
|
|
1442
|
+
* "from_table": "some_table",
|
|
1443
|
+
* "to_table": "some_table",
|
|
1444
|
+
* "from_column": "some_column",
|
|
1445
|
+
* "to_column": "some_column",
|
|
1446
|
+
* "type": "one_to_many"
|
|
1447
|
+
* },
|
|
1448
|
+
* {
|
|
1449
|
+
* "relationship_name": "another_relationship",
|
|
1450
|
+
* "from_table": "table_a",
|
|
1451
|
+
* "to_table": "table_b",
|
|
1452
|
+
* "from_column": "column_a",
|
|
1453
|
+
* "to_column": "column_b",
|
|
1454
|
+
* "type": "many_to_many"
|
|
1455
|
+
* }
|
|
1456
|
+
* ]
|
|
1457
|
+
* }
|
|
1458
|
+
*/
|
|
1459
|
+
Components.Schemas.RelationshipsListResponse;
|
|
1460
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1461
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1462
|
+
}
|
|
1463
|
+
}
|
|
1464
|
+
namespace GetAllViews {
|
|
1465
|
+
namespace Responses {
|
|
1466
|
+
export type $200 = /**
|
|
1467
|
+
* example:
|
|
1468
|
+
* {
|
|
1469
|
+
* "views": [
|
|
1470
|
+
* {
|
|
1471
|
+
* "view_name": "some_view",
|
|
1472
|
+
* "source_dataset": "current_entities",
|
|
1473
|
+
* "view_slug": "some_view",
|
|
1474
|
+
* "attributes": [
|
|
1475
|
+
* {
|
|
1476
|
+
* "name": "some_attribute",
|
|
1477
|
+
* "type": "string",
|
|
1478
|
+
* "description": "some description"
|
|
1479
|
+
* }
|
|
1480
|
+
* ]
|
|
1481
|
+
* },
|
|
1482
|
+
* {
|
|
1483
|
+
* "view_name": "another_view",
|
|
1484
|
+
* "source_dataset": "taxonomies",
|
|
1485
|
+
* "view_slug": "another_view",
|
|
1486
|
+
* "attributes": [
|
|
1487
|
+
* {
|
|
1488
|
+
* "name": "taxonomy_attribute",
|
|
1489
|
+
* "type": "string",
|
|
1490
|
+
* "description": "taxonomy attribute description"
|
|
1491
|
+
* }
|
|
1492
|
+
* ]
|
|
1493
|
+
* }
|
|
1494
|
+
* ]
|
|
1495
|
+
* }
|
|
1496
|
+
*/
|
|
1497
|
+
Components.Schemas.ViewsListResponse;
|
|
1498
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1499
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1500
|
+
}
|
|
1501
|
+
}
|
|
1502
|
+
namespace GetSemanticModel {
|
|
1503
|
+
namespace Responses {
|
|
1504
|
+
export type $200 = /* The semantic model exposing entities, relationships, and query capabilities */ Components.Schemas.SemanticModel;
|
|
1505
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1506
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1507
|
+
}
|
|
1508
|
+
}
|
|
1509
|
+
namespace GetView {
|
|
1510
|
+
namespace Parameters {
|
|
1511
|
+
export type ViewSlug = string;
|
|
1512
|
+
}
|
|
1513
|
+
export interface PathParameters {
|
|
1514
|
+
view_slug: Parameters.ViewSlug;
|
|
1515
|
+
}
|
|
1516
|
+
namespace Responses {
|
|
1517
|
+
export type $200 = /**
|
|
1518
|
+
* example:
|
|
1519
|
+
* {
|
|
1520
|
+
* "view_name": "some_view",
|
|
1521
|
+
* "source_dataset": "current_entities",
|
|
1522
|
+
* "attributes": [
|
|
1523
|
+
* {
|
|
1524
|
+
* "name": "some_attribute",
|
|
1525
|
+
* "type": "string",
|
|
1526
|
+
* "description": "some description"
|
|
1527
|
+
* }
|
|
1528
|
+
* ]
|
|
1529
|
+
* }
|
|
1530
|
+
*/
|
|
1531
|
+
Components.Schemas.ViewResponse;
|
|
1532
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1533
|
+
export type $404 = Components.Responses.NotFoundResponse;
|
|
1534
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1535
|
+
}
|
|
1536
|
+
}
|
|
1537
|
+
namespace ListAvailableDatasetsV2 {
|
|
1538
|
+
namespace Responses {
|
|
1539
|
+
export interface $200 {
|
|
1540
|
+
/**
|
|
1541
|
+
* example:
|
|
1542
|
+
* [
|
|
1543
|
+
* {
|
|
1544
|
+
* "domain": "entities",
|
|
1545
|
+
* "dataset": "entity_operations",
|
|
1546
|
+
* "endpoint": "/v2/query/domain/entities:execute"
|
|
1547
|
+
* },
|
|
1548
|
+
* {
|
|
1549
|
+
* "domain": "workflows",
|
|
1550
|
+
* "dataset": "workflow_execution_time_series",
|
|
1551
|
+
* "endpoint": "/v2/query/domain/workflows:execute"
|
|
1552
|
+
* },
|
|
1553
|
+
* {
|
|
1554
|
+
* "domain": "workflows",
|
|
1555
|
+
* "dataset": "phases_duration",
|
|
1556
|
+
* "endpoint": "/v2/query/domain/workflows:execute"
|
|
1557
|
+
* }
|
|
1558
|
+
* ]
|
|
1559
|
+
*/
|
|
1560
|
+
results?: Components.Schemas.Dataset[];
|
|
1561
|
+
}
|
|
1562
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1563
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1564
|
+
}
|
|
1565
|
+
}
|
|
1566
|
+
namespace ListCredentialsV2 {
|
|
1567
|
+
namespace Responses {
|
|
1568
|
+
export interface $200 {
|
|
1569
|
+
users?: {
|
|
1570
|
+
user_id?: string;
|
|
1571
|
+
}[];
|
|
1572
|
+
}
|
|
1573
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1574
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1575
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1576
|
+
}
|
|
1577
|
+
}
|
|
1578
|
+
namespace ListDatasets {
|
|
1579
|
+
namespace Responses {
|
|
1580
|
+
/**
|
|
1581
|
+
* example:
|
|
1582
|
+
* {
|
|
1583
|
+
* "results": [
|
|
1584
|
+
* {
|
|
1585
|
+
* "dataset": "entity_operations"
|
|
1586
|
+
* },
|
|
1587
|
+
* {
|
|
1588
|
+
* "dataset": "entities_timemachine"
|
|
1589
|
+
* }
|
|
1590
|
+
* ]
|
|
1591
|
+
* }
|
|
1592
|
+
*/
|
|
1593
|
+
export interface $200 {
|
|
1594
|
+
results?: Components.Schemas.Dataset[];
|
|
1595
|
+
}
|
|
1596
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1597
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1598
|
+
}
|
|
1599
|
+
}
|
|
1600
|
+
namespace ListPhaseNames {
|
|
1601
|
+
namespace Parameters {
|
|
1602
|
+
export type OrgId = string;
|
|
1603
|
+
}
|
|
1604
|
+
export interface QueryParameters {
|
|
1605
|
+
org_id?: Parameters.OrgId;
|
|
1606
|
+
}
|
|
1607
|
+
namespace Responses {
|
|
1608
|
+
export interface $200 {
|
|
1609
|
+
results?: {
|
|
1610
|
+
/**
|
|
1611
|
+
* example:
|
|
1612
|
+
* y0UdVCOI
|
|
1613
|
+
*/
|
|
1614
|
+
id: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* example:
|
|
1617
|
+
* PV Kauf
|
|
1618
|
+
*/
|
|
1619
|
+
name: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* example:
|
|
1622
|
+
* 2023-05-31T00:00:00.000Z
|
|
1623
|
+
*/
|
|
1624
|
+
max_date: string; // date-time
|
|
1625
|
+
/**
|
|
1626
|
+
* example:
|
|
1627
|
+
* 2023-01-00T00:00:00.000Z
|
|
1628
|
+
*/
|
|
1629
|
+
min_date: string; // date-time
|
|
1630
|
+
}[];
|
|
1631
|
+
}
|
|
1632
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1633
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1634
|
+
}
|
|
1635
|
+
}
|
|
1636
|
+
namespace ListWorkflowDefinitions {
|
|
1637
|
+
namespace Parameters {
|
|
1638
|
+
export type Mock = boolean;
|
|
1639
|
+
}
|
|
1640
|
+
export interface QueryParameters {
|
|
1641
|
+
mock?: Parameters.Mock;
|
|
1642
|
+
}
|
|
1643
|
+
namespace Responses {
|
|
1644
|
+
export interface $200 {
|
|
1645
|
+
results?: {
|
|
1646
|
+
/**
|
|
1647
|
+
* example:
|
|
1648
|
+
* y0UdVCOI
|
|
1649
|
+
*/
|
|
1650
|
+
id: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* example:
|
|
1653
|
+
* PV Kauf
|
|
1654
|
+
*/
|
|
1655
|
+
name: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* example:
|
|
1658
|
+
* 2023-05-31T00:00:00.000Z
|
|
1659
|
+
*/
|
|
1660
|
+
max_date: string; // date-time
|
|
1661
|
+
/**
|
|
1662
|
+
* example:
|
|
1663
|
+
* 2023-01-00T00:00:00.000Z
|
|
1664
|
+
*/
|
|
1665
|
+
min_date: string; // date-time
|
|
1666
|
+
}[];
|
|
1667
|
+
}
|
|
1668
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1669
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
namespace ListWorkflowPhasesByDefinitionId {
|
|
1673
|
+
namespace Parameters {
|
|
1674
|
+
export type WorkflowDefinitionId = string;
|
|
1675
|
+
}
|
|
1676
|
+
export interface PathParameters {
|
|
1677
|
+
workflowDefinitionId: Parameters.WorkflowDefinitionId;
|
|
1678
|
+
}
|
|
1679
|
+
namespace Responses {
|
|
1680
|
+
export type $200 = {
|
|
1681
|
+
/**
|
|
1682
|
+
* The unique identifier of the workflow phase.
|
|
1683
|
+
* example:
|
|
1684
|
+
* y0UdVCOI
|
|
1685
|
+
*/
|
|
1686
|
+
id?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* The name of the workflow phase.
|
|
1689
|
+
* example:
|
|
1690
|
+
* Initial Phase
|
|
1691
|
+
*/
|
|
1692
|
+
name?: string;
|
|
1693
|
+
}[];
|
|
1694
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1695
|
+
export type $404 = Components.Responses.NotFoundResponse;
|
|
1696
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1699
|
+
namespace RevokeCredentialsV2 {
|
|
1700
|
+
namespace Parameters {
|
|
1701
|
+
export type UserId = /* Execution Id for the query */ Components.Schemas.UserId;
|
|
1702
|
+
}
|
|
1703
|
+
export interface QueryParameters {
|
|
1704
|
+
user_id?: Parameters.UserId;
|
|
1705
|
+
}
|
|
1706
|
+
namespace Responses {
|
|
1707
|
+
export interface $200 {
|
|
1708
|
+
/**
|
|
1709
|
+
* example:
|
|
1710
|
+
* true
|
|
1711
|
+
*/
|
|
1712
|
+
success?: boolean;
|
|
1713
|
+
}
|
|
1714
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1715
|
+
export type $403 = Components.Responses.ForbiddenResponse;
|
|
1716
|
+
export type $404 = Components.Responses.NotFoundResponse;
|
|
1717
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1718
|
+
}
|
|
1719
|
+
}
|
|
1720
|
+
namespace WorkflowsAutocomplete {
|
|
1721
|
+
namespace Parameters {
|
|
1722
|
+
/**
|
|
1723
|
+
* example:
|
|
1724
|
+
* name
|
|
1725
|
+
*/
|
|
1726
|
+
export type Attribute = string;
|
|
1727
|
+
export type Input = string;
|
|
1728
|
+
export type Size = number;
|
|
1729
|
+
}
|
|
1730
|
+
export interface QueryParameters {
|
|
1731
|
+
input?: Parameters.Input;
|
|
1732
|
+
attribute: /**
|
|
1733
|
+
* example:
|
|
1734
|
+
* name
|
|
1735
|
+
*/
|
|
1736
|
+
Parameters.Attribute;
|
|
1737
|
+
size?: Parameters.Size;
|
|
1738
|
+
}
|
|
1739
|
+
namespace Responses {
|
|
1740
|
+
export interface $200 {
|
|
1741
|
+
/**
|
|
1742
|
+
* example:
|
|
1743
|
+
* [
|
|
1744
|
+
* "value"
|
|
1745
|
+
* ]
|
|
1746
|
+
*/
|
|
1747
|
+
results?: (string | boolean | {
|
|
1748
|
+
[name: string]: any;
|
|
1749
|
+
})[];
|
|
1750
|
+
}
|
|
1751
|
+
export type $400 = Components.Responses.BadRequestResponse;
|
|
1752
|
+
export type $401 = Components.Responses.UnauthorizedResponse;
|
|
1753
|
+
export type $500 = Components.Responses.InternalServerErrorResponse;
|
|
1754
|
+
}
|
|
1755
|
+
}
|
|
1756
|
+
}
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
interface OperationMethods {
|
|
1760
|
+
/**
|
|
1761
|
+
* getAllViews - getAllViews
|
|
1762
|
+
*
|
|
1763
|
+
* Retrieve all materialized data lake views configured for the organization.
|
|
1764
|
+
*/
|
|
1765
|
+
'getAllViews'(
|
|
1766
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1767
|
+
data?: any,
|
|
1768
|
+
config?: AxiosRequestConfig
|
|
1769
|
+
): OperationResponse<Paths.GetAllViews.Responses.$200>
|
|
1770
|
+
/**
|
|
1771
|
+
* createOrUpdateView - createOrUpdateView
|
|
1772
|
+
*
|
|
1773
|
+
* Create or update a materialized SQL view in the epilot data lake.
|
|
1774
|
+
*
|
|
1775
|
+
* Views expose epilot data (entities, taxonomies, workflow executions) as queryable tables that can be used by BI tools or queried directly. If a view with the same `view_name` already exists, it is updated.
|
|
1776
|
+
*
|
|
1777
|
+
*/
|
|
1778
|
+
'createOrUpdateView'(
|
|
1779
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1780
|
+
data?: Paths.CreateOrUpdateView.RequestBody,
|
|
1781
|
+
config?: AxiosRequestConfig
|
|
1782
|
+
): OperationResponse<Paths.CreateOrUpdateView.Responses.$200>
|
|
1783
|
+
/**
|
|
1784
|
+
* getView - getView
|
|
1785
|
+
*
|
|
1786
|
+
* Retrieve the definition and attributes of a specific data lake view by its slug.
|
|
1787
|
+
*/
|
|
1788
|
+
'getView'(
|
|
1789
|
+
parameters?: Parameters<Paths.GetView.PathParameters> | null,
|
|
1790
|
+
data?: any,
|
|
1791
|
+
config?: AxiosRequestConfig
|
|
1792
|
+
): OperationResponse<Paths.GetView.Responses.$200>
|
|
1793
|
+
/**
|
|
1794
|
+
* getAllRelationships - getAllRelationships
|
|
1795
|
+
*
|
|
1796
|
+
* Retrieve all table relationships configured for the organization's data lake.
|
|
1797
|
+
*/
|
|
1798
|
+
'getAllRelationships'(
|
|
1799
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1800
|
+
data?: any,
|
|
1801
|
+
config?: AxiosRequestConfig
|
|
1802
|
+
): OperationResponse<Paths.GetAllRelationships.Responses.$200>
|
|
1803
|
+
/**
|
|
1804
|
+
* createOrUpdateRelationship - createOrUpdateRelationship
|
|
1805
|
+
*
|
|
1806
|
+
* Define or update a relationship between two tables in the data lake.
|
|
1807
|
+
*
|
|
1808
|
+
* Relationships enable JOIN operations in views and queries. If a relationship with the same `relationship_name` already exists, it is updated.
|
|
1809
|
+
*
|
|
1810
|
+
*/
|
|
1811
|
+
'createOrUpdateRelationship'(
|
|
1812
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1813
|
+
data?: Paths.CreateOrUpdateRelationship.RequestBody,
|
|
1814
|
+
config?: AxiosRequestConfig
|
|
1815
|
+
): OperationResponse<Paths.CreateOrUpdateRelationship.Responses.$200>
|
|
1816
|
+
/**
|
|
1817
|
+
* listAvailableDatasetsV2 - listAvailableDatasetsV2
|
|
1818
|
+
*
|
|
1819
|
+
* Lists all available datasets grouped by domain
|
|
1820
|
+
*
|
|
1821
|
+
* Current domains are:
|
|
1822
|
+
* - Entity
|
|
1823
|
+
* - Workflow
|
|
1824
|
+
*
|
|
1825
|
+
*/
|
|
1826
|
+
'listAvailableDatasetsV2'(
|
|
1827
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1828
|
+
data?: any,
|
|
1829
|
+
config?: AxiosRequestConfig
|
|
1830
|
+
): OperationResponse<Paths.ListAvailableDatasetsV2.Responses.$200>
|
|
1831
|
+
/**
|
|
1832
|
+
* executeEntitiesQuery - executeEntitiesQuery
|
|
1833
|
+
*
|
|
1834
|
+
* Execute queries against entities datasets.
|
|
1835
|
+
*
|
|
1836
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
1837
|
+
*
|
|
1838
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
1839
|
+
*
|
|
1840
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
1841
|
+
*
|
|
1842
|
+
*/
|
|
1843
|
+
'executeEntitiesQuery'(
|
|
1844
|
+
parameters?: Parameters<Paths.ExecuteEntitiesQuery.QueryParameters> | null,
|
|
1845
|
+
data?: Paths.ExecuteEntitiesQuery.RequestBody,
|
|
1846
|
+
config?: AxiosRequestConfig
|
|
1847
|
+
): OperationResponse<Paths.ExecuteEntitiesQuery.Responses.$200>
|
|
1848
|
+
/**
|
|
1849
|
+
* executeWorkflowsQuery - executeWorkflowsQuery
|
|
1850
|
+
*
|
|
1851
|
+
* Query Workflow Analytics Datasets.
|
|
1852
|
+
*/
|
|
1853
|
+
'executeWorkflowsQuery'(
|
|
1854
|
+
parameters?: Parameters<Paths.ExecuteWorkflowsQuery.QueryParameters> | null,
|
|
1855
|
+
data?: Paths.ExecuteWorkflowsQuery.RequestBody,
|
|
1856
|
+
config?: AxiosRequestConfig
|
|
1857
|
+
): OperationResponse<Paths.ExecuteWorkflowsQuery.Responses.$200>
|
|
1858
|
+
/**
|
|
1859
|
+
* executeAutomationQuery - executeAutomationQuery
|
|
1860
|
+
*
|
|
1861
|
+
* Query Automation Analytics Datasets.
|
|
1862
|
+
*/
|
|
1863
|
+
'executeAutomationQuery'(
|
|
1864
|
+
parameters?: Parameters<Paths.ExecuteAutomationQuery.QueryParameters> | null,
|
|
1865
|
+
data?: Paths.ExecuteAutomationQuery.RequestBody,
|
|
1866
|
+
config?: AxiosRequestConfig
|
|
1867
|
+
): OperationResponse<Paths.ExecuteAutomationQuery.Responses.$200>
|
|
1868
|
+
/**
|
|
1869
|
+
* listWorkflowPhasesByDefinitionId - listWorkflowPhasesByDefinitionId
|
|
1870
|
+
*
|
|
1871
|
+
* Retrieves the workflow phases associated with a given workflow definition ID.
|
|
1872
|
+
*
|
|
1873
|
+
*/
|
|
1874
|
+
'listWorkflowPhasesByDefinitionId'(
|
|
1875
|
+
parameters?: Parameters<Paths.ListWorkflowPhasesByDefinitionId.PathParameters> | null,
|
|
1876
|
+
data?: any,
|
|
1877
|
+
config?: AxiosRequestConfig
|
|
1878
|
+
): OperationResponse<Paths.ListWorkflowPhasesByDefinitionId.Responses.$200>
|
|
1879
|
+
/**
|
|
1880
|
+
* listWorkflowDefinitions - listWorkflowDefinitions
|
|
1881
|
+
*
|
|
1882
|
+
* Lists available worflow definitions with their ids, names and start times
|
|
1883
|
+
*
|
|
1884
|
+
*/
|
|
1885
|
+
'listWorkflowDefinitions'(
|
|
1886
|
+
parameters?: Parameters<Paths.ListWorkflowDefinitions.QueryParameters> | null,
|
|
1887
|
+
data?: any,
|
|
1888
|
+
config?: AxiosRequestConfig
|
|
1889
|
+
): OperationResponse<Paths.ListWorkflowDefinitions.Responses.$200>
|
|
1890
|
+
/**
|
|
1891
|
+
* listPhaseNames - listPhaseNames
|
|
1892
|
+
*
|
|
1893
|
+
* Lists phase names of an org.
|
|
1894
|
+
*
|
|
1895
|
+
*/
|
|
1896
|
+
'listPhaseNames'(
|
|
1897
|
+
parameters?: Parameters<Paths.ListPhaseNames.QueryParameters> | null,
|
|
1898
|
+
data?: any,
|
|
1899
|
+
config?: AxiosRequestConfig
|
|
1900
|
+
): OperationResponse<Paths.ListPhaseNames.Responses.$200>
|
|
1901
|
+
/**
|
|
1902
|
+
* listDatasets - listDatasets
|
|
1903
|
+
*
|
|
1904
|
+
* Get list of available datasets
|
|
1905
|
+
*/
|
|
1906
|
+
'listDatasets'(
|
|
1907
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1908
|
+
data?: any,
|
|
1909
|
+
config?: AxiosRequestConfig
|
|
1910
|
+
): OperationResponse<Paths.ListDatasets.Responses.$200>
|
|
1911
|
+
/**
|
|
1912
|
+
* executeQuery - executeQuery
|
|
1913
|
+
*
|
|
1914
|
+
* Execute queries against datasets.
|
|
1915
|
+
*
|
|
1916
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
1917
|
+
*
|
|
1918
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
1919
|
+
*
|
|
1920
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
1921
|
+
*
|
|
1922
|
+
*/
|
|
1923
|
+
'executeQuery'(
|
|
1924
|
+
parameters?: Parameters<Paths.ExecuteQuery.QueryParameters> | null,
|
|
1925
|
+
data?: Paths.ExecuteQuery.RequestBody,
|
|
1926
|
+
config?: AxiosRequestConfig
|
|
1927
|
+
): OperationResponse<Paths.ExecuteQuery.Responses.$200>
|
|
1928
|
+
/**
|
|
1929
|
+
* generateCredentialsV2 - generateCredentialsV2
|
|
1930
|
+
*
|
|
1931
|
+
* Generate credentials for the epilot datalake for connecting other BI tools with ClickHouse
|
|
1932
|
+
*
|
|
1933
|
+
*/
|
|
1934
|
+
'generateCredentialsV2'(
|
|
1935
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1936
|
+
data?: any,
|
|
1937
|
+
config?: AxiosRequestConfig
|
|
1938
|
+
): OperationResponse<Paths.GenerateCredentialsV2.Responses.$200>
|
|
1939
|
+
/**
|
|
1940
|
+
* listCredentialsV2 - listCredentialsV2
|
|
1941
|
+
*
|
|
1942
|
+
* List all the credentialof Clickhouse for the organization here
|
|
1943
|
+
*/
|
|
1944
|
+
'listCredentialsV2'(
|
|
1945
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1946
|
+
data?: any,
|
|
1947
|
+
config?: AxiosRequestConfig
|
|
1948
|
+
): OperationResponse<Paths.ListCredentialsV2.Responses.$200>
|
|
1949
|
+
/**
|
|
1950
|
+
* revokeCredentialsV2 - revokeCredentialsV2
|
|
1951
|
+
*
|
|
1952
|
+
* Revoke credentials for the epilot datalake for connecting other BI tools with Clickhouse
|
|
1953
|
+
*
|
|
1954
|
+
*/
|
|
1955
|
+
'revokeCredentialsV2'(
|
|
1956
|
+
parameters?: Parameters<Paths.RevokeCredentialsV2.QueryParameters> | null,
|
|
1957
|
+
data?: any,
|
|
1958
|
+
config?: AxiosRequestConfig
|
|
1959
|
+
): OperationResponse<Paths.RevokeCredentialsV2.Responses.$200>
|
|
1960
|
+
/**
|
|
1961
|
+
* executeQueryV2 - executeQueryV2
|
|
1962
|
+
*
|
|
1963
|
+
* Execute queries against datasets.
|
|
1964
|
+
*
|
|
1965
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
1966
|
+
*
|
|
1967
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
1968
|
+
*
|
|
1969
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
1970
|
+
*
|
|
1971
|
+
*/
|
|
1972
|
+
'executeQueryV2'(
|
|
1973
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1974
|
+
data?: Paths.ExecuteQueryV2.RequestBody,
|
|
1975
|
+
config?: AxiosRequestConfig
|
|
1976
|
+
): OperationResponse<Paths.ExecuteQueryV2.Responses.$200>
|
|
1977
|
+
/**
|
|
1978
|
+
* getSemanticModel - getSemanticModel
|
|
1979
|
+
*
|
|
1980
|
+
* Get the semantic model for agent/tool consumption.
|
|
1981
|
+
*
|
|
1982
|
+
* Returns available entities, their relationships, and supported query capabilities
|
|
1983
|
+
* including aggregations, calculation types, date granularities, and filter operators.
|
|
1984
|
+
*
|
|
1985
|
+
*/
|
|
1986
|
+
'getSemanticModel'(
|
|
1987
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1988
|
+
data?: any,
|
|
1989
|
+
config?: AxiosRequestConfig
|
|
1990
|
+
): OperationResponse<Paths.GetSemanticModel.Responses.$200>
|
|
1991
|
+
/**
|
|
1992
|
+
* autocomplete - autocomplete
|
|
1993
|
+
*
|
|
1994
|
+
* Generic autocomplete endpoint for querying distinct values across datasets.
|
|
1995
|
+
* Use the dataset parameter to specify which data category to query.
|
|
1996
|
+
*
|
|
1997
|
+
*/
|
|
1998
|
+
'autocomplete'(
|
|
1999
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2000
|
+
data?: any,
|
|
2001
|
+
config?: AxiosRequestConfig
|
|
2002
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2003
|
+
/**
|
|
2004
|
+
* workflowsAutocomplete - workflowsAutocomplete
|
|
2005
|
+
*
|
|
2006
|
+
* Autocomplete Workflows data
|
|
2007
|
+
*
|
|
2008
|
+
*/
|
|
2009
|
+
'workflowsAutocomplete'(
|
|
2010
|
+
parameters?: Parameters<Paths.WorkflowsAutocomplete.QueryParameters> | null,
|
|
2011
|
+
data?: any,
|
|
2012
|
+
config?: AxiosRequestConfig
|
|
2013
|
+
): OperationResponse<Paths.WorkflowsAutocomplete.Responses.$200>
|
|
2014
|
+
}
|
|
2015
|
+
|
|
2016
|
+
interface PathsDictionary {
|
|
2017
|
+
['/datalake/views']: {
|
|
2018
|
+
/**
|
|
2019
|
+
* createOrUpdateView - createOrUpdateView
|
|
2020
|
+
*
|
|
2021
|
+
* Create or update a materialized SQL view in the epilot data lake.
|
|
2022
|
+
*
|
|
2023
|
+
* Views expose epilot data (entities, taxonomies, workflow executions) as queryable tables that can be used by BI tools or queried directly. If a view with the same `view_name` already exists, it is updated.
|
|
2024
|
+
*
|
|
2025
|
+
*/
|
|
2026
|
+
'post'(
|
|
2027
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2028
|
+
data?: Paths.CreateOrUpdateView.RequestBody,
|
|
2029
|
+
config?: AxiosRequestConfig
|
|
2030
|
+
): OperationResponse<Paths.CreateOrUpdateView.Responses.$200>
|
|
2031
|
+
/**
|
|
2032
|
+
* getAllViews - getAllViews
|
|
2033
|
+
*
|
|
2034
|
+
* Retrieve all materialized data lake views configured for the organization.
|
|
2035
|
+
*/
|
|
2036
|
+
'get'(
|
|
2037
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2038
|
+
data?: any,
|
|
2039
|
+
config?: AxiosRequestConfig
|
|
2040
|
+
): OperationResponse<Paths.GetAllViews.Responses.$200>
|
|
2041
|
+
}
|
|
2042
|
+
['/datalake/views/{view_slug}']: {
|
|
2043
|
+
/**
|
|
2044
|
+
* getView - getView
|
|
2045
|
+
*
|
|
2046
|
+
* Retrieve the definition and attributes of a specific data lake view by its slug.
|
|
2047
|
+
*/
|
|
2048
|
+
'get'(
|
|
2049
|
+
parameters?: Parameters<Paths.GetView.PathParameters> | null,
|
|
2050
|
+
data?: any,
|
|
2051
|
+
config?: AxiosRequestConfig
|
|
2052
|
+
): OperationResponse<Paths.GetView.Responses.$200>
|
|
2053
|
+
}
|
|
2054
|
+
['/datalake/relationships']: {
|
|
2055
|
+
/**
|
|
2056
|
+
* createOrUpdateRelationship - createOrUpdateRelationship
|
|
2057
|
+
*
|
|
2058
|
+
* Define or update a relationship between two tables in the data lake.
|
|
2059
|
+
*
|
|
2060
|
+
* Relationships enable JOIN operations in views and queries. If a relationship with the same `relationship_name` already exists, it is updated.
|
|
2061
|
+
*
|
|
2062
|
+
*/
|
|
2063
|
+
'post'(
|
|
2064
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2065
|
+
data?: Paths.CreateOrUpdateRelationship.RequestBody,
|
|
2066
|
+
config?: AxiosRequestConfig
|
|
2067
|
+
): OperationResponse<Paths.CreateOrUpdateRelationship.Responses.$200>
|
|
2068
|
+
/**
|
|
2069
|
+
* getAllRelationships - getAllRelationships
|
|
2070
|
+
*
|
|
2071
|
+
* Retrieve all table relationships configured for the organization's data lake.
|
|
2072
|
+
*/
|
|
2073
|
+
'get'(
|
|
2074
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2075
|
+
data?: any,
|
|
2076
|
+
config?: AxiosRequestConfig
|
|
2077
|
+
): OperationResponse<Paths.GetAllRelationships.Responses.$200>
|
|
2078
|
+
}
|
|
2079
|
+
['/v2/query/datasets']: {
|
|
2080
|
+
/**
|
|
2081
|
+
* listAvailableDatasetsV2 - listAvailableDatasetsV2
|
|
2082
|
+
*
|
|
2083
|
+
* Lists all available datasets grouped by domain
|
|
2084
|
+
*
|
|
2085
|
+
* Current domains are:
|
|
2086
|
+
* - Entity
|
|
2087
|
+
* - Workflow
|
|
2088
|
+
*
|
|
2089
|
+
*/
|
|
2090
|
+
'get'(
|
|
2091
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2092
|
+
data?: any,
|
|
2093
|
+
config?: AxiosRequestConfig
|
|
2094
|
+
): OperationResponse<Paths.ListAvailableDatasetsV2.Responses.$200>
|
|
2095
|
+
}
|
|
2096
|
+
['/v2/query/domain/entities:execute']: {
|
|
2097
|
+
/**
|
|
2098
|
+
* executeEntitiesQuery - executeEntitiesQuery
|
|
2099
|
+
*
|
|
2100
|
+
* Execute queries against entities datasets.
|
|
2101
|
+
*
|
|
2102
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
2103
|
+
*
|
|
2104
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
2105
|
+
*
|
|
2106
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
2107
|
+
*
|
|
2108
|
+
*/
|
|
2109
|
+
'post'(
|
|
2110
|
+
parameters?: Parameters<Paths.ExecuteEntitiesQuery.QueryParameters> | null,
|
|
2111
|
+
data?: Paths.ExecuteEntitiesQuery.RequestBody,
|
|
2112
|
+
config?: AxiosRequestConfig
|
|
2113
|
+
): OperationResponse<Paths.ExecuteEntitiesQuery.Responses.$200>
|
|
2114
|
+
}
|
|
2115
|
+
['/v2/query/domain/workflows:execute']: {
|
|
2116
|
+
/**
|
|
2117
|
+
* executeWorkflowsQuery - executeWorkflowsQuery
|
|
2118
|
+
*
|
|
2119
|
+
* Query Workflow Analytics Datasets.
|
|
2120
|
+
*/
|
|
2121
|
+
'post'(
|
|
2122
|
+
parameters?: Parameters<Paths.ExecuteWorkflowsQuery.QueryParameters> | null,
|
|
2123
|
+
data?: Paths.ExecuteWorkflowsQuery.RequestBody,
|
|
2124
|
+
config?: AxiosRequestConfig
|
|
2125
|
+
): OperationResponse<Paths.ExecuteWorkflowsQuery.Responses.$200>
|
|
2126
|
+
}
|
|
2127
|
+
['/v2/query/domain/automations:execute']: {
|
|
2128
|
+
/**
|
|
2129
|
+
* executeAutomationQuery - executeAutomationQuery
|
|
2130
|
+
*
|
|
2131
|
+
* Query Automation Analytics Datasets.
|
|
2132
|
+
*/
|
|
2133
|
+
'post'(
|
|
2134
|
+
parameters?: Parameters<Paths.ExecuteAutomationQuery.QueryParameters> | null,
|
|
2135
|
+
data?: Paths.ExecuteAutomationQuery.RequestBody,
|
|
2136
|
+
config?: AxiosRequestConfig
|
|
2137
|
+
): OperationResponse<Paths.ExecuteAutomationQuery.Responses.$200>
|
|
2138
|
+
}
|
|
2139
|
+
['/v2/query/domain/workflows/definitions/{workflowDefinitionId}/phases']: {
|
|
2140
|
+
/**
|
|
2141
|
+
* listWorkflowPhasesByDefinitionId - listWorkflowPhasesByDefinitionId
|
|
2142
|
+
*
|
|
2143
|
+
* Retrieves the workflow phases associated with a given workflow definition ID.
|
|
2144
|
+
*
|
|
2145
|
+
*/
|
|
2146
|
+
'get'(
|
|
2147
|
+
parameters?: Parameters<Paths.ListWorkflowPhasesByDefinitionId.PathParameters> | null,
|
|
2148
|
+
data?: any,
|
|
2149
|
+
config?: AxiosRequestConfig
|
|
2150
|
+
): OperationResponse<Paths.ListWorkflowPhasesByDefinitionId.Responses.$200>
|
|
2151
|
+
}
|
|
2152
|
+
['/v2/query/domain/workflows/definitions']: {
|
|
2153
|
+
/**
|
|
2154
|
+
* listWorkflowDefinitions - listWorkflowDefinitions
|
|
2155
|
+
*
|
|
2156
|
+
* Lists available worflow definitions with their ids, names and start times
|
|
2157
|
+
*
|
|
2158
|
+
*/
|
|
2159
|
+
'get'(
|
|
2160
|
+
parameters?: Parameters<Paths.ListWorkflowDefinitions.QueryParameters> | null,
|
|
2161
|
+
data?: any,
|
|
2162
|
+
config?: AxiosRequestConfig
|
|
2163
|
+
): OperationResponse<Paths.ListWorkflowDefinitions.Responses.$200>
|
|
2164
|
+
}
|
|
2165
|
+
['/v2/query/domain/workflows/phases']: {
|
|
2166
|
+
/**
|
|
2167
|
+
* listPhaseNames - listPhaseNames
|
|
2168
|
+
*
|
|
2169
|
+
* Lists phase names of an org.
|
|
2170
|
+
*
|
|
2171
|
+
*/
|
|
2172
|
+
'get'(
|
|
2173
|
+
parameters?: Parameters<Paths.ListPhaseNames.QueryParameters> | null,
|
|
2174
|
+
data?: any,
|
|
2175
|
+
config?: AxiosRequestConfig
|
|
2176
|
+
): OperationResponse<Paths.ListPhaseNames.Responses.$200>
|
|
2177
|
+
}
|
|
2178
|
+
['/v1/query/datasets']: {
|
|
2179
|
+
/**
|
|
2180
|
+
* listDatasets - listDatasets
|
|
2181
|
+
*
|
|
2182
|
+
* Get list of available datasets
|
|
2183
|
+
*/
|
|
2184
|
+
'get'(
|
|
2185
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2186
|
+
data?: any,
|
|
2187
|
+
config?: AxiosRequestConfig
|
|
2188
|
+
): OperationResponse<Paths.ListDatasets.Responses.$200>
|
|
2189
|
+
}
|
|
2190
|
+
['/v1/query:execute']: {
|
|
2191
|
+
/**
|
|
2192
|
+
* executeQuery - executeQuery
|
|
2193
|
+
*
|
|
2194
|
+
* Execute queries against datasets.
|
|
2195
|
+
*
|
|
2196
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
2197
|
+
*
|
|
2198
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
2199
|
+
*
|
|
2200
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
2201
|
+
*
|
|
2202
|
+
*/
|
|
2203
|
+
'post'(
|
|
2204
|
+
parameters?: Parameters<Paths.ExecuteQuery.QueryParameters> | null,
|
|
2205
|
+
data?: Paths.ExecuteQuery.RequestBody,
|
|
2206
|
+
config?: AxiosRequestConfig
|
|
2207
|
+
): OperationResponse<Paths.ExecuteQuery.Responses.$200>
|
|
2208
|
+
}
|
|
2209
|
+
['/v2/query/credentials:generate']: {
|
|
2210
|
+
/**
|
|
2211
|
+
* generateCredentialsV2 - generateCredentialsV2
|
|
2212
|
+
*
|
|
2213
|
+
* Generate credentials for the epilot datalake for connecting other BI tools with ClickHouse
|
|
2214
|
+
*
|
|
2215
|
+
*/
|
|
2216
|
+
'post'(
|
|
2217
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2218
|
+
data?: any,
|
|
2219
|
+
config?: AxiosRequestConfig
|
|
2220
|
+
): OperationResponse<Paths.GenerateCredentialsV2.Responses.$200>
|
|
2221
|
+
}
|
|
2222
|
+
['/v2/query/credentials:list']: {
|
|
2223
|
+
/**
|
|
2224
|
+
* listCredentialsV2 - listCredentialsV2
|
|
2225
|
+
*
|
|
2226
|
+
* List all the credentialof Clickhouse for the organization here
|
|
2227
|
+
*/
|
|
2228
|
+
'get'(
|
|
2229
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2230
|
+
data?: any,
|
|
2231
|
+
config?: AxiosRequestConfig
|
|
2232
|
+
): OperationResponse<Paths.ListCredentialsV2.Responses.$200>
|
|
2233
|
+
}
|
|
2234
|
+
['/v2/query/credentials:revoke']: {
|
|
2235
|
+
/**
|
|
2236
|
+
* revokeCredentialsV2 - revokeCredentialsV2
|
|
2237
|
+
*
|
|
2238
|
+
* Revoke credentials for the epilot datalake for connecting other BI tools with Clickhouse
|
|
2239
|
+
*
|
|
2240
|
+
*/
|
|
2241
|
+
'post'(
|
|
2242
|
+
parameters?: Parameters<Paths.RevokeCredentialsV2.QueryParameters> | null,
|
|
2243
|
+
data?: any,
|
|
2244
|
+
config?: AxiosRequestConfig
|
|
2245
|
+
): OperationResponse<Paths.RevokeCredentialsV2.Responses.$200>
|
|
2246
|
+
}
|
|
2247
|
+
['/v2/query:execute']: {
|
|
2248
|
+
/**
|
|
2249
|
+
* executeQueryV2 - executeQueryV2
|
|
2250
|
+
*
|
|
2251
|
+
* Execute queries against datasets.
|
|
2252
|
+
*
|
|
2253
|
+
* **Measures** are referred to as quantitative data, such as number of unique entities, operations, sum of profit, and so on.
|
|
2254
|
+
*
|
|
2255
|
+
* **Dimensions** are referred to as categorical data, such as workflow status, product name, or units of time (e.g., day, week, month).
|
|
2256
|
+
*
|
|
2257
|
+
* **Filters** are used to narrow down the dataset to be more specific e.g. only to a time range or specific entity schemas.
|
|
2258
|
+
*
|
|
2259
|
+
*/
|
|
2260
|
+
'post'(
|
|
2261
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2262
|
+
data?: Paths.ExecuteQueryV2.RequestBody,
|
|
2263
|
+
config?: AxiosRequestConfig
|
|
2264
|
+
): OperationResponse<Paths.ExecuteQueryV2.Responses.$200>
|
|
2265
|
+
}
|
|
2266
|
+
['/v2/query/semantic-model']: {
|
|
2267
|
+
/**
|
|
2268
|
+
* getSemanticModel - getSemanticModel
|
|
2269
|
+
*
|
|
2270
|
+
* Get the semantic model for agent/tool consumption.
|
|
2271
|
+
*
|
|
2272
|
+
* Returns available entities, their relationships, and supported query capabilities
|
|
2273
|
+
* including aggregations, calculation types, date granularities, and filter operators.
|
|
2274
|
+
*
|
|
2275
|
+
*/
|
|
2276
|
+
'get'(
|
|
2277
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2278
|
+
data?: any,
|
|
2279
|
+
config?: AxiosRequestConfig
|
|
2280
|
+
): OperationResponse<Paths.GetSemanticModel.Responses.$200>
|
|
2281
|
+
}
|
|
2282
|
+
['/v2/query/autocomplete']: {
|
|
2283
|
+
/**
|
|
2284
|
+
* autocomplete - autocomplete
|
|
2285
|
+
*
|
|
2286
|
+
* Generic autocomplete endpoint for querying distinct values across datasets.
|
|
2287
|
+
* Use the dataset parameter to specify which data category to query.
|
|
2288
|
+
*
|
|
2289
|
+
*/
|
|
2290
|
+
'get'(
|
|
2291
|
+
parameters?: Parameters<Paths.Autocomplete.QueryParameters> | null,
|
|
2292
|
+
data?: any,
|
|
2293
|
+
config?: AxiosRequestConfig
|
|
2294
|
+
): OperationResponse<Paths.Autocomplete.Responses.$200>
|
|
2295
|
+
}
|
|
2296
|
+
['/v2/query/workflows:autocomplete']: {
|
|
2297
|
+
/**
|
|
2298
|
+
* workflowsAutocomplete - workflowsAutocomplete
|
|
2299
|
+
*
|
|
2300
|
+
* Autocomplete Workflows data
|
|
2301
|
+
*
|
|
2302
|
+
*/
|
|
2303
|
+
'get'(
|
|
2304
|
+
parameters?: Parameters<Paths.WorkflowsAutocomplete.QueryParameters> | null,
|
|
2305
|
+
data?: any,
|
|
2306
|
+
config?: AxiosRequestConfig
|
|
2307
|
+
): OperationResponse<Paths.WorkflowsAutocomplete.Responses.$200>
|
|
2308
|
+
}
|
|
2309
|
+
}
|
|
2310
|
+
|
|
2311
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
type AutomationConfig = Components.Schemas.AutomationConfig;
|
|
2315
|
+
type AutomationExecutionDataset = Components.Schemas.AutomationExecutionDataset;
|
|
2316
|
+
type AutomationExecutionResponse = Components.Schemas.AutomationExecutionResponse;
|
|
2317
|
+
type AutomationQueryOptions = Components.Schemas.AutomationQueryOptions;
|
|
2318
|
+
type CacheExpiration = Components.Schemas.CacheExpiration;
|
|
2319
|
+
type CurrentEntitiesViewRequest = Components.Schemas.CurrentEntitiesViewRequest;
|
|
2320
|
+
type DatalakeQuery = Components.Schemas.DatalakeQuery;
|
|
2321
|
+
type DatalakeQueryOptions = Components.Schemas.DatalakeQueryOptions;
|
|
2322
|
+
type Dataset = Components.Schemas.Dataset;
|
|
2323
|
+
type DatasetDomain = Components.Schemas.DatasetDomain;
|
|
2324
|
+
type DatasetName = Components.Schemas.DatasetName;
|
|
2325
|
+
type DatasetOptions_AutomationExecutionsOverview = Components.Schemas.DatasetOptionsAutomationExecutionsOverview;
|
|
2326
|
+
type DatasetOptions_CancellationReasons = Components.Schemas.DatasetOptionsCancellationReasons;
|
|
2327
|
+
type DatasetOptions_CumulativeSumOfWorkflows = Components.Schemas.DatasetOptionsCumulativeSumOfWorkflows;
|
|
2328
|
+
type DatasetOptions_ListAutomationDefinitions = Components.Schemas.DatasetOptionsListAutomationDefinitions;
|
|
2329
|
+
type DatasetOptions_TotalCountOfWorkflowExecutions = Components.Schemas.DatasetOptionsTotalCountOfWorkflowExecutions;
|
|
2330
|
+
type DatasetOptions_WorkflowExecutionTimeSeries = Components.Schemas.DatasetOptionsWorkflowExecutionTimeSeries;
|
|
2331
|
+
type DatasetOptions_WorkflowTasksOverview = Components.Schemas.DatasetOptionsWorkflowTasksOverview;
|
|
2332
|
+
type DynamicDueDate = Components.Schemas.DynamicDueDate;
|
|
2333
|
+
type ECPDetails = Components.Schemas.ECPDetails;
|
|
2334
|
+
type EntityDataset = Components.Schemas.EntityDataset;
|
|
2335
|
+
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
2336
|
+
type ListAutomationDefinitionsResponse = Components.Schemas.ListAutomationDefinitionsResponse;
|
|
2337
|
+
type NameDurationSettings = Components.Schemas.NameDurationSettings;
|
|
2338
|
+
type NoCache = Components.Schemas.NoCache;
|
|
2339
|
+
type PhaseStates = Components.Schemas.PhaseStates;
|
|
2340
|
+
type QueryResults = Components.Schemas.QueryResults;
|
|
2341
|
+
type RelationshipRequest = Components.Schemas.RelationshipRequest;
|
|
2342
|
+
type RelationshipResponse = Components.Schemas.RelationshipResponse;
|
|
2343
|
+
type RelationshipsListResponse = Components.Schemas.RelationshipsListResponse;
|
|
2344
|
+
type RelativeTimeRange = Components.Schemas.RelativeTimeRange;
|
|
2345
|
+
type Response_WorkflowTaskOverview = Components.Schemas.ResponseWorkflowTaskOverview;
|
|
2346
|
+
type SemanticModel = Components.Schemas.SemanticModel;
|
|
2347
|
+
type SortBy = Components.Schemas.SortBy;
|
|
2348
|
+
type Task = Components.Schemas.Task;
|
|
2349
|
+
type TaskRequirement = Components.Schemas.TaskRequirement;
|
|
2350
|
+
type TaskStates = Components.Schemas.TaskStates;
|
|
2351
|
+
type TaskStatus = Components.Schemas.TaskStatus;
|
|
2352
|
+
type TaskType = Components.Schemas.TaskType;
|
|
2353
|
+
type TaxonomiesViewRequest = Components.Schemas.TaxonomiesViewRequest;
|
|
2354
|
+
type TimeGroups = Components.Schemas.TimeGroups;
|
|
2355
|
+
type TimeSeriesSettings = Components.Schemas.TimeSeriesSettings;
|
|
2356
|
+
type UserId = Components.Schemas.UserId;
|
|
2357
|
+
type ViewRequest = Components.Schemas.ViewRequest;
|
|
2358
|
+
type ViewResponse = Components.Schemas.ViewResponse;
|
|
2359
|
+
type ViewsListResponse = Components.Schemas.ViewsListResponse;
|
|
2360
|
+
type WorkflowContext = Components.Schemas.WorkflowContext;
|
|
2361
|
+
type WorkflowDataset = Components.Schemas.WorkflowDataset;
|
|
2362
|
+
type WorkflowExecutionsViewRequest = Components.Schemas.WorkflowExecutionsViewRequest;
|
|
2363
|
+
type WorkflowStates = Components.Schemas.WorkflowStates;
|
|
2364
|
+
type WorkflowStatus = Components.Schemas.WorkflowStatus;
|
|
2365
|
+
type WorkflowsQueryOptions = Components.Schemas.WorkflowsQueryOptions;
|
|
2366
|
+
type WorkflowsQueryOptions_EntitySchema = Components.Schemas.WorkflowsQueryOptionsEntitySchema;
|
|
2367
|
+
type WorkflowsQueryOptions_GroupTimeBy = Components.Schemas.WorkflowsQueryOptionsGroupTimeBy;
|
|
2368
|
+
type WorkflowsQueryOptions_RelativeTimeRange = Components.Schemas.WorkflowsQueryOptionsRelativeTimeRange;
|
|
2369
|
+
type WorkflowsQueryOptions_TimeRangeFrom = Components.Schemas.WorkflowsQueryOptionsTimeRangeFrom;
|
|
2370
|
+
type WorkflowsQueryOptions_TimeRangeTo = Components.Schemas.WorkflowsQueryOptionsTimeRangeTo;
|
|
2371
|
+
type WorkflowsQueryOptions_WorkflowDefinitionIDs = Components.Schemas.WorkflowsQueryOptionsWorkflowDefinitionIDs;
|
|
2372
|
+
type WorkflowsQueryOptions_WorkflowStates = Components.Schemas.WorkflowsQueryOptionsWorkflowStates;
|
|
2373
|
+
type WorkflowsQueryResult = Components.Schemas.WorkflowsQueryResult;
|
|
2374
|
+
|
|
2375
|
+
export { type WorkflowExecutionsViewRequest as $, type AutomationConfig as A, type Response_WorkflowTaskOverview as B, type Client as C, type DatalakeQuery as D, type ECPDetails as E, type SortBy as F, type TaskRequirement as G, type TaskStates as H, type TaskStatus as I, type TaskType as J, type TaxonomiesViewRequest as K, type ListAutomationDefinitionsResponse as L, type TimeGroups as M, type NameDurationSettings as N, type OperationMethods as O, Paths as P, type QueryResults as Q, type RelationshipRequest as R, type SemanticModel as S, type Task as T, type TimeSeriesSettings as U, type UserId as V, type ViewRequest as W, type ViewResponse as X, type ViewsListResponse as Y, type WorkflowContext as Z, type WorkflowDataset as _, Components as a, type WorkflowStates as a0, type WorkflowStatus as a1, type WorkflowsQueryOptions as a2, type WorkflowsQueryOptions_EntitySchema as a3, type WorkflowsQueryOptions_GroupTimeBy as a4, type WorkflowsQueryOptions_RelativeTimeRange as a5, type WorkflowsQueryOptions_TimeRangeFrom as a6, type WorkflowsQueryOptions_TimeRangeTo as a7, type WorkflowsQueryOptions_WorkflowDefinitionIDs as a8, type WorkflowsQueryOptions_WorkflowStates as a9, type WorkflowsQueryResult as aa, type PathsDictionary as b, type AutomationExecutionDataset as c, type AutomationExecutionResponse as d, type AutomationQueryOptions as e, type CacheExpiration as f, type CurrentEntitiesViewRequest as g, type DatalakeQueryOptions as h, type Dataset as i, type DatasetDomain as j, type DatasetName as k, type DatasetOptions_AutomationExecutionsOverview as l, type DatasetOptions_CancellationReasons as m, type DatasetOptions_CumulativeSumOfWorkflows as n, type DatasetOptions_ListAutomationDefinitions as o, type DatasetOptions_TotalCountOfWorkflowExecutions as p, type DatasetOptions_WorkflowExecutionTimeSeries as q, type DatasetOptions_WorkflowTasksOverview as r, type DynamicDueDate as s, type EntityDataset as t, type ErrorResponse as u, type NoCache as v, type PhaseStates as w, type RelationshipResponse as x, type RelationshipsListResponse as y, type RelativeTimeRange as z };
|