@magemetrics/core 0.0.59 → 0.0.60
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/dist/index.d.ts +3464 -0
- package/dist/index.js +2923 -0
- package/dist/index.js.map +1 -0
- package/package.json +12 -9
- package/dist/package.json +0 -59
- package/dist/src/adapters/storage/browser.d.ts +0 -11
- package/dist/src/adapters/storage/browser.d.ts.map +0 -1
- package/dist/src/adapters/storage/browser.js +0 -37
- package/dist/src/adapters/storage/browser.js.map +0 -1
- package/dist/src/adapters/storage/factory.d.ts +0 -8
- package/dist/src/adapters/storage/factory.d.ts.map +0 -1
- package/dist/src/adapters/storage/factory.js +0 -24
- package/dist/src/adapters/storage/factory.js.map +0 -1
- package/dist/src/adapters/storage/interface.d.ts +0 -26
- package/dist/src/adapters/storage/interface.d.ts.map +0 -1
- package/dist/src/adapters/storage/interface.js +0 -1
- package/dist/src/adapters/storage/interface.js.map +0 -1
- package/dist/src/adapters/storage/memory.d.ts +0 -11
- package/dist/src/adapters/storage/memory.d.ts.map +0 -1
- package/dist/src/adapters/storage/memory.js +0 -20
- package/dist/src/adapters/storage/memory.js.map +0 -1
- package/dist/src/core/MageMetricsClient.d.ts +0 -103
- package/dist/src/core/MageMetricsClient.d.ts.map +0 -1
- package/dist/src/core/MageMetricsClient.js +0 -509
- package/dist/src/core/MageMetricsClient.js.map +0 -1
- package/dist/src/core/MageMetricsEventEmitter.d.ts +0 -25
- package/dist/src/core/MageMetricsEventEmitter.d.ts.map +0 -1
- package/dist/src/core/MageMetricsEventEmitter.js +0 -48
- package/dist/src/core/MageMetricsEventEmitter.js.map +0 -1
- package/dist/src/core/types.d.ts +0 -37
- package/dist/src/core/types.d.ts.map +0 -1
- package/dist/src/core/types.js +0 -6
- package/dist/src/core/types.js.map +0 -1
- package/dist/src/index.d.ts +0 -8
- package/dist/src/index.d.ts.map +0 -1
- package/dist/src/index.js +0 -7
- package/dist/src/index.js.map +0 -1
- package/dist/src/utils/hash.d.ts +0 -8
- package/dist/src/utils/hash.d.ts.map +0 -1
- package/dist/src/utils/hash.js +0 -16
- package/dist/src/utils/hash.js.map +0 -1
- package/dist/src/utils/platform.d.ts +0 -10
- package/dist/src/utils/platform.d.ts.map +0 -1
- package/dist/src/utils/platform.js +0 -25
- package/dist/src/utils/platform.js.map +0 -1
- package/dist/tsconfig.tsbuildinfo +0 -1
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3464 @@
|
|
|
1
|
+
import { Client } from 'openapi-fetch';
|
|
2
|
+
import type { Simplify } from 'type-fest';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Universal storage adapter interface for cross-platform compatibility.
|
|
7
|
+
* All operations are async to accommodate different storage mechanisms.
|
|
8
|
+
*/
|
|
9
|
+
export declare interface AsyncStorage {
|
|
10
|
+
/**
|
|
11
|
+
* Retrieve an item from storage
|
|
12
|
+
* @param key - The storage key
|
|
13
|
+
* @returns Promise resolving to the stored value or null if not found
|
|
14
|
+
*/
|
|
15
|
+
getItem(key: string): Promise<string | null>;
|
|
16
|
+
/**
|
|
17
|
+
* Store an item in storage
|
|
18
|
+
* @param key - The storage key
|
|
19
|
+
* @param value - The value to store (must be a string)
|
|
20
|
+
* @returns Promise resolving when storage is complete
|
|
21
|
+
*/
|
|
22
|
+
setItem(key: string, value: string): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* Remove an item from storage
|
|
25
|
+
* @param key - The storage key
|
|
26
|
+
* @returns Promise resolving when removal is complete
|
|
27
|
+
*/
|
|
28
|
+
removeItem(key: string): Promise<void>;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Universal storage adapter interface for cross-platform compatibility.
|
|
33
|
+
* All operations are async to accommodate different storage mechanisms.
|
|
34
|
+
*/
|
|
35
|
+
declare interface AsyncStorage_2 {
|
|
36
|
+
/**
|
|
37
|
+
* Retrieve an item from storage
|
|
38
|
+
* @param key - The storage key
|
|
39
|
+
* @returns Promise resolving to the stored value or null if not found
|
|
40
|
+
*/
|
|
41
|
+
getItem(key: string): Promise<string | null>;
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Store an item in storage
|
|
45
|
+
* @param key - The storage key
|
|
46
|
+
* @param value - The value to store (must be a string)
|
|
47
|
+
* @returns Promise resolving when storage is complete
|
|
48
|
+
*/
|
|
49
|
+
setItem(key: string, value: string): Promise<void>;
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Remove an item from storage
|
|
53
|
+
* @param key - The storage key
|
|
54
|
+
* @returns Promise resolving when removal is complete
|
|
55
|
+
*/
|
|
56
|
+
removeItem(key: string): Promise<void>;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Authentication states
|
|
61
|
+
*/
|
|
62
|
+
export declare type AuthState = "initializing" | "ready" | "error";
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Browser localStorage adapter with async interface.
|
|
66
|
+
* Wraps the synchronous localStorage API with async methods for consistency.
|
|
67
|
+
*/
|
|
68
|
+
export declare class BrowserStorageAdapter implements AsyncStorage {
|
|
69
|
+
getItem(key: string): Promise<string | null>;
|
|
70
|
+
setItem(key: string, value: string): Promise<void>;
|
|
71
|
+
removeItem(key: string): Promise<void>;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export declare const CHECK_KEY = "mm-ai-check-key";
|
|
75
|
+
|
|
76
|
+
declare interface components {
|
|
77
|
+
schemas: {
|
|
78
|
+
VisualizationData: {
|
|
79
|
+
[key: string]: string | (number | null) | unknown | null;
|
|
80
|
+
}[];
|
|
81
|
+
VisualizationWithData: {
|
|
82
|
+
id: number;
|
|
83
|
+
flow_data_id: number;
|
|
84
|
+
created_at: string;
|
|
85
|
+
bookmarked: boolean;
|
|
86
|
+
configuration: {
|
|
87
|
+
/** @enum {string} */
|
|
88
|
+
type: "bar";
|
|
89
|
+
title: string;
|
|
90
|
+
/** @enum {number} */
|
|
91
|
+
config_version: 2;
|
|
92
|
+
xAxisLabel: string;
|
|
93
|
+
yAxisLabel: string;
|
|
94
|
+
categoryColumn: string;
|
|
95
|
+
secondaryCategoryColumn?: string;
|
|
96
|
+
valueColumn: string;
|
|
97
|
+
} | {
|
|
98
|
+
/** @enum {string} */
|
|
99
|
+
type: "line/area";
|
|
100
|
+
/** @enum {number} */
|
|
101
|
+
config_version: 2;
|
|
102
|
+
title: string;
|
|
103
|
+
xAxisColumn: string;
|
|
104
|
+
valueColumns: string[];
|
|
105
|
+
yAxisLabels: string[];
|
|
106
|
+
} | {
|
|
107
|
+
/** @enum {string} */
|
|
108
|
+
type: "line/area-categorical";
|
|
109
|
+
title: string;
|
|
110
|
+
/** @enum {number} */
|
|
111
|
+
config_version: 2;
|
|
112
|
+
valueColumn: string;
|
|
113
|
+
xAxisColumn: string;
|
|
114
|
+
xAxisLabel: string;
|
|
115
|
+
yAxisLabel: string;
|
|
116
|
+
categoryColumn: string;
|
|
117
|
+
} | {
|
|
118
|
+
/** @enum {string} */
|
|
119
|
+
type: "scatter";
|
|
120
|
+
title: string;
|
|
121
|
+
/** @enum {number} */
|
|
122
|
+
config_version: 2;
|
|
123
|
+
xAxisLabel: string;
|
|
124
|
+
yAxisLabel: string;
|
|
125
|
+
xAxisValueColumn: string;
|
|
126
|
+
yAxisValueColumn: string;
|
|
127
|
+
} | {
|
|
128
|
+
/** @enum {string} */
|
|
129
|
+
type: "pie";
|
|
130
|
+
title: string;
|
|
131
|
+
/** @enum {number} */
|
|
132
|
+
config_version: 2;
|
|
133
|
+
categoryColumn: string;
|
|
134
|
+
valueColumn: string;
|
|
135
|
+
};
|
|
136
|
+
data: components["schemas"]["VisualizationData"];
|
|
137
|
+
_metadata?: {
|
|
138
|
+
wasSampled: boolean;
|
|
139
|
+
originalCount: number;
|
|
140
|
+
sampledCount: number;
|
|
141
|
+
};
|
|
142
|
+
} | {
|
|
143
|
+
id: number;
|
|
144
|
+
flow_data_id: number;
|
|
145
|
+
created_at: string;
|
|
146
|
+
bookmarked: boolean;
|
|
147
|
+
configuration: {
|
|
148
|
+
/** @enum {string} */
|
|
149
|
+
type: "bar";
|
|
150
|
+
title: string;
|
|
151
|
+
xAxisLabel: string;
|
|
152
|
+
yAxisLabel: string;
|
|
153
|
+
xAxisDataKey?: string;
|
|
154
|
+
yAxisDataKey?: string;
|
|
155
|
+
dimensionDataKey?: string;
|
|
156
|
+
valueColumns?: string[];
|
|
157
|
+
} | {
|
|
158
|
+
/** @enum {string} */
|
|
159
|
+
type: "line/area";
|
|
160
|
+
title: string;
|
|
161
|
+
xAxisLabel: string;
|
|
162
|
+
yAxisLabel: string;
|
|
163
|
+
xAxisDataKey?: string;
|
|
164
|
+
yAxisDataKey?: string;
|
|
165
|
+
dimensionDataKey?: string;
|
|
166
|
+
valueColumns?: string[];
|
|
167
|
+
} | {
|
|
168
|
+
/** @enum {string} */
|
|
169
|
+
type: "scatter";
|
|
170
|
+
title: string;
|
|
171
|
+
xAxisLabel: string;
|
|
172
|
+
yAxisLabel: string;
|
|
173
|
+
xAxisDataKey?: string;
|
|
174
|
+
yAxisDataKey?: string;
|
|
175
|
+
dimensionDataKey?: string;
|
|
176
|
+
valueColumns?: string[];
|
|
177
|
+
} | {
|
|
178
|
+
/** @enum {string} */
|
|
179
|
+
type: "pie";
|
|
180
|
+
title: string;
|
|
181
|
+
nameKey: string;
|
|
182
|
+
dataKey: string;
|
|
183
|
+
};
|
|
184
|
+
data: components["schemas"]["VisualizationData"];
|
|
185
|
+
_metadata?: {
|
|
186
|
+
wasSampled: boolean;
|
|
187
|
+
originalCount: number;
|
|
188
|
+
sampledCount: number;
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
/** Format: uuid */
|
|
192
|
+
DashboardId: string;
|
|
193
|
+
ReportColumns: {
|
|
194
|
+
name: string;
|
|
195
|
+
data_type: string;
|
|
196
|
+
dataType: string;
|
|
197
|
+
renderType?: string;
|
|
198
|
+
unit?: string;
|
|
199
|
+
}[];
|
|
200
|
+
ReportData: Record<string, unknown>[];
|
|
201
|
+
/** @description Starter recommendations */
|
|
202
|
+
StarterRecommendation: {
|
|
203
|
+
starter: string;
|
|
204
|
+
explanation: string;
|
|
205
|
+
type: string;
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
responses: never;
|
|
209
|
+
parameters: never;
|
|
210
|
+
requestBodies: never;
|
|
211
|
+
headers: never;
|
|
212
|
+
pathItems: never;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
declare type ExtractInsightResponse = z.infer<typeof ExtractInsightResponseSchema>;
|
|
216
|
+
|
|
217
|
+
declare const ExtractInsightResponseSchema: z.ZodUnion<[z.ZodObject<{
|
|
218
|
+
type: z.ZodLiteral<"text">;
|
|
219
|
+
insight: z.ZodString;
|
|
220
|
+
}, "strip", z.ZodTypeAny, {
|
|
221
|
+
type: "text";
|
|
222
|
+
insight: string;
|
|
223
|
+
}, {
|
|
224
|
+
type: "text";
|
|
225
|
+
insight: string;
|
|
226
|
+
}>, z.ZodObject<{
|
|
227
|
+
type: z.ZodLiteral<"missing">;
|
|
228
|
+
}, "strip", z.ZodTypeAny, {
|
|
229
|
+
type: "missing";
|
|
230
|
+
}, {
|
|
231
|
+
type: "missing";
|
|
232
|
+
}>]>;
|
|
233
|
+
|
|
234
|
+
declare type FrontendDashboard = z.infer<typeof FrontendDashboardSchema>;
|
|
235
|
+
|
|
236
|
+
declare const FrontendDashboardSchema: z.ZodObject<Omit<{
|
|
237
|
+
company_id: z.ZodNumber;
|
|
238
|
+
created_at: z.ZodString;
|
|
239
|
+
description: z.ZodNullable<z.ZodString>;
|
|
240
|
+
id: z.ZodString;
|
|
241
|
+
name: z.ZodString;
|
|
242
|
+
positions: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
|
|
243
|
+
type: z.ZodLiteral<"data-report">;
|
|
244
|
+
flowId: z.ZodString;
|
|
245
|
+
flowDataId: z.ZodNumber;
|
|
246
|
+
title: z.ZodString;
|
|
247
|
+
col: z.ZodNumber;
|
|
248
|
+
colSpan: z.ZodNumber;
|
|
249
|
+
rowSpan: z.ZodNumber;
|
|
250
|
+
}, "strip", z.ZodTypeAny, {
|
|
251
|
+
type: "data-report";
|
|
252
|
+
title: string;
|
|
253
|
+
flowDataId: number;
|
|
254
|
+
flowId: string;
|
|
255
|
+
col: number;
|
|
256
|
+
colSpan: number;
|
|
257
|
+
rowSpan: number;
|
|
258
|
+
}, {
|
|
259
|
+
type: "data-report";
|
|
260
|
+
title: string;
|
|
261
|
+
flowDataId: number;
|
|
262
|
+
flowId: string;
|
|
263
|
+
col: number;
|
|
264
|
+
colSpan: number;
|
|
265
|
+
rowSpan: number;
|
|
266
|
+
}>, z.ZodObject<{
|
|
267
|
+
type: z.ZodLiteral<"visualization">;
|
|
268
|
+
visualizationId: z.ZodNumber;
|
|
269
|
+
title: z.ZodString;
|
|
270
|
+
col: z.ZodNumber;
|
|
271
|
+
colSpan: z.ZodNumber;
|
|
272
|
+
rowSpan: z.ZodNumber;
|
|
273
|
+
}, "strip", z.ZodTypeAny, {
|
|
274
|
+
type: "visualization";
|
|
275
|
+
title: string;
|
|
276
|
+
col: number;
|
|
277
|
+
colSpan: number;
|
|
278
|
+
rowSpan: number;
|
|
279
|
+
visualizationId: number;
|
|
280
|
+
}, {
|
|
281
|
+
type: "visualization";
|
|
282
|
+
title: string;
|
|
283
|
+
col: number;
|
|
284
|
+
colSpan: number;
|
|
285
|
+
rowSpan: number;
|
|
286
|
+
visualizationId: number;
|
|
287
|
+
}>]>, "many">;
|
|
288
|
+
updated_at: z.ZodString;
|
|
289
|
+
is_removed: z.ZodBoolean;
|
|
290
|
+
is_public: z.ZodBoolean;
|
|
291
|
+
}, "created_at" | "is_removed" | "company_id" | "updated_at">, "strip", z.ZodTypeAny, {
|
|
292
|
+
description: string | null;
|
|
293
|
+
name: string;
|
|
294
|
+
id: string;
|
|
295
|
+
positions: ({
|
|
296
|
+
type: "data-report";
|
|
297
|
+
title: string;
|
|
298
|
+
flowDataId: number;
|
|
299
|
+
flowId: string;
|
|
300
|
+
col: number;
|
|
301
|
+
colSpan: number;
|
|
302
|
+
rowSpan: number;
|
|
303
|
+
} | {
|
|
304
|
+
type: "visualization";
|
|
305
|
+
title: string;
|
|
306
|
+
col: number;
|
|
307
|
+
colSpan: number;
|
|
308
|
+
rowSpan: number;
|
|
309
|
+
visualizationId: number;
|
|
310
|
+
})[];
|
|
311
|
+
is_public: boolean;
|
|
312
|
+
}, {
|
|
313
|
+
description: string | null;
|
|
314
|
+
name: string;
|
|
315
|
+
id: string;
|
|
316
|
+
positions: ({
|
|
317
|
+
type: "data-report";
|
|
318
|
+
title: string;
|
|
319
|
+
flowDataId: number;
|
|
320
|
+
flowId: string;
|
|
321
|
+
col: number;
|
|
322
|
+
colSpan: number;
|
|
323
|
+
rowSpan: number;
|
|
324
|
+
} | {
|
|
325
|
+
type: "visualization";
|
|
326
|
+
title: string;
|
|
327
|
+
col: number;
|
|
328
|
+
colSpan: number;
|
|
329
|
+
rowSpan: number;
|
|
330
|
+
visualizationId: number;
|
|
331
|
+
})[];
|
|
332
|
+
is_public: boolean;
|
|
333
|
+
}>;
|
|
334
|
+
|
|
335
|
+
declare type FrontendRecentFlows = z.infer<typeof FrontendRecentFlowsSchema>;
|
|
336
|
+
|
|
337
|
+
declare const FrontendRecentFlowsSchema: z.ZodObject<Omit<{
|
|
338
|
+
created_at: z.ZodString;
|
|
339
|
+
id: z.ZodString;
|
|
340
|
+
request: z.ZodString;
|
|
341
|
+
user_id: z.ZodNullable<z.ZodString>;
|
|
342
|
+
flow_steps: z.ZodArray<z.ZodObject<{
|
|
343
|
+
name: z.ZodString;
|
|
344
|
+
status: z.ZodEnum<["running", "completed", "failed", "awaiting_input"]>;
|
|
345
|
+
output: z.ZodNullable<z.ZodUnion<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, z.ZodArray<z.ZodUnknown, "many">]>>;
|
|
346
|
+
}, "strip", z.ZodTypeAny, {
|
|
347
|
+
status: "running" | "completed" | "failed" | "awaiting_input";
|
|
348
|
+
name: string;
|
|
349
|
+
output: unknown[] | z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | null;
|
|
350
|
+
}, {
|
|
351
|
+
status: "running" | "completed" | "failed" | "awaiting_input";
|
|
352
|
+
name: string;
|
|
353
|
+
output: unknown[] | z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | null;
|
|
354
|
+
}>, "many">;
|
|
355
|
+
flow_chat_messages: z.ZodArray<z.ZodObject<{
|
|
356
|
+
count: z.ZodNumber;
|
|
357
|
+
}, "strip", z.ZodTypeAny, {
|
|
358
|
+
count: number;
|
|
359
|
+
}, {
|
|
360
|
+
count: number;
|
|
361
|
+
}>, "many">;
|
|
362
|
+
}, "flow_steps" | "flow_chat_messages">, "strip", z.ZodTypeAny, {
|
|
363
|
+
id: string;
|
|
364
|
+
request: string;
|
|
365
|
+
created_at: string;
|
|
366
|
+
user_id: string | null;
|
|
367
|
+
}, {
|
|
368
|
+
id: string;
|
|
369
|
+
request: string;
|
|
370
|
+
created_at: string;
|
|
371
|
+
user_id: string | null;
|
|
372
|
+
}>;
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Parameters for generating contextual insights
|
|
376
|
+
*/
|
|
377
|
+
export declare type GenerateInsightParam = {
|
|
378
|
+
selectedFilterValue: string;
|
|
379
|
+
customId: string;
|
|
380
|
+
};
|
|
381
|
+
|
|
382
|
+
export declare const getPublicApiClient: (apiUrl: string, apiKey: string) => Client<NoAuthPaths>;
|
|
383
|
+
|
|
384
|
+
declare type InternalApiClient = Simplify<Client<NoAuthPaths, `${string}/${string}`>>;
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Core MageMetrics client that handles authentication lifecycle and provides
|
|
388
|
+
* a promise-based API that automatically waits for authentication to complete.
|
|
389
|
+
*
|
|
390
|
+
* This version uses composition instead of inheritance and pluggable storage adapters
|
|
391
|
+
* for cross-platform compatibility.
|
|
392
|
+
*/
|
|
393
|
+
export declare class MageMetricsClient {
|
|
394
|
+
private config;
|
|
395
|
+
private authState;
|
|
396
|
+
private supabaseClient;
|
|
397
|
+
private internalApiClient;
|
|
398
|
+
private noAuthApiClient;
|
|
399
|
+
private authApiResponse;
|
|
400
|
+
private authPromise;
|
|
401
|
+
private processedJwt;
|
|
402
|
+
private storageAdapter;
|
|
403
|
+
private events;
|
|
404
|
+
constructor(config: MageMetricsClientConfig);
|
|
405
|
+
/**
|
|
406
|
+
* Add an event listener for authentication state changes
|
|
407
|
+
* @param type the type of the event
|
|
408
|
+
* @param listener the listener to add
|
|
409
|
+
* @param options options for the event listener
|
|
410
|
+
* @param options.signal an optional AbortSignal to abort the event listener
|
|
411
|
+
*/
|
|
412
|
+
addEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>, options?: {
|
|
413
|
+
signal?: AbortSignal;
|
|
414
|
+
}): void;
|
|
415
|
+
/**
|
|
416
|
+
* Remove an event listener
|
|
417
|
+
* @param type the type of the event
|
|
418
|
+
* @param listener the listener to remove
|
|
419
|
+
*/
|
|
420
|
+
removeEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>): void;
|
|
421
|
+
waitForAuth(): Promise<void>;
|
|
422
|
+
updateExternalJwt(jwt: string): Promise<void>;
|
|
423
|
+
get state(): AuthState;
|
|
424
|
+
getAuthHeaders(): Promise<Record<string, string>>;
|
|
425
|
+
private clearStorage;
|
|
426
|
+
logout(): Promise<void>;
|
|
427
|
+
/**
|
|
428
|
+
* Public API methods that automatically wait for authentication
|
|
429
|
+
*/
|
|
430
|
+
api: {
|
|
431
|
+
getRecentFlows: (params?: {
|
|
432
|
+
limit?: number;
|
|
433
|
+
}) => Promise<FrontendRecentFlows[]>;
|
|
434
|
+
/**
|
|
435
|
+
* @deprecated Use `createFlow` instead.
|
|
436
|
+
* @param request the user request
|
|
437
|
+
* @returns the id of the created flow
|
|
438
|
+
*/
|
|
439
|
+
startFlow: (request: StartFlowParam) => Promise<string>;
|
|
440
|
+
createFlow: (request: StartFlowParam) => Promise<{
|
|
441
|
+
flowId: string;
|
|
442
|
+
}>;
|
|
443
|
+
getDashboard: (dashboardId: string) => Promise<FrontendDashboard>;
|
|
444
|
+
exportReportData: (reportId: number, format?: "text" | "blob") => Promise<{
|
|
445
|
+
filename: string;
|
|
446
|
+
data: Blob | string;
|
|
447
|
+
}>;
|
|
448
|
+
generateContextualInsight: (payload: GenerateInsightParam) => Promise<ExtractInsightResponse>;
|
|
449
|
+
};
|
|
450
|
+
/**
|
|
451
|
+
* Initialize authentication flow
|
|
452
|
+
*/
|
|
453
|
+
private initializeAuth;
|
|
454
|
+
/**
|
|
455
|
+
* Perform the complete authentication flow
|
|
456
|
+
*/
|
|
457
|
+
private performAuthFlow;
|
|
458
|
+
private getApiInformation;
|
|
459
|
+
private initializeSupabaseClient;
|
|
460
|
+
client(): Promise<InternalApiClient>;
|
|
461
|
+
/**
|
|
462
|
+
* Initialize the API client with Supabase headers
|
|
463
|
+
*/
|
|
464
|
+
private initializeApiClient;
|
|
465
|
+
/**
|
|
466
|
+
* Handle the authentication logic (check session or exchange token)
|
|
467
|
+
*/
|
|
468
|
+
private handleAuthentication;
|
|
469
|
+
/**
|
|
470
|
+
* Exchange external JWT for Supabase tokens
|
|
471
|
+
*/
|
|
472
|
+
private exchangeExternalToken;
|
|
473
|
+
private createSupabaseHeaderMiddleware;
|
|
474
|
+
private setState;
|
|
475
|
+
private encodeCheckKey;
|
|
476
|
+
saveCheckKey(externalJwt: string, apiKey: string): Promise<void>;
|
|
477
|
+
compareCheckKey(externalJwt: string, apiKey: string): Promise<boolean>;
|
|
478
|
+
clearCheckKey(): Promise<void>;
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Configuration options for the MageMetricsClient
|
|
483
|
+
*/
|
|
484
|
+
export declare interface MageMetricsClientConfig {
|
|
485
|
+
apiUrl: string;
|
|
486
|
+
apiKey: string;
|
|
487
|
+
externalJwt?: string;
|
|
488
|
+
additionalHeaders?: Record<string, string>;
|
|
489
|
+
storageAdapter?: AsyncStorage_2;
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Event types using discriminated union for type safety and extensibility
|
|
494
|
+
*/
|
|
495
|
+
export declare type MageMetricsEvent = {
|
|
496
|
+
type: "authStateChange";
|
|
497
|
+
detail: AuthState;
|
|
498
|
+
};
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* Simple event emitter for MageMetrics client.
|
|
502
|
+
* Uses discriminated unions for type-safe events.
|
|
503
|
+
*/
|
|
504
|
+
export declare class MageMetricsEventEmitter {
|
|
505
|
+
private listeners;
|
|
506
|
+
addEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>, options?: {
|
|
507
|
+
signal?: AbortSignal;
|
|
508
|
+
}): void;
|
|
509
|
+
removeEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>): void;
|
|
510
|
+
dispatch<T extends MageMetricsEvent>(type: T["type"], detail: T["detail"]): void;
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* Event listener function type
|
|
515
|
+
*/
|
|
516
|
+
export declare type MageMetricsEventListener<T extends MageMetricsEvent = MageMetricsEvent> = (event: T) => void;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* in-memory storage adapter.
|
|
520
|
+
*/
|
|
521
|
+
export declare class MemoryStorageAdapter implements AsyncStorage {
|
|
522
|
+
private storage;
|
|
523
|
+
getItem(key: string): Promise<string | null>;
|
|
524
|
+
setItem(key: string, value: string): Promise<void>;
|
|
525
|
+
removeItem(key: string): Promise<void>;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
declare type NoAuthPaths = Simplify<{
|
|
529
|
+
[Path in keyof paths]: RemoveAuthHeader<paths[Path]>;
|
|
530
|
+
}>;
|
|
531
|
+
|
|
532
|
+
declare interface operations {
|
|
533
|
+
exchangeExternalToken: {
|
|
534
|
+
parameters: {
|
|
535
|
+
query?: never;
|
|
536
|
+
header?: never;
|
|
537
|
+
path?: never;
|
|
538
|
+
cookie?: never;
|
|
539
|
+
};
|
|
540
|
+
requestBody: {
|
|
541
|
+
content: {
|
|
542
|
+
"application/json": {
|
|
543
|
+
apiKey: string;
|
|
544
|
+
externalJWT: string;
|
|
545
|
+
};
|
|
546
|
+
};
|
|
547
|
+
};
|
|
548
|
+
responses: {
|
|
549
|
+
/** @description Retrieve a JWT for an external user */
|
|
550
|
+
200: {
|
|
551
|
+
headers: {
|
|
552
|
+
[name: string]: unknown;
|
|
553
|
+
};
|
|
554
|
+
content: {
|
|
555
|
+
"application/json": {
|
|
556
|
+
accessToken: string;
|
|
557
|
+
refreshToken: string;
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
};
|
|
561
|
+
/** @description Invalid input */
|
|
562
|
+
400: {
|
|
563
|
+
headers: {
|
|
564
|
+
[name: string]: unknown;
|
|
565
|
+
};
|
|
566
|
+
content: {
|
|
567
|
+
"application/json": {
|
|
568
|
+
error: string;
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
/** @description Unable to retrieve a JWT for an external user */
|
|
573
|
+
500: {
|
|
574
|
+
headers: {
|
|
575
|
+
[name: string]: unknown;
|
|
576
|
+
};
|
|
577
|
+
content: {
|
|
578
|
+
"application/json": {
|
|
579
|
+
error: string;
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
getApiInformation: {
|
|
586
|
+
parameters: {
|
|
587
|
+
query: {
|
|
588
|
+
apiKey: string;
|
|
589
|
+
};
|
|
590
|
+
header?: never;
|
|
591
|
+
path?: never;
|
|
592
|
+
cookie?: never;
|
|
593
|
+
};
|
|
594
|
+
requestBody?: never;
|
|
595
|
+
responses: {
|
|
596
|
+
/** @description Retrieve the API URL and anon key */
|
|
597
|
+
200: {
|
|
598
|
+
headers: {
|
|
599
|
+
[name: string]: unknown;
|
|
600
|
+
};
|
|
601
|
+
content: {
|
|
602
|
+
"application/json": {
|
|
603
|
+
apiUrl: string;
|
|
604
|
+
anonKey: string;
|
|
605
|
+
};
|
|
606
|
+
};
|
|
607
|
+
};
|
|
608
|
+
/** @description Invalid input */
|
|
609
|
+
400: {
|
|
610
|
+
headers: {
|
|
611
|
+
[name: string]: unknown;
|
|
612
|
+
};
|
|
613
|
+
content: {
|
|
614
|
+
"application/json": {
|
|
615
|
+
error: string;
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
};
|
|
619
|
+
/** @description Unable to retrieve the API URL and anon key */
|
|
620
|
+
500: {
|
|
621
|
+
headers: {
|
|
622
|
+
[name: string]: unknown;
|
|
623
|
+
};
|
|
624
|
+
content: {
|
|
625
|
+
"application/json": {
|
|
626
|
+
error: string;
|
|
627
|
+
};
|
|
628
|
+
};
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
PublicDashboardFetchVisualization: {
|
|
633
|
+
parameters: {
|
|
634
|
+
query?: never;
|
|
635
|
+
header?: never;
|
|
636
|
+
path: {
|
|
637
|
+
visualization_id: string;
|
|
638
|
+
dashboard_id: string;
|
|
639
|
+
};
|
|
640
|
+
cookie?: never;
|
|
641
|
+
};
|
|
642
|
+
requestBody?: never;
|
|
643
|
+
responses: {
|
|
644
|
+
/** @description The content of the visualization */
|
|
645
|
+
200: {
|
|
646
|
+
headers: {
|
|
647
|
+
[name: string]: unknown;
|
|
648
|
+
};
|
|
649
|
+
content: {
|
|
650
|
+
"application/json": components["schemas"]["VisualizationWithData"];
|
|
651
|
+
};
|
|
652
|
+
};
|
|
653
|
+
/** @description Invalid arguments to fetch visualization */
|
|
654
|
+
400: {
|
|
655
|
+
headers: {
|
|
656
|
+
[name: string]: unknown;
|
|
657
|
+
};
|
|
658
|
+
content: {
|
|
659
|
+
"application/json": {
|
|
660
|
+
error: string;
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
};
|
|
664
|
+
/** @description Unable to fetch visualization with this id */
|
|
665
|
+
404: {
|
|
666
|
+
headers: {
|
|
667
|
+
[name: string]: unknown;
|
|
668
|
+
};
|
|
669
|
+
content: {
|
|
670
|
+
"application/json": {
|
|
671
|
+
error: string;
|
|
672
|
+
};
|
|
673
|
+
};
|
|
674
|
+
};
|
|
675
|
+
/** @description Something wrong happened */
|
|
676
|
+
500: {
|
|
677
|
+
headers: {
|
|
678
|
+
[name: string]: unknown;
|
|
679
|
+
};
|
|
680
|
+
content: {
|
|
681
|
+
"application/json": {
|
|
682
|
+
error: string;
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
};
|
|
688
|
+
retrievePublicDashboard: {
|
|
689
|
+
parameters: {
|
|
690
|
+
query?: never;
|
|
691
|
+
header?: never;
|
|
692
|
+
path: {
|
|
693
|
+
dashboard_id: components["schemas"]["DashboardId"];
|
|
694
|
+
};
|
|
695
|
+
cookie?: never;
|
|
696
|
+
};
|
|
697
|
+
requestBody?: never;
|
|
698
|
+
responses: {
|
|
699
|
+
/** @description The dashboard with the given id */
|
|
700
|
+
200: {
|
|
701
|
+
headers: {
|
|
702
|
+
[name: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
content: {
|
|
705
|
+
"application/json": {
|
|
706
|
+
description: string | null;
|
|
707
|
+
/** Format: uuid */
|
|
708
|
+
id: string;
|
|
709
|
+
name: string;
|
|
710
|
+
positions: ({
|
|
711
|
+
/** @enum {string} */
|
|
712
|
+
type: "data-report";
|
|
713
|
+
flowId: string;
|
|
714
|
+
flowDataId: number;
|
|
715
|
+
title: string;
|
|
716
|
+
col: number;
|
|
717
|
+
colSpan: number;
|
|
718
|
+
rowSpan: number;
|
|
719
|
+
} | {
|
|
720
|
+
/** @enum {string} */
|
|
721
|
+
type: "visualization";
|
|
722
|
+
visualizationId: number;
|
|
723
|
+
title: string;
|
|
724
|
+
col: number;
|
|
725
|
+
colSpan: number;
|
|
726
|
+
rowSpan: number;
|
|
727
|
+
})[];
|
|
728
|
+
is_public: boolean;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
/** @description Unable to retrieve dashboard with this id */
|
|
733
|
+
404: {
|
|
734
|
+
headers: {
|
|
735
|
+
[name: string]: unknown;
|
|
736
|
+
};
|
|
737
|
+
content: {
|
|
738
|
+
"application/json": {
|
|
739
|
+
error: string;
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
};
|
|
743
|
+
/** @description Something wrong happened */
|
|
744
|
+
500: {
|
|
745
|
+
headers: {
|
|
746
|
+
[name: string]: unknown;
|
|
747
|
+
};
|
|
748
|
+
content: {
|
|
749
|
+
"application/json": {
|
|
750
|
+
error: string;
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
getPublicDataReportColumns: {
|
|
757
|
+
parameters: {
|
|
758
|
+
query?: never;
|
|
759
|
+
header?: never;
|
|
760
|
+
path: {
|
|
761
|
+
report_id: string;
|
|
762
|
+
dashboard_id: components["schemas"]["DashboardId"];
|
|
763
|
+
};
|
|
764
|
+
cookie?: never;
|
|
765
|
+
};
|
|
766
|
+
requestBody?: never;
|
|
767
|
+
responses: {
|
|
768
|
+
/** @description A list containing the columns of the report */
|
|
769
|
+
200: {
|
|
770
|
+
headers: {
|
|
771
|
+
[name: string]: unknown;
|
|
772
|
+
};
|
|
773
|
+
content: {
|
|
774
|
+
"application/json": components["schemas"]["ReportColumns"];
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
/** @description Unable to retrieve report with this id */
|
|
778
|
+
404: {
|
|
779
|
+
headers: {
|
|
780
|
+
[name: string]: unknown;
|
|
781
|
+
};
|
|
782
|
+
content: {
|
|
783
|
+
"application/json": {
|
|
784
|
+
error: string;
|
|
785
|
+
};
|
|
786
|
+
};
|
|
787
|
+
};
|
|
788
|
+
/** @description Something wrong happened */
|
|
789
|
+
500: {
|
|
790
|
+
headers: {
|
|
791
|
+
[name: string]: unknown;
|
|
792
|
+
};
|
|
793
|
+
content: {
|
|
794
|
+
"application/json": {
|
|
795
|
+
error: string;
|
|
796
|
+
};
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
getPublicDataReportData: {
|
|
802
|
+
parameters: {
|
|
803
|
+
query?: {
|
|
804
|
+
limit?: number;
|
|
805
|
+
/** @example name:asc,date:desc */
|
|
806
|
+
order?: string;
|
|
807
|
+
cursor?: number;
|
|
808
|
+
/** @example status:active,name:John%20Doe */
|
|
809
|
+
filter?: string;
|
|
810
|
+
};
|
|
811
|
+
header?: never;
|
|
812
|
+
path: {
|
|
813
|
+
report_id: string;
|
|
814
|
+
dashboard_id: components["schemas"]["DashboardId"];
|
|
815
|
+
};
|
|
816
|
+
cookie?: never;
|
|
817
|
+
};
|
|
818
|
+
requestBody?: never;
|
|
819
|
+
responses: {
|
|
820
|
+
/** @description The content of the report */
|
|
821
|
+
200: {
|
|
822
|
+
headers: {
|
|
823
|
+
[name: string]: unknown;
|
|
824
|
+
};
|
|
825
|
+
content: {
|
|
826
|
+
"application/json": components["schemas"]["ReportData"];
|
|
827
|
+
};
|
|
828
|
+
};
|
|
829
|
+
/** @description Unable to retrieve report with this id */
|
|
830
|
+
404: {
|
|
831
|
+
headers: {
|
|
832
|
+
[name: string]: unknown;
|
|
833
|
+
};
|
|
834
|
+
content: {
|
|
835
|
+
"application/json": {
|
|
836
|
+
error: string;
|
|
837
|
+
};
|
|
838
|
+
};
|
|
839
|
+
};
|
|
840
|
+
/** @description Something wrong happened */
|
|
841
|
+
500: {
|
|
842
|
+
headers: {
|
|
843
|
+
[name: string]: unknown;
|
|
844
|
+
};
|
|
845
|
+
content: {
|
|
846
|
+
"application/json": {
|
|
847
|
+
error: string;
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
getPublicDataReportRowCount: {
|
|
854
|
+
parameters: {
|
|
855
|
+
query?: never;
|
|
856
|
+
header?: never;
|
|
857
|
+
path: {
|
|
858
|
+
report_id: string;
|
|
859
|
+
dashboard_id: components["schemas"]["DashboardId"];
|
|
860
|
+
};
|
|
861
|
+
cookie?: never;
|
|
862
|
+
};
|
|
863
|
+
requestBody?: never;
|
|
864
|
+
responses: {
|
|
865
|
+
/** @description The total count of rows in the report */
|
|
866
|
+
200: {
|
|
867
|
+
headers: {
|
|
868
|
+
[name: string]: unknown;
|
|
869
|
+
};
|
|
870
|
+
content: {
|
|
871
|
+
"application/json": {
|
|
872
|
+
/** @description Total number of rows in the report */
|
|
873
|
+
count: number;
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
/** @description Unable to retrieve report with this id */
|
|
878
|
+
404: {
|
|
879
|
+
headers: {
|
|
880
|
+
[name: string]: unknown;
|
|
881
|
+
};
|
|
882
|
+
content: {
|
|
883
|
+
"application/json": {
|
|
884
|
+
error: string;
|
|
885
|
+
};
|
|
886
|
+
};
|
|
887
|
+
};
|
|
888
|
+
/** @description Something wrong happened */
|
|
889
|
+
500: {
|
|
890
|
+
headers: {
|
|
891
|
+
[name: string]: unknown;
|
|
892
|
+
};
|
|
893
|
+
content: {
|
|
894
|
+
"application/json": {
|
|
895
|
+
error: string;
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
};
|
|
901
|
+
runEnd2EndFlow: {
|
|
902
|
+
parameters: {
|
|
903
|
+
query?: never;
|
|
904
|
+
header: {
|
|
905
|
+
"sp-access-token": string;
|
|
906
|
+
};
|
|
907
|
+
path?: never;
|
|
908
|
+
cookie?: never;
|
|
909
|
+
};
|
|
910
|
+
requestBody: {
|
|
911
|
+
content: {
|
|
912
|
+
"application/json": {
|
|
913
|
+
userQuery: string;
|
|
914
|
+
/** @default true */
|
|
915
|
+
isNewAnalysisGoal?: boolean;
|
|
916
|
+
/**
|
|
917
|
+
* @default complex
|
|
918
|
+
* @enum {string}
|
|
919
|
+
*/
|
|
920
|
+
difficultyLevel?: "simple" | "moderate" | "complex";
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
responses: {
|
|
925
|
+
/** @description Run the end2end flow */
|
|
926
|
+
200: {
|
|
927
|
+
headers: {
|
|
928
|
+
[name: string]: unknown;
|
|
929
|
+
};
|
|
930
|
+
content: {
|
|
931
|
+
"application/json": {
|
|
932
|
+
/** @enum {string} */
|
|
933
|
+
status: "error";
|
|
934
|
+
error: string;
|
|
935
|
+
} | {
|
|
936
|
+
/** @enum {string} */
|
|
937
|
+
status: "success";
|
|
938
|
+
flowId: string;
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
};
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
retrieveFlow: {
|
|
945
|
+
parameters: {
|
|
946
|
+
query?: never;
|
|
947
|
+
header: {
|
|
948
|
+
"sp-access-token": string;
|
|
949
|
+
};
|
|
950
|
+
path: {
|
|
951
|
+
flowId: string;
|
|
952
|
+
};
|
|
953
|
+
cookie?: never;
|
|
954
|
+
};
|
|
955
|
+
requestBody?: never;
|
|
956
|
+
responses: {
|
|
957
|
+
/** @description The flow with its steps */
|
|
958
|
+
200: {
|
|
959
|
+
headers: {
|
|
960
|
+
[name: string]: unknown;
|
|
961
|
+
};
|
|
962
|
+
content: {
|
|
963
|
+
"application/json": {
|
|
964
|
+
created_at: string;
|
|
965
|
+
id: string;
|
|
966
|
+
request: string;
|
|
967
|
+
user_id: string | null;
|
|
968
|
+
user_friendly_goal?: string;
|
|
969
|
+
has_chat_messages: boolean;
|
|
970
|
+
};
|
|
971
|
+
};
|
|
972
|
+
};
|
|
973
|
+
/** @description Unable to retrieve flow with this id */
|
|
974
|
+
404: {
|
|
975
|
+
headers: {
|
|
976
|
+
[name: string]: unknown;
|
|
977
|
+
};
|
|
978
|
+
content: {
|
|
979
|
+
"application/json": {
|
|
980
|
+
error: string;
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
/** @description Something wrong happened */
|
|
985
|
+
500: {
|
|
986
|
+
headers: {
|
|
987
|
+
[name: string]: unknown;
|
|
988
|
+
};
|
|
989
|
+
content: {
|
|
990
|
+
"application/json": {
|
|
991
|
+
error: string;
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
};
|
|
997
|
+
retrieveRecentFlows: {
|
|
998
|
+
parameters: {
|
|
999
|
+
query?: {
|
|
1000
|
+
limit?: number;
|
|
1001
|
+
};
|
|
1002
|
+
header: {
|
|
1003
|
+
"sp-access-token": string;
|
|
1004
|
+
};
|
|
1005
|
+
path?: never;
|
|
1006
|
+
cookie?: never;
|
|
1007
|
+
};
|
|
1008
|
+
requestBody?: never;
|
|
1009
|
+
responses: {
|
|
1010
|
+
/** @description A list of recent flows */
|
|
1011
|
+
200: {
|
|
1012
|
+
headers: {
|
|
1013
|
+
[name: string]: unknown;
|
|
1014
|
+
};
|
|
1015
|
+
content: {
|
|
1016
|
+
"application/json": {
|
|
1017
|
+
created_at: string;
|
|
1018
|
+
id: string;
|
|
1019
|
+
request: string;
|
|
1020
|
+
user_id: string | null;
|
|
1021
|
+
}[];
|
|
1022
|
+
};
|
|
1023
|
+
};
|
|
1024
|
+
/** @description Something wrong happened */
|
|
1025
|
+
500: {
|
|
1026
|
+
headers: {
|
|
1027
|
+
[name: string]: unknown;
|
|
1028
|
+
};
|
|
1029
|
+
content: {
|
|
1030
|
+
"application/json": {
|
|
1031
|
+
error: string;
|
|
1032
|
+
};
|
|
1033
|
+
};
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
retrieveFlowDataReports: {
|
|
1038
|
+
parameters: {
|
|
1039
|
+
query?: never;
|
|
1040
|
+
header: {
|
|
1041
|
+
"sp-access-token": string;
|
|
1042
|
+
};
|
|
1043
|
+
path: {
|
|
1044
|
+
flowId: string;
|
|
1045
|
+
};
|
|
1046
|
+
cookie?: never;
|
|
1047
|
+
};
|
|
1048
|
+
requestBody?: never;
|
|
1049
|
+
responses: {
|
|
1050
|
+
/** @description The data reports associated with the flow */
|
|
1051
|
+
200: {
|
|
1052
|
+
headers: {
|
|
1053
|
+
[name: string]: unknown;
|
|
1054
|
+
};
|
|
1055
|
+
content: {
|
|
1056
|
+
"application/json": {
|
|
1057
|
+
created_at: string;
|
|
1058
|
+
flow_id: string;
|
|
1059
|
+
id: number;
|
|
1060
|
+
title: string;
|
|
1061
|
+
request: string | null;
|
|
1062
|
+
data_summary: {
|
|
1063
|
+
columns: {
|
|
1064
|
+
[key: string]: {
|
|
1065
|
+
position?: number;
|
|
1066
|
+
data_type: string;
|
|
1067
|
+
null_count: number | null;
|
|
1068
|
+
unique_count: number | null;
|
|
1069
|
+
unique_percentage: number | null;
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
};
|
|
1073
|
+
bookmarked: boolean;
|
|
1074
|
+
status: string | null;
|
|
1075
|
+
}[];
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
/** @description Unable to retrieve flow with this id */
|
|
1079
|
+
404: {
|
|
1080
|
+
headers: {
|
|
1081
|
+
[name: string]: unknown;
|
|
1082
|
+
};
|
|
1083
|
+
content: {
|
|
1084
|
+
"application/json": {
|
|
1085
|
+
error: string;
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
/** @description Something wrong happened */
|
|
1090
|
+
500: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content: {
|
|
1095
|
+
"application/json": {
|
|
1096
|
+
error: string;
|
|
1097
|
+
};
|
|
1098
|
+
};
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
getDataReportFeedback: {
|
|
1103
|
+
parameters: {
|
|
1104
|
+
query?: never;
|
|
1105
|
+
header: {
|
|
1106
|
+
"sp-access-token": string;
|
|
1107
|
+
};
|
|
1108
|
+
path: {
|
|
1109
|
+
report_id: string;
|
|
1110
|
+
};
|
|
1111
|
+
cookie?: never;
|
|
1112
|
+
};
|
|
1113
|
+
requestBody?: never;
|
|
1114
|
+
responses: {
|
|
1115
|
+
/** @description The feedback for the report */
|
|
1116
|
+
200: {
|
|
1117
|
+
headers: {
|
|
1118
|
+
[name: string]: unknown;
|
|
1119
|
+
};
|
|
1120
|
+
content: {
|
|
1121
|
+
"application/json": {
|
|
1122
|
+
created_at: string;
|
|
1123
|
+
flow_data_id: number;
|
|
1124
|
+
/** @enum {string} */
|
|
1125
|
+
helpfulness: "helpful" | "partially helpful" | "not helpful" | "incorrect";
|
|
1126
|
+
id: number;
|
|
1127
|
+
} | null;
|
|
1128
|
+
};
|
|
1129
|
+
};
|
|
1130
|
+
/** @description Unable to retrieve feedback */
|
|
1131
|
+
404: {
|
|
1132
|
+
headers: {
|
|
1133
|
+
[name: string]: unknown;
|
|
1134
|
+
};
|
|
1135
|
+
content: {
|
|
1136
|
+
"application/json": {
|
|
1137
|
+
error: string;
|
|
1138
|
+
};
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
/** @description Something wrong happened */
|
|
1142
|
+
500: {
|
|
1143
|
+
headers: {
|
|
1144
|
+
[name: string]: unknown;
|
|
1145
|
+
};
|
|
1146
|
+
content: {
|
|
1147
|
+
"application/json": {
|
|
1148
|
+
error: string;
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
};
|
|
1154
|
+
upsertReportFeedback: {
|
|
1155
|
+
parameters: {
|
|
1156
|
+
query?: never;
|
|
1157
|
+
header: {
|
|
1158
|
+
"sp-access-token": string;
|
|
1159
|
+
};
|
|
1160
|
+
path: {
|
|
1161
|
+
report_id: string;
|
|
1162
|
+
};
|
|
1163
|
+
cookie?: never;
|
|
1164
|
+
};
|
|
1165
|
+
/** @description The feedback for the flow data */
|
|
1166
|
+
requestBody: {
|
|
1167
|
+
content: {
|
|
1168
|
+
"application/json": {
|
|
1169
|
+
/** @enum {string} */
|
|
1170
|
+
helpfulness: "helpful" | "partially helpful" | "not helpful" | "incorrect";
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
responses: {
|
|
1175
|
+
/** @description Successfully upserted feedback */
|
|
1176
|
+
200: {
|
|
1177
|
+
headers: {
|
|
1178
|
+
[name: string]: unknown;
|
|
1179
|
+
};
|
|
1180
|
+
content?: never;
|
|
1181
|
+
};
|
|
1182
|
+
/** @description Something wrong happened */
|
|
1183
|
+
500: {
|
|
1184
|
+
headers: {
|
|
1185
|
+
[name: string]: unknown;
|
|
1186
|
+
};
|
|
1187
|
+
content: {
|
|
1188
|
+
"application/json": {
|
|
1189
|
+
error: string;
|
|
1190
|
+
};
|
|
1191
|
+
};
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
};
|
|
1195
|
+
deleteReportFeedback: {
|
|
1196
|
+
parameters: {
|
|
1197
|
+
query?: never;
|
|
1198
|
+
header: {
|
|
1199
|
+
"sp-access-token": string;
|
|
1200
|
+
};
|
|
1201
|
+
path: {
|
|
1202
|
+
report_id: string;
|
|
1203
|
+
};
|
|
1204
|
+
cookie?: never;
|
|
1205
|
+
};
|
|
1206
|
+
requestBody?: never;
|
|
1207
|
+
responses: {
|
|
1208
|
+
/** @description Successfully deleted feedback */
|
|
1209
|
+
200: {
|
|
1210
|
+
headers: {
|
|
1211
|
+
[name: string]: unknown;
|
|
1212
|
+
};
|
|
1213
|
+
content?: never;
|
|
1214
|
+
};
|
|
1215
|
+
/** @description Unable to retrieve feedback */
|
|
1216
|
+
404: {
|
|
1217
|
+
headers: {
|
|
1218
|
+
[name: string]: unknown;
|
|
1219
|
+
};
|
|
1220
|
+
content: {
|
|
1221
|
+
"application/json": {
|
|
1222
|
+
error: string;
|
|
1223
|
+
};
|
|
1224
|
+
};
|
|
1225
|
+
};
|
|
1226
|
+
/** @description Something wrong happened */
|
|
1227
|
+
500: {
|
|
1228
|
+
headers: {
|
|
1229
|
+
[name: string]: unknown;
|
|
1230
|
+
};
|
|
1231
|
+
content: {
|
|
1232
|
+
"application/json": {
|
|
1233
|
+
error: string;
|
|
1234
|
+
};
|
|
1235
|
+
};
|
|
1236
|
+
};
|
|
1237
|
+
};
|
|
1238
|
+
};
|
|
1239
|
+
retrieveLatestDataReportStatus: {
|
|
1240
|
+
parameters: {
|
|
1241
|
+
query?: never;
|
|
1242
|
+
header: {
|
|
1243
|
+
"sp-access-token": string;
|
|
1244
|
+
};
|
|
1245
|
+
path: {
|
|
1246
|
+
flowId: string;
|
|
1247
|
+
};
|
|
1248
|
+
cookie?: never;
|
|
1249
|
+
};
|
|
1250
|
+
requestBody?: never;
|
|
1251
|
+
responses: {
|
|
1252
|
+
/** @description The status of the latest flow data for a given flow */
|
|
1253
|
+
200: {
|
|
1254
|
+
headers: {
|
|
1255
|
+
[name: string]: unknown;
|
|
1256
|
+
};
|
|
1257
|
+
content: {
|
|
1258
|
+
"application/json": {
|
|
1259
|
+
status: string | null;
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
/** @description Unable to retrieve status for latest flow data of flow with this id */
|
|
1264
|
+
404: {
|
|
1265
|
+
headers: {
|
|
1266
|
+
[name: string]: unknown;
|
|
1267
|
+
};
|
|
1268
|
+
content: {
|
|
1269
|
+
"application/json": {
|
|
1270
|
+
error: string;
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
};
|
|
1274
|
+
/** @description Something wrong happened */
|
|
1275
|
+
500: {
|
|
1276
|
+
headers: {
|
|
1277
|
+
[name: string]: unknown;
|
|
1278
|
+
};
|
|
1279
|
+
content: {
|
|
1280
|
+
"application/json": {
|
|
1281
|
+
error: string;
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
};
|
|
1285
|
+
};
|
|
1286
|
+
};
|
|
1287
|
+
getDataReportExplainability: {
|
|
1288
|
+
parameters: {
|
|
1289
|
+
query?: never;
|
|
1290
|
+
header: {
|
|
1291
|
+
"sp-access-token": string;
|
|
1292
|
+
};
|
|
1293
|
+
path: {
|
|
1294
|
+
report_id: string;
|
|
1295
|
+
};
|
|
1296
|
+
cookie?: never;
|
|
1297
|
+
};
|
|
1298
|
+
requestBody?: never;
|
|
1299
|
+
responses: {
|
|
1300
|
+
/** @description The explainability of the report */
|
|
1301
|
+
200: {
|
|
1302
|
+
headers: {
|
|
1303
|
+
[name: string]: unknown;
|
|
1304
|
+
};
|
|
1305
|
+
content: {
|
|
1306
|
+
"application/json": {
|
|
1307
|
+
sql_explanation?: {
|
|
1308
|
+
chunk_title: string;
|
|
1309
|
+
chunk_explanation: string;
|
|
1310
|
+
lines: {
|
|
1311
|
+
sql: string;
|
|
1312
|
+
explanation: string;
|
|
1313
|
+
}[];
|
|
1314
|
+
}[] | null;
|
|
1315
|
+
business_explanation?: {
|
|
1316
|
+
summary: string;
|
|
1317
|
+
implementation: string[];
|
|
1318
|
+
assumptions: {
|
|
1319
|
+
/** @enum {string} */
|
|
1320
|
+
type: "grain" | "completeness" | "transformation" | "relationship" | "other";
|
|
1321
|
+
details: string;
|
|
1322
|
+
explanation: string;
|
|
1323
|
+
}[];
|
|
1324
|
+
} | null;
|
|
1325
|
+
columns_lineage?: {
|
|
1326
|
+
[key: string]: {
|
|
1327
|
+
nodes: {
|
|
1328
|
+
id: string;
|
|
1329
|
+
/** @enum {string} */
|
|
1330
|
+
type: "entity" | "attribute" | "filter" | "process" | "combine" | "result";
|
|
1331
|
+
explanation: string;
|
|
1332
|
+
}[];
|
|
1333
|
+
edges: {
|
|
1334
|
+
source: string;
|
|
1335
|
+
target: string;
|
|
1336
|
+
}[];
|
|
1337
|
+
};
|
|
1338
|
+
} | null;
|
|
1339
|
+
confidence_score: number;
|
|
1340
|
+
confidence_score_reason: string;
|
|
1341
|
+
assumptions_score?: number;
|
|
1342
|
+
assumptions_score_reason?: string;
|
|
1343
|
+
friendliness_score?: number;
|
|
1344
|
+
friendliness_score_reason?: string;
|
|
1345
|
+
flow_data_id: number;
|
|
1346
|
+
};
|
|
1347
|
+
};
|
|
1348
|
+
};
|
|
1349
|
+
/** @description Unable to retrieve report with this id */
|
|
1350
|
+
404: {
|
|
1351
|
+
headers: {
|
|
1352
|
+
[name: string]: unknown;
|
|
1353
|
+
};
|
|
1354
|
+
content: {
|
|
1355
|
+
"application/json": {
|
|
1356
|
+
error: string;
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
/** @description Something wrong happened */
|
|
1361
|
+
500: {
|
|
1362
|
+
headers: {
|
|
1363
|
+
[name: string]: unknown;
|
|
1364
|
+
};
|
|
1365
|
+
content: {
|
|
1366
|
+
"application/json": {
|
|
1367
|
+
error: string;
|
|
1368
|
+
};
|
|
1369
|
+
};
|
|
1370
|
+
};
|
|
1371
|
+
};
|
|
1372
|
+
};
|
|
1373
|
+
toggleBookmark: {
|
|
1374
|
+
parameters: {
|
|
1375
|
+
query?: never;
|
|
1376
|
+
header: {
|
|
1377
|
+
"sp-access-token": string;
|
|
1378
|
+
};
|
|
1379
|
+
path?: never;
|
|
1380
|
+
cookie?: never;
|
|
1381
|
+
};
|
|
1382
|
+
/** @description Toggle bookmark for timeline item */
|
|
1383
|
+
requestBody: {
|
|
1384
|
+
content: {
|
|
1385
|
+
"application/json": {
|
|
1386
|
+
/** @enum {string} */
|
|
1387
|
+
type: "dataReport";
|
|
1388
|
+
flowDataId: number;
|
|
1389
|
+
bookmarked: boolean;
|
|
1390
|
+
} | {
|
|
1391
|
+
/** @enum {string} */
|
|
1392
|
+
type: "visualization";
|
|
1393
|
+
flowDataVisualizationId: number;
|
|
1394
|
+
bookmarked: boolean;
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1397
|
+
};
|
|
1398
|
+
responses: {
|
|
1399
|
+
/** @description Successfully toggled bookmark */
|
|
1400
|
+
200: {
|
|
1401
|
+
headers: {
|
|
1402
|
+
[name: string]: unknown;
|
|
1403
|
+
};
|
|
1404
|
+
content: {
|
|
1405
|
+
"application/json": {
|
|
1406
|
+
success: boolean;
|
|
1407
|
+
bookmarked: boolean;
|
|
1408
|
+
};
|
|
1409
|
+
};
|
|
1410
|
+
};
|
|
1411
|
+
/** @description Timeline item not found */
|
|
1412
|
+
404: {
|
|
1413
|
+
headers: {
|
|
1414
|
+
[name: string]: unknown;
|
|
1415
|
+
};
|
|
1416
|
+
content: {
|
|
1417
|
+
"application/json": {
|
|
1418
|
+
error: string;
|
|
1419
|
+
};
|
|
1420
|
+
};
|
|
1421
|
+
};
|
|
1422
|
+
/** @description Something wrong happened */
|
|
1423
|
+
500: {
|
|
1424
|
+
headers: {
|
|
1425
|
+
[name: string]: unknown;
|
|
1426
|
+
};
|
|
1427
|
+
content: {
|
|
1428
|
+
"application/json": {
|
|
1429
|
+
error: string;
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
retrieveLatestDataRefresh: {
|
|
1436
|
+
parameters: {
|
|
1437
|
+
query?: never;
|
|
1438
|
+
header: {
|
|
1439
|
+
"sp-access-token": string;
|
|
1440
|
+
};
|
|
1441
|
+
path?: never;
|
|
1442
|
+
cookie?: never;
|
|
1443
|
+
};
|
|
1444
|
+
requestBody?: never;
|
|
1445
|
+
responses: {
|
|
1446
|
+
/** @description The latest data refresh */
|
|
1447
|
+
200: {
|
|
1448
|
+
headers: {
|
|
1449
|
+
[name: string]: unknown;
|
|
1450
|
+
};
|
|
1451
|
+
content: {
|
|
1452
|
+
"application/json": {
|
|
1453
|
+
updated_at: string;
|
|
1454
|
+
};
|
|
1455
|
+
};
|
|
1456
|
+
};
|
|
1457
|
+
/** @description Unable to retrieve latest data refresh */
|
|
1458
|
+
404: {
|
|
1459
|
+
headers: {
|
|
1460
|
+
[name: string]: unknown;
|
|
1461
|
+
};
|
|
1462
|
+
content: {
|
|
1463
|
+
"application/json": {
|
|
1464
|
+
error: string;
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
};
|
|
1468
|
+
/** @description Something wrong happened */
|
|
1469
|
+
500: {
|
|
1470
|
+
headers: {
|
|
1471
|
+
[name: string]: unknown;
|
|
1472
|
+
};
|
|
1473
|
+
content: {
|
|
1474
|
+
"application/json": {
|
|
1475
|
+
error: string;
|
|
1476
|
+
};
|
|
1477
|
+
};
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
};
|
|
1481
|
+
exportReportData: {
|
|
1482
|
+
parameters: {
|
|
1483
|
+
query?: never;
|
|
1484
|
+
header: {
|
|
1485
|
+
"sp-access-token": string;
|
|
1486
|
+
};
|
|
1487
|
+
path: {
|
|
1488
|
+
report_id: string;
|
|
1489
|
+
};
|
|
1490
|
+
cookie?: never;
|
|
1491
|
+
};
|
|
1492
|
+
requestBody?: never;
|
|
1493
|
+
responses: {
|
|
1494
|
+
/** @description The report data exported in CSV format */
|
|
1495
|
+
200: {
|
|
1496
|
+
headers: {
|
|
1497
|
+
[name: string]: unknown;
|
|
1498
|
+
};
|
|
1499
|
+
content: {
|
|
1500
|
+
"text/csv": string;
|
|
1501
|
+
};
|
|
1502
|
+
};
|
|
1503
|
+
/** @description Unable to retrieve flow with this id */
|
|
1504
|
+
404: {
|
|
1505
|
+
headers: {
|
|
1506
|
+
[name: string]: unknown;
|
|
1507
|
+
};
|
|
1508
|
+
content: {
|
|
1509
|
+
"application/json": {
|
|
1510
|
+
error: string;
|
|
1511
|
+
};
|
|
1512
|
+
};
|
|
1513
|
+
};
|
|
1514
|
+
/** @description Something wrong happened */
|
|
1515
|
+
500: {
|
|
1516
|
+
headers: {
|
|
1517
|
+
[name: string]: unknown;
|
|
1518
|
+
};
|
|
1519
|
+
content: {
|
|
1520
|
+
"application/json": {
|
|
1521
|
+
error: string;
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
};
|
|
1525
|
+
};
|
|
1526
|
+
};
|
|
1527
|
+
getDataReportColumns: {
|
|
1528
|
+
parameters: {
|
|
1529
|
+
query?: never;
|
|
1530
|
+
header: {
|
|
1531
|
+
"sp-access-token": string;
|
|
1532
|
+
};
|
|
1533
|
+
path: {
|
|
1534
|
+
report_id: string;
|
|
1535
|
+
};
|
|
1536
|
+
cookie?: never;
|
|
1537
|
+
};
|
|
1538
|
+
requestBody?: never;
|
|
1539
|
+
responses: {
|
|
1540
|
+
/** @description A list containing the columns of the report */
|
|
1541
|
+
200: {
|
|
1542
|
+
headers: {
|
|
1543
|
+
[name: string]: unknown;
|
|
1544
|
+
};
|
|
1545
|
+
content: {
|
|
1546
|
+
"application/json": components["schemas"]["ReportColumns"];
|
|
1547
|
+
};
|
|
1548
|
+
};
|
|
1549
|
+
/** @description Unable to retrieve report with this id */
|
|
1550
|
+
404: {
|
|
1551
|
+
headers: {
|
|
1552
|
+
[name: string]: unknown;
|
|
1553
|
+
};
|
|
1554
|
+
content: {
|
|
1555
|
+
"application/json": {
|
|
1556
|
+
error: string;
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
};
|
|
1560
|
+
/** @description Something wrong happened */
|
|
1561
|
+
500: {
|
|
1562
|
+
headers: {
|
|
1563
|
+
[name: string]: unknown;
|
|
1564
|
+
};
|
|
1565
|
+
content: {
|
|
1566
|
+
"application/json": {
|
|
1567
|
+
error: string;
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
};
|
|
1571
|
+
};
|
|
1572
|
+
};
|
|
1573
|
+
getDataReportData: {
|
|
1574
|
+
parameters: {
|
|
1575
|
+
query?: {
|
|
1576
|
+
/** @example name,date */
|
|
1577
|
+
columns?: string;
|
|
1578
|
+
limit?: number;
|
|
1579
|
+
/** @example name:asc,date:desc */
|
|
1580
|
+
order?: string;
|
|
1581
|
+
cursor?: number;
|
|
1582
|
+
/** @example status:active,name:John%20Doe */
|
|
1583
|
+
filter?: string;
|
|
1584
|
+
};
|
|
1585
|
+
header: {
|
|
1586
|
+
"sp-access-token": string;
|
|
1587
|
+
};
|
|
1588
|
+
path: {
|
|
1589
|
+
report_id: string;
|
|
1590
|
+
};
|
|
1591
|
+
cookie?: never;
|
|
1592
|
+
};
|
|
1593
|
+
requestBody?: never;
|
|
1594
|
+
responses: {
|
|
1595
|
+
/** @description The content of the report */
|
|
1596
|
+
200: {
|
|
1597
|
+
headers: {
|
|
1598
|
+
[name: string]: unknown;
|
|
1599
|
+
};
|
|
1600
|
+
content: {
|
|
1601
|
+
"application/json": components["schemas"]["ReportData"];
|
|
1602
|
+
};
|
|
1603
|
+
};
|
|
1604
|
+
/** @description Unable to retrieve report with this id */
|
|
1605
|
+
404: {
|
|
1606
|
+
headers: {
|
|
1607
|
+
[name: string]: unknown;
|
|
1608
|
+
};
|
|
1609
|
+
content: {
|
|
1610
|
+
"application/json": {
|
|
1611
|
+
error: string;
|
|
1612
|
+
};
|
|
1613
|
+
};
|
|
1614
|
+
};
|
|
1615
|
+
/** @description Something wrong happened */
|
|
1616
|
+
500: {
|
|
1617
|
+
headers: {
|
|
1618
|
+
[name: string]: unknown;
|
|
1619
|
+
};
|
|
1620
|
+
content: {
|
|
1621
|
+
"application/json": {
|
|
1622
|
+
error: string;
|
|
1623
|
+
};
|
|
1624
|
+
};
|
|
1625
|
+
};
|
|
1626
|
+
};
|
|
1627
|
+
};
|
|
1628
|
+
getDataReportRowCount: {
|
|
1629
|
+
parameters: {
|
|
1630
|
+
query?: never;
|
|
1631
|
+
header: {
|
|
1632
|
+
"sp-access-token": string;
|
|
1633
|
+
};
|
|
1634
|
+
path: {
|
|
1635
|
+
report_id: string;
|
|
1636
|
+
};
|
|
1637
|
+
cookie?: never;
|
|
1638
|
+
};
|
|
1639
|
+
requestBody?: never;
|
|
1640
|
+
responses: {
|
|
1641
|
+
/** @description The total count of rows in the report */
|
|
1642
|
+
200: {
|
|
1643
|
+
headers: {
|
|
1644
|
+
[name: string]: unknown;
|
|
1645
|
+
};
|
|
1646
|
+
content: {
|
|
1647
|
+
"application/json": {
|
|
1648
|
+
/** @description Total number of rows in the report */
|
|
1649
|
+
count: number;
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
};
|
|
1653
|
+
/** @description Unable to retrieve report with this id */
|
|
1654
|
+
404: {
|
|
1655
|
+
headers: {
|
|
1656
|
+
[name: string]: unknown;
|
|
1657
|
+
};
|
|
1658
|
+
content: {
|
|
1659
|
+
"application/json": {
|
|
1660
|
+
error: string;
|
|
1661
|
+
};
|
|
1662
|
+
};
|
|
1663
|
+
};
|
|
1664
|
+
/** @description Something wrong happened */
|
|
1665
|
+
500: {
|
|
1666
|
+
headers: {
|
|
1667
|
+
[name: string]: unknown;
|
|
1668
|
+
};
|
|
1669
|
+
content: {
|
|
1670
|
+
"application/json": {
|
|
1671
|
+
error: string;
|
|
1672
|
+
};
|
|
1673
|
+
};
|
|
1674
|
+
};
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
getDataReport: {
|
|
1678
|
+
parameters: {
|
|
1679
|
+
query?: never;
|
|
1680
|
+
header: {
|
|
1681
|
+
"sp-access-token": string;
|
|
1682
|
+
};
|
|
1683
|
+
path: {
|
|
1684
|
+
report_id: string;
|
|
1685
|
+
};
|
|
1686
|
+
cookie?: never;
|
|
1687
|
+
};
|
|
1688
|
+
requestBody?: never;
|
|
1689
|
+
responses: {
|
|
1690
|
+
/** @description The visualizations for the report */
|
|
1691
|
+
200: {
|
|
1692
|
+
headers: {
|
|
1693
|
+
[name: string]: unknown;
|
|
1694
|
+
};
|
|
1695
|
+
content: {
|
|
1696
|
+
"application/json": {
|
|
1697
|
+
created_at: string;
|
|
1698
|
+
flow_id: string;
|
|
1699
|
+
id: number;
|
|
1700
|
+
title: string;
|
|
1701
|
+
request: string | null;
|
|
1702
|
+
data_summary: {
|
|
1703
|
+
columns: {
|
|
1704
|
+
[key: string]: {
|
|
1705
|
+
position?: number;
|
|
1706
|
+
data_type: string;
|
|
1707
|
+
null_count: number | null;
|
|
1708
|
+
unique_count: number | null;
|
|
1709
|
+
unique_percentage: number | null;
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
};
|
|
1713
|
+
bookmarked: boolean;
|
|
1714
|
+
status: string | null;
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
};
|
|
1718
|
+
/** @description Unable to retrieve report with this id */
|
|
1719
|
+
404: {
|
|
1720
|
+
headers: {
|
|
1721
|
+
[name: string]: unknown;
|
|
1722
|
+
};
|
|
1723
|
+
content: {
|
|
1724
|
+
"application/json": {
|
|
1725
|
+
error: string;
|
|
1726
|
+
};
|
|
1727
|
+
};
|
|
1728
|
+
};
|
|
1729
|
+
/** @description Something wrong happened */
|
|
1730
|
+
500: {
|
|
1731
|
+
headers: {
|
|
1732
|
+
[name: string]: unknown;
|
|
1733
|
+
};
|
|
1734
|
+
content: {
|
|
1735
|
+
"application/json": {
|
|
1736
|
+
error: string;
|
|
1737
|
+
};
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
};
|
|
1741
|
+
};
|
|
1742
|
+
createFlow: {
|
|
1743
|
+
parameters: {
|
|
1744
|
+
query?: never;
|
|
1745
|
+
header: {
|
|
1746
|
+
"sp-access-token": string;
|
|
1747
|
+
};
|
|
1748
|
+
path?: never;
|
|
1749
|
+
cookie?: never;
|
|
1750
|
+
};
|
|
1751
|
+
requestBody: {
|
|
1752
|
+
content: {
|
|
1753
|
+
"application/json": {
|
|
1754
|
+
userQuery: string;
|
|
1755
|
+
};
|
|
1756
|
+
};
|
|
1757
|
+
};
|
|
1758
|
+
responses: {
|
|
1759
|
+
/** @description Create a new flow */
|
|
1760
|
+
200: {
|
|
1761
|
+
headers: {
|
|
1762
|
+
[name: string]: unknown;
|
|
1763
|
+
};
|
|
1764
|
+
content: {
|
|
1765
|
+
"application/json": {
|
|
1766
|
+
/** @enum {string} */
|
|
1767
|
+
status: "success";
|
|
1768
|
+
flowId: string;
|
|
1769
|
+
};
|
|
1770
|
+
};
|
|
1771
|
+
};
|
|
1772
|
+
/** @description Something wrong happened */
|
|
1773
|
+
500: {
|
|
1774
|
+
headers: {
|
|
1775
|
+
[name: string]: unknown;
|
|
1776
|
+
};
|
|
1777
|
+
content: {
|
|
1778
|
+
"application/json": {
|
|
1779
|
+
error: string;
|
|
1780
|
+
};
|
|
1781
|
+
};
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
};
|
|
1785
|
+
retrieveChatTimeline: {
|
|
1786
|
+
parameters: {
|
|
1787
|
+
query?: never;
|
|
1788
|
+
header: {
|
|
1789
|
+
"sp-access-token": string;
|
|
1790
|
+
};
|
|
1791
|
+
path: {
|
|
1792
|
+
flowId: string;
|
|
1793
|
+
};
|
|
1794
|
+
cookie?: never;
|
|
1795
|
+
};
|
|
1796
|
+
requestBody?: never;
|
|
1797
|
+
responses: {
|
|
1798
|
+
/** @description The timeline of generated insights for the flow */
|
|
1799
|
+
200: {
|
|
1800
|
+
headers: {
|
|
1801
|
+
[name: string]: unknown;
|
|
1802
|
+
};
|
|
1803
|
+
content: {
|
|
1804
|
+
"application/json": ({
|
|
1805
|
+
/** @enum {string} */
|
|
1806
|
+
type: "dataReport";
|
|
1807
|
+
flowDataId: number;
|
|
1808
|
+
flowId: string;
|
|
1809
|
+
title: string;
|
|
1810
|
+
bookmarked: boolean;
|
|
1811
|
+
answer: string | null;
|
|
1812
|
+
} | {
|
|
1813
|
+
/** @enum {string} */
|
|
1814
|
+
type: "visualization";
|
|
1815
|
+
flowId: string;
|
|
1816
|
+
flowDataId: number;
|
|
1817
|
+
flowDataVisualizationId: number;
|
|
1818
|
+
title: string;
|
|
1819
|
+
bookmarked: boolean;
|
|
1820
|
+
} | {
|
|
1821
|
+
/** @enum {string} */
|
|
1822
|
+
type: "message";
|
|
1823
|
+
})[];
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1826
|
+
/** @description Unable to retrieve flow with this id */
|
|
1827
|
+
404: {
|
|
1828
|
+
headers: {
|
|
1829
|
+
[name: string]: unknown;
|
|
1830
|
+
};
|
|
1831
|
+
content: {
|
|
1832
|
+
"application/json": {
|
|
1833
|
+
error: string;
|
|
1834
|
+
};
|
|
1835
|
+
};
|
|
1836
|
+
};
|
|
1837
|
+
/** @description Something wrong happened */
|
|
1838
|
+
500: {
|
|
1839
|
+
headers: {
|
|
1840
|
+
[name: string]: unknown;
|
|
1841
|
+
};
|
|
1842
|
+
content: {
|
|
1843
|
+
"application/json": {
|
|
1844
|
+
error: string;
|
|
1845
|
+
};
|
|
1846
|
+
};
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
};
|
|
1850
|
+
retrieveChatMessages: {
|
|
1851
|
+
parameters: {
|
|
1852
|
+
query?: never;
|
|
1853
|
+
header: {
|
|
1854
|
+
"sp-access-token": string;
|
|
1855
|
+
};
|
|
1856
|
+
path: {
|
|
1857
|
+
flowId: string;
|
|
1858
|
+
};
|
|
1859
|
+
cookie?: never;
|
|
1860
|
+
};
|
|
1861
|
+
requestBody?: never;
|
|
1862
|
+
responses: {
|
|
1863
|
+
/** @description The messages from the given flow */
|
|
1864
|
+
200: {
|
|
1865
|
+
headers: {
|
|
1866
|
+
[name: string]: unknown;
|
|
1867
|
+
};
|
|
1868
|
+
content: {
|
|
1869
|
+
"application/json": {
|
|
1870
|
+
messages: Record<string, unknown>[];
|
|
1871
|
+
};
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
/** @description Unable to retrieve flow with this id */
|
|
1875
|
+
404: {
|
|
1876
|
+
headers: {
|
|
1877
|
+
[name: string]: unknown;
|
|
1878
|
+
};
|
|
1879
|
+
content: {
|
|
1880
|
+
"application/json": {
|
|
1881
|
+
error: string;
|
|
1882
|
+
};
|
|
1883
|
+
};
|
|
1884
|
+
};
|
|
1885
|
+
/** @description Something wrong happened */
|
|
1886
|
+
500: {
|
|
1887
|
+
headers: {
|
|
1888
|
+
[name: string]: unknown;
|
|
1889
|
+
};
|
|
1890
|
+
content: {
|
|
1891
|
+
"application/json": {
|
|
1892
|
+
error: string;
|
|
1893
|
+
};
|
|
1894
|
+
};
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
getStarterRecommendations: {
|
|
1899
|
+
parameters: {
|
|
1900
|
+
query?: {
|
|
1901
|
+
count?: number;
|
|
1902
|
+
};
|
|
1903
|
+
header: {
|
|
1904
|
+
"sp-access-token": string;
|
|
1905
|
+
};
|
|
1906
|
+
path?: never;
|
|
1907
|
+
cookie?: never;
|
|
1908
|
+
};
|
|
1909
|
+
requestBody?: never;
|
|
1910
|
+
responses: {
|
|
1911
|
+
/** @description Get starter recommendations */
|
|
1912
|
+
200: {
|
|
1913
|
+
headers: {
|
|
1914
|
+
[name: string]: unknown;
|
|
1915
|
+
};
|
|
1916
|
+
content: {
|
|
1917
|
+
"application/json": {
|
|
1918
|
+
recommendations: components["schemas"]["StarterRecommendation"][];
|
|
1919
|
+
};
|
|
1920
|
+
};
|
|
1921
|
+
};
|
|
1922
|
+
/** @description Something wrong happened */
|
|
1923
|
+
500: {
|
|
1924
|
+
headers: {
|
|
1925
|
+
[name: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
content: {
|
|
1928
|
+
"application/json": {
|
|
1929
|
+
error: string;
|
|
1930
|
+
};
|
|
1931
|
+
};
|
|
1932
|
+
};
|
|
1933
|
+
};
|
|
1934
|
+
};
|
|
1935
|
+
fetchVisualization: {
|
|
1936
|
+
parameters: {
|
|
1937
|
+
query?: never;
|
|
1938
|
+
header: {
|
|
1939
|
+
"sp-access-token": string;
|
|
1940
|
+
};
|
|
1941
|
+
path: {
|
|
1942
|
+
visualization_id: string;
|
|
1943
|
+
};
|
|
1944
|
+
cookie?: never;
|
|
1945
|
+
};
|
|
1946
|
+
requestBody?: never;
|
|
1947
|
+
responses: {
|
|
1948
|
+
/** @description The content of the visualization */
|
|
1949
|
+
200: {
|
|
1950
|
+
headers: {
|
|
1951
|
+
[name: string]: unknown;
|
|
1952
|
+
};
|
|
1953
|
+
content: {
|
|
1954
|
+
"application/json": components["schemas"]["VisualizationWithData"];
|
|
1955
|
+
};
|
|
1956
|
+
};
|
|
1957
|
+
/** @description Invalid arguments to fetch visualization */
|
|
1958
|
+
400: {
|
|
1959
|
+
headers: {
|
|
1960
|
+
[name: string]: unknown;
|
|
1961
|
+
};
|
|
1962
|
+
content: {
|
|
1963
|
+
"application/json": {
|
|
1964
|
+
error: string;
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
/** @description Unable to fetch visualization with this id */
|
|
1969
|
+
404: {
|
|
1970
|
+
headers: {
|
|
1971
|
+
[name: string]: unknown;
|
|
1972
|
+
};
|
|
1973
|
+
content: {
|
|
1974
|
+
"application/json": {
|
|
1975
|
+
error: string;
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
};
|
|
1979
|
+
/** @description Something wrong happened */
|
|
1980
|
+
500: {
|
|
1981
|
+
headers: {
|
|
1982
|
+
[name: string]: unknown;
|
|
1983
|
+
};
|
|
1984
|
+
content: {
|
|
1985
|
+
"application/json": {
|
|
1986
|
+
error: string;
|
|
1987
|
+
};
|
|
1988
|
+
};
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
};
|
|
1992
|
+
listVisualizationsForFlow: {
|
|
1993
|
+
parameters: {
|
|
1994
|
+
query?: {
|
|
1995
|
+
flowDataId?: string;
|
|
1996
|
+
};
|
|
1997
|
+
header: {
|
|
1998
|
+
"sp-access-token": string;
|
|
1999
|
+
};
|
|
2000
|
+
path: {
|
|
2001
|
+
flowId: string;
|
|
2002
|
+
};
|
|
2003
|
+
cookie?: never;
|
|
2004
|
+
};
|
|
2005
|
+
requestBody?: never;
|
|
2006
|
+
responses: {
|
|
2007
|
+
/** @description List visualizations for a given flow. Can be filtered by flow data id as well */
|
|
2008
|
+
200: {
|
|
2009
|
+
headers: {
|
|
2010
|
+
[name: string]: unknown;
|
|
2011
|
+
};
|
|
2012
|
+
content: {
|
|
2013
|
+
"application/json": {
|
|
2014
|
+
id: number;
|
|
2015
|
+
flow_data_id: number;
|
|
2016
|
+
created_at: string;
|
|
2017
|
+
bookmarked: boolean;
|
|
2018
|
+
configuration: {
|
|
2019
|
+
/** @enum {string} */
|
|
2020
|
+
type: "bar";
|
|
2021
|
+
title: string;
|
|
2022
|
+
/** @enum {number} */
|
|
2023
|
+
config_version: 2;
|
|
2024
|
+
xAxisLabel: string;
|
|
2025
|
+
yAxisLabel: string;
|
|
2026
|
+
categoryColumn: string;
|
|
2027
|
+
secondaryCategoryColumn?: string;
|
|
2028
|
+
valueColumn: string;
|
|
2029
|
+
} | {
|
|
2030
|
+
/** @enum {string} */
|
|
2031
|
+
type: "line/area";
|
|
2032
|
+
/** @enum {number} */
|
|
2033
|
+
config_version: 2;
|
|
2034
|
+
title: string;
|
|
2035
|
+
xAxisColumn: string;
|
|
2036
|
+
valueColumns: string[];
|
|
2037
|
+
yAxisLabels: string[];
|
|
2038
|
+
} | {
|
|
2039
|
+
/** @enum {string} */
|
|
2040
|
+
type: "line/area-categorical";
|
|
2041
|
+
title: string;
|
|
2042
|
+
/** @enum {number} */
|
|
2043
|
+
config_version: 2;
|
|
2044
|
+
valueColumn: string;
|
|
2045
|
+
xAxisColumn: string;
|
|
2046
|
+
xAxisLabel: string;
|
|
2047
|
+
yAxisLabel: string;
|
|
2048
|
+
categoryColumn: string;
|
|
2049
|
+
} | {
|
|
2050
|
+
/** @enum {string} */
|
|
2051
|
+
type: "scatter";
|
|
2052
|
+
title: string;
|
|
2053
|
+
/** @enum {number} */
|
|
2054
|
+
config_version: 2;
|
|
2055
|
+
xAxisLabel: string;
|
|
2056
|
+
yAxisLabel: string;
|
|
2057
|
+
xAxisValueColumn: string;
|
|
2058
|
+
yAxisValueColumn: string;
|
|
2059
|
+
} | {
|
|
2060
|
+
/** @enum {string} */
|
|
2061
|
+
type: "pie";
|
|
2062
|
+
title: string;
|
|
2063
|
+
/** @enum {number} */
|
|
2064
|
+
config_version: 2;
|
|
2065
|
+
categoryColumn: string;
|
|
2066
|
+
valueColumn: string;
|
|
2067
|
+
};
|
|
2068
|
+
}[];
|
|
2069
|
+
};
|
|
2070
|
+
};
|
|
2071
|
+
/** @description Invalid arguments to fetch visualization */
|
|
2072
|
+
400: {
|
|
2073
|
+
headers: {
|
|
2074
|
+
[name: string]: unknown;
|
|
2075
|
+
};
|
|
2076
|
+
content: {
|
|
2077
|
+
"application/json": {
|
|
2078
|
+
error: string;
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
2081
|
+
};
|
|
2082
|
+
/** @description Unable to list visualizations */
|
|
2083
|
+
404: {
|
|
2084
|
+
headers: {
|
|
2085
|
+
[name: string]: unknown;
|
|
2086
|
+
};
|
|
2087
|
+
content: {
|
|
2088
|
+
"application/json": {
|
|
2089
|
+
error: string;
|
|
2090
|
+
};
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
/** @description Something wrong happened */
|
|
2094
|
+
500: {
|
|
2095
|
+
headers: {
|
|
2096
|
+
[name: string]: unknown;
|
|
2097
|
+
};
|
|
2098
|
+
content: {
|
|
2099
|
+
"application/json": {
|
|
2100
|
+
error: string;
|
|
2101
|
+
};
|
|
2102
|
+
};
|
|
2103
|
+
};
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
triggerFlow: {
|
|
2107
|
+
parameters: {
|
|
2108
|
+
query?: never;
|
|
2109
|
+
header: {
|
|
2110
|
+
"sp-access-token": string;
|
|
2111
|
+
};
|
|
2112
|
+
path?: never;
|
|
2113
|
+
cookie?: never;
|
|
2114
|
+
};
|
|
2115
|
+
/** @description Trigger flow request body */
|
|
2116
|
+
requestBody: {
|
|
2117
|
+
content: {
|
|
2118
|
+
"application/json": {
|
|
2119
|
+
triggerId: string;
|
|
2120
|
+
variables: {
|
|
2121
|
+
[key: string]: string;
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
};
|
|
2126
|
+
responses: {
|
|
2127
|
+
/** @description Flow id */
|
|
2128
|
+
200: {
|
|
2129
|
+
headers: {
|
|
2130
|
+
[name: string]: unknown;
|
|
2131
|
+
};
|
|
2132
|
+
content: {
|
|
2133
|
+
"application/json": {
|
|
2134
|
+
/** @enum {string} */
|
|
2135
|
+
status: "error";
|
|
2136
|
+
error: string;
|
|
2137
|
+
} | {
|
|
2138
|
+
/** @enum {string} */
|
|
2139
|
+
status: "success";
|
|
2140
|
+
flowId: string;
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2143
|
+
};
|
|
2144
|
+
/** @description Invalid template or variable values */
|
|
2145
|
+
400: {
|
|
2146
|
+
headers: {
|
|
2147
|
+
[name: string]: unknown;
|
|
2148
|
+
};
|
|
2149
|
+
content: {
|
|
2150
|
+
"application/json": {
|
|
2151
|
+
error: string;
|
|
2152
|
+
};
|
|
2153
|
+
};
|
|
2154
|
+
};
|
|
2155
|
+
/** @description Unable to retrieve trigger with this id */
|
|
2156
|
+
404: {
|
|
2157
|
+
headers: {
|
|
2158
|
+
[name: string]: unknown;
|
|
2159
|
+
};
|
|
2160
|
+
content: {
|
|
2161
|
+
"application/json": {
|
|
2162
|
+
error: string;
|
|
2163
|
+
};
|
|
2164
|
+
};
|
|
2165
|
+
};
|
|
2166
|
+
/** @description Something wrong happened */
|
|
2167
|
+
500: {
|
|
2168
|
+
headers: {
|
|
2169
|
+
[name: string]: unknown;
|
|
2170
|
+
};
|
|
2171
|
+
content: {
|
|
2172
|
+
"application/json": {
|
|
2173
|
+
error: string;
|
|
2174
|
+
};
|
|
2175
|
+
};
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
retrieveDashboard: {
|
|
2180
|
+
parameters: {
|
|
2181
|
+
query?: never;
|
|
2182
|
+
header: {
|
|
2183
|
+
"sp-access-token": string;
|
|
2184
|
+
};
|
|
2185
|
+
path: {
|
|
2186
|
+
dashboard_id: components["schemas"]["DashboardId"];
|
|
2187
|
+
};
|
|
2188
|
+
cookie?: never;
|
|
2189
|
+
};
|
|
2190
|
+
requestBody?: never;
|
|
2191
|
+
responses: {
|
|
2192
|
+
/** @description The dashboard with the given id */
|
|
2193
|
+
200: {
|
|
2194
|
+
headers: {
|
|
2195
|
+
[name: string]: unknown;
|
|
2196
|
+
};
|
|
2197
|
+
content: {
|
|
2198
|
+
"application/json": {
|
|
2199
|
+
description: string | null;
|
|
2200
|
+
/** Format: uuid */
|
|
2201
|
+
id: string;
|
|
2202
|
+
name: string;
|
|
2203
|
+
positions: ({
|
|
2204
|
+
/** @enum {string} */
|
|
2205
|
+
type: "data-report";
|
|
2206
|
+
flowId: string;
|
|
2207
|
+
flowDataId: number;
|
|
2208
|
+
title: string;
|
|
2209
|
+
col: number;
|
|
2210
|
+
colSpan: number;
|
|
2211
|
+
rowSpan: number;
|
|
2212
|
+
} | {
|
|
2213
|
+
/** @enum {string} */
|
|
2214
|
+
type: "visualization";
|
|
2215
|
+
visualizationId: number;
|
|
2216
|
+
title: string;
|
|
2217
|
+
col: number;
|
|
2218
|
+
colSpan: number;
|
|
2219
|
+
rowSpan: number;
|
|
2220
|
+
})[];
|
|
2221
|
+
is_public: boolean;
|
|
2222
|
+
};
|
|
2223
|
+
};
|
|
2224
|
+
};
|
|
2225
|
+
/** @description Unable to retrieve dashboard with this id */
|
|
2226
|
+
404: {
|
|
2227
|
+
headers: {
|
|
2228
|
+
[name: string]: unknown;
|
|
2229
|
+
};
|
|
2230
|
+
content: {
|
|
2231
|
+
"application/json": {
|
|
2232
|
+
error: string;
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
};
|
|
2236
|
+
/** @description Something wrong happened */
|
|
2237
|
+
500: {
|
|
2238
|
+
headers: {
|
|
2239
|
+
[name: string]: unknown;
|
|
2240
|
+
};
|
|
2241
|
+
content: {
|
|
2242
|
+
"application/json": {
|
|
2243
|
+
error: string;
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2249
|
+
generateInsight: {
|
|
2250
|
+
parameters: {
|
|
2251
|
+
query?: never;
|
|
2252
|
+
header?: never;
|
|
2253
|
+
path?: never;
|
|
2254
|
+
cookie?: never;
|
|
2255
|
+
};
|
|
2256
|
+
requestBody?: {
|
|
2257
|
+
content: {
|
|
2258
|
+
"application/json": {
|
|
2259
|
+
selected_filter_value: string;
|
|
2260
|
+
custom_id: string;
|
|
2261
|
+
};
|
|
2262
|
+
};
|
|
2263
|
+
};
|
|
2264
|
+
responses: {
|
|
2265
|
+
/** @description Insight generated successfully */
|
|
2266
|
+
200: {
|
|
2267
|
+
headers: {
|
|
2268
|
+
[name: string]: unknown;
|
|
2269
|
+
};
|
|
2270
|
+
content: {
|
|
2271
|
+
"application/json": {
|
|
2272
|
+
/** @enum {string} */
|
|
2273
|
+
type: "text";
|
|
2274
|
+
insight: string;
|
|
2275
|
+
} | {
|
|
2276
|
+
/** @enum {string} */
|
|
2277
|
+
type: "missing";
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
};
|
|
2281
|
+
/** @description Invalid request */
|
|
2282
|
+
400: {
|
|
2283
|
+
headers: {
|
|
2284
|
+
[name: string]: unknown;
|
|
2285
|
+
};
|
|
2286
|
+
content: {
|
|
2287
|
+
"application/json": {
|
|
2288
|
+
error: string;
|
|
2289
|
+
};
|
|
2290
|
+
};
|
|
2291
|
+
};
|
|
2292
|
+
/** @description Insight not found */
|
|
2293
|
+
404: {
|
|
2294
|
+
headers: {
|
|
2295
|
+
[name: string]: unknown;
|
|
2296
|
+
};
|
|
2297
|
+
content: {
|
|
2298
|
+
"application/json": {
|
|
2299
|
+
error: string;
|
|
2300
|
+
};
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
/** @description Something wrong happened */
|
|
2304
|
+
500: {
|
|
2305
|
+
headers: {
|
|
2306
|
+
[name: string]: unknown;
|
|
2307
|
+
};
|
|
2308
|
+
content: {
|
|
2309
|
+
"application/json": {
|
|
2310
|
+
error: string;
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
};
|
|
2314
|
+
};
|
|
2315
|
+
};
|
|
2316
|
+
createQueryExample: {
|
|
2317
|
+
parameters: {
|
|
2318
|
+
query?: never;
|
|
2319
|
+
header?: never;
|
|
2320
|
+
path?: never;
|
|
2321
|
+
cookie?: never;
|
|
2322
|
+
};
|
|
2323
|
+
requestBody?: {
|
|
2324
|
+
content: {
|
|
2325
|
+
"application/json": {
|
|
2326
|
+
request: string;
|
|
2327
|
+
sql: string;
|
|
2328
|
+
};
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
responses: {
|
|
2332
|
+
/** @description Query example created successfully */
|
|
2333
|
+
200: {
|
|
2334
|
+
headers: {
|
|
2335
|
+
[name: string]: unknown;
|
|
2336
|
+
};
|
|
2337
|
+
content: {
|
|
2338
|
+
"application/json": {
|
|
2339
|
+
id: number;
|
|
2340
|
+
};
|
|
2341
|
+
};
|
|
2342
|
+
};
|
|
2343
|
+
/** @description Something wrong happened */
|
|
2344
|
+
500: {
|
|
2345
|
+
headers: {
|
|
2346
|
+
[name: string]: unknown;
|
|
2347
|
+
};
|
|
2348
|
+
content: {
|
|
2349
|
+
"application/json": {
|
|
2350
|
+
error: string;
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
};
|
|
2354
|
+
};
|
|
2355
|
+
};
|
|
2356
|
+
updateQueryExample: {
|
|
2357
|
+
parameters: {
|
|
2358
|
+
query?: never;
|
|
2359
|
+
header?: never;
|
|
2360
|
+
path: {
|
|
2361
|
+
id: string;
|
|
2362
|
+
};
|
|
2363
|
+
cookie?: never;
|
|
2364
|
+
};
|
|
2365
|
+
requestBody?: {
|
|
2366
|
+
content: {
|
|
2367
|
+
"application/json": {
|
|
2368
|
+
request?: string;
|
|
2369
|
+
sql?: string;
|
|
2370
|
+
is_active?: boolean;
|
|
2371
|
+
is_removed?: boolean;
|
|
2372
|
+
};
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
responses: {
|
|
2376
|
+
/** @description Query example updated successfully */
|
|
2377
|
+
200: {
|
|
2378
|
+
headers: {
|
|
2379
|
+
[name: string]: unknown;
|
|
2380
|
+
};
|
|
2381
|
+
content: {
|
|
2382
|
+
"application/json": {
|
|
2383
|
+
id: number;
|
|
2384
|
+
};
|
|
2385
|
+
};
|
|
2386
|
+
};
|
|
2387
|
+
/** @description Something wrong happened */
|
|
2388
|
+
500: {
|
|
2389
|
+
headers: {
|
|
2390
|
+
[name: string]: unknown;
|
|
2391
|
+
};
|
|
2392
|
+
content: {
|
|
2393
|
+
"application/json": {
|
|
2394
|
+
error: string;
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
};
|
|
2398
|
+
};
|
|
2399
|
+
};
|
|
2400
|
+
sqlPreview: {
|
|
2401
|
+
parameters: {
|
|
2402
|
+
query?: never;
|
|
2403
|
+
header?: never;
|
|
2404
|
+
path?: never;
|
|
2405
|
+
cookie?: never;
|
|
2406
|
+
};
|
|
2407
|
+
requestBody?: {
|
|
2408
|
+
content: {
|
|
2409
|
+
"application/json": {
|
|
2410
|
+
sql: string;
|
|
2411
|
+
};
|
|
2412
|
+
};
|
|
2413
|
+
};
|
|
2414
|
+
responses: {
|
|
2415
|
+
/** @description SQL query executed successfully */
|
|
2416
|
+
200: {
|
|
2417
|
+
headers: {
|
|
2418
|
+
[name: string]: unknown;
|
|
2419
|
+
};
|
|
2420
|
+
content: {
|
|
2421
|
+
"application/json": {
|
|
2422
|
+
columns: {
|
|
2423
|
+
id: string;
|
|
2424
|
+
accessorKey: string;
|
|
2425
|
+
header: string;
|
|
2426
|
+
cell?: unknown;
|
|
2427
|
+
meta?: {
|
|
2428
|
+
[key: string]: unknown;
|
|
2429
|
+
};
|
|
2430
|
+
}[];
|
|
2431
|
+
data: {
|
|
2432
|
+
[key: string]: unknown;
|
|
2433
|
+
}[];
|
|
2434
|
+
metadata?: {
|
|
2435
|
+
wasSampled: boolean;
|
|
2436
|
+
originalCount: number;
|
|
2437
|
+
sampledCount: number;
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
};
|
|
2441
|
+
};
|
|
2442
|
+
/** @description Invalid SQL query or request */
|
|
2443
|
+
400: {
|
|
2444
|
+
headers: {
|
|
2445
|
+
[name: string]: unknown;
|
|
2446
|
+
};
|
|
2447
|
+
content: {
|
|
2448
|
+
"application/json": {
|
|
2449
|
+
error: string;
|
|
2450
|
+
};
|
|
2451
|
+
};
|
|
2452
|
+
};
|
|
2453
|
+
/** @description Internal server error */
|
|
2454
|
+
500: {
|
|
2455
|
+
headers: {
|
|
2456
|
+
[name: string]: unknown;
|
|
2457
|
+
};
|
|
2458
|
+
content: {
|
|
2459
|
+
"application/json": {
|
|
2460
|
+
error: string;
|
|
2461
|
+
};
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
};
|
|
2465
|
+
};
|
|
2466
|
+
getSankeyData: {
|
|
2467
|
+
parameters: {
|
|
2468
|
+
query?: never;
|
|
2469
|
+
header?: never;
|
|
2470
|
+
path?: never;
|
|
2471
|
+
cookie?: never;
|
|
2472
|
+
};
|
|
2473
|
+
requestBody?: never;
|
|
2474
|
+
responses: {
|
|
2475
|
+
/** @description Sankey data retrieved successfully */
|
|
2476
|
+
200: {
|
|
2477
|
+
headers: {
|
|
2478
|
+
[name: string]: unknown;
|
|
2479
|
+
};
|
|
2480
|
+
content: {
|
|
2481
|
+
"application/json": {
|
|
2482
|
+
metadata: {
|
|
2483
|
+
embedding_type: string;
|
|
2484
|
+
approach: string;
|
|
2485
|
+
total_clusters: number;
|
|
2486
|
+
total_noise_points: number;
|
|
2487
|
+
total_requests: number;
|
|
2488
|
+
generation_timestamp: string;
|
|
2489
|
+
};
|
|
2490
|
+
clusters: {
|
|
2491
|
+
cluster_id: number;
|
|
2492
|
+
cluster_name: string;
|
|
2493
|
+
representative_questions: {
|
|
2494
|
+
question: string;
|
|
2495
|
+
count: number;
|
|
2496
|
+
sample_requests: string[];
|
|
2497
|
+
avg_confidence_score?: number | null;
|
|
2498
|
+
avg_assumptions_score?: number | null;
|
|
2499
|
+
avg_friendliness_score?: number | null;
|
|
2500
|
+
}[];
|
|
2501
|
+
count: number;
|
|
2502
|
+
avg_confidence_score?: number | null;
|
|
2503
|
+
avg_assumptions_score?: number | null;
|
|
2504
|
+
avg_friendliness_score?: number | null;
|
|
2505
|
+
}[];
|
|
2506
|
+
};
|
|
2507
|
+
};
|
|
2508
|
+
};
|
|
2509
|
+
/** @description Something wrong happened */
|
|
2510
|
+
500: {
|
|
2511
|
+
headers: {
|
|
2512
|
+
[name: string]: unknown;
|
|
2513
|
+
};
|
|
2514
|
+
content: {
|
|
2515
|
+
"application/json": {
|
|
2516
|
+
error: string;
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
};
|
|
2522
|
+
generateInsightTemplate: {
|
|
2523
|
+
parameters: {
|
|
2524
|
+
query?: never;
|
|
2525
|
+
header?: never;
|
|
2526
|
+
path?: never;
|
|
2527
|
+
cookie?: never;
|
|
2528
|
+
};
|
|
2529
|
+
requestBody?: {
|
|
2530
|
+
content: {
|
|
2531
|
+
"application/json": {
|
|
2532
|
+
request: string;
|
|
2533
|
+
insight_type: string;
|
|
2534
|
+
additional_context?: string;
|
|
2535
|
+
};
|
|
2536
|
+
};
|
|
2537
|
+
};
|
|
2538
|
+
responses: {
|
|
2539
|
+
/** @description Insight template generated successfully */
|
|
2540
|
+
200: {
|
|
2541
|
+
headers: {
|
|
2542
|
+
[name: string]: unknown;
|
|
2543
|
+
};
|
|
2544
|
+
content: {
|
|
2545
|
+
"application/json": {
|
|
2546
|
+
expanded_request: string;
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
/** @description Something wrong happened */
|
|
2551
|
+
500: {
|
|
2552
|
+
headers: {
|
|
2553
|
+
[name: string]: unknown;
|
|
2554
|
+
};
|
|
2555
|
+
content: {
|
|
2556
|
+
"application/json": {
|
|
2557
|
+
error: string;
|
|
2558
|
+
};
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
};
|
|
2562
|
+
};
|
|
2563
|
+
getContextualInsightPreviewData: {
|
|
2564
|
+
parameters: {
|
|
2565
|
+
query?: {
|
|
2566
|
+
limit?: number;
|
|
2567
|
+
/** @example name:asc,date:desc */
|
|
2568
|
+
order?: string;
|
|
2569
|
+
cursor?: number;
|
|
2570
|
+
/** @example status:active,name:John%20Doe */
|
|
2571
|
+
filter?: string;
|
|
2572
|
+
};
|
|
2573
|
+
header?: never;
|
|
2574
|
+
path: {
|
|
2575
|
+
report_id: string;
|
|
2576
|
+
};
|
|
2577
|
+
cookie?: never;
|
|
2578
|
+
};
|
|
2579
|
+
requestBody?: never;
|
|
2580
|
+
responses: {
|
|
2581
|
+
/** @description The preview data for the contextual insight */
|
|
2582
|
+
200: {
|
|
2583
|
+
headers: {
|
|
2584
|
+
[name: string]: unknown;
|
|
2585
|
+
};
|
|
2586
|
+
content: {
|
|
2587
|
+
"application/json": {
|
|
2588
|
+
columns: {
|
|
2589
|
+
id: string;
|
|
2590
|
+
accessorKey: string;
|
|
2591
|
+
header: string;
|
|
2592
|
+
cell?: unknown;
|
|
2593
|
+
meta?: {
|
|
2594
|
+
[key: string]: unknown;
|
|
2595
|
+
};
|
|
2596
|
+
}[];
|
|
2597
|
+
data: {
|
|
2598
|
+
[key: string]: unknown;
|
|
2599
|
+
}[];
|
|
2600
|
+
metadata?: {
|
|
2601
|
+
wasSampled: boolean;
|
|
2602
|
+
originalCount: number;
|
|
2603
|
+
sampledCount: number;
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
};
|
|
2607
|
+
};
|
|
2608
|
+
/** @description Unable to retrieve flow data with this id */
|
|
2609
|
+
404: {
|
|
2610
|
+
headers: {
|
|
2611
|
+
[name: string]: unknown;
|
|
2612
|
+
};
|
|
2613
|
+
content: {
|
|
2614
|
+
"application/json": {
|
|
2615
|
+
error: string;
|
|
2616
|
+
};
|
|
2617
|
+
};
|
|
2618
|
+
};
|
|
2619
|
+
/** @description Something wrong happened */
|
|
2620
|
+
500: {
|
|
2621
|
+
headers: {
|
|
2622
|
+
[name: string]: unknown;
|
|
2623
|
+
};
|
|
2624
|
+
content: {
|
|
2625
|
+
"application/json": {
|
|
2626
|
+
error: string;
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
};
|
|
2630
|
+
};
|
|
2631
|
+
};
|
|
2632
|
+
getContextualInsightColumnSampleValues: {
|
|
2633
|
+
parameters: {
|
|
2634
|
+
query: {
|
|
2635
|
+
column_name: string;
|
|
2636
|
+
};
|
|
2637
|
+
header?: never;
|
|
2638
|
+
path: {
|
|
2639
|
+
report_id: string;
|
|
2640
|
+
};
|
|
2641
|
+
cookie?: never;
|
|
2642
|
+
};
|
|
2643
|
+
requestBody?: never;
|
|
2644
|
+
responses: {
|
|
2645
|
+
/** @description Sample values for the specified column */
|
|
2646
|
+
200: {
|
|
2647
|
+
headers: {
|
|
2648
|
+
[name: string]: unknown;
|
|
2649
|
+
};
|
|
2650
|
+
content: {
|
|
2651
|
+
"application/json": {
|
|
2652
|
+
options: unknown[];
|
|
2653
|
+
};
|
|
2654
|
+
};
|
|
2655
|
+
};
|
|
2656
|
+
/** @description Unable to retrieve flow data with this id */
|
|
2657
|
+
404: {
|
|
2658
|
+
headers: {
|
|
2659
|
+
[name: string]: unknown;
|
|
2660
|
+
};
|
|
2661
|
+
content: {
|
|
2662
|
+
"application/json": {
|
|
2663
|
+
error: string;
|
|
2664
|
+
};
|
|
2665
|
+
};
|
|
2666
|
+
};
|
|
2667
|
+
/** @description Something wrong happened */
|
|
2668
|
+
500: {
|
|
2669
|
+
headers: {
|
|
2670
|
+
[name: string]: unknown;
|
|
2671
|
+
};
|
|
2672
|
+
content: {
|
|
2673
|
+
"application/json": {
|
|
2674
|
+
error: string;
|
|
2675
|
+
};
|
|
2676
|
+
};
|
|
2677
|
+
};
|
|
2678
|
+
};
|
|
2679
|
+
};
|
|
2680
|
+
extractInsight: {
|
|
2681
|
+
parameters: {
|
|
2682
|
+
query?: never;
|
|
2683
|
+
header?: never;
|
|
2684
|
+
path?: never;
|
|
2685
|
+
cookie?: never;
|
|
2686
|
+
};
|
|
2687
|
+
requestBody?: {
|
|
2688
|
+
content: {
|
|
2689
|
+
"application/json": {
|
|
2690
|
+
flow_id: string;
|
|
2691
|
+
report_id: number;
|
|
2692
|
+
topic: string;
|
|
2693
|
+
expanded_request: string;
|
|
2694
|
+
insight_type: string;
|
|
2695
|
+
selected_filter: string;
|
|
2696
|
+
selected_filter_value: string;
|
|
2697
|
+
additional_context?: string;
|
|
2698
|
+
};
|
|
2699
|
+
};
|
|
2700
|
+
};
|
|
2701
|
+
responses: {
|
|
2702
|
+
/** @description Insight extracted successfully */
|
|
2703
|
+
200: {
|
|
2704
|
+
headers: {
|
|
2705
|
+
[name: string]: unknown;
|
|
2706
|
+
};
|
|
2707
|
+
content: {
|
|
2708
|
+
"application/json": {
|
|
2709
|
+
/** @enum {string} */
|
|
2710
|
+
type: "text";
|
|
2711
|
+
insight: string;
|
|
2712
|
+
} | {
|
|
2713
|
+
/** @enum {string} */
|
|
2714
|
+
type: "missing";
|
|
2715
|
+
};
|
|
2716
|
+
};
|
|
2717
|
+
};
|
|
2718
|
+
/** @description Something wrong happened */
|
|
2719
|
+
500: {
|
|
2720
|
+
headers: {
|
|
2721
|
+
[name: string]: unknown;
|
|
2722
|
+
};
|
|
2723
|
+
content: {
|
|
2724
|
+
"application/json": {
|
|
2725
|
+
error: string;
|
|
2726
|
+
};
|
|
2727
|
+
};
|
|
2728
|
+
};
|
|
2729
|
+
};
|
|
2730
|
+
};
|
|
2731
|
+
suggestFilterColumn: {
|
|
2732
|
+
parameters: {
|
|
2733
|
+
query?: never;
|
|
2734
|
+
header?: never;
|
|
2735
|
+
path?: never;
|
|
2736
|
+
cookie?: never;
|
|
2737
|
+
};
|
|
2738
|
+
requestBody?: {
|
|
2739
|
+
content: {
|
|
2740
|
+
"application/json": {
|
|
2741
|
+
report_id: number;
|
|
2742
|
+
request: string;
|
|
2743
|
+
insight_type: string;
|
|
2744
|
+
additional_context?: string;
|
|
2745
|
+
};
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
responses: {
|
|
2749
|
+
/** @description Filter column suggestion generated successfully */
|
|
2750
|
+
200: {
|
|
2751
|
+
headers: {
|
|
2752
|
+
[name: string]: unknown;
|
|
2753
|
+
};
|
|
2754
|
+
content: {
|
|
2755
|
+
"application/json": {
|
|
2756
|
+
recommended_column: string;
|
|
2757
|
+
reasoning: string;
|
|
2758
|
+
};
|
|
2759
|
+
};
|
|
2760
|
+
};
|
|
2761
|
+
/** @description Report not found */
|
|
2762
|
+
404: {
|
|
2763
|
+
headers: {
|
|
2764
|
+
[name: string]: unknown;
|
|
2765
|
+
};
|
|
2766
|
+
content: {
|
|
2767
|
+
"application/json": {
|
|
2768
|
+
error: string;
|
|
2769
|
+
};
|
|
2770
|
+
};
|
|
2771
|
+
};
|
|
2772
|
+
/** @description Something wrong happened */
|
|
2773
|
+
500: {
|
|
2774
|
+
headers: {
|
|
2775
|
+
[name: string]: unknown;
|
|
2776
|
+
};
|
|
2777
|
+
content: {
|
|
2778
|
+
"application/json": {
|
|
2779
|
+
error: string;
|
|
2780
|
+
};
|
|
2781
|
+
};
|
|
2782
|
+
};
|
|
2783
|
+
};
|
|
2784
|
+
};
|
|
2785
|
+
}
|
|
2786
|
+
|
|
2787
|
+
declare type PatchParam<T, Config extends RemoveParamsConfig, P extends keyof Config> = Simplify<T extends {
|
|
2788
|
+
[key in P]: infer H;
|
|
2789
|
+
} ? H extends Partial<Record<string, unknown>> ? Config[P] extends string ? Omit<H, Config[P]> : H : never : never>;
|
|
2790
|
+
|
|
2791
|
+
/**
|
|
2792
|
+
* This file was auto-generated by openapi-typescript.
|
|
2793
|
+
* Do not make direct changes to the file.
|
|
2794
|
+
*/
|
|
2795
|
+
|
|
2796
|
+
declare interface paths {
|
|
2797
|
+
"/api/v1/auth/exchangeExternalToken": {
|
|
2798
|
+
parameters: {
|
|
2799
|
+
query?: never;
|
|
2800
|
+
header?: never;
|
|
2801
|
+
path?: never;
|
|
2802
|
+
cookie?: never;
|
|
2803
|
+
};
|
|
2804
|
+
get?: never;
|
|
2805
|
+
put?: never;
|
|
2806
|
+
post: operations["exchangeExternalToken"];
|
|
2807
|
+
delete?: never;
|
|
2808
|
+
options?: never;
|
|
2809
|
+
head?: never;
|
|
2810
|
+
patch?: never;
|
|
2811
|
+
trace?: never;
|
|
2812
|
+
};
|
|
2813
|
+
"/api/v1/auth/apiInformation": {
|
|
2814
|
+
parameters: {
|
|
2815
|
+
query?: never;
|
|
2816
|
+
header?: never;
|
|
2817
|
+
path?: never;
|
|
2818
|
+
cookie?: never;
|
|
2819
|
+
};
|
|
2820
|
+
get: operations["getApiInformation"];
|
|
2821
|
+
put?: never;
|
|
2822
|
+
post?: never;
|
|
2823
|
+
delete?: never;
|
|
2824
|
+
options?: never;
|
|
2825
|
+
head?: never;
|
|
2826
|
+
patch?: never;
|
|
2827
|
+
trace?: never;
|
|
2828
|
+
};
|
|
2829
|
+
"/api/v1/public/dashboards/{dashboard_id}/visualizations/{visualization_id}": {
|
|
2830
|
+
parameters: {
|
|
2831
|
+
query?: never;
|
|
2832
|
+
header?: never;
|
|
2833
|
+
path?: never;
|
|
2834
|
+
cookie?: never;
|
|
2835
|
+
};
|
|
2836
|
+
get: operations["PublicDashboardFetchVisualization"];
|
|
2837
|
+
put?: never;
|
|
2838
|
+
post?: never;
|
|
2839
|
+
delete?: never;
|
|
2840
|
+
options?: never;
|
|
2841
|
+
head?: never;
|
|
2842
|
+
patch?: never;
|
|
2843
|
+
trace?: never;
|
|
2844
|
+
};
|
|
2845
|
+
"/api/v1/public/dashboards/{dashboard_id}": {
|
|
2846
|
+
parameters: {
|
|
2847
|
+
query?: never;
|
|
2848
|
+
header?: never;
|
|
2849
|
+
path?: never;
|
|
2850
|
+
cookie?: never;
|
|
2851
|
+
};
|
|
2852
|
+
get: operations["retrievePublicDashboard"];
|
|
2853
|
+
put?: never;
|
|
2854
|
+
post?: never;
|
|
2855
|
+
delete?: never;
|
|
2856
|
+
options?: never;
|
|
2857
|
+
head?: never;
|
|
2858
|
+
patch?: never;
|
|
2859
|
+
trace?: never;
|
|
2860
|
+
};
|
|
2861
|
+
"/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/columns": {
|
|
2862
|
+
parameters: {
|
|
2863
|
+
query?: never;
|
|
2864
|
+
header?: never;
|
|
2865
|
+
path?: never;
|
|
2866
|
+
cookie?: never;
|
|
2867
|
+
};
|
|
2868
|
+
get: operations["getPublicDataReportColumns"];
|
|
2869
|
+
put?: never;
|
|
2870
|
+
post?: never;
|
|
2871
|
+
delete?: never;
|
|
2872
|
+
options?: never;
|
|
2873
|
+
head?: never;
|
|
2874
|
+
patch?: never;
|
|
2875
|
+
trace?: never;
|
|
2876
|
+
};
|
|
2877
|
+
"/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/data": {
|
|
2878
|
+
parameters: {
|
|
2879
|
+
query?: never;
|
|
2880
|
+
header?: never;
|
|
2881
|
+
path?: never;
|
|
2882
|
+
cookie?: never;
|
|
2883
|
+
};
|
|
2884
|
+
get: operations["getPublicDataReportData"];
|
|
2885
|
+
put?: never;
|
|
2886
|
+
post?: never;
|
|
2887
|
+
delete?: never;
|
|
2888
|
+
options?: never;
|
|
2889
|
+
head?: never;
|
|
2890
|
+
patch?: never;
|
|
2891
|
+
trace?: never;
|
|
2892
|
+
};
|
|
2893
|
+
"/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/count": {
|
|
2894
|
+
parameters: {
|
|
2895
|
+
query?: never;
|
|
2896
|
+
header?: never;
|
|
2897
|
+
path?: never;
|
|
2898
|
+
cookie?: never;
|
|
2899
|
+
};
|
|
2900
|
+
get: operations["getPublicDataReportRowCount"];
|
|
2901
|
+
put?: never;
|
|
2902
|
+
post?: never;
|
|
2903
|
+
delete?: never;
|
|
2904
|
+
options?: never;
|
|
2905
|
+
head?: never;
|
|
2906
|
+
patch?: never;
|
|
2907
|
+
trace?: never;
|
|
2908
|
+
};
|
|
2909
|
+
"/api/v1/end2end": {
|
|
2910
|
+
parameters: {
|
|
2911
|
+
query?: never;
|
|
2912
|
+
header?: never;
|
|
2913
|
+
path?: never;
|
|
2914
|
+
cookie?: never;
|
|
2915
|
+
};
|
|
2916
|
+
get?: never;
|
|
2917
|
+
put?: never;
|
|
2918
|
+
post: operations["runEnd2EndFlow"];
|
|
2919
|
+
delete?: never;
|
|
2920
|
+
options?: never;
|
|
2921
|
+
head?: never;
|
|
2922
|
+
patch?: never;
|
|
2923
|
+
trace?: never;
|
|
2924
|
+
};
|
|
2925
|
+
"/api/v1/flows/{flowId}": {
|
|
2926
|
+
parameters: {
|
|
2927
|
+
query?: never;
|
|
2928
|
+
header?: never;
|
|
2929
|
+
path?: never;
|
|
2930
|
+
cookie?: never;
|
|
2931
|
+
};
|
|
2932
|
+
get: operations["retrieveFlow"];
|
|
2933
|
+
put?: never;
|
|
2934
|
+
post?: never;
|
|
2935
|
+
delete?: never;
|
|
2936
|
+
options?: never;
|
|
2937
|
+
head?: never;
|
|
2938
|
+
patch?: never;
|
|
2939
|
+
trace?: never;
|
|
2940
|
+
};
|
|
2941
|
+
"/api/v1/recent-flows": {
|
|
2942
|
+
parameters: {
|
|
2943
|
+
query?: never;
|
|
2944
|
+
header?: never;
|
|
2945
|
+
path?: never;
|
|
2946
|
+
cookie?: never;
|
|
2947
|
+
};
|
|
2948
|
+
get: operations["retrieveRecentFlows"];
|
|
2949
|
+
put?: never;
|
|
2950
|
+
post?: never;
|
|
2951
|
+
delete?: never;
|
|
2952
|
+
options?: never;
|
|
2953
|
+
head?: never;
|
|
2954
|
+
patch?: never;
|
|
2955
|
+
trace?: never;
|
|
2956
|
+
};
|
|
2957
|
+
"/api/v1/flows/{flowId}/data-reports": {
|
|
2958
|
+
parameters: {
|
|
2959
|
+
query?: never;
|
|
2960
|
+
header?: never;
|
|
2961
|
+
path?: never;
|
|
2962
|
+
cookie?: never;
|
|
2963
|
+
};
|
|
2964
|
+
get: operations["retrieveFlowDataReports"];
|
|
2965
|
+
put?: never;
|
|
2966
|
+
post?: never;
|
|
2967
|
+
delete?: never;
|
|
2968
|
+
options?: never;
|
|
2969
|
+
head?: never;
|
|
2970
|
+
patch?: never;
|
|
2971
|
+
trace?: never;
|
|
2972
|
+
};
|
|
2973
|
+
"/api/v1/data-reports/{report_id}/feedback": {
|
|
2974
|
+
parameters: {
|
|
2975
|
+
query?: never;
|
|
2976
|
+
header?: never;
|
|
2977
|
+
path?: never;
|
|
2978
|
+
cookie?: never;
|
|
2979
|
+
};
|
|
2980
|
+
get: operations["getDataReportFeedback"];
|
|
2981
|
+
put?: never;
|
|
2982
|
+
post: operations["upsertReportFeedback"];
|
|
2983
|
+
delete: operations["deleteReportFeedback"];
|
|
2984
|
+
options?: never;
|
|
2985
|
+
head?: never;
|
|
2986
|
+
patch?: never;
|
|
2987
|
+
trace?: never;
|
|
2988
|
+
};
|
|
2989
|
+
"/api/v1/flows/{flowId}/data-reports/last/status": {
|
|
2990
|
+
parameters: {
|
|
2991
|
+
query?: never;
|
|
2992
|
+
header?: never;
|
|
2993
|
+
path?: never;
|
|
2994
|
+
cookie?: never;
|
|
2995
|
+
};
|
|
2996
|
+
get: operations["retrieveLatestDataReportStatus"];
|
|
2997
|
+
put?: never;
|
|
2998
|
+
post?: never;
|
|
2999
|
+
delete?: never;
|
|
3000
|
+
options?: never;
|
|
3001
|
+
head?: never;
|
|
3002
|
+
patch?: never;
|
|
3003
|
+
trace?: never;
|
|
3004
|
+
};
|
|
3005
|
+
"/api/v1/data-reports/{report_id}/explainability": {
|
|
3006
|
+
parameters: {
|
|
3007
|
+
query?: never;
|
|
3008
|
+
header?: never;
|
|
3009
|
+
path?: never;
|
|
3010
|
+
cookie?: never;
|
|
3011
|
+
};
|
|
3012
|
+
get: operations["getDataReportExplainability"];
|
|
3013
|
+
put?: never;
|
|
3014
|
+
post?: never;
|
|
3015
|
+
delete?: never;
|
|
3016
|
+
options?: never;
|
|
3017
|
+
head?: never;
|
|
3018
|
+
patch?: never;
|
|
3019
|
+
trace?: never;
|
|
3020
|
+
};
|
|
3021
|
+
"/api/v1/timeline/bookmark": {
|
|
3022
|
+
parameters: {
|
|
3023
|
+
query?: never;
|
|
3024
|
+
header?: never;
|
|
3025
|
+
path?: never;
|
|
3026
|
+
cookie?: never;
|
|
3027
|
+
};
|
|
3028
|
+
get?: never;
|
|
3029
|
+
put?: never;
|
|
3030
|
+
post: operations["toggleBookmark"];
|
|
3031
|
+
delete?: never;
|
|
3032
|
+
options?: never;
|
|
3033
|
+
head?: never;
|
|
3034
|
+
patch?: never;
|
|
3035
|
+
trace?: never;
|
|
3036
|
+
};
|
|
3037
|
+
"/api/v1/data-tables/latest-refresh": {
|
|
3038
|
+
parameters: {
|
|
3039
|
+
query?: never;
|
|
3040
|
+
header?: never;
|
|
3041
|
+
path?: never;
|
|
3042
|
+
cookie?: never;
|
|
3043
|
+
};
|
|
3044
|
+
get: operations["retrieveLatestDataRefresh"];
|
|
3045
|
+
put?: never;
|
|
3046
|
+
post?: never;
|
|
3047
|
+
delete?: never;
|
|
3048
|
+
options?: never;
|
|
3049
|
+
head?: never;
|
|
3050
|
+
patch?: never;
|
|
3051
|
+
trace?: never;
|
|
3052
|
+
};
|
|
3053
|
+
"/api/v1/data-reports/{report_id}/export": {
|
|
3054
|
+
parameters: {
|
|
3055
|
+
query?: never;
|
|
3056
|
+
header?: never;
|
|
3057
|
+
path?: never;
|
|
3058
|
+
cookie?: never;
|
|
3059
|
+
};
|
|
3060
|
+
get: operations["exportReportData"];
|
|
3061
|
+
put?: never;
|
|
3062
|
+
post?: never;
|
|
3063
|
+
delete?: never;
|
|
3064
|
+
options?: never;
|
|
3065
|
+
head?: never;
|
|
3066
|
+
patch?: never;
|
|
3067
|
+
trace?: never;
|
|
3068
|
+
};
|
|
3069
|
+
"/api/v1/data-reports/{report_id}/columns": {
|
|
3070
|
+
parameters: {
|
|
3071
|
+
query?: never;
|
|
3072
|
+
header?: never;
|
|
3073
|
+
path?: never;
|
|
3074
|
+
cookie?: never;
|
|
3075
|
+
};
|
|
3076
|
+
get: operations["getDataReportColumns"];
|
|
3077
|
+
put?: never;
|
|
3078
|
+
post?: never;
|
|
3079
|
+
delete?: never;
|
|
3080
|
+
options?: never;
|
|
3081
|
+
head?: never;
|
|
3082
|
+
patch?: never;
|
|
3083
|
+
trace?: never;
|
|
3084
|
+
};
|
|
3085
|
+
"/api/v1/data-reports/{report_id}/data": {
|
|
3086
|
+
parameters: {
|
|
3087
|
+
query?: never;
|
|
3088
|
+
header?: never;
|
|
3089
|
+
path?: never;
|
|
3090
|
+
cookie?: never;
|
|
3091
|
+
};
|
|
3092
|
+
get: operations["getDataReportData"];
|
|
3093
|
+
put?: never;
|
|
3094
|
+
post?: never;
|
|
3095
|
+
delete?: never;
|
|
3096
|
+
options?: never;
|
|
3097
|
+
head?: never;
|
|
3098
|
+
patch?: never;
|
|
3099
|
+
trace?: never;
|
|
3100
|
+
};
|
|
3101
|
+
"/api/v1/data-reports/{report_id}/count": {
|
|
3102
|
+
parameters: {
|
|
3103
|
+
query?: never;
|
|
3104
|
+
header?: never;
|
|
3105
|
+
path?: never;
|
|
3106
|
+
cookie?: never;
|
|
3107
|
+
};
|
|
3108
|
+
get: operations["getDataReportRowCount"];
|
|
3109
|
+
put?: never;
|
|
3110
|
+
post?: never;
|
|
3111
|
+
delete?: never;
|
|
3112
|
+
options?: never;
|
|
3113
|
+
head?: never;
|
|
3114
|
+
patch?: never;
|
|
3115
|
+
trace?: never;
|
|
3116
|
+
};
|
|
3117
|
+
"/api/v1/data-reports/{report_id}": {
|
|
3118
|
+
parameters: {
|
|
3119
|
+
query?: never;
|
|
3120
|
+
header?: never;
|
|
3121
|
+
path?: never;
|
|
3122
|
+
cookie?: never;
|
|
3123
|
+
};
|
|
3124
|
+
get: operations["getDataReport"];
|
|
3125
|
+
put?: never;
|
|
3126
|
+
post?: never;
|
|
3127
|
+
delete?: never;
|
|
3128
|
+
options?: never;
|
|
3129
|
+
head?: never;
|
|
3130
|
+
patch?: never;
|
|
3131
|
+
trace?: never;
|
|
3132
|
+
};
|
|
3133
|
+
"/api/v1/flows": {
|
|
3134
|
+
parameters: {
|
|
3135
|
+
query?: never;
|
|
3136
|
+
header?: never;
|
|
3137
|
+
path?: never;
|
|
3138
|
+
cookie?: never;
|
|
3139
|
+
};
|
|
3140
|
+
get?: never;
|
|
3141
|
+
put?: never;
|
|
3142
|
+
post: operations["createFlow"];
|
|
3143
|
+
delete?: never;
|
|
3144
|
+
options?: never;
|
|
3145
|
+
head?: never;
|
|
3146
|
+
patch?: never;
|
|
3147
|
+
trace?: never;
|
|
3148
|
+
};
|
|
3149
|
+
"/api/v1/chat/{flowId}/timeline": {
|
|
3150
|
+
parameters: {
|
|
3151
|
+
query?: never;
|
|
3152
|
+
header?: never;
|
|
3153
|
+
path?: never;
|
|
3154
|
+
cookie?: never;
|
|
3155
|
+
};
|
|
3156
|
+
get: operations["retrieveChatTimeline"];
|
|
3157
|
+
put?: never;
|
|
3158
|
+
post?: never;
|
|
3159
|
+
delete?: never;
|
|
3160
|
+
options?: never;
|
|
3161
|
+
head?: never;
|
|
3162
|
+
patch?: never;
|
|
3163
|
+
trace?: never;
|
|
3164
|
+
};
|
|
3165
|
+
"/api/v1/chat/{flowId}/messages": {
|
|
3166
|
+
parameters: {
|
|
3167
|
+
query?: never;
|
|
3168
|
+
header?: never;
|
|
3169
|
+
path?: never;
|
|
3170
|
+
cookie?: never;
|
|
3171
|
+
};
|
|
3172
|
+
get: operations["retrieveChatMessages"];
|
|
3173
|
+
put?: never;
|
|
3174
|
+
post?: never;
|
|
3175
|
+
delete?: never;
|
|
3176
|
+
options?: never;
|
|
3177
|
+
head?: never;
|
|
3178
|
+
patch?: never;
|
|
3179
|
+
trace?: never;
|
|
3180
|
+
};
|
|
3181
|
+
"/api/v1/recommendations": {
|
|
3182
|
+
parameters: {
|
|
3183
|
+
query?: never;
|
|
3184
|
+
header?: never;
|
|
3185
|
+
path?: never;
|
|
3186
|
+
cookie?: never;
|
|
3187
|
+
};
|
|
3188
|
+
get: operations["getStarterRecommendations"];
|
|
3189
|
+
put?: never;
|
|
3190
|
+
post?: never;
|
|
3191
|
+
delete?: never;
|
|
3192
|
+
options?: never;
|
|
3193
|
+
head?: never;
|
|
3194
|
+
patch?: never;
|
|
3195
|
+
trace?: never;
|
|
3196
|
+
};
|
|
3197
|
+
"/api/v1/visualizations/{visualization_id}": {
|
|
3198
|
+
parameters: {
|
|
3199
|
+
query?: never;
|
|
3200
|
+
header?: never;
|
|
3201
|
+
path?: never;
|
|
3202
|
+
cookie?: never;
|
|
3203
|
+
};
|
|
3204
|
+
get: operations["fetchVisualization"];
|
|
3205
|
+
put?: never;
|
|
3206
|
+
post?: never;
|
|
3207
|
+
delete?: never;
|
|
3208
|
+
options?: never;
|
|
3209
|
+
head?: never;
|
|
3210
|
+
patch?: never;
|
|
3211
|
+
trace?: never;
|
|
3212
|
+
};
|
|
3213
|
+
"/api/v1/flows/{flowId}/visualizations": {
|
|
3214
|
+
parameters: {
|
|
3215
|
+
query?: never;
|
|
3216
|
+
header?: never;
|
|
3217
|
+
path?: never;
|
|
3218
|
+
cookie?: never;
|
|
3219
|
+
};
|
|
3220
|
+
get: operations["listVisualizationsForFlow"];
|
|
3221
|
+
put?: never;
|
|
3222
|
+
post?: never;
|
|
3223
|
+
delete?: never;
|
|
3224
|
+
options?: never;
|
|
3225
|
+
head?: never;
|
|
3226
|
+
patch?: never;
|
|
3227
|
+
trace?: never;
|
|
3228
|
+
};
|
|
3229
|
+
"/api/v1/trigger-flow/": {
|
|
3230
|
+
parameters: {
|
|
3231
|
+
query?: never;
|
|
3232
|
+
header?: never;
|
|
3233
|
+
path?: never;
|
|
3234
|
+
cookie?: never;
|
|
3235
|
+
};
|
|
3236
|
+
get?: never;
|
|
3237
|
+
put?: never;
|
|
3238
|
+
post: operations["triggerFlow"];
|
|
3239
|
+
delete?: never;
|
|
3240
|
+
options?: never;
|
|
3241
|
+
head?: never;
|
|
3242
|
+
patch?: never;
|
|
3243
|
+
trace?: never;
|
|
3244
|
+
};
|
|
3245
|
+
"/api/v1/dashboard/{dashboard_id}": {
|
|
3246
|
+
parameters: {
|
|
3247
|
+
query?: never;
|
|
3248
|
+
header?: never;
|
|
3249
|
+
path?: never;
|
|
3250
|
+
cookie?: never;
|
|
3251
|
+
};
|
|
3252
|
+
get: operations["retrieveDashboard"];
|
|
3253
|
+
put?: never;
|
|
3254
|
+
post?: never;
|
|
3255
|
+
delete?: never;
|
|
3256
|
+
options?: never;
|
|
3257
|
+
head?: never;
|
|
3258
|
+
patch?: never;
|
|
3259
|
+
trace?: never;
|
|
3260
|
+
};
|
|
3261
|
+
"/api/v1/contextual-insights/generate-insight": {
|
|
3262
|
+
parameters: {
|
|
3263
|
+
query?: never;
|
|
3264
|
+
header?: never;
|
|
3265
|
+
path?: never;
|
|
3266
|
+
cookie?: never;
|
|
3267
|
+
};
|
|
3268
|
+
get?: never;
|
|
3269
|
+
put?: never;
|
|
3270
|
+
post: operations["generateInsight"];
|
|
3271
|
+
delete?: never;
|
|
3272
|
+
options?: never;
|
|
3273
|
+
head?: never;
|
|
3274
|
+
patch?: never;
|
|
3275
|
+
trace?: never;
|
|
3276
|
+
};
|
|
3277
|
+
"/api/v1/admin-console/query-examples": {
|
|
3278
|
+
parameters: {
|
|
3279
|
+
query?: never;
|
|
3280
|
+
header?: never;
|
|
3281
|
+
path?: never;
|
|
3282
|
+
cookie?: never;
|
|
3283
|
+
};
|
|
3284
|
+
get?: never;
|
|
3285
|
+
put?: never;
|
|
3286
|
+
post: operations["createQueryExample"];
|
|
3287
|
+
delete?: never;
|
|
3288
|
+
options?: never;
|
|
3289
|
+
head?: never;
|
|
3290
|
+
patch?: never;
|
|
3291
|
+
trace?: never;
|
|
3292
|
+
};
|
|
3293
|
+
"/api/v1/admin-console/query-examples/{id}": {
|
|
3294
|
+
parameters: {
|
|
3295
|
+
query?: never;
|
|
3296
|
+
header?: never;
|
|
3297
|
+
path?: never;
|
|
3298
|
+
cookie?: never;
|
|
3299
|
+
};
|
|
3300
|
+
get?: never;
|
|
3301
|
+
put?: never;
|
|
3302
|
+
post?: never;
|
|
3303
|
+
delete?: never;
|
|
3304
|
+
options?: never;
|
|
3305
|
+
head?: never;
|
|
3306
|
+
patch: operations["updateQueryExample"];
|
|
3307
|
+
trace?: never;
|
|
3308
|
+
};
|
|
3309
|
+
"/api/v1/admin-console/sql/preview": {
|
|
3310
|
+
parameters: {
|
|
3311
|
+
query?: never;
|
|
3312
|
+
header?: never;
|
|
3313
|
+
path?: never;
|
|
3314
|
+
cookie?: never;
|
|
3315
|
+
};
|
|
3316
|
+
get?: never;
|
|
3317
|
+
put?: never;
|
|
3318
|
+
post: operations["sqlPreview"];
|
|
3319
|
+
delete?: never;
|
|
3320
|
+
options?: never;
|
|
3321
|
+
head?: never;
|
|
3322
|
+
patch?: never;
|
|
3323
|
+
trace?: never;
|
|
3324
|
+
};
|
|
3325
|
+
"/api/v1/admin-console/usage-insights/sankey": {
|
|
3326
|
+
parameters: {
|
|
3327
|
+
query?: never;
|
|
3328
|
+
header?: never;
|
|
3329
|
+
path?: never;
|
|
3330
|
+
cookie?: never;
|
|
3331
|
+
};
|
|
3332
|
+
get: operations["getSankeyData"];
|
|
3333
|
+
put?: never;
|
|
3334
|
+
post?: never;
|
|
3335
|
+
delete?: never;
|
|
3336
|
+
options?: never;
|
|
3337
|
+
head?: never;
|
|
3338
|
+
patch?: never;
|
|
3339
|
+
trace?: never;
|
|
3340
|
+
};
|
|
3341
|
+
"/api/v1/admin-console/contextual-insights/generate-template": {
|
|
3342
|
+
parameters: {
|
|
3343
|
+
query?: never;
|
|
3344
|
+
header?: never;
|
|
3345
|
+
path?: never;
|
|
3346
|
+
cookie?: never;
|
|
3347
|
+
};
|
|
3348
|
+
get?: never;
|
|
3349
|
+
put?: never;
|
|
3350
|
+
post: operations["generateInsightTemplate"];
|
|
3351
|
+
delete?: never;
|
|
3352
|
+
options?: never;
|
|
3353
|
+
head?: never;
|
|
3354
|
+
patch?: never;
|
|
3355
|
+
trace?: never;
|
|
3356
|
+
};
|
|
3357
|
+
"/api/v1/admin-console/contextual-insights/preview/{report_id}/data": {
|
|
3358
|
+
parameters: {
|
|
3359
|
+
query?: never;
|
|
3360
|
+
header?: never;
|
|
3361
|
+
path?: never;
|
|
3362
|
+
cookie?: never;
|
|
3363
|
+
};
|
|
3364
|
+
get: operations["getContextualInsightPreviewData"];
|
|
3365
|
+
put?: never;
|
|
3366
|
+
post?: never;
|
|
3367
|
+
delete?: never;
|
|
3368
|
+
options?: never;
|
|
3369
|
+
head?: never;
|
|
3370
|
+
patch?: never;
|
|
3371
|
+
trace?: never;
|
|
3372
|
+
};
|
|
3373
|
+
"/api/v1/admin-console/contextual-insights/preview/{report_id}/sample-values": {
|
|
3374
|
+
parameters: {
|
|
3375
|
+
query?: never;
|
|
3376
|
+
header?: never;
|
|
3377
|
+
path?: never;
|
|
3378
|
+
cookie?: never;
|
|
3379
|
+
};
|
|
3380
|
+
get: operations["getContextualInsightColumnSampleValues"];
|
|
3381
|
+
put?: never;
|
|
3382
|
+
post?: never;
|
|
3383
|
+
delete?: never;
|
|
3384
|
+
options?: never;
|
|
3385
|
+
head?: never;
|
|
3386
|
+
patch?: never;
|
|
3387
|
+
trace?: never;
|
|
3388
|
+
};
|
|
3389
|
+
"/api/v1/admin-console/contextual-insights/extract-insight": {
|
|
3390
|
+
parameters: {
|
|
3391
|
+
query?: never;
|
|
3392
|
+
header?: never;
|
|
3393
|
+
path?: never;
|
|
3394
|
+
cookie?: never;
|
|
3395
|
+
};
|
|
3396
|
+
get?: never;
|
|
3397
|
+
put?: never;
|
|
3398
|
+
post: operations["extractInsight"];
|
|
3399
|
+
delete?: never;
|
|
3400
|
+
options?: never;
|
|
3401
|
+
head?: never;
|
|
3402
|
+
patch?: never;
|
|
3403
|
+
trace?: never;
|
|
3404
|
+
};
|
|
3405
|
+
"/api/v1/admin-console/contextual-insights/suggest-filter-column": {
|
|
3406
|
+
parameters: {
|
|
3407
|
+
query?: never;
|
|
3408
|
+
header?: never;
|
|
3409
|
+
path?: never;
|
|
3410
|
+
cookie?: never;
|
|
3411
|
+
};
|
|
3412
|
+
get?: never;
|
|
3413
|
+
put?: never;
|
|
3414
|
+
post: operations["suggestFilterColumn"];
|
|
3415
|
+
delete?: never;
|
|
3416
|
+
options?: never;
|
|
3417
|
+
head?: never;
|
|
3418
|
+
patch?: never;
|
|
3419
|
+
trace?: never;
|
|
3420
|
+
};
|
|
3421
|
+
}
|
|
3422
|
+
|
|
3423
|
+
declare type RemoveAuthHeader<PathSchema> = Simplify<{
|
|
3424
|
+
[Method in keyof PathSchema]: RemoveParams<PathSchema[Method], ToRemove>;
|
|
3425
|
+
}>;
|
|
3426
|
+
|
|
3427
|
+
declare type RemoveParams<MethodSchema, Config extends RemoveParamsConfig> = Simplify<MethodSchema extends {
|
|
3428
|
+
parameters: infer P;
|
|
3429
|
+
} ? Omit<MethodSchema, "parameters"> & {
|
|
3430
|
+
parameters: {
|
|
3431
|
+
header?: PatchParam<P, Config, "header">;
|
|
3432
|
+
query?: PatchParam<P, Config, "query">;
|
|
3433
|
+
path?: PatchParam<P, Config, "path">;
|
|
3434
|
+
cookie?: PatchParam<P, Config, "cookie">;
|
|
3435
|
+
};
|
|
3436
|
+
} : MethodSchema>;
|
|
3437
|
+
|
|
3438
|
+
declare type RemoveParamsConfig = Simplify<{
|
|
3439
|
+
header?: string;
|
|
3440
|
+
query?: string;
|
|
3441
|
+
path?: string;
|
|
3442
|
+
cookie?: string;
|
|
3443
|
+
}>;
|
|
3444
|
+
|
|
3445
|
+
/**
|
|
3446
|
+
* Parameters for starting a flow
|
|
3447
|
+
*/
|
|
3448
|
+
export declare type StartFlowParam = {
|
|
3449
|
+
query: string;
|
|
3450
|
+
} | {
|
|
3451
|
+
triggerId: string;
|
|
3452
|
+
variables: Record<string, string>;
|
|
3453
|
+
};
|
|
3454
|
+
|
|
3455
|
+
/**
|
|
3456
|
+
* Token storage keys
|
|
3457
|
+
*/
|
|
3458
|
+
export declare const TOKEN_STORAGE_KEY = "mm-ai-sp-token";
|
|
3459
|
+
|
|
3460
|
+
declare type ToRemove = Simplify<{
|
|
3461
|
+
header: "sp-access-token";
|
|
3462
|
+
}>;
|
|
3463
|
+
|
|
3464
|
+
export { }
|