@magemetrics/core 0.1.8 → 0.2.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,111 @@ 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
+ }[]>;
556
549
  getRecentFlows: (params?: {
557
550
  limit?: number;
558
551
  }) => Promise<FrontendRecentFlows[]>;
559
552
  createFlow: (request: CreateFlowParam) => Promise<{
560
553
  flowId: string;
561
554
  }>;
562
- getDashboard: (dashboardId: string) => Promise<FrontendDashboard>;
555
+ canvas: {
556
+ list: (query?: string) => Promise<{
557
+ id: string;
558
+ title: string | null;
559
+ is_public: boolean;
560
+ nodes: any[];
561
+ edges: any[];
562
+ canvas_flows: {
563
+ flow_id: string;
564
+ }[];
565
+ }[]>;
566
+ get: (canvasId: string) => Promise<{
567
+ title: string | null;
568
+ id: string;
569
+ nodes: any[];
570
+ edges: any[];
571
+ is_public: boolean;
572
+ }>;
573
+ create: (body: CreateCanvas) => Promise<{
574
+ id: string;
575
+ }>;
576
+ update: (body: z.infer<typeof UpdateCanvasSchema>) => Promise<{
577
+ success: true;
578
+ }>;
579
+ delete: (canvasId: string) => Promise<void>;
580
+ getForFlow: (flowId: string) => Promise<{
581
+ title: string | null;
582
+ id: string;
583
+ nodes: any[];
584
+ edges: any[];
585
+ is_public: boolean;
586
+ }>;
587
+ };
563
588
  exportReportData: (reportId: number, format?: "text" | "blob") => Promise<{
564
589
  filename: string;
565
590
  data: Blob | string;
@@ -773,39 +798,28 @@ declare interface operations {
773
798
  };
774
799
  };
775
800
  };
