@magemetrics/core 0.1.8 → 0.3.0

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 CHANGED
@@ -86,6 +86,16 @@ export declare interface ColumnSort {
86
86
 
87
87
  declare interface components {
88
88
  schemas: {
89
+ ReportColumns: {
90
+ name: string;
91
+ data_type: string;
92
+ dataType: string;
93
+ renderType?: string;
94
+ unit?: string;
95
+ }[];
96
+ /** Format: uuid */
97
+ CanvasId: string;
98
+ ReportData: Record<string, unknown>[];
89
99
  VisualizationData: {
90
100
  [key: string]: string | (number | null) | unknown | null;
91
101
  }[];
@@ -199,16 +209,6 @@ declare interface components {
199
209
  sampledCount: number;
200
210
  };
201
211
  };
202
- /** Format: uuid */
203
- DashboardId: string;
204
- ReportColumns: {
205
- name: string;
206
- data_type: string;
207
- dataType: string;
208
- renderType?: string;
209
- unit?: string;
210
- }[];
211
- ReportData: Record<string, unknown>[];
212
212
  /** @description Starter recommendations */
213
213
  StarterRecommendation: {
214
214
  starter: string;
@@ -223,6 +223,34 @@ declare interface components {
223
223
  pathItems: never;
224
224
  }
225
225
 
226
+ declare type CreateCanvas = z.infer<typeof CreateCanvasSchema>;
227
+
228
+ declare const CreateCanvasSchema: z.ZodObject<Omit<{
229
+ company_id: z.ZodNumber;
230
+ created_at: z.ZodString;
231
+ id: z.ZodString;
232
+ title: z.ZodNullable<z.ZodString>;
233
+ updated_at: z.ZodString;
234
+ is_removed: z.ZodBoolean;
235
+ is_public: z.ZodBoolean;
236
+ nodes: z.ZodArray<z.ZodAny, "many">;
237
+ edges: z.ZodArray<z.ZodAny, "many">;
238
+ }, "id" | "company_id" | "created_at" | "updated_at" | "is_removed"> & {
239
+ flow_id: z.ZodOptional<z.ZodString>;
240
+ }, "strip", z.ZodTypeAny, {
241
+ title: string | null;
242
+ nodes: any[];
243
+ edges: any[];
244
+ is_public: boolean;
245
+ flow_id?: string | undefined;
246
+ }, {
247
+ title: string | null;
248
+ nodes: any[];
249
+ edges: any[];
250
+ is_public: boolean;
251
+ flow_id?: string | undefined;
252
+ }>;
253
+
226
254
  /**
227
255
  * Parameters for starting a flow
228
256
  */
@@ -257,107 +285,6 @@ declare const ExtractInsightResponseSchema: z.ZodUnion<[z.ZodObject<{
257
285
  type: "missing";
258
286
  }>]>;
259
287
 
260
- declare type FrontendDashboard = z.infer<typeof FrontendDashboardSchema>;
261
-
262
- declare const FrontendDashboardSchema: z.ZodObject<Omit<{
263
- company_id: z.ZodNumber;
264
- created_at: z.ZodString;
265
- description: z.ZodNullable<z.ZodString>;
266
- id: z.ZodString;
267
- name: z.ZodString;
268
- positions: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
269
- type: z.ZodLiteral<"data-report">;
270
- flowId: z.ZodString;
271
- flowDataId: z.ZodNumber;
272
- title: z.ZodString;
273
- col: z.ZodNumber;
274
- colSpan: z.ZodNumber;
275
- rowSpan: z.ZodNumber;
276
- }, "strip", z.ZodTypeAny, {
277
- type: "data-report";
278
- title: string;
279
- flowDataId: number;
280
- flowId: string;
281
- col: number;
282
- colSpan: number;
283
- rowSpan: number;
284
- }, {
285
- type: "data-report";
286
- title: string;
287
- flowDataId: number;
288
- flowId: string;
289
- col: number;
290
- colSpan: number;
291
- rowSpan: number;
292
- }>, z.ZodObject<{
293
- type: z.ZodLiteral<"visualization">;
294
- visualizationId: z.ZodNumber;
295
- title: z.ZodString;
296
- col: z.ZodNumber;
297
- colSpan: z.ZodNumber;
298
- rowSpan: z.ZodNumber;
299
- }, "strip", z.ZodTypeAny, {
300
- type: "visualization";
301
- title: string;
302
- col: number;
303
- colSpan: number;
304
- rowSpan: number;
305
- visualizationId: number;
306
- }, {
307
- type: "visualization";
308
- title: string;
309
- col: number;
310
- colSpan: number;
311
- rowSpan: number;
312
- visualizationId: number;
313
- }>]>, "many">;
314
- updated_at: z.ZodString;
315
- is_removed: z.ZodBoolean;
316
- is_public: z.ZodBoolean;
317
- }, "created_at" | "is_removed" | "company_id" | "updated_at">, "strip", z.ZodTypeAny, {
318
- description: string | null;
319
- name: string;
320
- id: string;
321
- positions: ({
322
- type: "data-report";
323
- title: string;
324
- flowDataId: number;
325
- flowId: string;
326
- col: number;
327
- colSpan: number;
328
- rowSpan: number;
329
- } | {
330
- type: "visualization";
331
- title: string;
332
- col: number;
333
- colSpan: number;
334
- rowSpan: number;
335
- visualizationId: number;
336
- })[];
337
- is_public: boolean;
338
- }, {
339
- description: string | null;
340
- name: string;
341
- id: string;
342
- positions: ({
343
- type: "data-report";
344
- title: string;
345
- flowDataId: number;
346
- flowId: string;
347
- col: number;
348
- colSpan: number;
349
- rowSpan: number;
350
- } | {
351
- type: "visualization";
352
- title: string;
353
- col: number;
354
- colSpan: number;
355
- rowSpan: number;
356
- visualizationId: number;
357
- })[];
358
- is_public: boolean;
359
- }>;
360
-
361
288
  declare type FrontendRecentFlows = z.infer<typeof FrontendRecentFlowsSchema>;
362
289
 
363
290
  declare const FrontendRecentFlowsSchema: z.ZodObject<Omit<{
@@ -553,13 +480,112 @@ export declare class MageMetricsClient {
553
480
  * Public API methods that automatically wait for authentication
554
481
  */
555
482
  api: {
483
+ getFlowVisualizations: (flowId: string) => Promise<{
484
+ id: number;
485
+ flow_data_id: number;
486
+ created_at: string;
487
+ bookmarked: boolean;
488
+ configuration: {
489
+ type: "bar";
490
+ title: string;
491
+ config_version: 2;
492
+ xAxisLabel: string;
493
+ yAxisLabel: string;
494
+ categoryColumn: string;
495
+ secondaryCategoryColumn?: string;
496
+ valueColumn: string;
497
+ } | {
498
+ type: "line/area";
499
+ config_version: 2;
500
+ title: string;
501
+ xAxisColumn: string;
502
+ valueColumns: string[];
503
+ yAxisLabels: string[];
504
+ } | {
505
+ type: "line/area-categorical";
506
+ title: string;
507
+ config_version: 2;
508
+ valueColumn: string;
509
+ xAxisColumn: string;
510
+ xAxisLabel: string;
511
+ yAxisLabel: string;
512
+ categoryColumn: string;
513
+ } | {
514
+ type: "scatter";
515
+ title: string;
516
+ config_version: 2;
517
+ xAxisLabel: string;
518
+ yAxisLabel: string;
519
+ xAxisValueColumn: string;
520
+ yAxisValueColumn: string;
521
+ } | {
522
+ type: "pie";
523
+ title: string;
524
+ config_version: 2;
525
+ categoryColumn: string;
526
+ valueColumn: string;
527
+ };
528
+ }[]>;
529
+ getFlowDataReports: (flowId: string) => Promise<{
530
+ created_at: string;
531
+ flow_id: string;
532
+ id: number;
533
+ title: string;
534
+ request: string | null;
535
+ data_summary: {
536
+ columns: {
537
+ [key: string]: {
538
+ position?: number;
539
+ data_type: string;
540
+ null_count: number | null;
541
+ unique_count: number | null;
542
+ unique_percentage: number | null;
543
+ };
544
+ };
545
+ };
546
+ bookmarked: boolean;
547
+ status: string | null;
548
+ is_removed: boolean;
549
+ }[]>;
556
550
  getRecentFlows: (params?: {
557
551
  limit?: number;
558
552
  }) => Promise<FrontendRecentFlows[]>;
559
553
  createFlow: (request: CreateFlowParam) => Promise<{
560
554
  flowId: string;
561
555
  }>;
562
- getDashboard: (dashboardId: string) => Promise<FrontendDashboard>;
556
+ canvas: {
557
+ list: (query?: string) => Promise<{
558
+ id: string;
559
+ title: string | null;
560
+ is_public: boolean;
561
+ nodes: any[];
562
+ edges: any[];
563
+ canvas_flows: {
564
+ flow_id: string;
565
+ }[];
566
+ }[]>;
567
+ get: (canvasId: string) => Promise<{
568
+ title: string | null;
569
+ id: string;
570
+ nodes: any[];
571
+ edges: any[];
572
+ is_public: boolean;
573
+ }>;
574
+ create: (body: CreateCanvas) => Promise<{
575
+ id: string;
576
+ }>;
577
+ update: (body: z.infer<typeof UpdateCanvasSchema>) => Promise<{
578
+ success: true;
579
+ }>;
580
+ delete: (canvasId: string) => Promise<void>;
581
+ getForFlow: (flowId: string) => Promise<{
582
+ title: string | null;
583
+ id: string;
584
+ nodes: any[];
585
+ edges: any[];
586
+ is_public: boolean;
587
+ }>;
588
+ };
563
589
  exportReportData: (reportId: number, format?: "text" | "blob") => Promise<{
564
590
  filename: string;
565
591
  data: Blob | string;
@@ -773,39 +799,28 @@ declare interface operations {
773
799
  };
774
800
  };
775
801
  };
776
- PublicDashboardFetchVisualization: {
802
+ getPublicCanvasDataReportColumns: {
777
803
  parameters: {
778
804
  query?: never;
779
805
  header?: never;
780
806
  path: {
781
- visualization_id: string;
782
- dashboard_id: string;
807
+ report_id: string;
808
+ canvas_id: components["schemas"]["CanvasId"];
783
809
  };
784
810
  cookie?: never;
785
811
  };
786
812
  requestBody?: never;
787
813
  responses: {
788
- /** @description The content of the visualization */
814
+ /** @description A list containing the columns of the report */
789
815
  200: {
790
816
  headers: {
791
817
  [name: string]: unknown;
792
818
  };
793
819
  content: {
794
- "application/json": components["schemas"]["VisualizationWithData"];
795
- };
796
- };
797
- /** @description Invalid arguments to fetch visualization */
798
- 400: {
799
- headers: {
800
- [name: string]: unknown;
801
- };
802
- content: {
803
- "application/json": {
804
- error: string;
805
- };
820
+ "application/json": components["schemas"]["ReportColumns"];
806
821
  };
807
822
  };
808
- /** @description Unable to fetch visualization with this id */
823
+ /** @description Unable to retrieve report with this id */
809
824
  404: {
810
825
  headers: {
811
826
  [name: string]: unknown;
@@ -829,51 +844,35 @@ declare interface operations {
829
844
  };
830
845
  };
831
846
  };
832
- retrievePublicDashboard: {
847
+ getPublicCanvasDataReportData: {
833
848
  parameters: {
834
- query?: never;
849
+ query?: {
850
+ limit?: number;
851
+ /** @example name:asc,date:desc */
852
+ order?: string;
853
+ cursor?: number;
854
+ /** @example status:active,name:John%20Doe */
855
+ filter?: string;
856
+ };
835
857
  header?: never;
836
858
  path: {
837
- dashboard_id: components["schemas"]["DashboardId"];
859
+ report_id: string;
860
+ canvas_id: components["schemas"]["CanvasId"];
838
861
  };
839
862
  cookie?: never;
840
863
  };
841
864
  requestBody?: never;
842
865
  responses: {
843
- /** @description The dashboard with the given id */
866
+ /** @description The content of the report */
844
867
  200: {
845
868
  headers: {
846
869
  [name: string]: unknown;
847
870
  };
848
871
  content: {
849
- "application/json": {
850
- description: string | null;
851
- /** Format: uuid */
852
- id: string;
853
- name: string;
854
- positions: ({
855
- /** @enum {string} */
856
- type: "data-report";
857
- flowId: string;
858
- flowDataId: number;
859
- title: string;
860
- col: number;
861
- colSpan: number;
862
- rowSpan: number;
863
- } | {
864
- /** @enum {string} */
865
- type: "visualization";
866
- visualizationId: number;
867
- title: string;
868
- col: number;
869
- colSpan: number;
870
- rowSpan: number;
871
- })[];
872
- is_public: boolean;
873
- };
872
+ "application/json": components["schemas"]["ReportData"];
874
873
  };
875
874
  };
876
- /** @description Unable to retrieve dashboard with this id */
875
+ /** @description Unable to retrieve report with this id */
877
876
  404: {
878
877
  headers: {
879
878
  [name: string]: unknown;
@@ -897,25 +896,28 @@ declare interface operations {
897
896
  };
898
897
  };
899
898
  };
900
- getPublicDataReportColumns: {
899
+ getPublicCanvasDataReportRowCount: {
901
900
  parameters: {
902
901
  query?: never;
903
902
  header?: never;
904
903
  path: {
905
904
  report_id: string;
906
- dashboard_id: components["schemas"]["DashboardId"];
905
+ canvas_id: components["schemas"]["CanvasId"];
907
906
  };
908
907
  cookie?: never;
909
908
  };
910
909
  requestBody?: never;
911
910
  responses: {
912
- /** @description A list containing the columns of the report */
911
+ /** @description The total count of rows in the report */
913
912
  200: {
914
913
  headers: {
915
914
  [name: string]: unknown;
916
915
  };
917
916
  content: {
918
- "application/json": components["schemas"]["ReportColumns"];
917
+ "application/json": {
918
+ /** @description Total number of rows in the report */
919
+ count: number;
920
+ };
919
921
  };
920
922
  };
921
923
  /** @description Unable to retrieve report with this id */
@@ -942,35 +944,34 @@ declare interface operations {
942
944
  };
943
945
  };
944
946
  };
945
- getPublicDataReportData: {
947
+ retrievePublicCanvas: {
946
948
  parameters: {
947
- query?: {
948
- limit?: number;
949
- /** @example name:asc,date:desc */
950
- order?: string;
951
- cursor?: number;
952
- /** @example status:active,name:John%20Doe */
953
- filter?: string;
954
- };
949
+ query?: never;
955
950
  header?: never;
956
951
  path: {
957
- report_id: string;
958
- dashboard_id: components["schemas"]["DashboardId"];
952
+ canvas_id: components["schemas"]["CanvasId"];
959
953
  };
960
954
  cookie?: never;
961
955
  };
962
956
  requestBody?: never;
963
957
  responses: {
964
- /** @description The content of the report */
958
+ /** @description The canvas with the given id */
965
959
  200: {
966
960
  headers: {
967
961
  [name: string]: unknown;
968
962
  };
969
963
  content: {
970
- "application/json": components["schemas"]["ReportData"];
964
+ "application/json": {
965
+ /** Format: uuid */
966
+ id: string;
967
+ title: string | null;
968
+ is_public: boolean;
969
+ nodes: unknown[];
970
+ edges: unknown[];
971
+ };
971
972
  };
972
973
  };
973
- /** @description Unable to retrieve report with this id */
974
+ /** @description Unable to retrieve canvas with this id */
974
975
  404: {
975
976
  headers: {
976
977
  [name: string]: unknown;
@@ -994,31 +995,39 @@ declare interface operations {
994
995
  };
995
996
  };
996
997
  };
997
- getPublicDataReportRowCount: {
998
+ PublicCanvasFetchVisualization: {
998
999
  parameters: {
999
1000
  query?: never;
1000
1001
  header?: never;
1001
1002
  path: {
1002
- report_id: string;
1003
- dashboard_id: components["schemas"]["DashboardId"];
1003
+ visualization_id: string;
1004
+ canvas_id: components["schemas"]["CanvasId"];
1004
1005
  };
1005
1006
  cookie?: never;
1006
1007
  };
1007
1008
  requestBody?: never;
1008
1009
  responses: {
1009
- /** @description The total count of rows in the report */
1010
+ /** @description The content of the visualization */
1010
1011
  200: {
1012
+ headers: {
1013
+ [name: string]: unknown;
1014
+ };
1015
+ content: {
1016
+ "application/json": components["schemas"]["VisualizationWithData"];
1017
+ };
1018
+ };
1019
+ /** @description Invalid arguments to fetch visualization */
1020
+ 400: {
1011
1021
  headers: {
1012
1022
  [name: string]: unknown;
1013
1023
  };
1014
1024
  content: {
1015
1025
  "application/json": {
1016
- /** @description Total number of rows in the report */
1017
- count: number;
1026
+ error: string;
1018
1027
  };
1019
1028
  };
1020
1029
  };
1021
- /** @description Unable to retrieve report with this id */
1030
+ /** @description Unable to fetch visualization with this id */
1022
1031
  404: {
1023
1032
  headers: {
1024
1033
  [name: string]: unknown;
@@ -1216,6 +1225,7 @@ declare interface operations {
1216
1225
  };
1217
1226
  bookmarked: boolean;
1218
1227
  status: string | null;
1228
+ is_removed: boolean;
1219
1229
  }[];
1220
1230
  };
1221
1231
  };
@@ -1856,6 +1866,7 @@ declare interface operations {
1856
1866
  };
1857
1867
  bookmarked: boolean;
1858
1868
  status: string | null;
1869
+ is_removed: boolean;
1859
1870
  };
1860
1871
  };
1861
1872
  };
@@ -2255,53 +2266,292 @@ declare interface operations {
2255
2266
  };
2256
2267
  };
2257
2268
  };
2258
- retrieveDashboard: {
2269
+ retrieveCanvas: {
2259
2270
  parameters: {
2260
2271
  query?: never;
2261
2272
  header: {
2262
2273
  "sp-access-token": string;
2263
2274
  };
2264
2275
  path: {
2265
- dashboard_id: components["schemas"]["DashboardId"];
2276
+ canvas_id: components["schemas"]["CanvasId"];
2266
2277
  };
2267
2278
  cookie?: never;
2268
2279
  };
2269
2280
  requestBody?: never;
2270
2281
  responses: {
2271
- /** @description The dashboard with the given id */
2282
+ /** @description The canvas with the given id */
2272
2283
  200: {
2273
2284
  headers: {
2274
2285
  [name: string]: unknown;
2275
2286
  };
2276
2287
  content: {
2277
2288
  "application/json": {
2278
- description: string | null;
2279
2289
  /** Format: uuid */
2280
2290
  id: string;
2281
- name: string;
2282
- positions: ({
2283
- /** @enum {string} */
2284
- type: "data-report";
2285
- flowId: string;
2286
- flowDataId: number;
2287
- title: string;
2288
- col: number;
2289
- colSpan: number;
2290
- rowSpan: number;
2291
- } | {
2292
- /** @enum {string} */
2293
- type: "visualization";
2294
- visualizationId: number;
2295
- title: string;
2296
- col: number;
2297
- colSpan: number;
2298
- rowSpan: number;
2299
- })[];
2291
+ title: string | null;
2292
+ is_public: boolean;
2293
+ nodes: unknown[];
2294
+ edges: unknown[];
2295
+ };
2296
+ };
2297
+ };
2298
+ /** @description Unable to retrieve canvas with this id */
2299
+ 404: {
2300
+ headers: {
2301
+ [name: string]: unknown;
2302
+ };
2303
+ content: {
2304
+ "application/json": {
2305
+ error: string;
2306
+ };
2307
+ };
2308
+ };
2309
+ /** @description Something wrong happened */
2310
+ 500: {
2311
+ headers: {
2312
+ [name: string]: unknown;
2313
+ };
2314
+ content: {
2315
+ "application/json": {
2316
+ error: string;
2317
+ };
2318
+ };
2319
+ };
2320
+ };
2321
+ };
2322
+ updateCanvas: {
2323
+ parameters: {
2324
+ query?: never;
2325
+ header: {
2326
+ "sp-access-token": string;
2327
+ };
2328
+ path: {
2329
+ canvas_id: components["schemas"]["CanvasId"];
2330
+ };
2331
+ cookie?: never;
2332
+ };
2333
+ requestBody: {
2334
+ content: {
2335
+ "application/json": {
2336
+ title?: string | null;
2337
+ nodes?: unknown[];
2338
+ edges?: unknown[];
2339
+ is_public?: boolean;
2340
+ };
2341
+ };
2342
+ };
2343
+ responses: {
2344
+ /** @description The updated canvas */
2345
+ 200: {
2346
+ headers: {
2347
+ [name: string]: unknown;
2348
+ };
2349
+ content: {
2350
+ "application/json": {
2351
+ /** @enum {boolean} */
2352
+ success: true;
2353
+ };
2354
+ };
2355
+ };
2356
+ /** @description Unable to retrieve canvas with this id */
2357
+ 404: {
2358
+ headers: {
2359
+ [name: string]: unknown;
2360
+ };
2361
+ content: {
2362
+ "application/json": {
2363
+ error: string;
2364
+ };
2365
+ };
2366
+ };
2367
+ /** @description Something wrong happened */
2368
+ 500: {
2369
+ headers: {
2370
+ [name: string]: unknown;
2371
+ };
2372
+ content: {
2373
+ "application/json": {
2374
+ error: string;
2375
+ };
2376
+ };
2377
+ };
2378
+ };
2379
+ };
2380
+ deleteCanvas: {
2381
+ parameters: {
2382
+ query?: never;
2383
+ header: {
2384
+ "sp-access-token": string;
2385
+ };
2386
+ path: {
2387
+ canvas_id: components["schemas"]["CanvasId"];
2388
+ };
2389
+ cookie?: never;
2390
+ };
2391
+ requestBody?: never;
2392
+ responses: {
2393
+ /** @description Canvas deleted successfully */
2394
+ 204: {
2395
+ headers: {
2396
+ [name: string]: unknown;
2397
+ };
2398
+ content?: never;
2399
+ };
2400
+ /** @description Unable to delete canvas with this id */
2401
+ 404: {
2402
+ headers: {
2403
+ [name: string]: unknown;
2404
+ };
2405
+ content: {
2406
+ "application/json": {
2407
+ error: string;
2408
+ };
2409
+ };
2410
+ };
2411
+ /** @description Something wrong happened */
2412
+ 500: {
2413
+ headers: {
2414
+ [name: string]: unknown;
2415
+ };
2416
+ content: {
2417
+ "application/json": {
2418
+ error: string;
2419
+ };
2420
+ };
2421
+ };
2422
+ };
2423
+ };
2424
+ createCanvas: {
2425
+ parameters: {
2426
+ query?: never;
2427
+ header: {
2428
+ "sp-access-token": string;
2429
+ };
2430
+ path?: never;
2431
+ cookie?: never;
2432
+ };
2433
+ requestBody: {
2434
+ content: {
2435
+ "application/json": {
2436
+ title: string | null;
2437
+ is_public: boolean;
2438
+ nodes: unknown[];
2439
+ edges: unknown[];
2440
+ flow_id?: string;
2441
+ };
2442
+ };
2443
+ };
2444
+ responses: {
2445
+ /** @description The created canvas */
2446
+ 201: {
2447
+ headers: {
2448
+ [name: string]: unknown;
2449
+ };
2450
+ content: {
2451
+ "application/json": {
2452
+ id: string;
2453
+ };
2454
+ };
2455
+ };
2456
+ /** @description Invalid request */
2457
+ 400: {
2458
+ headers: {
2459
+ [name: string]: unknown;
2460
+ };
2461
+ content: {
2462
+ "application/json": {
2463
+ error: string;
2464
+ };
2465
+ };
2466
+ };
2467
+ /** @description Something wrong happened */
2468
+ 500: {
2469
+ headers: {
2470
+ [name: string]: unknown;
2471
+ };
2472
+ content: {
2473
+ "application/json": {
2474
+ error: string;
2475
+ };
2476
+ };
2477
+ };
2478
+ };
2479
+ };
2480
+ listCanvases: {
2481
+ parameters: {
2482
+ query?: {
2483
+ search?: string;
2484
+ };
2485
+ header: {
2486
+ "sp-access-token": string;
2487
+ };
2488
+ path?: never;
2489
+ cookie?: never;
2490
+ };
2491
+ requestBody?: never;
2492
+ responses: {
2493
+ /** @description A list of canvases */
2494
+ 200: {
2495
+ headers: {
2496
+ [name: string]: unknown;
2497
+ };
2498
+ content: {
2499
+ "application/json": {
2500
+ /** Format: uuid */
2501
+ id: string;
2502
+ title: string | null;
2503
+ is_public: boolean;
2504
+ nodes: unknown[];
2505
+ edges: unknown[];
2506
+ canvas_flows: {
2507
+ flow_id: string;
2508
+ }[];
2509
+ }[];
2510
+ };
2511
+ };
2512
+ /** @description Something wrong happened */
2513
+ 500: {
2514
+ headers: {
2515
+ [name: string]: unknown;
2516
+ };
2517
+ content: {
2518
+ "application/json": {
2519
+ error: string;
2520
+ };
2521
+ };
2522
+ };
2523
+ };
2524
+ };
2525
+ getCanvasForFlow: {
2526
+ parameters: {
2527
+ query?: never;
2528
+ header: {
2529
+ "sp-access-token": string;
2530
+ };
2531
+ path: {
2532
+ flow_id: string;
2533
+ };
2534
+ cookie?: never;
2535
+ };
2536
+ requestBody?: never;
2537
+ responses: {
2538
+ /** @description The canvas for the given flow */
2539
+ 200: {
2540
+ headers: {
2541
+ [name: string]: unknown;
2542
+ };
2543
+ content: {
2544
+ "application/json": {
2545
+ /** Format: uuid */
2546
+ id: string;
2547
+ title: string | null;
2300
2548
  is_public: boolean;
2549
+ nodes: unknown[];
2550
+ edges: unknown[];
2301
2551
  };
2302
2552
  };
2303
2553
  };
2304
- /** @description Unable to retrieve dashboard with this id */
2554
+ /** @description Unable to retrieve canvas for this flow */
2305
2555
  404: {
2306
2556
  headers: {
2307
2557
  [name: string]: unknown;
@@ -2596,6 +2846,8 @@ declare interface operations {
2596
2846
  /** @description JSON-encoded map of { [field_key]: string[] } to be passed to RPC */
2597
2847
  external_filters?: string;
2598
2848
  max_results?: number;
2849
+ /** @description If true, exclude users with @magemetrics emails from results */
2850
+ exclude_magemetrics_emails?: string;
2599
2851
  };
2600
2852
  header?: never;
2601
2853
  path?: never;
@@ -2977,14 +3229,14 @@ declare interface paths {
2977
3229
  patch?: never;
2978
3230
  trace?: never;
2979
3231
  };
2980
- "/api/v1/public/dashboards/{dashboard_id}/visualizations/{visualization_id}": {
3232
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/columns": {
2981
3233
  parameters: {
2982
3234
  query?: never;
2983
3235
  header?: never;
2984
3236
  path?: never;
2985
3237
  cookie?: never;
2986
3238
  };
2987
- get: operations["PublicDashboardFetchVisualization"];
3239
+ get: operations["getPublicCanvasDataReportColumns"];
2988
3240
  put?: never;
2989
3241
  post?: never;
2990
3242
  delete?: never;
@@ -2993,14 +3245,14 @@ declare interface paths {
2993
3245
  patch?: never;
2994
3246
  trace?: never;
2995
3247
  };
2996
- "/api/v1/public/dashboards/{dashboard_id}": {
3248
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/data": {
2997
3249
  parameters: {
2998
3250
  query?: never;
2999
3251
  header?: never;
3000
3252
  path?: never;
3001
3253
  cookie?: never;
3002
3254
  };
3003
- get: operations["retrievePublicDashboard"];
3255
+ get: operations["getPublicCanvasDataReportData"];
3004
3256
  put?: never;
3005
3257
  post?: never;
3006
3258
  delete?: never;
@@ -3009,14 +3261,14 @@ declare interface paths {
3009
3261
  patch?: never;
3010
3262
  trace?: never;
3011
3263
  };
3012
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/columns": {
3264
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/count": {
3013
3265
  parameters: {
3014
3266
  query?: never;
3015
3267
  header?: never;
3016
3268
  path?: never;
3017
3269
  cookie?: never;
3018
3270
  };
3019
- get: operations["getPublicDataReportColumns"];
3271
+ get: operations["getPublicCanvasDataReportRowCount"];
3020
3272
  put?: never;
3021
3273
  post?: never;
3022
3274
  delete?: never;
@@ -3025,14 +3277,14 @@ declare interface paths {
3025
3277
  patch?: never;
3026
3278
  trace?: never;
3027
3279
  };
3028
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/data": {
3280
+ "/api/v1/public/canvas/{canvas_id}": {
3029
3281
  parameters: {
3030
3282
  query?: never;
3031
3283
  header?: never;
3032
3284
  path?: never;
3033
3285
  cookie?: never;
3034
3286
  };
3035
- get: operations["getPublicDataReportData"];
3287
+ get: operations["retrievePublicCanvas"];
3036
3288
  put?: never;
3037
3289
  post?: never;
3038
3290
  delete?: never;
@@ -3041,14 +3293,14 @@ declare interface paths {
3041
3293
  patch?: never;
3042
3294
  trace?: never;
3043
3295
  };
3044
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/count": {
3296
+ "/api/v1/public/canvas/{canvas_id}/visualizations/{visualization_id}": {
3045
3297
  parameters: {
3046
3298
  query?: never;
3047
3299
  header?: never;
3048
3300
  path?: never;
3049
3301
  cookie?: never;
3050
3302
  };
3051
- get: operations["getPublicDataReportRowCount"];
3303
+ get: operations["PublicCanvasFetchVisualization"];
3052
3304
  put?: never;
3053
3305
  post?: never;
3054
3306
  delete?: never;
@@ -3377,14 +3629,62 @@ declare interface paths {
3377
3629
  patch?: never;
3378
3630
  trace?: never;
3379
3631
  };
3380
- "/api/v1/dashboard/{dashboard_id}": {
3632
+ "/api/v1/canvas/{canvas_id}": {
3633
+ parameters: {
3634
+ query?: never;
3635
+ header?: never;
3636
+ path?: never;
3637
+ cookie?: never;
3638
+ };
3639
+ get: operations["retrieveCanvas"];
3640
+ put: operations["updateCanvas"];
3641
+ post?: never;
3642
+ delete: operations["deleteCanvas"];
3643
+ options?: never;
3644
+ head?: never;
3645
+ patch?: never;
3646
+ trace?: never;
3647
+ };
3648
+ "/api/v1/canvas/": {
3649
+ parameters: {
3650
+ query?: never;
3651
+ header?: never;
3652
+ path?: never;
3653
+ cookie?: never;
3654
+ };
3655
+ get?: never;
3656
+ put?: never;
3657
+ post: operations["createCanvas"];
3658
+ delete?: never;
3659
+ options?: never;
3660
+ head?: never;
3661
+ patch?: never;
3662
+ trace?: never;
3663
+ };
3664
+ "/api/v1/canvases": {
3381
3665
  parameters: {
3382
3666
  query?: never;
3383
3667
  header?: never;
3384
3668
  path?: never;
3385
3669
  cookie?: never;
3386
3670
  };
3387
- get: operations["retrieveDashboard"];
3671
+ get: operations["listCanvases"];
3672
+ put?: never;
3673
+ post?: never;
3674
+ delete?: never;
3675
+ options?: never;
3676
+ head?: never;
3677
+ patch?: never;
3678
+ trace?: never;
3679
+ };
3680
+ "/api/v1/canvas/flow/{flow_id}": {
3681
+ parameters: {
3682
+ query?: never;
3683
+ header?: never;
3684
+ path?: never;
3685
+ cookie?: never;
3686
+ };
3687
+ get: operations["getCanvasForFlow"];
3388
3688
  put?: never;
3389
3689
  post?: never;
3390
3690
  delete?: never;
@@ -3755,13 +4055,9 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3755
4055
  private: z.ZodObject<{
3756
4056
  message: z.ZodOptional<z.ZodString>;
3757
4057
  columns: z.ZodArray<z.ZodObject<{
3758
- id: z.ZodNumber;
3759
4058
  name: z.ZodString;
3760
4059
  data_type: z.ZodNullable<z.ZodString>;
3761
4060
  description: z.ZodNullable<z.ZodString>;
3762
- null_percentage: z.ZodNullable<z.ZodNumber>;
3763
- unique_values: z.ZodNullable<z.ZodNumber>;
3764
- sample_values: z.ZodNullable<z.ZodArray<z.ZodAny, "many">>;
3765
4061
  table: z.ZodObject<{
3766
4062
  table_name: z.ZodString;
3767
4063
  description: z.ZodNullable<z.ZodString>;
@@ -3780,11 +4076,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3780
4076
  description: string | null;
3781
4077
  table_name: string;
3782
4078
  };
3783
- id: number;
3784
4079
  data_type: string | null;
3785
- null_percentage: number | null;
3786
- unique_values: number | null;
3787
- sample_values: any[] | null;
3788
4080
  matched_values: string[];
3789
4081
  }, {
3790
4082
  description: string | null;
@@ -3793,11 +4085,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3793
4085
  description: string | null;
3794
4086
  table_name: string;
3795
4087
  };
3796
- id: number;
3797
4088
  data_type: string | null;
3798
- null_percentage: number | null;
3799
- unique_values: number | null;
3800
- sample_values: any[] | null;
3801
4089
  matched_values: string[];
3802
4090
  }>, "many">;
3803
4091
  }, "strip", z.ZodTypeAny, {
@@ -3808,11 +4096,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3808
4096
  description: string | null;
3809
4097
  table_name: string;
3810
4098
  };
3811
- id: number;
3812
4099
  data_type: string | null;
3813
- null_percentage: number | null;
3814
- unique_values: number | null;
3815
- sample_values: any[] | null;
3816
4100
  matched_values: string[];
3817
4101
  }[];
3818
4102
  message?: string | undefined;
@@ -3824,11 +4108,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3824
4108
  description: string | null;
3825
4109
  table_name: string;
3826
4110
  };
3827
- id: number;
3828
4111
  data_type: string | null;
3829
- null_percentage: number | null;
3830
- unique_values: number | null;
3831
- sample_values: any[] | null;
3832
4112
  matched_values: string[];
3833
4113
  }[];
3834
4114
  message?: string | undefined;
@@ -3876,28 +4156,23 @@ declare const redactedOutputSchema_4: z.ZodObject<{
3876
4156
  public: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
3877
4157
  private: z.ZodObject<{
3878
4158
  tables: z.ZodArray<z.ZodObject<{
3879
- id: z.ZodNumber;
3880
4159
  table_name: z.ZodString;
3881
4160
  description: z.ZodNullable<z.ZodString>;
3882
4161
  }, "strip", z.ZodTypeAny, {
3883
4162
  description: string | null;
3884
- id: number;
3885
4163
  table_name: string;
3886
4164
  }, {
3887
4165
  description: string | null;
3888
- id: number;
3889
4166
  table_name: string;
3890
4167
  }>, "many">;
3891
4168
  }, "strip", z.ZodTypeAny, {
3892
4169
  tables: {
3893
4170
  description: string | null;
3894
- id: number;
3895
4171
  table_name: string;
3896
4172
  }[];
3897
4173
  }, {
3898
4174
  tables: {
3899
4175
  description: string | null;
3900
- id: number;
3901
4176
  table_name: string;
3902
4177
  }[];
3903
4178
  }>;
@@ -3945,7 +4220,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3945
4220
  private: z.ZodObject<{
3946
4221
  message: z.ZodOptional<z.ZodString>;
3947
4222
  columns: z.ZodArray<z.ZodObject<{
3948
- id: z.ZodNumber;
3949
4223
  name: z.ZodString;
3950
4224
  data_type: z.ZodNullable<z.ZodString>;
3951
4225
  description: z.ZodNullable<z.ZodString>;
@@ -3955,7 +4229,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3955
4229
  }, "strip", z.ZodTypeAny, {
3956
4230
  description: string | null;
3957
4231
  name: string;
3958
- id: number;
3959
4232
  data_type: string | null;
3960
4233
  null_percentage: number | null;
3961
4234
  unique_values: number | null;
@@ -3963,7 +4236,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3963
4236
  }, {
3964
4237
  description: string | null;
3965
4238
  name: string;
3966
- id: number;
3967
4239
  data_type: string | null;
3968
4240
  null_percentage: number | null;
3969
4241
  unique_values: number | null;
@@ -3973,7 +4245,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3973
4245
  columns: {
3974
4246
  description: string | null;
3975
4247
  name: string;
3976
- id: number;
3977
4248
  data_type: string | null;
3978
4249
  null_percentage: number | null;
3979
4250
  unique_values: number | null;
@@ -3984,7 +4255,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3984
4255
  columns: {
3985
4256
  description: string | null;
3986
4257
  name: string;
3987
- id: number;
3988
4258
  data_type: string | null;
3989
4259
  null_percentage: number | null;
3990
4260
  unique_values: number | null;
@@ -4040,28 +4310,28 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4040
4310
  title: z.ZodString;
4041
4311
  }, "strip", z.ZodTypeAny, {
4042
4312
  title: string;
4043
- id: string;
4044
4313
  sourceType: "url";
4045
4314
  url: string;
4315
+ id: string;
4046
4316
  }, {
4047
4317
  title: string;
4048
- id: string;
4049
4318
  sourceType: "url";
4050
4319
  url: string;
4320
+ id: string;
4051
4321
  }>, "many">>;
4052
4322
  }, "strip", z.ZodTypeAny, {
4053
4323
  sources?: {
4054
4324
  title: string;
4055
- id: string;
4056
4325
  sourceType: "url";
4057
4326
  url: string;
4327
+ id: string;
4058
4328
  }[] | undefined;
4059
4329
  }, {
4060
4330
  sources?: {
4061
4331
  title: string;
4062
- id: string;
4063
4332
  sourceType: "url";
4064
4333
  url: string;
4334
+ id: string;
4065
4335
  }[] | undefined;
4066
4336
  }>;
4067
4337
  private: z.ZodObject<{
@@ -4076,9 +4346,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4076
4346
  public: {
4077
4347
  sources?: {
4078
4348
  title: string;
4079
- id: string;
4080
4349
  sourceType: "url";
4081
4350
  url: string;
4351
+ id: string;
4082
4352
  }[] | undefined;
4083
4353
  };
4084
4354
  }, {
@@ -4086,9 +4356,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4086
4356
  public: {
4087
4357
  sources?: {
4088
4358
  title: string;
4089
- id: string;
4090
4359
  sourceType: "url";
4091
4360
  url: string;
4361
+ id: string;
4092
4362
  }[] | undefined;
4093
4363
  };
4094
4364
  }>, z.ZodObject<{
@@ -4108,9 +4378,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4108
4378
  public: {
4109
4379
  sources?: {
4110
4380
  title: string;
4111
- id: string;
4112
4381
  sourceType: "url";
4113
4382
  url: string;
4383
+ id: string;
4114
4384
  }[] | undefined;
4115
4385
  };
4116
4386
  } | {
@@ -4124,9 +4394,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4124
4394
  public: {
4125
4395
  sources?: {
4126
4396
  title: string;
4127
- id: string;
4128
4397
  sourceType: "url";
4129
4398
  url: string;
4399
+ id: string;
4130
4400
  }[] | undefined;
4131
4401
  };
4132
4402
  } | {
@@ -4241,4 +4511,24 @@ declare type UiTool_6 = InferUITool<Tool<z.infer<typeof inputSchema_6>, z.infer<
4241
4511
 
4242
4512
  declare type UiTool_7 = InferUITool<Tool<z.infer<typeof inputSchema_7>, z.infer<typeof redactedOutputSchema_6>>>;
4243
4513
 
4514
+ declare const UpdateCanvasSchema: z.ZodObject<{
4515
+ id: z.ZodString;
4516
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4517
+ nodes: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
4518
+ edges: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
4519
+ is_public: z.ZodOptional<z.ZodBoolean>;
4520
+ }, "strip", z.ZodTypeAny, {
4521
+ id: string;
4522
+ title?: string | null | undefined;
4523
+ nodes?: any[] | undefined;
4524
+ edges?: any[] | undefined;
4525
+ is_public?: boolean | undefined;
4526
+ }, {
4527
+ id: string;
4528
+ title?: string | null | undefined;
4529
+ nodes?: any[] | undefined;
4530
+ edges?: any[] | undefined;
4531
+ is_public?: boolean | undefined;
4532
+ }>;
4533
+
4244
4534
  export { }