@cosmotech/api-ts 5.0.0-beta5 → 5.0.0-rc1

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.
Files changed (46) hide show
  1. package/.github/workflows/publish.yaml +10 -8
  2. package/.github/workflows/track_dependencies.yml +3 -0
  3. package/.openapi-generator/FILES +1 -7
  4. package/README.md +4 -12
  5. package/api.ts +160 -482
  6. package/base.ts +1 -1
  7. package/common.ts +1 -1
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +159 -381
  10. package/dist/api.js +64 -271
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +1 -1
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +1 -1
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/Dataset.md +4 -2
  20. package/docs/DatasetApi.md +34 -15
  21. package/docs/DatasetCreateInfo.md +24 -0
  22. package/docs/DatasetCreateRequest.md +2 -2
  23. package/docs/DatasetEditInfo.md +22 -0
  24. package/docs/DatasetPart.md +4 -2
  25. package/docs/DatasetPartCreateRequest.md +2 -0
  26. package/docs/DatasetPartUpdateRequest.md +2 -0
  27. package/docs/DatasetUpdateRequest.md +2 -0
  28. package/docs/RunApi.md +0 -129
  29. package/docs/RunData.md +1 -1
  30. package/docs/RunTemplateParameter.md +2 -4
  31. package/docs/RunTemplateParameterCreateRequest.md +2 -4
  32. package/docs/RunTemplateParameterGroup.md +2 -6
  33. package/docs/RunTemplateParameterGroupCreateRequest.md +2 -6
  34. package/docs/RunTemplateParameterGroupUpdateRequest.md +2 -6
  35. package/docs/RunTemplateParameterUpdateRequest.md +2 -4
  36. package/docs/Runner.md +3 -3
  37. package/docs/RunnerCreateRequest.md +2 -2
  38. package/docs/RunnerUpdateRequest.md +2 -2
  39. package/docs/SendRunDataRequest.md +2 -3
  40. package/docs/Workspace.md +2 -2
  41. package/docs/WorkspaceCreateRequest.md +2 -2
  42. package/docs/WorkspaceSolution.md +0 -4
  43. package/docs/WorkspaceUpdateRequest.md +2 -2
  44. package/git_push.sh +2 -2
  45. package/index.ts +1 -1
  46. package/package.json +2 -2
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 5.0.1-SNAPSHOT
5
+ * The version of the OpenAPI document: 5.0.0-rc1
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -134,31 +134,6 @@ export interface ContainerResourceSizing {
134
134
  */
135
135
  'limits': ContainerResourceSizeInfo;
136
136
  }
137
- /**
138
- *
139
- * @export
140
- * @interface CreateInfo
141
- */
142
- export interface CreateInfo {
143
- /**
144
- * The timestamp of the creation in millisecond
145
- * @type {number}
146
- * @memberof CreateInfo
147
- */
148
- 'timestamp': number;
149
- /**
150
- * The id of the user who did the creation
151
- * @type {string}
152
- * @memberof CreateInfo
153
- */
154
- 'userId': string;
155
- /**
156
- * The runner id which has created the dataset (nullable)
157
- * @type {string}
158
- * @memberof CreateInfo
159
- */
160
- 'runnerId'?: string;
161
- }
162
137
  /**
163
138
  * Newly created Run info
164
139
  * @export
@@ -214,6 +189,14 @@ export interface Dataset {
214
189
  * @memberof Dataset
215
190
  */
216
191
  'tags': Array<string>;
192
+ /**
193
+ * Free form additional data
194
+ * @type {{ [key: string]: any; }}
195
+ * @memberof Dataset
196
+ */
197
+ 'additionalData'?: {
198
+ [key: string]: any;
199
+ };
217
200
  /**
218
201
  *
219
202
  * @type {Array<DatasetPart>}
@@ -222,16 +205,16 @@ export interface Dataset {
222
205
  'parts': Array<DatasetPart>;
223
206
  /**
224
207
  * The details of the Dataset creation
225
- * @type {CreateInfo}
208
+ * @type {DatasetEditInfo}
226
209
  * @memberof Dataset
227
210
  */
228
- 'createInfo': CreateInfo;
211
+ 'createInfo': DatasetEditInfo;
229
212
  /**
230
213
  * The details of the Dataset last update
231
- * @type {EditInfo}
214
+ * @type {DatasetEditInfo}
232
215
  * @memberof Dataset
233
216
  */