776
- PublicDashboardFetchVisualization: {
801
+ getPublicCanvasDataReportColumns: {
777
802
  parameters: {
778
803
  query?: never;
779
804
  header?: never;
780
805
  path: {
781
- visualization_id: string;
782
- dashboard_id: string;
806
+ report_id: string;
807
+ canvas_id: components["schemas"]["CanvasId"];
783
808
  };
784
809
  cookie?: never;
785
810
  };
786
811
  requestBody?: never;
787
812
  responses: {
788
- /** @description The content of the visualization */
813
+ /** @description A list containing the columns of the report */
789
814
  200: {
790
815
  headers: {
791
816
  [name: string]: unknown;
792
817
  };
793
818
  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
- };
819
+ "application/json": components["schemas"]["ReportColumns"];
806
820
  };
807
821
  };
808
- /** @description Unable to fetch visualization with this id */
822
+ /** @description Unable to retrieve report with this id */
809
823
  404: {
810
824
  headers: {
811
825
  [name: string]: unknown;
@@ -829,51 +843,35 @@ declare interface operations {
829
843
  };
830
844
  };
831
845
  };
832
- retrievePublicDashboard: {
846
+ getPublicCanvasDataReportData: {
833
847
  parameters: {
834
- query?: never;
848
+ query?: {
849
+ limit?: number;
850
+ /** @example name:asc,date:desc */
851
+ order?: string;
852
+ cursor?: number;
853
+ /** @example status:active,name:John%20Doe */
854
+ filter?: string;
855
+ };
835
856
  header?: never;
836
857
  path: {
837
- dashboard_id: components["schemas"]["DashboardId"];
858
+ report_id: string;
859
+ canvas_id: components["schemas"]["CanvasId"];
838
860
  };
839
861
  cookie?: never;
840
862
  };
841
863
  requestBody?: never;
842
864
  responses: {
843
- /** @description The dashboard with the given id */
865
+ /** @description The content of the report */
844
866
  200: {
845
867
  headers: {
846
868
  [name: string]: unknown;
847
869
  };
848
870
  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
- };
871
+ "application/json": components["schemas"]["ReportData"];
874
872
  };
875
873
  };
876
- /** @description Unable to retrieve dashboard with this id */
874
+ /** @description Unable to retrieve report with this id */
877
875
  404: {
878
876
  headers: {
879
877
  [name: string]: unknown;
@@ -897,25 +895,28 @@ declare interface operations {
897
895
  };
898
896
  };
899
897
  };
900
- getPublicDataReportColumns: {
898
+ getPublicCanvasDataReportRowCount: {
901
899
  parameters: {
902
900
  query?: never;
903
901
  header?: never;
904
902
  path: {
905
903
  report_id: string;
906
- dashboard_id: components["schemas"]["DashboardId"];
904
+ canvas_id: components["schemas"]["CanvasId"];
907
905
  };
908
906
  cookie?: never;
909
907
  };
910
908
  requestBody?: never;
911
909
  responses: {
912
- /** @description A list containing the columns of the report */
910
+ /** @description The total count of rows in the report */
913
911
  200: {
914
912
  headers: {
915
913
  [name: string]: unknown;
916
914
  };
917
915
  content: {
918
- "application/json": components["schemas"]["ReportColumns"];
916
+ "application/json": {
917
+ /** @description Total number of rows in the report */
918
+ count: number;
919
+ };
919
920
  };
920
921
  };
921
922
  /** @description Unable to retrieve report with this id */
@@ -942,35 +943,34 @@ declare interface operations {
942
943
  };
943
944
  };
944
945
  };
945
- getPublicDataReportData: {
946
+ retrievePublicCanvas: {
946
947
  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
- };
948
+ query?: never;
955
949
  header?: never;
956
950
  path: {
957
- report_id: string;
958
- dashboard_id: components["schemas"]["DashboardId"];
951
+ canvas_id: components["schemas"]["CanvasId"];
959
952
  };
960
953
  cookie?: never;
961
954
  };
962
955
  requestBody?: never;
963
956
  responses: {
964
- /** @description The content of the report */
957
+ /** @description The canvas with the given id */
965
958
  200: {
966
959
  headers: {
967
960
  [name: string]: unknown;
968
961
  };
969
962
  content: {
970
- "application/json": components["schemas"]["ReportData"];
963
+ "application/json": {
964
+ /** Format: uuid */
965
+ id: string;
966
+ title: string | null;
967
+ is_public: boolean;
968
+ nodes: unknown[];
969
+ edges: unknown[];
970
+ };
971
971
  };
972
972
  };
973
- /** @description Unable to retrieve report with this id */
973
+ /** @description Unable to retrieve canvas with this id */
974
974
  404: {
975
975
  headers: {
976
976
  [name: string]: unknown;
@@ -994,31 +994,39 @@ declare interface operations {
994
994
  };
995
995
  };
996
996
  };
997
- getPublicDataReportRowCount: {
997
+ PublicCanvasFetchVisualization: {
998
998
  parameters: {
999
999
  query?: never;
1000
1000
  header?: never;
1001
1001
  path: {
1002
- report_id: string;
1003
- dashboard_id: components["schemas"]["DashboardId"];
1002
+ visualization_id: string;
1003
+ canvas_id: components["schemas"]["CanvasId"];
1004
1004
  };
1005
1005
  cookie?: never;
1006
1006
  };
1007
1007
  requestBody?: never;
1008
1008
  responses: {
1009
- /** @description The total count of rows in the report */
1009
+ /** @description The content of the visualization */
1010
1010
  200: {
1011
+ headers: {
1012
+ [name: string]: unknown;
1013
+ };
1014
+ content: {
1015
+ "application/json": components["schemas"]["VisualizationWithData"];
1016
+ };
1017
+ };
1018
+ /** @description Invalid arguments to fetch visualization */
1019
+ 400: {
1011
1020
  headers: {
1012
1021
  [name: string]: unknown;
1013
1022
  };
1014
1023
  content: {
1015
1024
  "application/json": {
1016
- /** @description Total number of rows in the report */
1017
- count: number;
1025
+ error: string;
1018
1026
  };
1019
1027
  };
1020
1028
  };
1021
- /** @description Unable to retrieve report with this id */
1029
+ /** @description Unable to fetch visualization with this id */
1022
1030
  404: {
1023
1031
  headers: {
1024
1032
  [name: string]: unknown;
@@ -2255,53 +2263,292 @@ declare interface operations {
2255
2263
  };
2256
2264
  };
2257
2265
  };
2258
- retrieveDashboard: {
2266
+ retrieveCanvas: {
2259
2267
  parameters: {
2260
2268
  query?: never;
2261
2269
  header: {
2262
2270
  "sp-access-token": string;
2263
2271
  };
2264
2272
  path: {
2265
- dashboard_id: components["schemas"]["DashboardId"];
2273
+ canvas_id: components["schemas"]["CanvasId"];
2266
2274
  };
2267
2275
  cookie?: never;
2268
2276
  };
2269
2277
  requestBody?: never;
2270
2278
  responses: {
2271
- /** @description The dashboard with the given id */
2279
+ /** @description The canvas with the given id */
2272
2280
  200: {
2273
2281
  headers: {
2274
2282
  [name: string]: unknown;
2275
2283
  };
2276
2284
  content: {
2277
2285
  "application/json": {
2278
- description: string | null;
2279
2286
  /** Format: uuid */
2280
2287
  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
- })[];
2288
+ title: string | null;
2289
+ is_public: boolean;
2290
+ nodes: unknown[];
2291
+ edges: unknown[];
2292
+ };
2293
+ };
2294
+ };
2295
+ /** @description Unable to retrieve canvas with this id */
2296
+ 404: {
2297
+ headers: {
2298
+ [name: string]: unknown;
2299
+ };
2300
+ content: {
2301
+ "application/json": {
2302
+ error: string;
2303
+ };
2304
+ };
2305
+ };
2306
+ /** @description Something wrong happened */
2307
+ 500: {
2308
+ headers: {
2309
+ [name: string]: unknown;
2310
+ };
2311
+ content: {
2312
+ "application/json": {
2313
+ error: string;
2314
+ };
2315
+ };
2316
+ };
2317
+ };
2318
+ };
2319
+ updateCanvas: {
2320
+ parameters: {
2321
+ query?: never;
2322
+ header: {
2323
+ "sp-access-token": string;
2324
+ };
2325
+ path: {
2326
+ canvas_id: components["schemas"]["CanvasId"];
2327
+ };
2328
+ cookie?: never;
2329
+ };
2330
+ requestBody: {
2331
+ content: {
2332
+ "application/json": {
2333
+ title?: string | null;
2334
+ nodes?: unknown[];
2335
+ edges?: unknown[];
2336
+ is_public?: boolean;
2337
+ };
2338
+ };
2339
+ };
2340
+ responses: {
2341
+ /** @description The updated canvas */
2342
+ 200: {
2343
+ headers: {
2344
+ [name: string]: unknown;
2345
+ };
2346
+ content: {
2347
+ "application/json": {
2348
+ /** @enum {boolean} */
2349
+ success: true;
2350
+ };
2351
+ };
2352
+ };
2353
+ /** @description Unable to retrieve canvas with this id */
2354
+ 404: {
2355
+ headers: {
2356
+ [name: string]: unknown;
2357
+ };
2358
+ content: {
2359
+ "application/json": {
2360
+ error: string;
2361
+ };
2362
+ };
2363
+ };
2364
+ /** @description Something wrong happened */
2365
+ 500: {
2366
+ headers: {
2367
+ [name: string]: unknown;
2368
+ };
2369
+ content: {
2370
+ "application/json": {
2371
+ error: string;
2372
+ };
2373
+ };
2374
+ };
2375
+ };
2376
+ };
2377
+ deleteCanvas: {
2378
+ parameters: {
2379
+ query?: never;
2380
+ header: {
2381
+ "sp-access-token": string;
2382
+ };
2383
+ path: {
2384
+ canvas_id: components["schemas"]["CanvasId"];
2385
+ };
2386
+ cookie?: never;
2387
+ };
2388
+ requestBody?: never;
2389
+ responses: {
2390
+ /** @description Canvas deleted successfully */
2391
+ 204: {
2392
+ headers: {
2393
+ [name: string]: unknown;
2394
+ };
2395
+ content?: never;
2396
+ };
2397
+ /** @description Unable to delete canvas with this id */
2398
+ 404: {
2399
+ headers: {
2400
+ [name: string]: unknown;
2401
+ };
2402
+ content: {
2403
+ "application/json": {
2404
+ error: string;
2405
+ };
2406
+ };
2407
+ };
2408
+ /** @description Something wrong happened */
2409
+ 500: {
2410
+ headers: {
2411
+ [name: string]: unknown;
2412
+ };
2413
+ content: {
2414
+ "application/json": {
2415
+ error: string;
2416
+ };
2417
+ };
2418
+ };
2419
+ };
2420
+ };
2421
+ createCanvas: {
2422
+ parameters: {
2423
+ query?: never;
2424
+ header: {
2425
+ "sp-access-token": string;
2426
+ };
2427
+ path?: never;
2428
+ cookie?: never;
2429
+ };
2430
+ requestBody: {
2431
+ content: {
2432
+ "application/json": {
2433
+ title: string | null;
2434
+ is_public: boolean;
2435
+ nodes: unknown[];
2436
+ edges: unknown[];
2437
+ flow_id?: string;
2438
+ };
2439
+ };
2440
+ };
2441
+ responses: {
2442
+ /** @description The created canvas */
2443
+ 201: {
2444
+ headers: {
2445
+ [name: string]: unknown;
2446
+ };
2447
+ content: {
2448
+ "application/json": {
2449
+ id: string;
2450
+ };
2451
+ };
2452
+ };
2453
+ /** @description Invalid request */
2454
+ 400: {
2455
+ headers: {
2456
+ [name: string]: unknown;
2457
+ };
2458
+ content: {
2459
+ "application/json": {
2460
+ error: string;
2461
+ };
2462
+ };
2463
+ };
2464
+ /** @description Something wrong happened */
2465
+ 500: {
2466
+ headers: {
2467
+ [name: string]: unknown;
2468
+ };
2469
+ content: {
2470
+ "application/json": {
2471
+ error: string;
2472
+ };
2473
+ };
2474
+ };
2475
+ };
2476
+ };
2477
+ listCanvases: {
2478
+ parameters: {
2479
+ query?: {
2480
+ search?: string;
2481
+ };
2482
+ header: {
2483
+ "sp-access-token": string;
2484
+ };
2485
+ path?: never;
2486
+ cookie?: never;
2487
+ };
2488
+ requestBody?: never;
2489
+ responses: {
2490
+ /** @description A list of canvases */
2491
+ 200: {
2492
+ headers: {
2493
+ [name: string]: unknown;
2494
+ };
2495
+ content: {
2496
+ "application/json": {
2497
+ /** Format: uuid */
2498
+ id: string;
2499
+ title: string | null;
2500
+ is_public: boolean;
2501
+ nodes: unknown[];
2502
+ edges: unknown[];
2503
+ canvas_flows: {
2504
+ flow_id: string;
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
+ getCanvasForFlow: {
2523
+ parameters: {
2524
+ query?: never;
2525
+ header: {
2526
+ "sp-access-token": string;
2527
+ };
2528
+ path: {
2529
+ flow_id: string;
2530
+ };
2531
+ cookie?: never;
2532
+ };
2533
+ requestBody?: never;
2534
+ responses: {
2535
+ /** @description The canvas for the given flow */
2536
+ 200: {
2537
+ headers: {
2538
+ [name: string]: unknown;
2539
+ };
2540
+ content: {
2541
+ "application/json": {
2542
+ /** Format: uuid */
2543
+ id: string;
2544
+ title: string | null;
2300
2545
  is_public: boolean;
2546
+ nodes: unknown[];
2547
+ edges: unknown[];
2301
2548
  };
2302
2549
  };
2303
2550
  };
2304
- /** @description Unable to retrieve dashboard with this id */
2551
+ /** @description Unable to retrieve canvas for this flow */
2305
2552
  404: {
2306
2553
  headers: {
2307
2554
  [name: string]: unknown;
@@ -2596,6 +2843,8 @@ declare interface operations {
2596
2843
  /** @description JSON-encoded map of { [field_key]: string[] } to be passed to RPC */
2597
2844
  external_filters?: string;
2598
2845
  max_results?: number;
2846
+ /** @description If true, exclude users with @magemetrics emails from results */
2847
+ exclude_magemetrics_emails?: string;
2599
2848
  };
2600
2849
  header?: never;
2601
2850
  path?: never;
@@ -2977,14 +3226,14 @@ declare interface paths {
2977
3226
  patch?: never;
2978
3227
  trace?: never;
2979
3228
  };
2980
- "/api/v1/public/dashboards/{dashboard_id}/visualizations/{visualization_id}": {
3229
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/columns": {
2981
3230
  parameters: {
2982
3231
  query?: never;
2983
3232
  header?: never;
2984
3233
  path?: never;
2985
3234
  cookie?: never;
2986
3235
  };
2987
- get: operations["PublicDashboardFetchVisualization"];
3236
+ get: operations["getPublicCanvasDataReportColumns"];
2988
3237
  put?: never;
2989
3238
  post?: never;
2990
3239
  delete?: never;
@@ -2993,14 +3242,14 @@ declare interface paths {
2993
3242
  patch?: never;
2994
3243
  trace?: never;
2995
3244
  };
2996
- "/api/v1/public/dashboards/{dashboard_id}": {
3245
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/data": {
2997
3246
  parameters: {
2998
3247
  query?: never;
2999
3248
  header?: never;
3000
3249
  path?: never;
3001
3250
  cookie?: never;
3002
3251
  };
3003
- get: operations["retrievePublicDashboard"];
3252
+ get: operations["getPublicCanvasDataReportData"];
3004
3253
  put?: never;
3005
3254
  post?: never;
3006
3255
  delete?: never;
@@ -3009,14 +3258,14 @@ declare interface paths {
3009
3258
  patch?: never;
3010
3259
  trace?: never;
3011
3260
  };
3012
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/columns": {
3261
+ "/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/count": {
3013
3262
  parameters: {
3014
3263
  query?: never;
3015
3264
  header?: never;
3016
3265
  path?: never;
3017
3266
  cookie?: never;
3018
3267
  };
3019
- get: operations["getPublicDataReportColumns"];
3268
+ get: operations["getPublicCanvasDataReportRowCount"];
3020
3269
  put?: never;
3021
3270
  post?: never;
3022
3271
  delete?: never;
@@ -3025,14 +3274,14 @@ declare interface paths {
3025
3274
  patch?: never;
3026
3275
  trace?: never;
3027
3276
  };
3028
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/data": {
3277
+ "/api/v1/public/canvas/{canvas_id}": {
3029
3278
  parameters: {
3030
3279
  query?: never;
3031
3280
  header?: never;
3032
3281
  path?: never;
3033
3282
  cookie?: never;
3034
3283
  };
3035
- get: operations["getPublicDataReportData"];
3284
+ get: operations["retrievePublicCanvas"];
3036
3285
  put?: never;
3037
3286
  post?: never;
3038
3287
  delete?: never;
@@ -3041,14 +3290,14 @@ declare interface paths {
3041
3290
  patch?: never;
3042
3291
  trace?: never;
3043
3292
  };
3044
- "/api/v1/public/dashboards/{dashboard_id}/data-reports/{report_id}/count": {
3293
+ "/api/v1/public/canvas/{canvas_id}/visualizations/{visualization_id}": {
3045
3294
  parameters: {
3046
3295
  query?: never;
3047
3296
  header?: never;
3048
3297
  path?: never;
3049
3298
  cookie?: never;
3050
3299
  };
3051
- get: operations["getPublicDataReportRowCount"];
3300
+ get: operations["PublicCanvasFetchVisualization"];
3052
3301
  put?: never;
3053
3302
  post?: never;
3054
3303
  delete?: never;
@@ -3377,14 +3626,62 @@ declare interface paths {
3377
3626
  patch?: never;
3378
3627
  trace?: never;
3379
3628
  };
3380
- "/api/v1/dashboard/{dashboard_id}": {
3629
+ "/api/v1/canvas/{canvas_id}": {
3630
+ parameters: {
3631
+ query?: never;
3632
+ header?: never;
3633
+ path?: never;
3634
+ cookie?: never;
3635
+ };
3636
+ get: operations["retrieveCanvas"];
3637
+ put: operations["updateCanvas"];
3638
+ post?: never;
3639
+ delete: operations["deleteCanvas"];
3640
+ options?: never;
3641
+ head?: never;
3642
+ patch?: never;
3643
+ trace?: never;
3644
+ };
3645
+ "/api/v1/canvas/": {
3646
+ parameters: {
3647
+ query?: never;
3648
+ header?: never;
3649
+ path?: never;
3650
+ cookie?: never;
3651
+ };
3652
+ get?: never;
3653
+ put?: never;
3654
+ post: operations["createCanvas"];
3655
+ delete?: never;
3656
+ options?: never;
3657
+ head?: never;
3658
+ patch?: never;
3659
+ trace?: never;
3660
+ };
3661
+ "/api/v1/canvases": {
3381
3662
  parameters: {
3382
3663
  query?: never;
3383
3664
  header?: never;
3384
3665
  path?: never;
3385
3666
  cookie?: never;
3386
3667
  };
3387
- get: operations["retrieveDashboard"];
3668
+ get: operations["listCanvases"];
3669
+ put?: never;
3670
+ post?: never;
3671
+ delete?: never;
3672
+ options?: never;
3673
+ head?: never;
3674
+ patch?: never;
3675
+ trace?: never;
3676
+ };
3677
+ "/api/v1/canvas/flow/{flow_id}": {
3678
+ parameters: {
3679
+ query?: never;
3680
+ header?: never;
3681
+ path?: never;
3682
+ cookie?: never;
3683
+ };
3684
+ get: operations["getCanvasForFlow"];
3388
3685
  put?: never;
3389
3686
  post?: never;
3390
3687
  delete?: never;
@@ -3755,13 +4052,9 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3755
4052
  private: z.ZodObject<{
3756
4053
  message: z.ZodOptional<z.ZodString>;
3757
4054
  columns: z.ZodArray<z.ZodObject<{
3758
- id: z.ZodNumber;
3759
4055
  name: z.ZodString;
3760
4056
  data_type: z.ZodNullable<z.ZodString>;
3761
4057
  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
4058
  table: z.ZodObject<{
3766
4059
  table_name: z.ZodString;
3767
4060
  description: z.ZodNullable<z.ZodString>;
@@ -3780,11 +4073,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3780
4073
  description: string | null;
3781
4074
  table_name: string;
3782
4075
  };
3783
- id: number;
3784
4076
  data_type: string | null;
3785
- null_percentage: number | null;
3786
- unique_values: number | null;
3787
- sample_values: any[] | null;
3788
4077
  matched_values: string[];
3789
4078
  }, {
3790
4079
  description: string | null;
@@ -3793,11 +4082,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3793
4082
  description: string | null;
3794
4083
  table_name: string;
3795
4084
  };
3796
- id: number;
3797
4085
  data_type: string | null;
3798
- null_percentage: number | null;
3799
- unique_values: number | null;
3800
- sample_values: any[] | null;
3801
4086
  matched_values: string[];
3802
4087
  }>, "many">;
3803
4088
  }, "strip", z.ZodTypeAny, {
@@ -3808,11 +4093,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3808
4093
  description: string | null;
3809
4094
  table_name: string;
3810
4095
  };
3811
- id: number;
3812
4096
  data_type: string | null;
3813
- null_percentage: number | null;
3814
- unique_values: number | null;
3815
- sample_values: any[] | null;
3816
4097
  matched_values: string[];
3817
4098
  }[];
3818
4099
  message?: string | undefined;
@@ -3824,11 +4105,7 @@ declare const redactedOutputSchema_3: z.ZodObject<{
3824
4105
  description: string | null;
3825
4106
  table_name: string;
3826
4107
  };
3827
- id: number;
3828
4108
  data_type: string | null;
3829
- null_percentage: number | null;
3830
- unique_values: number | null;
3831
- sample_values: any[] | null;
3832
4109
  matched_values: string[];
3833
4110
  }[];
3834
4111
  message?: string | undefined;
@@ -3876,28 +4153,23 @@ declare const redactedOutputSchema_4: z.ZodObject<{
3876
4153
  public: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
3877
4154
  private: z.ZodObject<{
3878
4155
  tables: z.ZodArray<z.ZodObject<{
3879
- id: z.ZodNumber;
3880
4156
  table_name: z.ZodString;
3881
4157
  description: z.ZodNullable<z.ZodString>;
3882
4158
  }, "strip", z.ZodTypeAny, {
3883
4159
  description: string | null;
3884
- id: number;
3885
4160
  table_name: string;
3886
4161
  }, {
3887
4162
  description: string | null;
3888
- id: number;
3889
4163
  table_name: string;
3890
4164
  }>, "many">;
3891
4165
  }, "strip", z.ZodTypeAny, {
3892
4166
  tables: {
3893
4167
  description: string | null;
3894
- id: number;
3895
4168
  table_name: string;
3896
4169
  }[];
3897
4170
  }, {
3898
4171
  tables: {
3899
4172
  description: string | null;
3900
- id: number;
3901
4173
  table_name: string;
3902
4174
  }[];
3903
4175
  }>;
@@ -3945,7 +4217,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3945
4217
  private: z.ZodObject<{
3946
4218
  message: z.ZodOptional<z.ZodString>;
3947
4219
  columns: z.ZodArray<z.ZodObject<{
3948
- id: z.ZodNumber;
3949
4220
  name: z.ZodString;
3950
4221
  data_type: z.ZodNullable<z.ZodString>;
3951
4222
  description: z.ZodNullable<z.ZodString>;
@@ -3955,7 +4226,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3955
4226
  }, "strip", z.ZodTypeAny, {
3956
4227
  description: string | null;
3957
4228
  name: string;
3958
- id: number;
3959
4229
  data_type: string | null;
3960
4230
  null_percentage: number | null;
3961
4231
  unique_values: number | null;
@@ -3963,7 +4233,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3963
4233
  }, {
3964
4234
  description: string | null;
3965
4235
  name: string;
3966
- id: number;
3967
4236
  data_type: string | null;
3968
4237
  null_percentage: number | null;
3969
4238
  unique_values: number | null;
@@ -3973,7 +4242,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3973
4242
  columns: {
3974
4243
  description: string | null;
3975
4244
  name: string;
3976
- id: number;
3977
4245
  data_type: string | null;
3978
4246
  null_percentage: number | null;
3979
4247
  unique_values: number | null;
@@ -3984,7 +4252,6 @@ declare const redactedOutputSchema_5: z.ZodObject<{
3984
4252
  columns: {
3985
4253
  description: string | null;
3986
4254
  name: string;
3987
- id: number;
3988
4255
  data_type: string | null;
3989
4256
  null_percentage: number | null;
3990
4257
  unique_values: number | null;
@@ -4040,28 +4307,28 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4040
4307
  title: z.ZodString;
4041
4308
  }, "strip", z.ZodTypeAny, {
4042
4309
  title: string;
4043
- id: string;
4044
4310
  sourceType: "url";
4045
4311
  url: string;
4312
+ id: string;
4046
4313
  }, {
4047
4314
  title: string;
4048
- id: string;
4049
4315
  sourceType: "url";
4050
4316
  url: string;
4317
+ id: string;
4051
4318
  }>, "many">>;
4052
4319
  }, "strip", z.ZodTypeAny, {
4053
4320
  sources?: {
4054
4321
  title: string;
4055
- id: string;
4056
4322
  sourceType: "url";
4057
4323
  url: string;
4324
+ id: string;
4058
4325
  }[] | undefined;
4059
4326
  }, {
4060
4327
  sources?: {
4061
4328
  title: string;
4062
- id: string;
4063
4329
  sourceType: "url";
4064
4330
  url: string;
4331
+ id: string;
4065
4332
  }[] | undefined;
4066
4333
  }>;
4067
4334
  private: z.ZodObject<{
@@ -4076,9 +4343,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4076
4343
  public: {
4077
4344
  sources?: {
4078
4345
  title: string;
4079
- id: string;
4080
4346
  sourceType: "url";
4081
4347
  url: string;
4348
+ id: string;
4082
4349
  }[] | undefined;
4083
4350
  };
4084
4351
  }, {
@@ -4086,9 +4353,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4086
4353
  public: {
4087
4354
  sources?: {
4088
4355
  title: string;
4089
- id: string;
4090
4356
  sourceType: "url";
4091
4357
  url: string;
4358
+ id: string;
4092
4359
  }[] | undefined;
4093
4360
  };
4094
4361
  }>, z.ZodObject<{
@@ -4108,9 +4375,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4108
4375
  public: {
4109
4376
  sources?: {
4110
4377
  title: string;
4111
- id: string;
4112
4378
  sourceType: "url";
4113
4379
  url: string;
4380
+ id: string;
4114
4381
  }[] | undefined;
4115
4382
  };
4116
4383
  } | {
@@ -4124,9 +4391,9 @@ declare const redactedOutputSchema_6: z.ZodObject<{
4124
4391
  public: {
4125
4392
  sources?: {
4126
4393
  title: string;
4127
- id: string;
4128
4394
  sourceType: "url";
4129
4395
  url: string;
4396
+ id: string;
4130
4397
  }[] | undefined;
4131
4398
  };
4132
4399
  } | {
@@ -4241,4 +4508,24 @@ declare type UiTool_6 = InferUITool<Tool<z.infer<typeof inputSchema_6>, z.infer<
4241
4508
 
4242
4509
  declare type UiTool_7 = InferUITool<Tool<z.infer<typeof inputSchema_7>, z.infer<typeof redactedOutputSchema_6>>>;
4243
4510
 
4511
+ declare const UpdateCanvasSchema: z.ZodObject<{
4512
+ id: z.ZodString;
4513
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4514
+ nodes: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
4515
+ edges: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
4516
+ is_public: z.ZodOptional<z.ZodBoolean>;
4517
+ }, "strip", z.ZodTypeAny, {
4518
+ id: string;
4519
+ title?: string | null | undefined;
4520
+ nodes?: any[] | undefined;
4521
+ edges?: any[] | undefined;
4522
+ is_public?: boolean | undefined;
4523
+ }, {
4524
+ id: string;
4525
+ title?: string | null | undefined;
4526
+ nodes?: any[] | undefined;
4527
+ edges?: any[] | undefined;
4528
+ is_public?: boolean | undefined;
4529
+ }>;
4530
+
4244
4531
  export { }