234
- 'updateInfo': EditInfo;
217
+ 'updateInfo': DatasetEditInfo;
235
218
  /**
236
219
  *
237
220
  * @type {DatasetSecurity}
@@ -282,6 +265,14 @@ export interface DatasetCreateRequest {
282
265
  * @memberof DatasetCreateRequest
283
266
  */
284
267
  'tags'?: Array<string>;
268
+ /**
269
+ * Free form additional data
270
+ * @type {{ [key: string]: any; }}
271
+ * @memberof DatasetCreateRequest
272
+ */
273
+ 'additionalData'?: {
274
+ [key: string]: any;
275
+ };
285
276
  /**
286
277
  *
287
278
  * @type {Array<DatasetPartCreateRequest>}
@@ -294,12 +285,25 @@ export interface DatasetCreateRequest {
294
285
  * @memberof DatasetCreateRequest
295
286
  */
296
287
  'security'?: DatasetSecurity;
288
+ }
289
+ /**
290
+ *
291
+ * @export
292
+ * @interface DatasetEditInfo
293
+ */
294
+ export interface DatasetEditInfo {
297
295
  /**
298
- *
296
+ * The timestamp of the modification in millisecond
297
+ * @type {number}
298
+ * @memberof DatasetEditInfo
299
+ */
300
+ 'timestamp': number;
301
+ /**
302
+ * The id of the user who did the modification
299
303
  * @type {string}
300
- * @memberof DatasetCreateRequest
304
+ * @memberof DatasetEditInfo
301
305
  */
302
- 'runnerId'?: string;
306
+ 'userId': string;
303
307
  }
304
308
  /**
305
309
  * Dataset part object
@@ -337,6 +341,14 @@ export interface DatasetPart {
337
341
  * @memberof DatasetPart
338
342
  */
339
343
  'tags': Array<string>;
344
+ /**
345
+ * Free form additional data
346
+ * @type {{ [key: string]: any; }}
347
+ * @memberof DatasetPart
348
+ */
349
+ 'additionalData'?: {
350
+ [key: string]: any;
351
+ };
340
352
  /**
341
353
  *
342
354
  * @type {DatasetPartTypeEnum}
@@ -363,16 +375,16 @@ export interface DatasetPart {
363
375
  'datasetId': string;
364
376
  /**
365
377
  * The details of the Dataset creation
366
- * @type {EditInfo}
378
+ * @type {DatasetEditInfo}
367
379
  * @memberof DatasetPart
368
380
  */
369
- 'createInfo': EditInfo;
381
+ 'createInfo': DatasetEditInfo;
370
382
  /**
371
383
  * The details of the Dataset last update
372
- * @type {EditInfo}
384
+ * @type {DatasetEditInfo}
373
385
  * @memberof DatasetPart
374
386
  */
375
- 'updateInfo': EditInfo;
387
+ 'updateInfo': DatasetEditInfo;
376
388
  }
377
389
  /**
378
390
  * Dataset part create request object
@@ -404,6 +416,14 @@ export interface DatasetPartCreateRequest {
404
416
  * @memberof DatasetPartCreateRequest
405
417
  */
406
418
  'tags'?: Array<string>;
419
+ /**
420
+ * Free form additional data
421
+ * @type {{ [key: string]: any; }}
422
+ * @memberof DatasetPartCreateRequest
423
+ */
424
+ 'additionalData'?: {
425
+ [key: string]: any;
426
+ };
407
427
  /**
408
428
  *
409
429
  * @type {DatasetPartTypeEnum}
@@ -445,6 +465,14 @@ export interface DatasetPartUpdateRequest {
445
465
  * @memberof DatasetPartUpdateRequest
446
466
  */
447
467
  'tags'?: Array<string>;
468
+ /**
469
+ * Free form additional data
470
+ * @type {{ [key: string]: any; }}
471
+ * @memberof DatasetPartUpdateRequest
472
+ */
473
+ 'additionalData'?: {
474
+ [key: string]: any;
475
+ };
448
476
  }
449
477
  /**
450
478
  * the Dataset Role
@@ -502,6 +530,14 @@ export interface DatasetUpdateRequest {
502
530
  * @memberof DatasetUpdateRequest
503
531
  */
504
532
  'tags'?: Array<string>;
533
+ /**
534
+ * Free form additional data
535
+ * @type {{ [key: string]: any; }}
536
+ * @memberof DatasetUpdateRequest
537
+ */
538
+ 'additionalData'?: {
539
+ [key: string]: any;
540
+ };
505
541
  /**
506
542
  *
507
543
  * @type {Array<DatasetPartCreateRequest>}
@@ -515,25 +551,6 @@ export interface DatasetUpdateRequest {
515
551
  */
516
552
  'security'?: DatasetSecurity;
517
553
  }
518
- /**
519
- *
520
- * @export
521
- * @interface EditInfo
522
- */
523
- export interface EditInfo {
524
- /**
525
- * The timestamp of the modification in millisecond
526
- * @type {number}
527
- * @memberof EditInfo
528
- */
529
- 'timestamp': number;
530
- /**
531
- * The id of the user who did the modification
532
- * @type {string}
533
- * @memberof EditInfo
534
- */
535
- 'userId': string;
536
- }
537
554
  /**
538
555
  * last run info from current runner
539
556
  * @export
@@ -700,21 +717,6 @@ export interface OrganizationUpdateRequest {
700
717
  */
701
718
  'name'?: string;
702
719
  }
703
- /**
704
- * the result of a SQL Query
705
- * @export
706
- * @interface QueryResult
707
- */
708
- export interface QueryResult {
709
- /**
710
- * the list of results
711
- * @type {Array<{ [key: string]: any; }>}
712
- * @memberof QueryResult
713
- */
714
- 'result'?: Array<{
715
- [key: string]: any;
716
- }>;
717
- }
718
720
  /**
719
721
  * define cpus and memory needs
720
722
  * @export
@@ -926,46 +928,6 @@ export interface RunContainer {
926
928
  */
927
929
  'runSizing'?: ContainerResourceSizing;
928
930
  }
929
- /**
930
- * Run Data stored
931
- * @export
932
- * @interface RunData
933
- */
934
- export interface RunData {
935
- /**
936
- * Database name
937
- * @type {string}
938
- * @memberof RunData
939
- */
940
- 'database_name'?: string;
941
- /**
942
- * Table name
943
- * @type {string}
944
- * @memberof RunData
945
- */
946
- 'table_name'?: string;
947
- /**
948
- *
949
- * @type {Array<{ [key: string]: any; }>}
950
- * @memberof RunData
951
- */
952
- 'data'?: Array<{
953
- [key: string]: any;
954
- }>;
955
- }
956
- /**
957
- * a data result query in SQL
958
- * @export
959
- * @interface RunDataQuery
960
- */
961
- export interface RunDataQuery {
962
- /**
963
- * the query in SQL
964
- * @type {string}
965
- * @memberof RunDataQuery
966
- */
967
- 'query': string;
968
- }
969
931
  /**
970
932
  *
971
933
  * @export
@@ -1370,17 +1332,11 @@ export interface RunTemplateParameter {
1370
1332
  */
1371
1333
  'maxValue'?: string;
1372
1334
  /**
1373
- * A regex to validate the value
1374
- * @type {string}
1375
- * @memberof RunTemplateParameter
1376
- */
1377
- 'regexValidation'?: string;
1378
- /**
1379
- * Freeform options
1335
+ * Free form additional data
1380
1336
  * @type {{ [key: string]: any; }}
1381
1337
  * @memberof RunTemplateParameter
1382
1338
  */
1383
- 'options'?: {
1339
+ 'additionalData'?: {
1384
1340
  [key: string]: any;
1385
1341
  };
1386
1342
  }
@@ -1435,17 +1391,11 @@ export interface RunTemplateParameterCreateRequest {
1435
1391
  */
1436
1392
  'maxValue'?: string;
1437
1393
  /**
1438
- * A regex to validate the value
1439
- * @type {string}
1440
- * @memberof RunTemplateParameterCreateRequest
1441
- */
1442
- 'regexValidation'?: string;
1443
- /**
1444
- * Freeform options
1394
+ * Free form additional data
1445
1395
  * @type {{ [key: string]: any; }}
1446
1396
  * @memberof RunTemplateParameterCreateRequest
1447
1397
  */
1448
- 'options'?: {
1398
+ 'additionalData'?: {
1449
1399
  [key: string]: any;
1450
1400
  };
1451
1401
  }
@@ -1476,25 +1426,13 @@ export interface RunTemplateParameterGroup {
1476
1426
  [key: string]: string;
1477
1427
  };
1478
1428
  /**
1479
- * Does the group define a table
1480
- * @type {boolean}
1481
- * @memberof RunTemplateParameterGroup
1482
- */
1483
- 'isTable': boolean;
1484
- /**
1485
- * Freeform options
1429
+ * Free form additional data
1486
1430
  * @type {{ [key: string]: any; }}
1487
1431
  * @memberof RunTemplateParameterGroup
1488
1432
  */
1489
- 'options'?: {
1433
+ 'additionalData'?: {
1490
1434
  [key: string]: any;
1491
1435
  };
1492
- /**
1493
- * The Run Template Group parent Id
1494
- * @type {string}
1495
- * @memberof RunTemplateParameterGroup
1496
- */
1497
- 'parentId'?: string;
1498
1436
  /**
1499
1437
  * An ordered list of Run Template Parameters
1500
1438
  * @type {Array<string>}
@@ -1529,25 +1467,13 @@ export interface RunTemplateParameterGroupCreateRequest {
1529
1467
  [key: string]: string;
1530
1468
  };
1531
1469
  /**
1532
- * Does the group define a table
1533
- * @type {boolean}
1534
- * @memberof RunTemplateParameterGroupCreateRequest
1535
- */
1536
- 'isTable'?: boolean;
1537
- /**
1538
- * Freeform options
1470
+ * Free form additional data
1539
1471
  * @type {{ [key: string]: any; }}
1540
1472
  * @memberof RunTemplateParameterGroupCreateRequest
1541
1473
  */
1542
- 'options'?: {
1474
+ 'additionalData'?: {
1543
1475
  [key: string]: any;
1544
1476
  };
1545
- /**
1546
- * The Run Template Group parent Id
1547
- * @type {string}
1548
- * @memberof RunTemplateParameterGroupCreateRequest
1549
- */
1550
- 'parentId'?: string;
1551
1477
  /**
1552
1478
  * An ordered list of Run Template Parameters
1553
1479
  * @type {Array<string>}
@@ -1576,25 +1502,13 @@ export interface RunTemplateParameterGroupUpdateRequest {
1576
1502
  [key: string]: string;
1577
1503
  };
1578
1504
  /**
1579
- * Does the group define a table
1580
- * @type {boolean}
1581
- * @memberof RunTemplateParameterGroupUpdateRequest
1582
- */
1583
- 'isTable'?: boolean;
1584
- /**
1585
- * Freeform options
1505
+ * Free form additional data
1586
1506
  * @type {{ [key: string]: any; }}
1587
1507
  * @memberof RunTemplateParameterGroupUpdateRequest
1588
1508
  */
1589
- 'options'?: {
1509
+ 'additionalData'?: {
1590
1510
  [key: string]: any;
1591
1511
  };
1592
- /**
1593
- * The Run Template Group parent Id
1594
- * @type {string}
1595
- * @memberof RunTemplateParameterGroupUpdateRequest
1596
- */
1597
- 'parentId'?: string;
1598
1512
  /**
1599
1513
  * An ordered list of Run Template Parameters
1600
1514
  * @type {Array<string>}
@@ -1647,17 +1561,11 @@ export interface RunTemplateParameterUpdateRequest {
1647
1561
  */
1648
1562
  'maxValue'?: string;
1649
1563
  /**
1650
- * A regex to validate the value
1651
- * @type {string}
1652
- * @memberof RunTemplateParameterUpdateRequest
1653
- */
1654
- 'regexValidation'?: string;
1655
- /**
1656
- * Freeform options
1564
+ * Free form additional data
1657
1565
  * @type {{ [key: string]: any; }}
1658
1566
  * @memberof RunTemplateParameterUpdateRequest
1659
1567
  */
1660
- 'options'?: {
1568
+ 'additionalData'?: {
1661
1569
  [key: string]: any;
1662
1570
  };
1663
1571
  }
@@ -1840,12 +1748,6 @@ export interface Runner {
1840
1748
  * @memberof Runner
1841
1749
  */
1842
1750
  'workspaceId': string;
1843
- /**
1844
- * the name of the owner
1845
- * @type {string}
1846
- * @memberof Runner
1847
- */
1848
- 'ownerName': string;
1849
1751
  /**
1850
1752
  * the Solution name
1851
1753
  * @type {string}
@@ -1859,7 +1761,15 @@ export interface Runner {
1859
1761
  */
1860
1762
  'runTemplateName'?: string;
1861
1763
  /**
1862
- *
1764
+ * Free form additional data
1765
+ * @type {{ [key: string]: any; }}
1766
+ * @memberof Runner
1767
+ */
1768
+ 'additionalData'?: {
1769
+ [key: string]: any;
1770
+ };
1771
+ /**
1772
+ * definition of datasets used by the runner
1863
1773
  * @type {RunnerDatasets}
1864
1774
  * @memberof Runner
1865
1775
  */
@@ -1975,11 +1885,13 @@ export interface RunnerCreateRequest {
1975
1885
  */
1976
1886
  'parametersValues'?: Array<RunnerRunTemplateParameterValue>;
1977
1887
  /**
1978
- * the name of the owner
1979
- * @type {string}
1888
+ * Free form additional data
1889
+ * @type {{ [key: string]: any; }}
1980
1890
  * @memberof RunnerCreateRequest
1981
1891
  */
1982
- 'ownerName': string;
1892
+ 'additionalData'?: {
1893
+ [key: string]: any;
1894
+ };
1983
1895
  /**
1984
1896
  * the Solution name
1985
1897
  * @type {string}
@@ -2174,11 +2086,13 @@ export interface RunnerUpdateRequest {
2174
2086
  */
2175
2087
  'parametersValues'?: Array<RunnerRunTemplateParameterValue>;
2176
2088
  /**
2177
- * the name of the owner
2178
- * @type {string}
2089
+ * Free form additional data
2090
+ * @type {{ [key: string]: any; }}
2179
2091
  * @memberof RunnerUpdateRequest
2180
2092
  */
2181
- 'ownerName'?: string;
2093
+ 'additionalData'?: {
2094
+ [key: string]: any;
2095
+ };
2182
2096
  /**
2183
2097
  * the Solution name
2184
2098
  * @type {string}
@@ -2204,27 +2118,6 @@ export declare const RunnerValidationStatus: {
2204
2118
  readonly Validated: "Validated";
2205
2119
  };
2206
2120
  export type RunnerValidationStatus = typeof RunnerValidationStatus[keyof typeof RunnerValidationStatus];
2207
- /**
2208
- * Run Data to send
2209
- * @export
2210
- * @interface SendRunDataRequest
2211
- */
2212
- export interface SendRunDataRequest {
2213
- /**
2214
- *
2215
- * @type {string}
2216
- * @memberof SendRunDataRequest
2217
- */
2218
- 'id': string;
2219
- /**
2220
- *
2221
- * @type {Array<{ [key: string]: any; }>}
2222
- * @memberof SendRunDataRequest
2223
- */
2224
- 'data': Array<{
2225
- [key: string]: any;
2226
- }>;
2227
- }
2228
2121
  /**
2229
2122
  * A version of a Solution
2230
2123
  * @export
@@ -2623,11 +2516,13 @@ export interface Workspace {
2623
2516
  */
2624
2517
  'solution': WorkspaceSolution;
2625
2518
  /**
2626
- *
2627
- * @type {WorkspaceWebApp}
2519
+ * Free form additional data
2520
+ * @type {{ [key: string]: any; }}
2628
2521
  * @memberof Workspace
2629
2522
  */
2630
- 'webApp'?: WorkspaceWebApp;
2523
+ 'additionalData'?: {
2524
+ [key: string]: any;
2525
+ };
2631
2526
  /**
2632
2527
  * Activate the copy of dataset on scenario creation, meaning that each scenario created in this workspace will make this copy. when false, scenario use directly the dataset specified.
2633
2528
  * @type {boolean}
@@ -2703,11 +2598,13 @@ export interface WorkspaceCreateRequest {
2703
2598
  */
2704
2599
  'solution': WorkspaceSolution;
2705
2600
  /**
2706
- *
2707
- * @type {WorkspaceWebApp}
2601
+ * Free form additional data
2602
+ * @type {{ [key: string]: any; }}
2708
2603
  * @memberof WorkspaceCreateRequest
2709
2604
  */
2710
- 'webApp'?: WorkspaceWebApp;
2605
+ 'additionalData'?: {
2606
+ [key: string]: any;
2607
+ };
2711
2608
  /**
2712
2609
  * Activate the copy of dataset on scenario creation
2713
2610
  * @type {boolean}
@@ -2811,20 +2708,6 @@ export interface WorkspaceSolution {
2811
2708
  'defaultParameterValues'?: {
2812
2709
  [key: string]: string;
2813
2710
  };
2814
- /**
2815
- * The list of Solution Run Template Id to filter
2816
- * @type {Array<string>}
2817
- * @memberof WorkspaceSolution
2818
- */
2819
- 'runTemplateFilter'?: Array<string>;
2820
- /**
2821
- * A map of RunTemplateId/DatasetId to set a default dataset for a Run Template
2822
- * @type {{ [key: string]: any; }}
2823
- * @memberof WorkspaceSolution
2824
- */
2825
- 'defaultRunTemplateDataset'?: {
2826
- [key: string]: any;
2827
- };
2828
2711
  }
2829
2712
  /**
2830
2713
  * Request object for updating a workspace
@@ -2863,11 +2746,13 @@ export interface WorkspaceUpdateRequest {
2863
2746
  */
2864
2747
  'solution'?: WorkspaceSolution;
2865
2748
  /**
2866
- *
2867
- * @type {WorkspaceWebApp}
2749
+ * Free form additional data
2750
+ * @type {{ [key: string]: any; }}
2868
2751
  * @memberof WorkspaceUpdateRequest
2869
2752
  */
2870
- 'webApp'?: WorkspaceWebApp;
2753
+ 'additionalData'?: {
2754
+ [key: string]: any;
2755
+ };
2871
2756
  /**
2872
2757
  * Activate the copy of dataset on scenario creation
2873
2758
  * @type {boolean}
@@ -2875,35 +2760,6 @@ export interface WorkspaceUpdateRequest {
2875
2760
  */
2876
2761
  'datasetCopy'?: boolean;
2877
2762
  }
2878
- /**
2879
- * A Workspace Web Application
2880
- * @export
2881
- * @interface WorkspaceWebApp
2882
- */
2883
- export interface WorkspaceWebApp {
2884
- /**
2885
- * The Workspace Web Application URL
2886
- * @type {string}
2887
- * @memberof WorkspaceWebApp
2888
- */
2889
- 'url': string;
2890
- /**
2891
- * A map of iframeKey/iframeURL
2892
- * @type {{ [key: string]: any; }}
2893
- * @memberof WorkspaceWebApp
2894
- */
2895
- 'iframes'?: {
2896
- [key: string]: any;
2897
- };
2898
- /**
2899
- * free form options for Web Application
2900
- * @type {{ [key: string]: any; }}
2901
- * @memberof WorkspaceWebApp
2902
- */
2903
- 'options'?: {
2904
- [key: string]: any;
2905
- };
2906
- }
2907
2763
  /**
2908
2764
  * DatasetApi - axios parameter creator
2909
2765
  * @export
@@ -3053,20 +2909,25 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3053
2909
  listDatasets: (organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3054
2910
  /**
3055
2911
  *
3056
- * @summary Get data of a Dataset
2912
+ * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
3057
2913
  * @param {string} organizationId the Organization identifier
3058
2914
  * @param {string} workspaceId the Workspace identifier
3059
2915
  * @param {string} datasetId the Dataset identifier
3060
2916
  * @param {string} datasetPartId the Dataset part identifier
3061
- * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like: - id - stock - quantity - ...
3062
- * @param {Array<string>} [sums] Property names to sum by
3063
- * @param {Array<string>} [counts] Property names to count by
2917
+ * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
2918
+ * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
2919
+ * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
2920
+ * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
2921
+ * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
2922
+ * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3064
2923
  * @param {number} [offset] The query offset
3065
2924
  * @param {number} [limit] The query limit
2925
+ * @param {Array<string>} [groupBys] Column names to group by
2926
+ * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
3066
2927
  * @param {*} [options] Override http request option.
3067
2928
  * @throws {RequiredError}
3068
2929
  */
3069
- queryData: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2930
+ queryData: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3070
2931
  /**
3071
2932
  *
3072
2933
  * @summary Replace existing dataset parts of a Dataset
@@ -3302,20 +3163,25 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3302
3163
  listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
3303
3164
  /**
3304
3165
  *
3305
- * @summary Get data of a Dataset
3166
+ * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
3306
3167
  * @param {string} organizationId the Organization identifier
3307
3168
  * @param {string} workspaceId the Workspace identifier
3308
3169
  * @param {string} datasetId the Dataset identifier
3309
3170
  * @param {string} datasetPartId the Dataset part identifier
3310
- * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like: - id - stock - quantity - ...
3311
- * @param {Array<string>} [sums] Property names to sum by
3312
- * @param {Array<string>} [counts] Property names to count by
3171
+ * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
3172
+ * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
3173
+ * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3174
+ * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
3175
+ * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3176
+ * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3313
3177
  * @param {number} [offset] The query offset
3314
3178
  * @param {number} [limit] The query limit
3179
+ * @param {Array<string>} [groupBys] Column names to group by
3180
+ * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
3315
3181
  * @param {*} [options] Override http request option.
3316
3182
  * @throws {RequiredError}
3317
3183
  */
3318
- queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
3184
+ queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
3319
3185
  /**
3320
3186
  *
3321
3187
  * @summary Replace existing dataset parts of a Dataset
@@ -3551,20 +3417,25 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3551
3417
  listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Dataset>>;
3552
3418
  /**
3553
3419
  *
3554
- * @summary Get data of a Dataset
3420
+ * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
3555
3421
  * @param {string} organizationId the Organization identifier
3556
3422
  * @param {string} workspaceId the Workspace identifier
3557
3423
  * @param {string} datasetId the Dataset identifier
3558
3424
  * @param {string} datasetPartId the Dataset part identifier
3559
- * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like: - id - stock - quantity - ...
3560
- * @param {Array<string>} [sums] Property names to sum by
3561
- * @param {Array<string>} [counts] Property names to count by
3425
+ * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
3426
+ * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
3427
+ * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3428
+ * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
3429
+ * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3430
+ * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3562
3431
  * @param {number} [offset] The query offset
3563
3432
  * @param {number} [limit] The query limit
3433
+ * @param {Array<string>} [groupBys] Column names to group by
3434
+ * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
3564
3435
  * @param {*} [options] Override http request option.
3565
3436
  * @throws {RequiredError}
3566
3437
  */
3567
- queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<object>>;
3438
+ queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<File>;
3568
3439
  /**
3569
3440
  *
3570
3441
  * @summary Replace existing dataset parts of a Dataset
@@ -3815,21 +3686,26 @@ export declare class DatasetApi extends BaseAPI {
3815
3686
  listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
3816
3687
  /**
3817
3688
  *
3818
- * @summary Get data of a Dataset
3689
+ * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
3819
3690
  * @param {string} organizationId the Organization identifier
3820
3691
  * @param {string} workspaceId the Workspace identifier
3821
3692
  * @param {string} datasetId the Dataset identifier
3822
3693
  * @param {string} datasetPartId the Dataset part identifier
3823
- * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like: - id - stock - quantity - ...
3824
- * @param {Array<string>} [sums] Property names to sum by
3825
- * @param {Array<string>} [counts] Property names to count by
3694
+ * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
3695
+ * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
3696
+ * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3697
+ * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
3698
+ * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3699
+ * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a * at the end of the column name (e.g. stock*).
3826
3700
  * @param {number} [offset] The query offset
3827
3701
  * @param {number} [limit] The query limit
3702
+ * @param {Array<string>} [groupBys] Column names to group by
3703
+ * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
3828
3704
  * @param {*} [options] Override http request option.
3829
3705
  * @throws {RequiredError}
3830
3706
  * @memberof DatasetApi
3831
3707
  */
3832
- queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object[], any, {}>>;
3708
+ queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
3833
3709
  /**
3834
3710
  *
3835
3711
  * @summary Replace existing dataset parts of a Dataset
@@ -4559,30 +4435,6 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4559
4435
  * @throws {RequiredError}
4560
4436
  */
4561
4437
  listRuns: (organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4562
- /**
4563
- *
4564
- * @summary query the run data
4565
- * @param {string} organizationId the Organization identifier
4566
- * @param {string} workspaceId the Workspace identifier
4567
- * @param {string} runnerId the Runner identifier
4568
- * @param {string} runId the Run identifier
4569
- * @param {RunDataQuery} runDataQuery the query to run
4570
- * @param {*} [options] Override http request option.
4571
- * @throws {RequiredError}
4572
- */
4573
- queryRunData: (organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4574
- /**
4575
- *
4576
- * @summary Send data associated to a run
4577
- * @param {string} organizationId the Organization identifier
4578
- * @param {string} workspaceId the Workspace identifier
4579
- * @param {string} runnerId the Runner identifier
4580
- * @param {string} runId the Run identifier
4581
- * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
4582
- * @param {*} [options] Override http request option.
4583
- * @throws {RequiredError}
4584
- */
4585
- sendRunData: (organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4586
4438
  };
4587
4439
  /**
4588
4440
  * RunApi - functional programming interface
@@ -4645,30 +4497,6 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4645
4497
  * @throws {RequiredError}
4646
4498
  */
4647
4499
  listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Run>>>;
4648
- /**
4649
- *
4650
- * @summary query the run data
4651
- * @param {string} organizationId the Organization identifier
4652
- * @param {string} workspaceId the Workspace identifier
4653
- * @param {string} runnerId the Runner identifier
4654
- * @param {string} runId the Run identifier
4655
- * @param {RunDataQuery} runDataQuery the query to run
4656
- * @param {*} [options] Override http request option.
4657
- * @throws {RequiredError}
4658
- */
4659
- queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
4660
- /**
4661
- *
4662
- * @summary Send data associated to a run
4663
- * @param {string} organizationId the Organization identifier
4664
- * @param {string} workspaceId the Workspace identifier
4665
- * @param {string} runnerId the Runner identifier
4666
- * @param {string} runId the Run identifier
4667
- * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
4668
- * @param {*} [options] Override http request option.
4669
- * @throws {RequiredError}
4670
- */
4671
- sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunData>>;
4672
4500
  };
4673
4501
  /**
4674
4502
  * RunApi - factory interface
@@ -4731,30 +4559,6 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4731
4559
  * @throws {RequiredError}
4732
4560
  */
4733
4561
  listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Run>>;
4734
- /**
4735
- *
4736
- * @summary query the run data
4737
- * @param {string} organizationId the Organization identifier
4738
- * @param {string} workspaceId the Workspace identifier
4739
- * @param {string} runnerId the Runner identifier
4740
- * @param {string} runId the Run identifier
4741
- * @param {RunDataQuery} runDataQuery the query to run
4742
- * @param {*} [options] Override http request option.
4743
- * @throws {RequiredError}
4744
- */
4745
- queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
4746
- /**
4747
- *
4748
- * @summary Send data associated to a run
4749
- * @param {string} organizationId the Organization identifier
4750
- * @param {string} workspaceId the Workspace identifier
4751
- * @param {string} runnerId the Runner identifier
4752
- * @param {string} runId the Run identifier
4753
- * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
4754
- * @param {*} [options] Override http request option.
4755
- * @throws {RequiredError}
4756
- */
4757
- sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunData>;
4758
4562
  };
4759
4563
  /**
4760
4564
  * RunApi - object-oriented interface
@@ -4824,32 +4628,6 @@ export declare class RunApi extends BaseAPI {
4824
4628
  * @memberof RunApi
4825
4629
  */
4826
4630
  listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Run[], any, {}>>;
4827
- /**
4828
- *
4829
- * @summary query the run data
4830
- * @param {string} organizationId the Organization identifier
4831
- * @param {string} workspaceId the Workspace identifier
4832
- * @param {string} runnerId the Runner identifier
4833
- * @param {string} runId the Run identifier
4834
- * @param {RunDataQuery} runDataQuery the query to run
4835
- * @param {*} [options] Override http request option.
4836
- * @throws {RequiredError}
4837
- * @memberof RunApi
4838
- */
4839
- queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryResult, any, {}>>;
4840
- /**
4841
- *
4842
- * @summary Send data associated to a run
4843
- * @param {string} organizationId the Organization identifier
4844
- * @param {string} workspaceId the Workspace identifier
4845
- * @param {string} runnerId the Runner identifier
4846
- * @param {string} runId the Run identifier
4847
- * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
4848
- * @param {*} [options] Override http request option.
4849
- * @throws {RequiredError}
4850
- * @memberof RunApi
4851
- */
4852
- sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunData, any, {}>>;
4853
4631
  }
4854
4632
  /**
4855
4633
  * RunnerApi - axios parameter creator