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

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/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.0-rc1
5
+ * The version of the OpenAPI document: 5.0.0-rc3
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,426 +15,217 @@ import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
16
  /**
17
17
  * Misc information about the api
18
- * @export
19
- * @interface AboutInfo
20
18
  */
21
19
  export interface AboutInfo {
22
- /**
23
- *
24
- * @type {AboutInfoVersion}
25
- * @memberof AboutInfo
26
- */
27
20
  'version': AboutInfoVersion;
28
21
  }
29
22
  /**
30
23
  * API version details
31
- * @export
32
- * @interface AboutInfoVersion
33
24
  */
34
25
  export interface AboutInfoVersion {
35
26
  /**
36
27
  * Full version representation
37
- * @type {string}
38
- * @memberof AboutInfoVersion
39
28
  */
40
29
  'full': string;
41
30
  /**
42
31
  * Release main version representation
43
- * @type {string}
44
- * @memberof AboutInfoVersion
45
32
  */
46
33
  'release': string;
47
34
  /**
48
35
  * Major version number
49
- * @type {number}
50
- * @memberof AboutInfoVersion
51
36
  */
52
37
  'major': number;
53
38
  /**
54
39
  * Minor version number
55
- * @type {number}
56
- * @memberof AboutInfoVersion
57
40
  */
58
41
  'minor': number;
59
42
  /**
60
43
  * Patch version number
61
- * @type {number}
62
- * @memberof AboutInfoVersion
63
44
  */
64
45
  'patch': number;
65
46
  /**
66
47
  * Label version, may be empty
67
- * @type {string}
68
- * @memberof AboutInfoVersion
69
48
  */
70
49
  'label': string;
71
50
  /**
72
51
  * Build VCS id
73
- * @type {string}
74
- * @memberof AboutInfoVersion
75
52
  */
76
53
  'build': string;
77
54
  }
78
55
  /**
79
56
  * A RBAC by component
80
- * @export
81
- * @interface ComponentRolePermissions
82
57
  */
83
58
  export interface ComponentRolePermissions {
84
- /**
85
- *
86
- * @type {string}
87
- * @memberof ComponentRolePermissions
88
- */
89
59
  'component': string;
90
- /**
91
- *
92
- * @type {{ [key: string]: Array<string>; }}
93
- * @memberof ComponentRolePermissions
94
- */
95
60
  'roles': {
96
61
  [key: string]: Array<string>;
97
62
  };
98
63
  }
99
64
  /**
100
65
  * define cpus and memory needs
101
- * @export
102
- * @interface ContainerResourceSizeInfo
103
66
  */
104
67
  export interface ContainerResourceSizeInfo {
105
68
  /**
106
69
  * define cpu needs
107
- * @type {string}
108
- * @memberof ContainerResourceSizeInfo
109
70
  */
110
71
  'cpu': string;
111
72
  /**
112
73
  * define memory needs
113
- * @type {string}
114
- * @memberof ContainerResourceSizeInfo
115
74
  */
116
75
  'memory': string;
117
76
  }
118
77
  /**
119
78
  * a description object for resource requests and limits (default same configuration as basic sizing)
120
- * @export
121
- * @interface ContainerResourceSizing
122
79
  */
123
80
  export interface ContainerResourceSizing {
124
- /**
125
- *
126
- * @type {ContainerResourceSizeInfo}
127
- * @memberof ContainerResourceSizing
128
- */
129
81
  'requests': ContainerResourceSizeInfo;
130
- /**
131
- *
132
- * @type {ContainerResourceSizeInfo}
133
- * @memberof ContainerResourceSizing
134
- */
135
82
  'limits': ContainerResourceSizeInfo;
136
83
  }
137
84
  /**
138
85
  * Newly created Run info
139
- * @export
140
- * @interface CreatedRun
141
86
  */
142
87
  export interface CreatedRun {
143
88
  /**
144
89
  * Run id
145
- * @type {string}
146
- * @memberof CreatedRun
147
90
  */
148
91
  'id': string;
149
92
  }
150
93
  /**
151
94
  * Dataset object
152
- * @export
153
- * @interface Dataset
154
95
  */
155
96
  export interface Dataset {
156
- /**
157
- *
158
- * @type {string}
159
- * @memberof Dataset
160
- */
161
97
  'id': string;
162
- /**
163
- *
164
- * @type {string}
165
- * @memberof Dataset
166
- */
167
98
  'name': string;
168
- /**
169
- *
170
- * @type {string}
171
- * @memberof Dataset
172
- */
173
99
  'description'?: string;
174
100
  /**
175
101
  * the associated Organization Id
176
- * @type {string}
177
- * @memberof Dataset
178
102
  */
179
103
  'organizationId': string;
180
104
  /**
181
105
  * the associated Workspace Id
182
- * @type {string}
183
- * @memberof Dataset
184
106
  */
185
107
  'workspaceId': string;
186
108
  /**
187
109
  * the list of tags
188
- * @type {Array<string>}
189
- * @memberof Dataset
190
110
  */
191
111
  'tags': Array<string>;
192
112
  /**
193
113
  * Free form additional data
194
- * @type {{ [key: string]: any; }}
195
- * @memberof Dataset
196
114
  */
197
115
  'additionalData'?: {
198
116
  [key: string]: any;
199
117
  };
200
- /**
201
- *
202
- * @type {Array<DatasetPart>}
203
- * @memberof Dataset
204
- */
205
118
  'parts': Array<DatasetPart>;
206
119
  /**
207
120
  * The details of the Dataset creation
208
- * @type {DatasetEditInfo}
209
- * @memberof Dataset
210
121
  */
211
122
  'createInfo': DatasetEditInfo;
212
123
  /**
213
124
  * The details of the Dataset last update
214
- * @type {DatasetEditInfo}
215
- * @memberof Dataset
216
125
  */
217
126
  'updateInfo': DatasetEditInfo;
218
- /**
219
- *
220
- * @type {DatasetSecurity}
221
- * @memberof Dataset
222
- */
223
127
  'security': DatasetSecurity;
224
128
  }
225
129
  /**
226
130
  * a Dataset access control item
227
- * @export
228
- * @interface DatasetAccessControl
229
131
  */
230
132
  export interface DatasetAccessControl {
231
133
  /**
232
134
  * the identity id
233
- * @type {string}
234
- * @memberof DatasetAccessControl
235
135
  */
236
136
  'id': string;
237
137
  /**
238
138
  * a role
239
- * @type {string}
240
- * @memberof DatasetAccessControl
241
139
  */
242
140
  'role': string;
243
141
  }
244
142
  /**
245
143
  * Dataset creation request
246
- * @export
247
- * @interface DatasetCreateRequest
248
144
  */
249
145
  export interface DatasetCreateRequest {
250
- /**
251
- *
252
- * @type {string}
253
- * @memberof DatasetCreateRequest
254
- */
255
146
  'name': string;
256
- /**
257
- *
258
- * @type {string}
259
- * @memberof DatasetCreateRequest
260
- */
261
147
  'description'?: string;
262
- /**
263
- *
264
- * @type {Array<string>}
265
- * @memberof DatasetCreateRequest
266
- */
267
148
  'tags'?: Array<string>;
268
149
  /**
269
150
  * Free form additional data
270
- * @type {{ [key: string]: any; }}
271
- * @memberof DatasetCreateRequest
272
151
  */
273
152
  'additionalData'?: {
274
153
  [key: string]: any;
275
154
  };
276
- /**
277
- *
278
- * @type {Array<DatasetPartCreateRequest>}
279
- * @memberof DatasetCreateRequest
280
- */
281
155
  'parts'?: Array<DatasetPartCreateRequest>;
282
- /**
283
- *
284
- * @type {DatasetSecurity}
285
- * @memberof DatasetCreateRequest
286
- */
287
156
  'security'?: DatasetSecurity;
288
157
  }
289
- /**
290
- *
291
- * @export
292
- * @interface DatasetEditInfo
293
- */
294
158
  export interface DatasetEditInfo {
295
159
  /**
296
160
  * The timestamp of the modification in millisecond
297
- * @type {number}
298
- * @memberof DatasetEditInfo
299
161
  */
300
162
  'timestamp': number;
301
163
  /**
302
164
  * The id of the user who did the modification
303
- * @type {string}
304
- * @memberof DatasetEditInfo
305
165
  */
306
166
  'userId': string;
307
167
  }
308
168
  /**
309
169
  * Dataset part object
310
- * @export
311
- * @interface DatasetPart
312
170
  */
313
171
  export interface DatasetPart {
314
- /**
315
- *
316
- * @type {string}
317
- * @memberof DatasetPart
318
- */
319
172
  'id': string;
320
- /**
321
- *
322
- * @type {string}
323
- * @memberof DatasetPart
324
- */
325
173
  'name': string;
326
174
  /**
327
175
  * the source data name (e.g. filename associated to the dataset part)
328
- * @type {string}
329
- * @memberof DatasetPart
330
176
  */
331
177
  'sourceName': string;
332
- /**
333
- *
334
- * @type {string}
335
- * @memberof DatasetPart
336
- */
337
178
  'description'?: string;
338
- /**
339
- *
340
- * @type {Array<string>}
341
- * @memberof DatasetPart
342
- */
343
179
  'tags': Array<string>;
344
180
  /**
345
181
  * Free form additional data
346
- * @type {{ [key: string]: any; }}
347
- * @memberof DatasetPart
348
182
  */
349
183
  'additionalData'?: {
350
184
  [key: string]: any;
351
185
  };
352
- /**
353
- *
354
- * @type {DatasetPartTypeEnum}
355
- * @memberof DatasetPart
356
- */
357
186
  'type': DatasetPartTypeEnum;
358
187
  /**
359
188
  * the associated Organization Id
360
- * @type {string}
361
- * @memberof DatasetPart
362
189
  */
363
190
  'organizationId': string;
364
191
  /**
365
192
  * the associated Workspace Id
366
- * @type {string}
367
- * @memberof DatasetPart
368
193
  */
369
194
  'workspaceId': string;
370
195
  /**
371
196
  * the associated Dataset Id
372
- * @type {string}
373
- * @memberof DatasetPart
374
197
  */
375
198
  'datasetId': string;
376
199
  /**
377
200
  * The details of the Dataset creation
378
- * @type {DatasetEditInfo}
379
- * @memberof DatasetPart
380
201
  */
381
202
  'createInfo': DatasetEditInfo;
382
203
  /**
383
204
  * The details of the Dataset last update
384
- * @type {DatasetEditInfo}
385
- * @memberof DatasetPart
386
205
  */
387
206
  'updateInfo': DatasetEditInfo;
388
207
  }
389
208
  /**
390
209
  * Dataset part create request object
391
- * @export
392
- * @interface DatasetPartCreateRequest
393
210
  */
394
211
  export interface DatasetPartCreateRequest {
395
- /**
396
- *
397
- * @type {string}
398
- * @memberof DatasetPartCreateRequest
399
- */
400
212
  'name': string;
401
213
  /**
402
214
  * the source data name (e.g. filename associated to the dataset part)
403
- * @type {string}
404
- * @memberof DatasetPartCreateRequest
405
215
  */
406
216
  'sourceName': string;
407
- /**
408
- *
409
- * @type {string}
410
- * @memberof DatasetPartCreateRequest
411
- */
412
217
  'description'?: string;
413
- /**
414
- *
415
- * @type {Array<string>}
416
- * @memberof DatasetPartCreateRequest
417
- */
418
218
  'tags'?: Array<string>;
419
219
  /**
420
220
  * Free form additional data
421
- * @type {{ [key: string]: any; }}
422
- * @memberof DatasetPartCreateRequest
423
221
  */
424
222
  'additionalData'?: {
425
223
  [key: string]: any;
426
224
  };
427
- /**
428
- *
429
- * @type {DatasetPartTypeEnum}
430
- * @memberof DatasetPartCreateRequest
431
- */
432
225
  'type'?: DatasetPartTypeEnum;
433
226
  }
434
227
  /**
435
228
  * The dataset part Type
436
- * @export
437
- * @enum {string}
438
229
  */
439
230
  export declare const DatasetPartTypeEnum: {
440
231
  readonly File: "File";
@@ -443,32 +234,16 @@ export declare const DatasetPartTypeEnum: {
443
234
  export type DatasetPartTypeEnum = typeof DatasetPartTypeEnum[keyof typeof DatasetPartTypeEnum];
444
235
  /**
445
236
  * Dataset part update request object
446
- * @export
447
- * @interface DatasetPartUpdateRequest
448
237
  */
449
238
  export interface DatasetPartUpdateRequest {
450
239
  /**
451
240
  * the source data name (e.g. filename associated to the dataset part)
452
- * @type {string}
453
- * @memberof DatasetPartUpdateRequest
454
241
  */
455
242
  'sourceName'?: string;
456
- /**
457
- *
458
- * @type {string}
459
- * @memberof DatasetPartUpdateRequest
460
- */
461
243
  'description'?: string;
462
- /**
463
- *
464
- * @type {Array<string>}
465
- * @memberof DatasetPartUpdateRequest
466
- */
467
244
  'tags'?: Array<string>;
468
245
  /**
469
246
  * Free form additional data
470
- * @type {{ [key: string]: any; }}
471
- * @memberof DatasetPartUpdateRequest
472
247
  */
473
248
  'additionalData'?: {
474
249
  [key: string]: any;
@@ -476,97 +251,51 @@ export interface DatasetPartUpdateRequest {
476
251
  }
477
252
  /**
478
253
  * the Dataset Role
479
- * @export
480
- * @interface DatasetRole
481
254
  */
482
255
  export interface DatasetRole {
483
256
  /**
484
257
  * the Dataset Role
485
- * @type {string}
486
- * @memberof DatasetRole
487
258
  */
488
259
  'role': string;
489
260
  }
490
261
  /**
491
262
  * the dataset security information
492
- * @export
493
- * @interface DatasetSecurity
494
263
  */
495
264
  export interface DatasetSecurity {
496
265
  /**
497
266
  * the role by default
498
- * @type {string}
499
- * @memberof DatasetSecurity
500
267
  */
501
268
  'default': string;
502
269
  /**
503
270
  * the list which can access this Dataset with detailed access control information
504
- * @type {Array<DatasetAccessControl>}
505
- * @memberof DatasetSecurity
506
271
  */
507
272
  'accessControlList': Array<DatasetAccessControl>;
508
273
  }
509
274
  /**
510
275
  * Dataset creation request
511
- * @export
512
- * @interface DatasetUpdateRequest
513
276
  */
514
277
  export interface DatasetUpdateRequest {
515
- /**
516
- *
517
- * @type {string}
518
- * @memberof DatasetUpdateRequest
519
- */
520
278
  'name'?: string;
521
- /**
522
- *
523
- * @type {string}
524
- * @memberof DatasetUpdateRequest
525
- */
526
279
  'description'?: string;
527
- /**
528
- *
529
- * @type {Array<string>}
530
- * @memberof DatasetUpdateRequest
531
- */
532
280
  'tags'?: Array<string>;
533
281
  /**
534
282
  * Free form additional data
535
- * @type {{ [key: string]: any; }}
536
- * @memberof DatasetUpdateRequest
537
283
  */
538
284
  'additionalData'?: {
539
285
  [key: string]: any;
540
286
  };
541
- /**
542
- *
543
- * @type {Array<DatasetPartCreateRequest>}
544
- * @memberof DatasetUpdateRequest
545
- */
546
287
  'parts'?: Array<DatasetPartCreateRequest>;
547
- /**
548
- *
549
- * @type {DatasetSecurity}
550
- * @memberof DatasetUpdateRequest
551
- */
552
- 'security'?: DatasetSecurity;
553
288
  }
554
289
  /**
555
290
  * last run info from current runner
556
- * @export
557
- * @interface LastRunInfo
558
291
  */
559
292
  export interface LastRunInfo {
560
293
  /**
561
294
  * last run id from current runner
562
- * @type {string}
563
- * @memberof LastRunInfo
564
295
  */
565
296
  'lastRunId'?: string;
566
297
  /**
567
298
  * last run status from current runner
568
- * @type {string}
569
- * @memberof LastRunInfo
570
299
  */
571
300
  'lastRunStatus'?: LastRunInfoLastRunStatusEnum;
572
301
  }
@@ -580,396 +309,252 @@ export declare const LastRunInfoLastRunStatusEnum: {
580
309
  export type LastRunInfoLastRunStatusEnum = typeof LastRunInfoLastRunStatusEnum[keyof typeof LastRunInfoLastRunStatusEnum];
581
310
  /**
582
311
  * An Organization
583
- * @export
584
- * @interface Organization
585
312
  */
586
313
  export interface Organization {
587
314
  /**
588
315
  * The Organization unique identifier
589
- * @type {string}
590
- * @memberof Organization
591
316
  */
592
317
  'id': string;
593
318
  /**
594
319
  * The Organization name
595
- * @type {string}
596
- * @memberof Organization
597
320
  */
598
321
  'name': string;
599
322
  /**
600
323
  * The details of the Organization creation
601
- * @type {OrganizationEditInfo}
602
- * @memberof Organization
603
324
  */
604
325
  'createInfo': OrganizationEditInfo;
605
326
  /**
606
327
  * The details of the Organization last update
607
- * @type {OrganizationEditInfo}
608
- * @memberof Organization
609
328
  */
610
329
  'updateInfo': OrganizationEditInfo;
611
- /**
612
- *
613
- * @type {OrganizationSecurity}
614
- * @memberof Organization
615
- */
616
330
  'security': OrganizationSecurity;
617
331
  }
618
332
  /**
619
333
  * Response object for organization access control
620
- * @export
621
- * @interface OrganizationAccessControl
622
334
  */
623
335
  export interface OrganizationAccessControl {
624
336
  /**
625
337
  * The identity id
626
- * @type {string}
627
- * @memberof OrganizationAccessControl
628
338
  */
629
339
  'id': string;
630
340
  /**
631
341
  * A role
632
- * @type {string}
633
- * @memberof OrganizationAccessControl
634
342
  */
635
343
  'role': string;
636
344
  }
637
345
  /**
638
346
  * Request object for creating a new organization
639
- * @export
640
- * @interface OrganizationCreateRequest
641
347
  */
642
348
  export interface OrganizationCreateRequest {
643
349
  /**
644
350
  * The Organization name
645
- * @type {string}
646
- * @memberof OrganizationCreateRequest
647
351
  */
648
352
  'name': string;
649
- /**
650
- *
651
- * @type {OrganizationSecurity}
652
- * @memberof OrganizationCreateRequest
653
- */
654
353
  'security'?: OrganizationSecurity;
655
354
  }
656
- /**
657
- *
658
- * @export
659
- * @interface OrganizationEditInfo
660
- */
661
355
  export interface OrganizationEditInfo {
662
356
  /**
663
357
  * The timestamp of the modification in millisecond
664
- * @type {number}
665
- * @memberof OrganizationEditInfo
666
358
  */
667
359
  'timestamp': number;
668
360
  /**
669
361
  * The id of the user who did the modification
670
- * @type {string}
671
- * @memberof OrganizationEditInfo
672
362
  */
673
363
  'userId': string;
674
364
  }
675
365
  /**
676
366
  * The Organization Role
677
- * @export
678
- * @interface OrganizationRole
679
367
  */
680
368
  export interface OrganizationRole {
681
369
  /**
682
370
  * The Organization Role
683
- * @type {string}
684
- * @memberof OrganizationRole
685
371
  */
686
372
  'role': string;
687
373
  }
688
374
  /**
689
375
  * Response object for organization security information
690
- * @export
691
- * @interface OrganizationSecurity
692
376
  */
693
377
  export interface OrganizationSecurity {
694
378
  /**
695
379
  * The role by default
696
- * @type {string}
697
- * @memberof OrganizationSecurity
698
380
  */
699
381
  'default': string;
700
382
  /**
701
383
  * The list which can access this Organization with detailed access control information
702
- * @type {Array<OrganizationAccessControl>}
703
- * @memberof OrganizationSecurity
704
384
  */
705
385
  'accessControlList': Array<OrganizationAccessControl>;
706
386
  }
707
387
  /**
708
388
  * Request object for updating an organization
709
- * @export
710
- * @interface OrganizationUpdateRequest
711
389
  */
712
390
  export interface OrganizationUpdateRequest {
713
391
  /**
714
392
  * The Organization name
715
- * @type {string}
716
- * @memberof OrganizationUpdateRequest
717
393
  */
718
394
  'name'?: string;
719
395
  }
720
396
  /**
721
397
  * define cpus and memory needs
722
- * @export
723
- * @interface ResourceSizeInfo
724
398
  */
725
399
  export interface ResourceSizeInfo {
726
400
  /**
727
401
  * define cpu needs
728
- * @type {string}
729
- * @memberof ResourceSizeInfo
730
402
  */
731
403
  'cpu': string;
732
404
  /**
733
405
  * define memory needs
734
- * @type {string}
735
- * @memberof ResourceSizeInfo
736
406
  */
737
407
  'memory': string;
738
408
  }
739
409
  /**
740
410
  * a Run with only base properties
741
- * @export
742
- * @interface Run
743
411
  */
744
412
  export interface Run {
745
413
  /**
746
414
  * the Run
747
- * @type {string}
748
- * @memberof Run
749
415
  */
750
416
  'id'?: string;
751
- /**
752
- *
753
- * @type {RunState}
754
- * @memberof Run
755
- */
756
417
  'state'?: RunState;
757
418
  /**
758
419
  * the Organization id
759
- * @type {string}
760
- * @memberof Run
761
420
  */
762
421
  'organizationId'?: string;
763
422
  /**
764
423
  * The details of the Run creation
765
- * @type {RunEditInfo}
766
- * @memberof Run
767
424
  */
768
425
  'createInfo': RunEditInfo;
769
426
  /**
770
427
  * the Cosmo Tech compute cluster Argo Workflow Id to search
771
- * @type {string}
772
- * @memberof Run
773
428
  */
774
429
  'workflowId'?: string;
775
430
  /**
776
431
  * the Cosmo Tech Simulation Run Id
777
- * @type {string}
778
- * @memberof Run
779
432
  */
780
433
  'csmSimulationRun'?: string;
781
434
  /**
782
435
  * the base name for workflow name generation
783
- * @type {string}
784
- * @memberof Run
785
436
  */
786
437
  'generateName'?: string;
787
438
  /**
788
439
  * the Cosmo Tech compute cluster Argo Workflow Name
789
- * @type {string}
790
- * @memberof Run
791
440
  */
792
441
  'workflowName'?: string;
793
442
  /**
794
443
  * the Workspace Id
795
- * @type {string}
796
- * @memberof Run
797
444
  */
798
445
  'workspaceId'?: string;
799
446
  /**
800
447
  * technical key for resource name convention and version grouping. Must be unique
801
- * @type {string}
802
- * @memberof Run
803
448
  */
804
449
  'workspaceKey'?: string;
805
450
  /**
806
451
  * the Runner Id
807
- * @type {string}
808
- * @memberof Run
809
452
  */
810
453
  'runnerId'?: string;
811
454
  /**
812
455
  * the Solution Id
813
- * @type {string}
814
- * @memberof Run
815
456
  */
816
457
  'solutionId'?: string;
817
458
  /**
818
459
  * the Solution Run Template id
819
- * @type {string}
820
- * @memberof Run
821
460
  */
822
461
  'runTemplateId'?: string;
823
462
  /**
824
463
  * the compute size needed for this Analysis. Standard sizes are basic and highcpu. Default is basic
825
- * @type {string}
826
- * @memberof Run
827
464
  */
828
465
  'computeSize'?: string;
829
466
  /**
830
467
  * the list of Dataset Id associated to this Run
831
- * @type {Array<string>}
832
- * @memberof Run
833
468
  */
834
469
  'datasetList'?: Array<string>;
835
470
  /**
836
471
  * the list of Run Template parameters values
837
- * @type {Array<RunTemplateParameterValue>}
838
- * @memberof Run
839
472
  */
840
473
  'parametersValues'?: Array<RunTemplateParameterValue>;
841
474
  /**
842
475
  * the node label request
843
- * @type {string}
844
- * @memberof Run
845
476
  */
846
477
  'nodeLabel'?: string;
847
478
  /**
848
479
  * the containers list. This information is not returned by the API.
849
- * @type {Array<RunContainer>}
850
- * @memberof Run
851
480
  */
852
481
  'containers'?: Array<RunContainer>;
853
482
  }
854
483
  /**
855
484
  * a Run container description
856
- * @export
857
- * @interface RunContainer
858
485
  */
859
486
  export interface RunContainer {
860
487
  /**
861
488
  * the container Id
862
- * @type {string}
863
- * @memberof RunContainer
864
489
  */
865
490
  'id'?: string;
866
491
  /**
867
492
  * the container name
868
- * @type {string}
869
- * @memberof RunContainer
870
493
  */
871
494
  'name': string;
872
495
  /**
873
496
  * the metadata labels
874
- * @type {{ [key: string]: string; }}
875
- * @memberof RunContainer
876
497
  */
877
498
  'labels'?: {
878
499
  [key: string]: string;
879
500
  };
880
501
  /**
881
502
  * environment variable map
882
- * @type {{ [key: string]: string; }}
883
- * @memberof RunContainer
884
503
  */
885
504
  'envVars'?: {
886
505
  [key: string]: string;
887
506
  };
888
507
  /**
889
508
  * the container image URI
890
- * @type {string}
891
- * @memberof RunContainer
892
509
  */
893
510
  'image': string;
894
511
  /**
895
512
  * the container entry point
896
- * @type {string}
897
- * @memberof RunContainer
898
513
  */
899
514
  'entrypoint'?: string;
900
515
  /**
901
516
  * the list of run arguments for the container
902
- * @type {Array<string>}
903
- * @memberof RunContainer
904
517
  */
905
518
  'runArgs'?: Array<string>;
906
519
  /**
907
520
  * the list of dependencies container name to run this container
908
- * @type {Array<string>}
909
- * @memberof RunContainer
910
521
  */
911
522
  'dependencies'?: Array<string>;
912
523
  /**
913
524
  * whether or not this container is a Cosmo Tech solution container
914
- * @type {boolean}
915
- * @memberof RunContainer
916
525
  */
917
526
  'solutionContainer'?: boolean;
918
527
  /**
919
528
  * the node label request
920
- * @type {string}
921
- * @memberof RunContainer
922
529
  */
923
530
  'nodeLabel'?: string;
924
- /**
925
- *
926
- * @type {ContainerResourceSizing}
927
- * @memberof RunContainer
928
- */
929
531
  'runSizing'?: ContainerResourceSizing;
930
532
  }
931
- /**
932
- *
933
- * @export
934
- * @interface RunEditInfo
935
- */
936
533
  export interface RunEditInfo {
937
534
  /**
938
535
  * The timestamp of the modification in millisecond
939
- * @type {number}
940
- * @memberof RunEditInfo
941
536
  */
942
537
  'timestamp': number;
943
538
  /**
944
539
  * The id of the user who did the modification
945
- * @type {string}
946
- * @memberof RunEditInfo
947
540
  */
948
541
  'userId': string;
949
542
  }
950
543
  /**
951
544
  * the memory and CPU requested by the pod
952
- * @export
953
- * @interface RunResourceRequested
954
545
  */
955
546
  export interface RunResourceRequested {
956
547
  /**
957
548
  * the cpu requested
958
- * @type {number}
959
- * @memberof RunResourceRequested
960
549
  */
961
550
  'cpu'?: number;
962
551
  /**
963
552
  * the memory requested
964
- * @type {number}
965
- * @memberof RunResourceRequested
966
553
  */
967
554
  'memory'?: number;
968
555
  }
969
556
  /**
970
557
  * the Run end-to-end state
971
- * @export
972
- * @enum {string}
973
558
  */
974
559
  export declare const RunState: {
975
560
  readonly Running: "Running";
@@ -981,360 +566,232 @@ export declare const RunState: {
981
566
  export type RunState = typeof RunState[keyof typeof RunState];
982
567
  /**
983
568
  * a Run status
984
- * @export
985
- * @interface RunStatus
986
569
  */
987
570
  export interface RunStatus {
988
571
  /**
989
572
  * the Run id
990
- * @type {string}
991
- * @memberof RunStatus
992
573
  */
993
574
  'id'?: string;
994
575
  /**
995
576
  * the Organization id
996
- * @type {string}
997
- * @memberof RunStatus
998
577
  */
999
578
  'organizationId'?: string;
1000
579
  /**
1001
580
  * the Workspace id
1002
- * @type {string}
1003
- * @memberof RunStatus
1004
581
  */
1005
582
  'workspaceId'?: string;
1006
583
  /**
1007
584
  * the Runner id
1008
- * @type {string}
1009
- * @memberof RunStatus
1010
585
  */
1011
586
  'runnerId'?: string;
1012
587
  /**
1013
588
  * the Cosmo Tech compute cluster Argo Workflow Id to search
1014
- * @type {string}
1015
- * @memberof RunStatus
1016
589
  */
1017
590
  'workflowId'?: string;
1018
591
  /**
1019
592
  * the Cosmo Tech compute cluster Argo Workflow Name
1020
- * @type {string}
1021
- * @memberof RunStatus
1022
593
  */
1023
594
  'workflowName'?: string;
1024
595
  /**
1025
596
  * The timestamp of the Run creation in milliseconds
1026
- * @type {RunEditInfo}
1027
- * @memberof RunStatus
1028
597
  */
1029
598
  'createInfo'?: RunEditInfo;
1030
599
  /**
1031
600
  * the Run start Date Time
1032
- * @type {string}
1033
- * @memberof RunStatus
1034
601
  */
1035
602
  'startTime'?: string;
1036
603
  /**
1037
604
  * the Run end Date Time
1038
- * @type {string}
1039
- * @memberof RunStatus
1040
605
  */
1041
606
  'endTime'?: string;
1042
607
  /**
1043
608
  * high-level summary of where the workflow is in its lifecycle
1044
- * @type {string}
1045
- * @memberof RunStatus
1046
609
  */
1047
610
  'phase'?: string;
1048
611
  /**
1049
612
  * progress to completion
1050
- * @type {string}
1051
- * @memberof RunStatus
1052
613
  */
1053
614
  'progress'?: string;
1054
615
  /**
1055
616
  * a human readable message indicating details about why the workflow is in this condition
1056
- * @type {string}
1057
- * @memberof RunStatus
1058
617
  */
1059
618
  'message'?: string;
1060
619
  /**
1061
620
  * estimatedDuration in seconds
1062
- * @type {number}
1063
- * @memberof RunStatus
1064
621
  */
1065
622
  'estimatedDuration'?: number;
1066
623
  /**
1067
624
  * status of Run nodes
1068
- * @type {Array<RunStatusNode>}
1069
- * @memberof RunStatus
1070
625
  */
1071
626
  'nodes'?: Array<RunStatusNode>;
1072
- /**
1073
- *
1074
- * @type {RunState}
1075
- * @memberof RunStatus
1076
- */
1077
627
  'state'?: RunState;
1078
628
  }
1079
629
  /**
1080
630
  * status of a Run Node
1081
- * @export
1082
- * @interface RunStatusNode
1083
631
  */
1084
632
  export interface RunStatusNode {
1085
633
  /**
1086
634
  * the node id
1087
- * @type {string}
1088
- * @memberof RunStatusNode
1089
635
  */
1090
636
  'id'?: string;
1091
637
  /**
1092
638
  * the node unique name
1093
- * @type {string}
1094
- * @memberof RunStatusNode
1095
639
  */
1096
640
  'name'?: string;
1097
641
  /**
1098
642
  * the Run container name
1099
- * @type {string}
1100
- * @memberof RunStatusNode
1101
643
  */
1102
644
  'containerName'?: string;
1103
645
  /**
1104
646
  * the list of outbound nodes
1105
- * @type {Array<string>}
1106
- * @memberof RunStatusNode
1107
647
  */
1108
648
  'outboundNodes'?: Array<string>;
1109
- /**
1110
- *
1111
- * @type {RunResourceRequested}
1112
- * @memberof RunStatusNode
1113
- */
1114
649
  'resourcesDuration'?: RunResourceRequested;
1115
650
  /**
1116
651
  * estimatedDuration in seconds
1117
- * @type {number}
1118
- * @memberof RunStatusNode
1119
652
  */
1120
653
  'estimatedDuration'?: number;
1121
654
  /**
1122
655
  * HostNodeName name of the Kubernetes node on which the Pod is running, if applicable
1123
- * @type {string}
1124
- * @memberof RunStatusNode
1125
656
  */
1126
657
  'hostNodeName'?: string;
1127
658
  /**
1128
659
  * a human readable message indicating details about why the node is in this condition
1129
- * @type {string}
1130
- * @memberof RunStatusNode
1131
660
  */
1132
661
  'message'?: string;
1133
662
  /**
1134
663
  * high-level summary of where the node is in its lifecycle
1135
- * @type {string}
1136
- * @memberof RunStatusNode
1137
664
  */
1138
665
  'phase'?: string;
1139
666
  /**
1140
667
  * progress to completion
1141
- * @type {string}
1142
- * @memberof RunStatusNode
1143
668
  */
1144
669
  'progress'?: string;
1145
670
  /**
1146
671
  * the node start time
1147
- * @type {string}
1148
- * @memberof RunStatusNode
1149
672
  */
1150
673
  'startTime'?: string;
1151
674
  /**
1152
675
  * the node end time
1153
- * @type {string}
1154
- * @memberof RunStatusNode
1155
676
  */
1156
677
  'endTime'?: string;
1157
678
  }
1158
679
  /**
1159
680
  * A Solution Run Template
1160
- * @export
1161
- * @interface RunTemplate
1162
681
  */
1163
682
  export interface RunTemplate {
1164
683
  /**
1165
684
  * The Solution Run Template id
1166
- * @type {string}
1167
- * @memberof RunTemplate
1168
685
  */
1169
686
  'id': string;
1170
687
  /**
1171
688
  * The Run Template name
1172
- * @type {string}
1173
- * @memberof RunTemplate
1174
689
  */
1175
690
  'name'?: string;
1176
691
  /**
1177
692
  * A translated label with key as ISO 639-1 code
1178
- * @type {{ [key: string]: string; }}
1179
- * @memberof RunTemplate
1180
693
  */
1181
694
  'labels'?: {
1182
695
  [key: string]: string;
1183
696
  };
1184
697
  /**
1185
698
  * The Run Template description
1186
- * @type {string}
1187
- * @memberof RunTemplate
1188
699
  */
1189
700
  'description'?: string;
1190
701
  /**
1191
702
  * The list of Run Template tags
1192
- * @type {Array<string>}
1193
- * @memberof RunTemplate
1194
703
  */
1195
704
  'tags'?: Array<string>;
1196
705
  /**
1197
706
  * The compute size needed for this Run Template
1198
- * @type {string}
1199
- * @memberof RunTemplate
1200
707
  */
1201
708
  'computeSize'?: string;
1202
- /**
1203
- *
1204
- * @type {RunTemplateResourceSizing}
1205
- * @memberof RunTemplate
1206
- */
1207
709
  'runSizing'?: RunTemplateResourceSizing;
1208
710
  /**
1209
711
  * The ordered list of parameters groups for the Run Template
1210
- * @type {Array<string>}
1211
- * @memberof RunTemplate
1212
712
  */
1213
713
  'parameterGroups': Array<string>;
1214
714
  /**
1215
715
  * An optional duration in seconds in which a workflow is allowed to run
1216
- * @type {number}
1217
- * @memberof RunTemplate
1218
716
  */
1219
717
  'executionTimeout'?: number;
1220
718
  }
1221
719
  /**
1222
720
  * A Solution Run Template Create Request
1223
- * @export
1224
- * @interface RunTemplateCreateRequest
1225
721
  */
1226
722
  export interface RunTemplateCreateRequest {
1227
723
  /**
1228
724
  * The Solution Run Template id
1229
- * @type {string}
1230
- * @memberof RunTemplateCreateRequest
1231
725
  */
1232
726
  'id': string;
1233
727
  /**
1234
728
  * The Run Template name
1235
- * @type {string}
1236
- * @memberof RunTemplateCreateRequest
1237
729
  */
1238
730
  'name'?: string;
1239
731
  /**
1240
732
  * A translated label with key as ISO 639-1 code
1241
- * @type {{ [key: string]: string; }}
1242
- * @memberof RunTemplateCreateRequest
1243
733
  */
1244
734
  'labels'?: {
1245
735
  [key: string]: string;
1246
736
  };
1247
737
  /**
1248
738
  * The Run Template description
1249
- * @type {string}
1250
- * @memberof RunTemplateCreateRequest
1251
739
  */
1252
740
  'description'?: string;
1253
741
  /**
1254
742
  * The list of Run Template tags
1255
- * @type {Array<string>}
1256
- * @memberof RunTemplateCreateRequest
1257
743
  */
1258
744
  'tags'?: Array<string>;
1259
745
  /**
1260
746
  * The compute size needed for this Run Template
1261
- * @type {string}
1262
- * @memberof RunTemplateCreateRequest
1263
747
  */
1264
748
  'computeSize'?: string;
1265
- /**
1266
- *
1267
- * @type {RunTemplateResourceSizing}
1268
- * @memberof RunTemplateCreateRequest
1269
- */
1270
749
  'runSizing'?: RunTemplateResourceSizing;
1271
750
  /**
1272
751
  * The ordered list of parameters groups for the Run Template
1273
- * @type {Array<string>}
1274
- * @memberof RunTemplateCreateRequest
1275
752
  */
1276
753
  'parameterGroups'?: Array<string>;
1277
754
  /**
1278
755
  * An optional duration in seconds in which a workflow is allowed to run
1279
- * @type {number}
1280
- * @memberof RunTemplateCreateRequest
1281
756
  */
1282
757
  'executionTimeout'?: number;
1283
758
  }
1284
759
  /**
1285
760
  * A Run Template Parameter
1286
- * @export
1287
- * @interface RunTemplateParameter
1288
761
  */
1289
762
  export interface RunTemplateParameter {
1290
763
  /**
1291
764
  * The Parameter id
1292
- * @type {string}
1293
- * @memberof RunTemplateParameter
1294
765
  */
1295
766
  'id': string;
1296
767
  /**
1297
768
  * The parameter description
1298
- * @type {string}
1299
- * @memberof RunTemplateParameter
1300
769
  */
1301
770
  'description'?: string;
1302
771
  /**
1303
772
  * A translated label with key as ISO 639-1 code
1304
- * @type {{ [key: string]: string; }}
1305
- * @memberof RunTemplateParameter
1306
773
  */
1307
774
  'labels'?: {
1308
775
  [key: string]: string;
1309
776
  };
1310
777
  /**
1311
778
  * The variable type for the parameter. Basic types or special type %DATASETID%
1312
- * @type {string}
1313
- * @memberof RunTemplateParameter
1314
779
  */
1315
780
  'varType': string;
1316
781
  /**
1317
782
  * The default value for this parameter
1318
- * @type {string}
1319
- * @memberof RunTemplateParameter
1320
783
  */
1321
784
  'defaultValue'?: string;
1322
785
  /**
1323
786
  * The minimum value for this parameter
1324
- * @type {string}
1325
- * @memberof RunTemplateParameter
1326
787
  */
1327
788
  'minValue'?: string;
1328
789
  /**
1329
790
  * The maximum value for this parameter
1330
- * @type {string}
1331
- * @memberof RunTemplateParameter
1332
791
  */
1333
792
  'maxValue'?: string;
1334
793
  /**
1335
794
  * Free form additional data
1336
- * @type {{ [key: string]: any; }}
1337
- * @memberof RunTemplateParameter
1338
795
  */
1339
796
  'additionalData'?: {
1340
797
  [key: string]: any;
@@ -1342,58 +799,40 @@ export interface RunTemplateParameter {
1342
799
  }
1343
800
  /**
1344
801
  * A Run Template Parameter for creation
1345
- * @export
1346
- * @interface RunTemplateParameterCreateRequest
1347
802
  */
1348
803
  export interface RunTemplateParameterCreateRequest {
1349
804
  /**
1350
805
  * The Parameter id
1351
- * @type {string}
1352
- * @memberof RunTemplateParameterCreateRequest
1353
806
  */
1354
807
  'id': string;
1355
808
  /**
1356
809
  * The parameter description
1357
- * @type {string}
1358
- * @memberof RunTemplateParameterCreateRequest
1359
810
  */
1360
811
  'description'?: string;
1361
812
  /**
1362
813
  * A translated label with key as ISO 639-1 code
1363
- * @type {{ [key: string]: string; }}
1364
- * @memberof RunTemplateParameterCreateRequest
1365
814
  */
1366
815
  'labels'?: {
1367
816
  [key: string]: string;
1368
817
  };
1369
818
  /**
1370
819
  * The variable type for the parameter. Basic types or special type %DATASETID%
1371
- * @type {string}
1372
- * @memberof RunTemplateParameterCreateRequest
1373
820
  */
1374
821
  'varType': string;
1375
822
  /**
1376
823
  * The default value for this parameter
1377
- * @type {string}
1378
- * @memberof RunTemplateParameterCreateRequest
1379
824
  */
1380
825
  'defaultValue'?: string;
1381
826
  /**
1382
827
  * The minimum value for this parameter
1383
- * @type {string}
1384
- * @memberof RunTemplateParameterCreateRequest
1385
828
  */
1386
829
  'minValue'?: string;
1387
830
  /**
1388
831
  * The maximum value for this parameter
1389
- * @type {string}
1390
- * @memberof RunTemplateParameterCreateRequest
1391
832
  */
1392
833
  'maxValue'?: string;
1393
834
  /**
1394
835
  * Free form additional data
1395
- * @type {{ [key: string]: any; }}
1396
- * @memberof RunTemplateParameterCreateRequest
1397
836
  */
1398
837
  'additionalData'?: {
1399
838
  [key: string]: any;
@@ -1401,169 +840,119 @@ export interface RunTemplateParameterCreateRequest {
1401
840
  }
1402
841
  /**
1403
842
  * A Parameter Group for a Run Template
1404
- * @export
1405
- * @interface RunTemplateParameterGroup
1406
843
  */
1407
844
  export interface RunTemplateParameterGroup {
1408
845
  /**
1409
846
  * The Parameter Group id
1410
- * @type {string}
1411
- * @memberof RunTemplateParameterGroup
1412
847
  */
1413
848
  'id': string;
1414
849
  /**
1415
850
  * A description of the parameter group
1416
- * @type {string}
1417
- * @memberof RunTemplateParameterGroup
1418
851
  */
1419
852
  'description'?: string;
1420
853
  /**
1421
854
  * A translated label with key as ISO 639-1 code
1422
- * @type {{ [key: string]: string; }}
1423
- * @memberof RunTemplateParameterGroup
1424
855
  */
1425
856
  'labels'?: {
1426
857
  [key: string]: string;
1427
858
  };
1428
859
  /**
1429
860
  * Free form additional data
1430
- * @type {{ [key: string]: any; }}
1431
- * @memberof RunTemplateParameterGroup
1432
861
  */
1433
862
  'additionalData'?: {
1434
863
  [key: string]: any;
1435
864
  };
1436
865
  /**
1437
866
  * An ordered list of Run Template Parameters
1438
- * @type {Array<string>}
1439
- * @memberof RunTemplateParameterGroup
1440
867
  */
1441
868
  'parameters': Array<string>;
1442
869
  }
1443
870
  /**
1444
871
  * A Parameter Group Create Request for a Run Template
1445
- * @export
1446
- * @interface RunTemplateParameterGroupCreateRequest
1447
872
  */
1448
873
  export interface RunTemplateParameterGroupCreateRequest {
1449
874
  /**
1450
875
  * The Parameter Group id
1451
- * @type {string}
1452
- * @memberof RunTemplateParameterGroupCreateRequest
1453
876
  */
1454
877
  'id': string;
1455
878
  /**
1456
879
  * A description of the parameter group
1457
- * @type {string}
1458
- * @memberof RunTemplateParameterGroupCreateRequest
1459
880
  */
1460
881
  'description'?: string;
1461
882
  /**
1462
883
  * A translated label with key as ISO 639-1 code
1463
- * @type {{ [key: string]: string; }}
1464
- * @memberof RunTemplateParameterGroupCreateRequest
1465
884
  */
1466
885
  'labels'?: {
1467
886
  [key: string]: string;
1468
887
  };
1469
888
  /**
1470
889
  * Free form additional data
1471
- * @type {{ [key: string]: any; }}
1472
- * @memberof RunTemplateParameterGroupCreateRequest
1473
890
  */
1474
891
  'additionalData'?: {
1475
892
  [key: string]: any;
1476
893
  };
1477
894
  /**
1478
895
  * An ordered list of Run Template Parameters
1479
- * @type {Array<string>}
1480
- * @memberof RunTemplateParameterGroupCreateRequest
1481
896
  */
1482
897
  'parameters'?: Array<string>;
1483
898
  }
1484
899
  /**
1485
900
  * A Parameter Group Update Request for a Run Template
1486
- * @export
1487
- * @interface RunTemplateParameterGroupUpdateRequest
1488
901
  */
1489
902
  export interface RunTemplateParameterGroupUpdateRequest {
1490
903
  /**
1491
904
  * A description of the parameter group
1492
- * @type {string}
1493
- * @memberof RunTemplateParameterGroupUpdateRequest
1494
905
  */
1495
906
  'description'?: string;
1496
907
  /**
1497
908
  * A translated label with key as ISO 639-1 code
1498
- * @type {{ [key: string]: string; }}
1499
- * @memberof RunTemplateParameterGroupUpdateRequest
1500
909
  */
1501
910
  'labels'?: {
1502
911
  [key: string]: string;
1503
912
  };
1504
913
  /**
1505
914
  * Free form additional data
1506
- * @type {{ [key: string]: any; }}
1507
- * @memberof RunTemplateParameterGroupUpdateRequest
1508
915
  */
1509
916
  'additionalData'?: {
1510
917
  [key: string]: any;
1511
918
  };
1512
919
  /**
1513
920
  * An ordered list of Run Template Parameters
1514
- * @type {Array<string>}
1515
- * @memberof RunTemplateParameterGroupUpdateRequest
1516
921
  */
1517
922
  'parameters'?: Array<string>;
1518
923
  }
1519
924
  /**
1520
925
  * A Run Template Parameter for update parameter
1521
- * @export
1522
- * @interface RunTemplateParameterUpdateRequest
1523
926
  */
1524
927
  export interface RunTemplateParameterUpdateRequest {
1525
928
  /**
1526
929
  * The parameter description
1527
- * @type {string}
1528
- * @memberof RunTemplateParameterUpdateRequest
1529
930
  */
1530
931
  'description'?: string;
1531
932
  /**
1532
933
  * A translated label with key as ISO 639-1 code
1533
- * @type {{ [key: string]: string; }}
1534
- * @memberof RunTemplateParameterUpdateRequest
1535
934
  */
1536
935
  'labels'?: {
1537
936
  [key: string]: string;
1538
937
  };
1539
938
  /**
1540
939
  * The variable type for the parameter. Basic types or special type %DATASETID%
1541
- * @type {string}
1542
- * @memberof RunTemplateParameterUpdateRequest
1543
940
  */
1544
941
  'varType'?: string;
1545
942
  /**
1546
943
  * The default value for this parameter
1547
- * @type {string}
1548
- * @memberof RunTemplateParameterUpdateRequest
1549
944
  */
1550
945
  'defaultValue'?: string;
1551
946
  /**
1552
947
  * The minimum value for this parameter
1553
- * @type {string}
1554
- * @memberof RunTemplateParameterUpdateRequest
1555
948
  */
1556
949
  'minValue'?: string;
1557
950
  /**
1558
951
  * The maximum value for this parameter
1559
- * @type {string}
1560
- * @memberof RunTemplateParameterUpdateRequest
1561
952
  */
1562
953
  'maxValue'?: string;
1563
954
  /**
1564
955
  * Free form additional data
1565
- * @type {{ [key: string]: any; }}
1566
- * @memberof RunTemplateParameterUpdateRequest
1567
956
  */
1568
957
  'additionalData'?: {
1569
958
  [key: string]: any;
@@ -1571,545 +960,341 @@ export interface RunTemplateParameterUpdateRequest {
1571
960
  }
1572
961
  /**
1573
962
  * the value of Analysis parameter for a Runner for this Run
1574
- * @export
1575
- * @interface RunTemplateParameterValue
1576
963
  */
1577
964
  export interface RunTemplateParameterValue {
1578
965
  /**
1579
966
  * the parameter Id
1580
- * @type {string}
1581
- * @memberof RunTemplateParameterValue
1582
967
  */
1583
968
  'parameterId': string;
1584
969
  /**
1585
970
  * the parameter value type
1586
- * @type {string}
1587
- * @memberof RunTemplateParameterValue
1588
971
  */
1589
972
  'varType'?: string;
1590
973
  /**
1591
974
  * the parameter value
1592
- * @type {string}
1593
- * @memberof RunTemplateParameterValue
1594
975
  */
1595
976
  'value': string;
1596
977
  }
1597
978
  /**
1598
979
  * A description object for resource requests and limits
1599
- * @export
1600
- * @interface RunTemplateResourceSizing
1601
980
  */
1602
981
  export interface RunTemplateResourceSizing {
1603
- /**
1604
- *
1605
- * @type {ResourceSizeInfo}
1606
- * @memberof RunTemplateResourceSizing
1607
- */
1608
982
  'requests': ResourceSizeInfo;
1609
- /**
1610
- *
1611
- * @type {ResourceSizeInfo}
1612
- * @memberof RunTemplateResourceSizing
1613
- */
1614
983
  'limits': ResourceSizeInfo;
1615
984
  }
1616
985
  /**
1617
986
  * A Solution Run Template Create Request
1618
- * @export
1619
- * @interface RunTemplateUpdateRequest
1620
987
  */
1621
988
  export interface RunTemplateUpdateRequest {
1622
989
  /**
1623
990
  * The Run Template name
1624
- * @type {string}
1625
- * @memberof RunTemplateUpdateRequest
1626
991
  */
1627
992
  'name'?: string;
1628
993
  /**
1629
994
  * A translated label with key as ISO 639-1 code
1630
- * @type {{ [key: string]: string; }}
1631
- * @memberof RunTemplateUpdateRequest
1632
995
  */
1633
996
  'labels'?: {
1634
997
  [key: string]: string;
1635
998
  };
1636
999
  /**
1637
1000
  * The Run Template description
1638
- * @type {string}
1639
- * @memberof RunTemplateUpdateRequest
1640
1001
  */
1641
1002
  'description'?: string;
1642
1003
  /**
1643
1004
  * The list of Run Template tags
1644
- * @type {Array<string>}
1645
- * @memberof RunTemplateUpdateRequest
1646
1005
  */
1647
1006
  'tags'?: Array<string>;
1648
1007
  /**
1649
1008
  * The compute size needed for this Run Template
1650
- * @type {string}
1651
- * @memberof RunTemplateUpdateRequest
1652
1009
  */
1653
1010
  'computeSize'?: string;
1654
- /**
1655
- *
1656
- * @type {RunTemplateResourceSizing}
1657
- * @memberof RunTemplateUpdateRequest
1658
- */
1659
1011
  'runSizing'?: RunTemplateResourceSizing;
1660
1012
  /**
1661
1013
  * The ordered list of parameters groups for the Run Template
1662
- * @type {Array<string>}
1663
- * @memberof RunTemplateUpdateRequest
1664
1014
  */
1665
1015
  'parameterGroups'?: Array<string>;
1666
1016
  /**
1667
1017
  * An optional duration in seconds in which a workflow is allowed to run
1668
- * @type {number}
1669
- * @memberof RunTemplateUpdateRequest
1670
1018
  */
1671
1019
  'executionTimeout'?: number;
1672
1020
  }
1673
1021
  /**
1674
1022
  * a Runner with complete information
1675
- * @export
1676
- * @interface Runner
1677
1023
  */
1678
1024
  export interface Runner {
1679
1025
  /**
1680
1026
  * the Runner unique identifier
1681
- * @type {string}
1682
- * @memberof Runner
1683
1027
  */
1684
1028
  'id': string;
1685
1029
  /**
1686
1030
  * the Runner name
1687
- * @type {string}
1688
- * @memberof Runner
1689
1031
  */
1690
1032
  'name': string;
1691
1033
  /**
1692
1034
  * the Runner description
1693
- * @type {string}
1694
- * @memberof Runner
1695
1035
  */
1696
1036
  'description'?: string;
1697
1037
  /**
1698
1038
  * the list of tags
1699
- * @type {Array<string>}
1700
- * @memberof Runner
1701
1039
  */
1702
1040
  'tags'?: Array<string>;
1703
1041
  /**
1704
1042
  * the Runner parent id
1705
- * @type {string}
1706
- * @memberof Runner
1707
1043
  */
1708
1044
  'parentId'?: string;
1709
1045
  /**
1710
1046
  * The details of the Runner creation
1711
- * @type {RunnerEditInfo}
1712
- * @memberof Runner
1713
1047
  */
1714
1048
  'createInfo': RunnerEditInfo;
1715
1049
  /**
1716
1050
  * The details of the Runner last update
1717
- * @type {RunnerEditInfo}
1718
- * @memberof Runner
1719
1051
  */
1720
1052
  'updateInfo': RunnerEditInfo;
1721
1053
  /**
1722
1054
  * the runner root id
1723
- * @type {string}
1724
- * @memberof Runner
1725
1055
  */
1726
1056
  'rootId'?: string;
1727
1057
  /**
1728
1058
  * the Solution Id associated with this Runner
1729
- * @type {string}
1730
- * @memberof Runner
1731
1059
  */
1732
1060
  'solutionId': string;
1733
1061
  /**
1734
1062
  * the Solution Run Template Id associated with this Runner
1735
- * @type {string}
1736
- * @memberof Runner
1737
1063
  */
1738
1064
  'runTemplateId': string;
1739
1065
  /**
1740
1066
  * the associated Organization Id
1741
- * @type {string}
1742
- * @memberof Runner
1743
1067
  */
1744
1068
  'organizationId': string;
1745
1069
  /**
1746
1070
  * the associated Workspace Id
1747
- * @type {string}
1748
- * @memberof Runner
1749
1071
  */
1750
1072
  'workspaceId': string;
1751
1073
  /**
1752
1074
  * the Solution name
1753
- * @type {string}
1754
- * @memberof Runner
1755
1075
  */
1756
1076
  'solutionName'?: string;
1757
1077
  /**
1758
1078
  * the Solution Run Template name associated with this Runner
1759
- * @type {string}
1760
- * @memberof Runner
1761
1079
  */
1762
1080
  'runTemplateName'?: string;
1763
1081
  /**
1764
1082
  * Free form additional data
1765
- * @type {{ [key: string]: any; }}
1766
- * @memberof Runner
1767
1083
  */
1768
1084
  'additionalData'?: {
1769
1085
  [key: string]: any;
1770
1086
  };
1771
1087
  /**
1772
1088
  * definition of datasets used by the runner
1773
- * @type {RunnerDatasets}
1774
- * @memberof Runner
1775
1089
  */
1776
1090
  'datasets': RunnerDatasets;
1777
1091
  /**
1778
- *
1779
- * @type {RunnerResourceSizing}
1780
- * @memberof Runner
1092
+ * definition of resources needed for the runner run
1781
1093
  */
1782
1094
  'runSizing'?: RunnerResourceSizing;
1783
1095
  /**
1784
1096
  * the list of Solution Run Template parameters values
1785
- * @type {Array<RunnerRunTemplateParameterValue>}
1786
- * @memberof Runner
1787
1097
  */
1788
1098
  'parametersValues': Array<RunnerRunTemplateParameterValue>;
1789
1099
  /**
1790
- *
1791
- * @type {LastRunInfo}
1792
- * @memberof Runner
1100
+ * last run info from current runner
1793
1101
  */
1794
1102
  'lastRunInfo': LastRunInfo;
1795
- /**
1796
- *
1797
- * @type {RunnerValidationStatus}
1798
- * @memberof Runner
1799
- */
1800
1103
  'validationStatus': RunnerValidationStatus;
1801
- /**
1802
- *
1803
- * @type {RunnerSecurity}
1804
- * @memberof Runner
1805
- */
1806
1104
  'security': RunnerSecurity;
1807
1105
  }
1808
1106
  /**
1809
1107
  * a Runner access control item
1810
- * @export
1811
- * @interface RunnerAccessControl
1812
1108
  */
1813
1109
  export interface RunnerAccessControl {
1814
1110
  /**
1815
1111
  * the identity id
1816
- * @type {string}
1817
- * @memberof RunnerAccessControl
1818
1112
  */
1819
1113
  'id': string;
1820
1114
  /**
1821
1115
  * a role
1822
- * @type {string}
1823
- * @memberof RunnerAccessControl
1824
1116
  */
1825
1117
  'role': string;
1826
1118
  }
1827
1119
  /**
1828
1120
  * Request object for creating a new runner
1829
- * @export
1830
- * @interface RunnerCreateRequest
1831
1121
  */
1832
1122
  export interface RunnerCreateRequest {
1833
1123
  /**
1834
1124
  * the Runner name
1835
- * @type {string}
1836
- * @memberof RunnerCreateRequest
1837
1125
  */
1838
1126
  'name': string;
1839
1127
  /**
1840
1128
  * the Runner description
1841
- * @type {string}
1842
- * @memberof RunnerCreateRequest
1843
1129
  */
1844
1130
  'description'?: string;
1845
1131
  /**
1846
1132
  * the list of tags
1847
- * @type {Array<string>}
1848
- * @memberof RunnerCreateRequest
1849
1133
  */
1850
1134
  'tags'?: Array<string>;
1851
1135
  /**
1852
1136
  * the Solution Id associated with this Runner
1853
- * @type {string}
1854
- * @memberof RunnerCreateRequest
1855
1137
  */
1856
1138
  'solutionId': string;
1857
1139
  /**
1858
1140
  * the Runner parent id
1859
- * @type {string}
1860
- * @memberof RunnerCreateRequest
1861
1141
  */
1862
1142
  'parentId'?: string;
1863
1143
  /**
1864
1144
  * the Solution Run Template Id associated with this Runner
1865
- * @type {string}
1866
- * @memberof RunnerCreateRequest
1867
1145
  */
1868
1146
  'runTemplateId': string;
1869
1147
  /**
1870
1148
  * the list of Dataset Id associated to this Runner Run Template
1871
- * @type {Array<string>}
1872
- * @memberof RunnerCreateRequest
1873
1149
  */
1874
1150
  'datasetList'?: Array<string>;
1875
1151
  /**
1876
- *
1877
- * @type {RunnerResourceSizing}
1878
- * @memberof RunnerCreateRequest
1152
+ * definition of resources needed for the runner run
1879
1153
  */
1880
1154
  'runSizing'?: RunnerResourceSizing;
1881
1155
  /**
1882
1156
  * the list of Solution Run Template parameters values
1883
- * @type {Array<RunnerRunTemplateParameterValue>}
1884
- * @memberof RunnerCreateRequest
1885
1157
  */
1886
1158
  'parametersValues'?: Array<RunnerRunTemplateParameterValue>;
1887
1159
  /**
1888
1160
  * Free form additional data
1889
- * @type {{ [key: string]: any; }}
1890
- * @memberof RunnerCreateRequest
1891
1161
  */
1892
1162
  'additionalData'?: {
1893
1163
  [key: string]: any;
1894
1164
  };
1895
1165
  /**
1896
1166
  * the Solution name
1897
- * @type {string}
1898
- * @memberof RunnerCreateRequest
1899
1167
  */
1900
1168
  'solutionName'?: string;
1901
1169
  /**
1902
1170
  * the Solution Run Template name associated with this Runner
1903
- * @type {string}
1904
- * @memberof RunnerCreateRequest
1905
1171
  */
1906
1172
  'runTemplateName'?: string;
1907
- /**
1908
- *
1909
- * @type {RunnerSecurity}
1910
- * @memberof RunnerCreateRequest
1911
- */
1912
1173
  'security'?: RunnerSecurity;
1913
1174
  }
1914
- /**
1915
- *
1916
- * @export
1917
- * @interface RunnerDatasets
1918
- */
1919
1175
  export interface RunnerDatasets {
1920
1176
  /**
1921
1177
  * a list of Dataset Id used to build the Runner
1922
- * @type {Array<string>}
1923
- * @memberof RunnerDatasets
1924
1178
  */
1925
1179
  'bases': Array<string>;
1926
1180
  /**
1927
1181
  * The dataset id used for dataset parameters on current Runner
1928
- * @type {string}
1929
- * @memberof RunnerDatasets
1930
1182
  */
1931
1183
  'parameter': string;
1932
1184
  /**
1933
1185
  * The dataset parts retrieved from the parameter property (programmatically fulfilled)
1934
- * @type {Array<object>}
1935
- * @memberof RunnerDatasets
1936
1186
  */
1937
1187
  'parameters'?: Array<object>;
1938
1188
  }
1939
- /**
1940
- *
1941
- * @export
1942
- * @interface RunnerEditInfo
1943
- */
1944
1189
  export interface RunnerEditInfo {
1945
1190
  /**
1946
1191
  * The timestamp of the modification in millisecond
1947
- * @type {number}
1948
- * @memberof RunnerEditInfo
1949
1192
  */
1950
1193
  'timestamp': number;
1951
1194
  /**
1952
1195
  * The id of the user who did the modification
1953
- * @type {string}
1954
- * @memberof RunnerEditInfo
1955
1196
  */
1956
1197
  'userId': string;
1957
1198
  }
1958
1199
  /**
1959
1200
  * a description object for resource requests and limits (default same configuration as basic sizing)
1960
- * @export
1961
- * @interface RunnerResourceSizing
1962
1201
  */
1963
1202
  export interface RunnerResourceSizing {
1964
- /**
1965
- *
1966
- * @type {ResourceSizeInfo}
1967
- * @memberof RunnerResourceSizing
1968
- */
1969
1203
  'requests': ResourceSizeInfo;
1970
- /**
1971
- *
1972
- * @type {ResourceSizeInfo}
1973
- * @memberof RunnerResourceSizing
1974
- */
1975
1204
  'limits': ResourceSizeInfo;
1976
1205
  }
1977
1206
  /**
1978
1207
  * the Runner Role
1979
- * @export
1980
- * @interface RunnerRole
1981
1208
  */
1982
1209
  export interface RunnerRole {
1983
1210
  /**
1984
1211
  * the Runner Role
1985
- * @type {string}
1986
- * @memberof RunnerRole
1987
1212
  */
1988
1213
  'role': string;
1989
1214
  }
1990
1215
  /**
1991
1216
  * the value of a Solution Run Template parameter for a Runner
1992
- * @export
1993
- * @interface RunnerRunTemplateParameterValue
1994
1217
  */
1995
1218
  export interface RunnerRunTemplateParameterValue {
1996
1219
  /**
1997
1220
  * the parameter Id
1998
- * @type {string}
1999
- * @memberof RunnerRunTemplateParameterValue
2000
1221
  */
2001
1222
  'parameterId': string;
2002
1223
  /**
2003
1224
  * the parameter value type
2004
- * @type {string}
2005
- * @memberof RunnerRunTemplateParameterValue
2006
1225
  */
2007
1226
  'varType'?: string;
2008
1227
  /**
2009
1228
  * the parameter value
2010
- * @type {string}
2011
- * @memberof RunnerRunTemplateParameterValue
2012
1229
  */
2013
1230
  'value': string;
2014
1231
  /**
2015
1232
  * whether or not the value is inherited from parent or has been changed
2016
- * @type {boolean}
2017
- * @memberof RunnerRunTemplateParameterValue
2018
1233
  */
2019
1234
  'isInherited'?: boolean;
2020
1235
  }
2021
1236
  /**
2022
1237
  * the Runner security information
2023
- * @export
2024
- * @interface RunnerSecurity
2025
1238
  */
2026
1239
  export interface RunnerSecurity {
2027
1240
  /**
2028
1241
  * the role by default
2029
- * @type {string}
2030
- * @memberof RunnerSecurity
2031
1242
  */
2032
1243
  'default': string;
2033
1244
  /**
2034
1245
  * the list which can access this Runner with detailed access control information
2035
- * @type {Array<RunnerAccessControl>}
2036
- * @memberof RunnerSecurity
2037
1246
  */
2038
1247
  'accessControlList': Array<RunnerAccessControl>;
2039
1248
  }
2040
1249
  /**
2041
1250
  * Request object for updating a runner
2042
- * @export
2043
- * @interface RunnerUpdateRequest
2044
1251
  */
2045
1252
  export interface RunnerUpdateRequest {
2046
1253
  /**
2047
1254
  * the Runner name
2048
- * @type {string}
2049
- * @memberof RunnerUpdateRequest
2050
1255
  */
2051
1256
  'name'?: string;
2052
1257
  /**
2053
1258
  * the Runner description
2054
- * @type {string}
2055
- * @memberof RunnerUpdateRequest
2056
1259
  */
2057
1260
  'description'?: string;
2058
1261
  /**
2059
1262
  * the list of tags
2060
- * @type {Array<string>}
2061
- * @memberof RunnerUpdateRequest
2062
1263
  */
2063
1264
  'tags'?: Array<string>;
2064
1265
  /**
2065
1266
  * the Solution Run Template Id associated with this Runner
2066
- * @type {string}
2067
- * @memberof RunnerUpdateRequest
2068
1267
  */
2069
1268
  'runTemplateId'?: string;
2070
1269
  /**
2071
1270
  * the list of Dataset Id associated to this Runner Run Template
2072
- * @type {Array<string>}
2073
- * @memberof RunnerUpdateRequest
2074
1271
  */
2075
1272
  'datasetList'?: Array<string>;
2076
1273
  /**
2077
- *
2078
- * @type {RunnerResourceSizing}
2079
- * @memberof RunnerUpdateRequest
1274
+ * definition of resources needed for the runner run
2080
1275
  */
2081
1276
  'runSizing'?: RunnerResourceSizing;
2082
1277
  /**
2083
1278
  * the list of Solution Run Template parameters values
2084
- * @type {Array<RunnerRunTemplateParameterValue>}
2085
- * @memberof RunnerUpdateRequest
2086
1279
  */
2087
1280
  'parametersValues'?: Array<RunnerRunTemplateParameterValue>;
2088
1281
  /**
2089
1282
  * Free form additional data
2090
- * @type {{ [key: string]: any; }}
2091
- * @memberof RunnerUpdateRequest
2092
1283
  */
2093
1284
  'additionalData'?: {
2094
1285
  [key: string]: any;
2095
1286
  };
2096
1287
  /**
2097
1288
  * the Solution name
2098
- * @type {string}
2099
- * @memberof RunnerUpdateRequest
2100
1289
  */
2101
1290
  'solutionName'?: string;
2102
1291
  /**
2103
1292
  * the Solution Run Template name associated with this Runner
2104
- * @type {string}
2105
- * @memberof RunnerUpdateRequest
2106
1293
  */
2107
1294
  'runTemplateName'?: string;
2108
1295
  }
2109
1296
  /**
2110
1297
  * the validation status of the runner
2111
- * @export
2112
- * @enum {string}
2113
1298
  */
2114
1299
  export declare const RunnerValidationStatus: {
2115
1300
  readonly Draft: "Draft";
@@ -2120,590 +1305,376 @@ export declare const RunnerValidationStatus: {
2120
1305
  export type RunnerValidationStatus = typeof RunnerValidationStatus[keyof typeof RunnerValidationStatus];
2121
1306
  /**
2122
1307
  * A version of a Solution
2123
- * @export
2124
- * @interface Solution
2125
1308
  */
2126
1309
  export interface Solution {
2127
1310
  /**
2128
1311
  * The Solution version unique identifier
2129
- * @type {string}
2130
- * @memberof Solution
2131
1312
  */
2132
1313
  'id': string;
2133
1314
  /**
2134
1315
  * The Organization unique identifier
2135
- * @type {string}
2136
- * @memberof Solution
2137
1316
  */
2138
1317
  'organizationId': string;
2139
1318
  /**
2140
1319
  * The Solution key which groups Solution versions
2141
- * @type {string}
2142
- * @memberof Solution
2143
1320
  */
2144
1321
  'key': string;
2145
1322
  /**
2146
1323
  * The Solution name
2147
- * @type {string}
2148
- * @memberof Solution
2149
1324
  */
2150
1325
  'name': string;
2151
1326
  /**
2152
1327
  * The Solution description
2153
- * @type {string}
2154
- * @memberof Solution
2155
1328
  */
2156
1329
  'description'?: string;
2157
1330
  /**
2158
1331
  * The registry repository containing the image
2159
- * @type {string}
2160
- * @memberof Solution
2161
1332
  */
2162
1333
  'repository': string;
2163
1334
  /**
2164
1335
  * Set to true if the runtemplate wants to always pull the image
2165
- * @type {boolean}
2166
- * @memberof Solution
2167
1336
  */
2168
1337
  'alwaysPull'?: boolean;
2169
1338
  /**
2170
1339
  * The Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag
2171
- * @type {string}
2172
- * @memberof Solution
2173
1340
  */
2174
1341
  'version': string;
2175
1342
  /**
2176
1343
  * The details of the Solution creation
2177
- * @type {SolutionEditInfo}
2178
- * @memberof Solution
2179
1344
  */
2180
1345
  'createInfo': SolutionEditInfo;
2181
1346
  /**
2182
1347
  * The details of the Solution last update
2183
- * @type {SolutionEditInfo}
2184
- * @memberof Solution
2185
1348
  */
2186
1349
  'updateInfo': SolutionEditInfo;
2187
1350
  /**
2188
1351
  * The full SDK version used to build this solution, if available
2189
- * @type {string}
2190
- * @memberof Solution
2191
1352
  */
2192
1353
  'sdkVersion'?: string;
2193
1354
  /**
2194
1355
  * An optional URL link to solution page
2195
- * @type {string}
2196
- * @memberof Solution
2197
1356
  */
2198
1357
  'url'?: string;
2199
1358
  /**
2200
1359
  * The list of tags
2201
- * @type {Array<string>}
2202
- * @memberof Solution
2203
1360
  */
2204
1361
  'tags'?: Array<string>;
2205
1362
  /**
2206
1363
  * The list of Run Template Parameters
2207
- * @type {Array<RunTemplateParameter>}
2208
- * @memberof Solution
2209
1364
  */
2210
1365
  'parameters': Array<RunTemplateParameter>;
2211
1366
  /**
2212
1367
  * The list of parameters groups for the Run Templates
2213
- * @type {Array<RunTemplateParameterGroup>}
2214
- * @memberof Solution
2215
1368
  */
2216
1369
  'parameterGroups': Array<RunTemplateParameterGroup>;
2217
1370
  /**
2218
1371
  * List of Run Templates
2219
- * @type {Array<RunTemplate>}
2220
- * @memberof Solution
2221
1372
  */
2222
1373
  'runTemplates': Array<RunTemplate>;
2223
- /**
2224
- *
2225
- * @type {SolutionSecurity}
2226
- * @memberof Solution
2227
- */
2228
1374
  'security': SolutionSecurity;
2229
1375
  }
2230
1376
  /**
2231
1377
  * A Solution access control item
2232
- * @export
2233
- * @interface SolutionAccessControl
2234
1378
  */
2235
1379
  export interface SolutionAccessControl {
2236
1380
  /**
2237
1381
  * The identity id
2238
- * @type {string}
2239
- * @memberof SolutionAccessControl
2240
1382
  */
2241
1383
  'id': string;
2242
1384
  /**
2243
1385
  * The assigned role
2244
- * @type {string}
2245
- * @memberof SolutionAccessControl
2246
1386
  */
2247
1387
  'role': string;
2248
1388
  }
2249
1389
  /**
2250
1390
  * Request object for creating a new solution
2251
- * @export
2252
- * @interface SolutionCreateRequest
2253
1391
  */
2254
1392
  export interface SolutionCreateRequest {
2255
1393
  /**
2256
1394
  * Technical key for resource name convention and version grouping. Must be unique
2257
- * @type {string}
2258
- * @memberof SolutionCreateRequest
2259
1395
  */
2260
1396
  'key': string;
2261
1397
  /**
2262
1398
  * Solution name. This name is displayed in the sample webApp
2263
- * @type {string}
2264
- * @memberof SolutionCreateRequest
2265
1399
  */
2266
1400
  'name': string;
2267
1401
  /**
2268
1402
  * The Solution description
2269
- * @type {string}
2270
- * @memberof SolutionCreateRequest
2271
1403
  */
2272
1404
  'description'?: string;
2273
1405
  /**
2274
1406
  * The registry repository containing the image
2275
- * @type {string}
2276
- * @memberof SolutionCreateRequest
2277
1407
  */
2278
1408
  'repository': string;
2279
1409
  /**
2280
1410
  * The Solution version MAJOR.MINOR.PATCH
2281
- * @type {string}
2282
- * @memberof SolutionCreateRequest
2283
1411
  */
2284
1412
  'version': string;
2285
1413
  /**
2286
1414
  * Set to true if the runtemplate wants to always pull the image
2287
- * @type {boolean}
2288
- * @memberof SolutionCreateRequest
2289
1415
  */
2290
1416
  'alwaysPull'?: boolean;
2291
1417
  /**
2292
1418
  * The list of tags
2293
- * @type {Array<string>}
2294
- * @memberof SolutionCreateRequest
2295
1419
  */
2296
1420
  'tags'?: Array<string>;
2297
1421
  /**
2298
1422
  * The list of Run Template Parameters
2299
- * @type {Array<RunTemplateParameterCreateRequest>}
2300
- * @memberof SolutionCreateRequest
2301
1423
  */
2302
1424
  'parameters'?: Array<RunTemplateParameterCreateRequest>;
2303
1425
  /**
2304
1426
  * The list of parameters groups for the Run Templates
2305
- * @type {Array<RunTemplateParameterGroupCreateRequest>}
2306
- * @memberof SolutionCreateRequest
2307
1427
  */
2308
1428
  'parameterGroups'?: Array<RunTemplateParameterGroupCreateRequest>;
2309
1429
  /**
2310
1430
  * List of Run Templates
2311
- * @type {Array<RunTemplateCreateRequest>}
2312
- * @memberof SolutionCreateRequest
2313
1431
  */
2314
1432
  'runTemplates'?: Array<RunTemplateCreateRequest>;
2315
1433
  /**
2316
1434
  * An optional URL link to solution page
2317
- * @type {string}
2318
- * @memberof SolutionCreateRequest
2319
1435
  */
2320
1436
  'url'?: string;
2321
- /**
2322
- *
2323
- * @type {SolutionSecurity}
2324
- * @memberof SolutionCreateRequest
2325
- */
2326
1437
  'security'?: SolutionSecurity;
2327
1438
  }
2328
- /**
2329
- *
2330
- * @export
2331
- * @interface SolutionEditInfo
2332
- */
2333
1439
  export interface SolutionEditInfo {
2334
1440
  /**
2335
1441
  * The timestamp of the modification in millisecond
2336
- * @type {number}
2337
- * @memberof SolutionEditInfo
2338
1442
  */
2339
1443
  'timestamp': number;
2340
1444
  /**
2341
1445
  * The id of the user who did the modification
2342
- * @type {string}
2343
- * @memberof SolutionEditInfo
2344
1446
  */
2345
1447
  'userId': string;
2346
1448
  }
2347
1449
  /**
2348
1450
  * The Solution Role
2349
- * @export
2350
- * @interface SolutionRole
2351
1451
  */
2352
1452
  export interface SolutionRole {
2353
1453
  /**
2354
1454
  * The Solution Role
2355
- * @type {string}
2356
- * @memberof SolutionRole
2357
1455
  */
2358
1456
  'role': string;
2359
1457
  }
2360
1458
  /**
2361
1459
  * The Solution security information
2362
- * @export
2363
- * @interface SolutionSecurity
2364
1460
  */
2365
1461
  export interface SolutionSecurity {
2366
1462
  /**
2367
1463
  * The role by default
2368
- * @type {string}
2369
- * @memberof SolutionSecurity
2370
1464
  */
2371
1465
  'default': string;
2372
1466
  /**
2373
1467
  * The list which can access this Solution with detailed access control information
2374
- * @type {Array<SolutionAccessControl>}
2375
- * @memberof SolutionSecurity
2376
1468
  */
2377
1469
  'accessControlList': Array<SolutionAccessControl>;
2378
1470
  }
2379
1471
  /**
2380
1472
  * Request object for updating a solution
2381
- * @export
2382
- * @interface SolutionUpdateRequest
2383
1473
  */
2384
1474
  export interface SolutionUpdateRequest {
2385
1475
  /**
2386
1476
  * Technical key for resource name convention and version grouping. Must be unique
2387
- * @type {string}
2388
- * @memberof SolutionUpdateRequest
2389
1477
  */
2390
1478
  'key'?: string;
2391
1479
  /**
2392
1480
  * The Solution name
2393
- * @type {string}
2394
- * @memberof SolutionUpdateRequest
2395
1481
  */
2396
1482
  'name'?: string;
2397
1483
  /**
2398
1484
  * The Solution description
2399
- * @type {string}
2400
- * @memberof SolutionUpdateRequest
2401
1485
  */
2402
1486
  'description'?: string;
2403
1487
  /**
2404
1488
  * The registry repository containing the image
2405
- * @type {string}
2406
- * @memberof SolutionUpdateRequest
2407
1489
  */
2408
1490
  'repository'?: string;
2409
1491
  /**
2410
1492
  * Set to true if the runtemplate wants to always pull the image
2411
- * @type {boolean}
2412
- * @memberof SolutionUpdateRequest
2413
1493
  */
2414
1494
  'alwaysPull'?: boolean;
2415
1495
  /**
2416
1496
  * The Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag
2417
- * @type {string}
2418
- * @memberof SolutionUpdateRequest
2419
1497
  */
2420
1498
  'version'?: string;
2421
1499
  /**
2422
1500
  * An optional URL link to solution page
2423
- * @type {string}
2424
- * @memberof SolutionUpdateRequest
2425
1501
  */
2426
1502
  'url'?: string;
2427
1503
  /**
2428
1504
  * The list of tags
2429
- * @type {Array<string>}
2430
- * @memberof SolutionUpdateRequest
2431
1505
  */
2432
1506
  'tags'?: Array<string>;
2433
1507
  /**
2434
1508
  * The list of Run Template Parameters
2435
- * @type {Array<RunTemplateParameterCreateRequest>}
2436
- * @memberof SolutionUpdateRequest
2437
1509
  */
2438
1510
  'parameters'?: Array<RunTemplateParameterCreateRequest>;
2439
1511
  /**
2440
1512
  * The list of parameters groups for the Run Templates
2441
- * @type {Array<RunTemplateParameterGroupCreateRequest>}
2442
- * @memberof SolutionUpdateRequest
2443
1513
  */
2444
1514
  'parameterGroups'?: Array<RunTemplateParameterGroupCreateRequest>;
2445
1515
  /**
2446
1516
  * List of Run Templates
2447
- * @type {Array<RunTemplateCreateRequest>}
2448
- * @memberof SolutionUpdateRequest
2449
1517
  */
2450
1518
  'runTemplates'?: Array<RunTemplateCreateRequest>;
2451
1519
  }
2452
1520
  /**
2453
1521
  * A Workspace
2454
- * @export
2455
- * @interface Workspace
2456
1522
  */
2457
1523
  export interface Workspace {
2458
1524
  /**
2459
1525
  * Workspace unique identifier generated by the API
2460
- * @type {string}
2461
- * @memberof Workspace
2462
1526
  */
2463
1527
  'id': string;
2464
1528
  /**
2465
1529
  * Organization unique identifier under which the workspace resides
2466
- * @type {string}
2467
- * @memberof Workspace
2468
1530
  */
2469
1531
  'organizationId': string;
2470
1532
  /**
2471
1533
  * Technical key for resource name convention and version grouping. Must be unique
2472
- * @type {string}
2473
- * @memberof Workspace
2474
1534
  */
2475
1535
  'key': string;
2476
1536
  /**
2477
1537
  * Workspace name. This name is display in the sample webApp
2478
- * @type {string}
2479
- * @memberof Workspace
2480
1538
  */
2481
1539
  'name': string;
2482
1540
  /**
2483
1541
  * The Workspace description
2484
- * @type {string}
2485
- * @memberof Workspace
2486
1542
  */
2487
1543
  'description'?: string;
2488
1544
  /**
2489
1545
  * The Workspace version MAJOR.MINOR.PATCH.
2490
- * @type {string}
2491
- * @memberof Workspace
2492
1546
  */
2493
1547
  'version'?: string;
2494
1548
  /**
2495
1549
  * The list of tags
2496
- * @type {Array<string>}
2497
- * @memberof Workspace
2498
1550
  */
2499
1551
  'tags'?: Array<string>;
2500
1552
  /**
2501
1553
  * The details of the Workspace creation
2502
- * @type {WorkspaceEditInfo}
2503
- * @memberof Workspace
2504
1554
  */
2505
1555
  'createInfo': WorkspaceEditInfo;
2506
1556
  /**
2507
1557
  * The details of the Workspace last update
2508
- * @type {WorkspaceEditInfo}
2509
- * @memberof Workspace
2510
1558
  */
2511
1559
  'updateInfo': WorkspaceEditInfo;
2512
- /**
2513
- *
2514
- * @type {WorkspaceSolution}
2515
- * @memberof Workspace
2516
- */
2517
1560
  'solution': WorkspaceSolution;
2518
1561
  /**
2519
1562
  * Free form additional data
2520
- * @type {{ [key: string]: any; }}
2521
- * @memberof Workspace
2522
1563
  */
2523
1564
  'additionalData'?: {
2524
1565
  [key: string]: any;
2525
1566
  };
2526
1567
  /**
2527
1568
  * 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.
2528
- * @type {boolean}
2529
- * @memberof Workspace
2530
1569
  */
2531
1570
  'datasetCopy'?: boolean;
2532
- /**
2533
- *
2534
- * @type {WorkspaceSecurity}
2535
- * @memberof Workspace
2536
- */
2537
1571
  'security': WorkspaceSecurity;
2538
1572
  }
2539
1573
  /**
2540
1574
  * A Workspace access control item
2541
- * @export
2542
- * @interface WorkspaceAccessControl
2543
1575
  */
2544
1576
  export interface WorkspaceAccessControl {
2545
1577
  /**
2546
1578
  * The identity id
2547
- * @type {string}
2548
- * @memberof WorkspaceAccessControl
2549
1579
  */
2550
1580
  'id': string;
2551
1581
  /**
2552
1582
  * A role
2553
- * @type {string}
2554
- * @memberof WorkspaceAccessControl
2555
1583
  */
2556
1584
  'role': string;
2557
1585
  }
2558
1586
  /**
2559
1587
  * Request object for creating a new workspace
2560
- * @export
2561
- * @interface WorkspaceCreateRequest
2562
1588
  */
2563
1589
  export interface WorkspaceCreateRequest {
2564
1590
  /**
2565
1591
  * Technical key for resource name convention and version grouping. Must be unique
2566
- * @type {string}
2567
- * @memberof WorkspaceCreateRequest
2568
1592
  */
2569
1593
  'key': string;
2570
1594
  /**
2571
1595
  * Workspace name. This name is displayed in the sample webApp
2572
- * @type {string}
2573
- * @memberof WorkspaceCreateRequest
2574
1596
  */
2575
1597
  'name': string;
2576
1598
  /**
2577
1599
  * The Workspace description
2578
- * @type {string}
2579
- * @memberof WorkspaceCreateRequest
2580
1600
  */
2581
1601
  'description'?: string;
2582
1602
  /**
2583
1603
  * The Workspace version MAJOR.MINOR.PATCH.
2584
- * @type {string}
2585
- * @memberof WorkspaceCreateRequest
2586
1604
  */
2587
1605
  'version'?: string;
2588
1606
  /**
2589
1607
  * The list of tags
2590
- * @type {Array<string>}
2591
- * @memberof WorkspaceCreateRequest
2592
1608
  */
2593
1609
  'tags'?: Array<string>;
2594
- /**
2595
- *
2596
- * @type {WorkspaceSolution}
2597
- * @memberof WorkspaceCreateRequest
2598
- */
2599
1610
  'solution': WorkspaceSolution;
2600
1611
  /**
2601
1612
  * Free form additional data
2602
- * @type {{ [key: string]: any; }}
2603
- * @memberof WorkspaceCreateRequest
2604
1613
  */
2605
1614
  'additionalData'?: {
2606
1615
  [key: string]: any;
2607
1616
  };
2608
1617
  /**
2609
1618
  * Activate the copy of dataset on scenario creation
2610
- * @type {boolean}
2611
- * @memberof WorkspaceCreateRequest
2612
1619
  */
2613
1620
  'datasetCopy'?: boolean;
2614
- /**
2615
- *
2616
- * @type {WorkspaceSecurity}
2617
- * @memberof WorkspaceCreateRequest
2618
- */
2619
1621
  'security'?: WorkspaceSecurity;
2620
1622
  }
2621
- /**
2622
- *
2623
- * @export
2624
- * @interface WorkspaceEditInfo
2625
- */
2626
1623
  export interface WorkspaceEditInfo {
2627
1624
  /**
2628
1625
  * The timestamp of the modification in millisecond
2629
- * @type {number}
2630
- * @memberof WorkspaceEditInfo
2631
1626
  */
2632
1627
  'timestamp': number;
2633
1628
  /**
2634
1629
  * The id of the user who did the modification
2635
- * @type {string}
2636
- * @memberof WorkspaceEditInfo
2637
1630
  */
2638
1631
  'userId': string;
2639
1632
  }
2640
1633
  /**
2641
1634
  * A Workspace File resource
2642
- * @export
2643
- * @interface WorkspaceFile
2644
1635
  */
2645
1636
  export interface WorkspaceFile {
2646
1637
  /**
2647
1638
  * The Workspace File name
2648
- * @type {string}
2649
- * @memberof WorkspaceFile
2650
1639
  */
2651
1640
  'fileName': string;
2652
1641
  }
2653
1642
  /**
2654
1643
  * The Workspace Role
2655
- * @export
2656
- * @interface WorkspaceRole
2657
1644
  */
2658
1645
  export interface WorkspaceRole {
2659
1646
  /**
2660
1647
  * The Workspace Role
2661
- * @type {string}
2662
- * @memberof WorkspaceRole
2663
1648
  */
2664
1649
  'role': string;
2665
1650
  }
2666
1651
  /**
2667
1652
  * The workspace security information
2668
- * @export
2669
- * @interface WorkspaceSecurity
2670
1653
  */
2671
1654
  export interface WorkspaceSecurity {
2672
1655
  /**
2673
1656
  * The role by default
2674
- * @type {string}
2675
- * @memberof WorkspaceSecurity
2676
1657
  */
2677
1658
  'default': string;
2678
1659
  /**
2679
1660
  * The list which can access this Workspace with detailed access control information
2680
- * @type {Array<WorkspaceAccessControl>}
2681
- * @memberof WorkspaceSecurity
2682
1661
  */
2683
1662
  'accessControlList': Array<WorkspaceAccessControl>;
2684
1663
  }
2685
1664
  /**
2686
1665
  * The Workspace Solution configuration
2687
- * @export
2688
- * @interface WorkspaceSolution
2689
1666
  */
2690
1667
  export interface WorkspaceSolution {
2691
1668
  /**
2692
1669
  * The Solution Id attached to this workspace
2693
- * @type {string}
2694
- * @memberof WorkspaceSolution
2695
1670
  */
2696
1671
  'solutionId': string;
2697
1672
  /**
2698
1673
  * The Dataset Id attached to this workspace. This dataset will be used to store default values for Solution parameters with file\'s varType.
2699
- * @type {string}
2700
- * @memberof WorkspaceSolution
2701
1674
  */
2702
1675
  'datasetId'?: string;
2703
1676
  /**
2704
1677
  * A map of parameterId/value to set default values for Solution parameters with simple varType (int, string, ...)
2705
- * @type {{ [key: string]: string; }}
2706
- * @memberof WorkspaceSolution
2707
1678
  */
2708
1679
  'defaultParameterValues'?: {
2709
1680
  [key: string]: string;
@@ -2711,58 +1682,38 @@ export interface WorkspaceSolution {
2711
1682
  }
2712
1683
  /**
2713
1684
  * Request object for updating a workspace
2714
- * @export
2715
- * @interface WorkspaceUpdateRequest
2716
1685
  */
2717
1686
  export interface WorkspaceUpdateRequest {
2718
1687
  /**
2719
1688
  * Technical key for resource name convention and version grouping. Must be unique
2720
- * @type {string}
2721
- * @memberof WorkspaceUpdateRequest
2722
1689
  */
2723
1690
  'key'?: string;
2724
1691
  /**
2725
1692
  * Workspace name
2726
- * @type {string}
2727
- * @memberof WorkspaceUpdateRequest
2728
1693
  */
2729
1694
  'name'?: string;
2730
1695
  /**
2731
1696
  * The Workspace description
2732
- * @type {string}
2733
- * @memberof WorkspaceUpdateRequest
2734
1697
  */
2735
1698
  'description'?: string;
2736
1699
  /**
2737
1700
  * The list of tags
2738
- * @type {Array<string>}
2739
- * @memberof WorkspaceUpdateRequest
2740
1701
  */
2741
1702
  'tags'?: Array<string>;
2742
- /**
2743
- *
2744
- * @type {WorkspaceSolution}
2745
- * @memberof WorkspaceUpdateRequest
2746
- */
2747
1703
  'solution'?: WorkspaceSolution;
2748
1704
  /**
2749
1705
  * Free form additional data
2750
- * @type {{ [key: string]: any; }}
2751
- * @memberof WorkspaceUpdateRequest
2752
1706
  */
2753
1707
  'additionalData'?: {
2754
1708
  [key: string]: any;
2755
1709
  };
2756
1710
  /**
2757
1711
  * Activate the copy of dataset on scenario creation
2758
- * @type {boolean}
2759
- * @memberof WorkspaceUpdateRequest
2760
1712
  */
2761
1713
  'datasetCopy'?: boolean;
2762
1714
  }
2763
1715
  /**
2764
1716
  * DatasetApi - axios parameter creator
2765
- * @export
2766
1717
  */
2767
1718
  export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration) => {
2768
1719
  /**
@@ -2771,11 +1722,11 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
2771
1722
  * @param {string} organizationId the Organization identifier
2772
1723
  * @param {string} workspaceId the Workspace identifier
2773
1724
  * @param {DatasetCreateRequest} datasetCreateRequest
2774
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
1725
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2775
1726
  * @param {*} [options] Override http request option.
2776
1727
  * @throws {RequiredError}
2777
1728
  */
2778
- createDataset: (organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1729
+ createDataset: (organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2779
1730
  /**
2780
1731
  *
2781
1732
  * @summary Add a control access to the Dataset
@@ -2973,11 +1924,11 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
2973
1924
  * @param {string} workspaceId the Workspace identifier
2974
1925
  * @param {string} datasetId the Dataset identifier
2975
1926
  * @param {DatasetUpdateRequest} datasetUpdateRequest
2976
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
1927
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2977
1928
  * @param {*} [options] Override http request option.
2978
1929
  * @throws {RequiredError}
2979
1930
  */
2980
- updateDataset: (organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1931
+ updateDataset: (organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2981
1932
  /**
2982
1933
  *
2983
1934
  * @summary Update the specified access to User for a Dataset
@@ -3016,7 +1967,6 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3016
1967
  };
3017
1968
  /**
3018
1969
  * DatasetApi - functional programming interface
3019
- * @export
3020
1970
  */
3021
1971
  export declare const DatasetApiFp: (configuration?: Configuration) => {
3022
1972
  /**
@@ -3025,11 +1975,11 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3025
1975
  * @param {string} organizationId the Organization identifier
3026
1976
  * @param {string} workspaceId the Workspace identifier
3027
1977
  * @param {DatasetCreateRequest} datasetCreateRequest
3028
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
1978
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3029
1979
  * @param {*} [options] Override http request option.
3030
1980
  * @throws {RequiredError}
3031
1981
  */
3032
- createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
1982
+ createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
3033
1983
  /**
3034
1984
  *
3035
1985
  * @summary Add a control access to the Dataset
@@ -3227,11 +2177,11 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3227
2177
  * @param {string} workspaceId the Workspace identifier
3228
2178
  * @param {string} datasetId the Dataset identifier
3229
2179
  * @param {DatasetUpdateRequest} datasetUpdateRequest
3230
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2180
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3231
2181
  * @param {*} [options] Override http request option.
3232
2182
  * @throws {RequiredError}
3233
2183
  */
3234
- updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
2184
+ updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
3235
2185
  /**
3236
2186
  *
3237
2187
  * @summary Update the specified access to User for a Dataset
@@ -3270,7 +2220,6 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3270
2220
  };
3271
2221
  /**
3272
2222
  * DatasetApi - factory interface
3273
- * @export
3274
2223
  */
3275
2224
  export declare const DatasetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3276
2225
  /**
@@ -3279,11 +2228,11 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3279
2228
  * @param {string} organizationId the Organization identifier
3280
2229
  * @param {string} workspaceId the Workspace identifier
3281
2230
  * @param {DatasetCreateRequest} datasetCreateRequest
3282
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2231
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3283
2232
  * @param {*} [options] Override http request option.
3284
2233
  * @throws {RequiredError}
3285
2234
  */
3286
- createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): AxiosPromise<Dataset>;
2235
+ createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): AxiosPromise<Dataset>;
3287
2236
  /**
3288
2237
  *
3289
2238
  * @summary Add a control access to the Dataset
@@ -3481,11 +2430,11 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3481
2430
  * @param {string} workspaceId the Workspace identifier
3482
2431
  * @param {string} datasetId the Dataset identifier
3483
2432
  * @param {DatasetUpdateRequest} datasetUpdateRequest
3484
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2433
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3485
2434
  * @param {*} [options] Override http request option.
3486
2435
  * @throws {RequiredError}
3487
2436
  */
3488
- updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): AxiosPromise<Dataset>;
2437
+ updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): AxiosPromise<Dataset>;
3489
2438
  /**
3490
2439
  *
3491
2440
  * @summary Update the specified access to User for a Dataset
@@ -3524,9 +2473,6 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3524
2473
  };
3525
2474
  /**
3526
2475
  * DatasetApi - object-oriented interface
3527
- * @export
3528
- * @class DatasetApi
3529
- * @extends {BaseAPI}
3530
2476
  */
3531
2477
  export declare class DatasetApi extends BaseAPI {
3532
2478
  /**
@@ -3535,12 +2481,11 @@ export declare class DatasetApi extends BaseAPI {
3535
2481
  * @param {string} organizationId the Organization identifier
3536
2482
  * @param {string} workspaceId the Workspace identifier
3537
2483
  * @param {DatasetCreateRequest} datasetCreateRequest
3538
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2484
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3539
2485
  * @param {*} [options] Override http request option.
3540
2486
  * @throws {RequiredError}
3541
- * @memberof DatasetApi
3542
2487
  */
3543
- createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset, any, {}>>;
2488
+ createDataset(organizationId: string, workspaceId: string, datasetCreateRequest: DatasetCreateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset, any, {}>>;
3544
2489
  /**
3545
2490
  *
3546
2491
  * @summary Add a control access to the Dataset
@@ -3550,7 +2495,6 @@ export declare class DatasetApi extends BaseAPI {
3550
2495
  * @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
3551
2496
  * @param {*} [options] Override http request option.
3552
2497
  * @throws {RequiredError}
3553
- * @memberof DatasetApi
3554
2498
  */
3555
2499
  createDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl, any, {}>>;
3556
2500
  /**
@@ -3563,7 +2507,6 @@ export declare class DatasetApi extends BaseAPI {
3563
2507
  * @param {DatasetPartCreateRequest} datasetPartCreateRequest
3564
2508
  * @param {*} [options] Override http request option.
3565
2509
  * @throws {RequiredError}
3566
- * @memberof DatasetApi
3567
2510
  */
3568
2511
  createDatasetPart(organizationId: string, workspaceId: string, datasetId: string, file: File, datasetPartCreateRequest: DatasetPartCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
3569
2512
  /**
@@ -3574,7 +2517,6 @@ export declare class DatasetApi extends BaseAPI {
3574
2517
  * @param {string} datasetId the Dataset identifier
3575
2518
  * @param {*} [options] Override http request option.
3576
2519
  * @throws {RequiredError}
3577
- * @memberof DatasetApi
3578
2520
  */
3579
2521
  deleteDataset(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3580
2522
  /**
@@ -3586,7 +2528,6 @@ export declare class DatasetApi extends BaseAPI {
3586
2528
  * @param {string} identityId the User identifier
3587
2529
  * @param {*} [options] Override http request option.
3588
2530
  * @throws {RequiredError}
3589
- * @memberof DatasetApi
3590
2531
  */
3591
2532
  deleteDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3592
2533
  /**
@@ -3598,7 +2539,6 @@ export declare class DatasetApi extends BaseAPI {
3598
2539
  * @param {string} datasetPartId the Dataset part identifier
3599
2540
  * @param {*} [options] Override http request option.
3600
2541
  * @throws {RequiredError}
3601
- * @memberof DatasetApi
3602
2542
  */
3603
2543
  deleteDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3604
2544
  /**
@@ -3610,7 +2550,6 @@ export declare class DatasetApi extends BaseAPI {
3610
2550
  * @param {string} datasetPartId the Dataset part identifier
3611
2551
  * @param {*} [options] Override http request option.
3612
2552
  * @throws {RequiredError}
3613
- * @memberof DatasetApi
3614
2553
  */
3615
2554
  downloadDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
3616
2555
  /**
@@ -3621,7 +2560,6 @@ export declare class DatasetApi extends BaseAPI {
3621
2560
  * @param {string} datasetId the Dataset identifier
3622
2561
  * @param {*} [options] Override http request option.
3623
2562
  * @throws {RequiredError}
3624
- * @memberof DatasetApi
3625
2563
  */
3626
2564
  getDataset(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset, any, {}>>;
3627
2565
  /**
@@ -3633,7 +2571,6 @@ export declare class DatasetApi extends BaseAPI {
3633
2571
  * @param {string} identityId the User identifier
3634
2572
  * @param {*} [options] Override http request option.
3635
2573
  * @throws {RequiredError}
3636
- * @memberof DatasetApi
3637
2574
  */
3638
2575
  getDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl, any, {}>>;
3639
2576
  /**
@@ -3645,7 +2582,6 @@ export declare class DatasetApi extends BaseAPI {
3645
2582
  * @param {string} datasetPartId the Dataset part identifier
3646
2583
  * @param {*} [options] Override http request option.
3647
2584
  * @throws {RequiredError}
3648
- * @memberof DatasetApi
3649
2585
  */
3650
2586
  getDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
3651
2587
  /**
@@ -3658,7 +2594,6 @@ export declare class DatasetApi extends BaseAPI {
3658
2594
  * @param {number} [size] Amount of result by page
3659
2595
  * @param {*} [options] Override http request option.
3660
2596
  * @throws {RequiredError}
3661
- * @memberof DatasetApi
3662
2597
  */
3663
2598
  listDatasetParts(organizationId: string, workspaceId: string, datasetId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart[], any, {}>>;
3664
2599
  /**
@@ -3669,7 +2604,6 @@ export declare class DatasetApi extends BaseAPI {
3669
2604
  * @param {string} datasetId the Dataset identifier
3670
2605
  * @param {*} [options] Override http request option.
3671
2606
  * @throws {RequiredError}
3672
- * @memberof DatasetApi
3673
2607
  */
3674
2608
  listDatasetSecurityUsers(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
3675
2609
  /**
@@ -3681,7 +2615,6 @@ export declare class DatasetApi extends BaseAPI {
3681
2615
  * @param {number} [size] Amount of result by page
3682
2616
  * @param {*} [options] Override http request option.
3683
2617
  * @throws {RequiredError}
3684
- * @memberof DatasetApi
3685
2618
  */
3686
2619
  listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
3687
2620
  /**
@@ -3703,7 +2636,6 @@ export declare class DatasetApi extends BaseAPI {
3703
2636
  * @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).
3704
2637
  * @param {*} [options] Override http request option.
3705
2638
  * @throws {RequiredError}
3706
- * @memberof DatasetApi
3707
2639
  */
3708
2640
  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, {}>>;
3709
2641
  /**
@@ -3717,7 +2649,6 @@ export declare class DatasetApi extends BaseAPI {
3717
2649
  * @param {DatasetPartUpdateRequest} [datasetPartUpdateRequest]
3718
2650
  * @param {*} [options] Override http request option.
3719
2651
  * @throws {RequiredError}
3720
- * @memberof DatasetApi
3721
2652
  */
3722
2653
  replaceDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, file: File, datasetPartUpdateRequest?: DatasetPartUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
3723
2654
  /**
@@ -3731,7 +2662,6 @@ export declare class DatasetApi extends BaseAPI {
3731
2662
  * @param {number} [size] Amount of result by page
3732
2663
  * @param {*} [options] Override http request option.
3733
2664
  * @throws {RequiredError}
3734
- * @memberof DatasetApi
3735
2665
  */
3736
2666
  searchDatasetParts(organizationId: string, workspaceId: string, datasetId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart[], any, {}>>;
3737
2667
  /**
@@ -3744,7 +2674,6 @@ export declare class DatasetApi extends BaseAPI {
3744
2674
  * @param {number} [size] Amount of result by page
3745
2675
  * @param {*} [options] Override http request option.
3746
2676
  * @throws {RequiredError}
3747
- * @memberof DatasetApi
3748
2677
  */
3749
2678
  searchDatasets(organizationId: string, workspaceId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
3750
2679
  /**
@@ -3754,12 +2683,11 @@ export declare class DatasetApi extends BaseAPI {
3754
2683
  * @param {string} workspaceId the Workspace identifier
3755
2684
  * @param {string} datasetId the Dataset identifier
3756
2685
  * @param {DatasetUpdateRequest} datasetUpdateRequest
3757
- * @param {Array<File>} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
2686
+ * @param {Array<File> | null} [files] Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on
3758
2687
  * @param {*} [options] Override http request option.
3759
2688
  * @throws {RequiredError}
3760
- * @memberof DatasetApi
3761
2689
  */
3762
- updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset, any, {}>>;
2690
+ updateDataset(organizationId: string, workspaceId: string, datasetId: string, datasetUpdateRequest: DatasetUpdateRequest, files?: Array<File> | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset, any, {}>>;
3763
2691
  /**
3764
2692
  *
3765
2693
  * @summary Update the specified access to User for a Dataset
@@ -3770,7 +2698,6 @@ export declare class DatasetApi extends BaseAPI {
3770
2698
  * @param {DatasetRole} datasetRole The new Dataset Access Control
3771
2699
  * @param {*} [options] Override http request option.
3772
2700
  * @throws {RequiredError}
3773
- * @memberof DatasetApi
3774
2701
  */
3775
2702
  updateDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl, any, {}>>;
3776
2703
  /**
@@ -3782,7 +2709,6 @@ export declare class DatasetApi extends BaseAPI {
3782
2709
  * @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
3783
2710
  * @param {*} [options] Override http request option.
3784
2711
  * @throws {RequiredError}
3785
- * @memberof DatasetApi
3786
2712
  */
3787
2713
  updateDatasetDefaultSecurity(organizationId: string, workspaceId: string, datasetId: string, datasetRole: DatasetRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity, any, {}>>;
3788
2714
  /**
@@ -3795,13 +2721,11 @@ export declare class DatasetApi extends BaseAPI {
3795
2721
  * @param {DatasetPartUpdateRequest} datasetPartUpdateRequest Dataset part information to update
3796
2722
  * @param {*} [options] Override http request option.
3797
2723
  * @throws {RequiredError}
3798
- * @memberof DatasetApi
3799
2724
  */
3800
2725
  updateDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, datasetPartUpdateRequest: DatasetPartUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
3801
2726
  }
3802
2727
  /**
3803
2728
  * MetaApi - axios parameter creator
3804
- * @export
3805
2729
  */
3806
2730
  export declare const MetaApiAxiosParamCreator: (configuration?: Configuration) => {
3807
2731
  /**
@@ -3814,7 +2738,6 @@ export declare const MetaApiAxiosParamCreator: (configuration?: Configuration) =
3814
2738
  };
3815
2739
  /**
3816
2740
  * MetaApi - functional programming interface
3817
- * @export
3818
2741
  */
3819
2742
  export declare const MetaApiFp: (configuration?: Configuration) => {
3820
2743
  /**
@@ -3827,7 +2750,6 @@ export declare const MetaApiFp: (configuration?: Configuration) => {
3827
2750
  };
3828
2751
  /**
3829
2752
  * MetaApi - factory interface
3830
- * @export
3831
2753
  */
3832
2754
  export declare const MetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3833
2755
  /**
@@ -3840,9 +2762,6 @@ export declare const MetaApiFactory: (configuration?: Configuration, basePath?:
3840
2762
  };
3841
2763
  /**
3842
2764
  * MetaApi - object-oriented interface
3843
- * @export
3844
- * @class MetaApi
3845
- * @extends {BaseAPI}
3846
2765
  */
3847
2766
  export declare class MetaApi extends BaseAPI {
3848
2767
  /**
@@ -3850,13 +2769,11 @@ export declare class MetaApi extends BaseAPI {
3850
2769
  * @summary Get various information about the API
3851
2770
  * @param {*} [options] Override http request option.
3852
2771
  * @throws {RequiredError}
3853
- * @memberof MetaApi
3854
2772
  */
3855
2773
  about(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AboutInfo, any, {}>>;
3856
2774
  }
3857
2775
  /**
3858
2776
  * OrganizationApi - axios parameter creator
3859
- * @export
3860
2777
  */
3861
2778
  export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
3862
2779
  /**
@@ -3982,7 +2899,6 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
3982
2899
  };
3983
2900
  /**
3984
2901
  * OrganizationApi - functional programming interface
3985
- * @export
3986
2902
  */
3987
2903
  export declare const OrganizationApiFp: (configuration?: Configuration) => {
3988
2904
  /**
@@ -4108,7 +3024,6 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
4108
3024
  };
4109
3025
  /**
4110
3026
  * OrganizationApi - factory interface
4111
- * @export
4112
3027
  */
4113
3028
  export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4114
3029
  /**
@@ -4234,9 +3149,6 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
4234
3149
  };
4235
3150
  /**
4236
3151
  * OrganizationApi - object-oriented interface
4237
- * @export
4238
- * @class OrganizationApi
4239
- * @extends {BaseAPI}
4240
3152
  */
4241
3153
  export declare class OrganizationApi extends BaseAPI {
4242
3154
  /**
@@ -4245,7 +3157,6 @@ export declare class OrganizationApi extends BaseAPI {
4245
3157
  * @param {OrganizationCreateRequest} organizationCreateRequest The Organization to create
4246
3158
  * @param {*} [options] Override http request option.
4247
3159
  * @throws {RequiredError}
4248
- * @memberof OrganizationApi
4249
3160
  */
4250
3161
  createOrganization(organizationCreateRequest: OrganizationCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}>>;
4251
3162
  /**
@@ -4255,7 +3166,6 @@ export declare class OrganizationApi extends BaseAPI {
4255
3166
  * @param {OrganizationAccessControl} organizationAccessControl The new Organization security access to add.
4256
3167
  * @param {*} [options] Override http request option.
4257
3168
  * @throws {RequiredError}
4258
- * @memberof OrganizationApi
4259
3169
  */
4260
3170
  createOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl, any, {}>>;
4261
3171
  /**
@@ -4264,7 +3174,6 @@ export declare class OrganizationApi extends BaseAPI {
4264
3174
  * @param {string} organizationId The Organization identifier
4265
3175
  * @param {*} [options] Override http request option.
4266
3176
  * @throws {RequiredError}
4267
- * @memberof OrganizationApi
4268
3177
  */
4269
3178
  deleteOrganization(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
4270
3179
  /**
@@ -4274,7 +3183,6 @@ export declare class OrganizationApi extends BaseAPI {
4274
3183
  * @param {string} identityId The User identifier
4275
3184
  * @param {*} [options] Override http request option.
4276
3185
  * @throws {RequiredError}
4277
- * @memberof OrganizationApi
4278
3186
  */
4279
3187
  deleteOrganizationAccessControl(organizationId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
4280
3188
  /**
@@ -4283,7 +3191,6 @@ export declare class OrganizationApi extends BaseAPI {
4283
3191
  * @param {string} organizationId The Organization identifier
4284
3192
  * @param {*} [options] Override http request option.
4285
3193
  * @throws {RequiredError}
4286
- * @memberof OrganizationApi
4287
3194
  */
4288
3195
  getOrganization(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}>>;
4289
3196
  /**
@@ -4293,7 +3200,6 @@ export declare class OrganizationApi extends BaseAPI {
4293
3200
  * @param {string} identityId The User identifier
4294
3201
  * @param {*} [options] Override http request option.
4295
3202
  * @throws {RequiredError}
4296
- * @memberof OrganizationApi
4297
3203
  */
4298
3204
  getOrganizationAccessControl(organizationId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl, any, {}>>;
4299
3205
  /**
@@ -4303,7 +3209,6 @@ export declare class OrganizationApi extends BaseAPI {
4303
3209
  * @param {string} role The Role
4304
3210
  * @param {*} [options] Override http request option.
4305
3211
  * @throws {RequiredError}
4306
- * @memberof OrganizationApi
4307
3212
  */
4308
3213
  getOrganizationPermissions(organizationId: string, role: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
4309
3214
  /**
@@ -4312,7 +3217,6 @@ export declare class OrganizationApi extends BaseAPI {
4312
3217
  * @param {string} organizationId The Organization identifier
4313
3218
  * @param {*} [options] Override http request option.
4314
3219
  * @throws {RequiredError}
4315
- * @memberof OrganizationApi
4316
3220
  */
4317
3221
  getOrganizationSecurity(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationSecurity, any, {}>>;
4318
3222
  /**
@@ -4321,7 +3225,6 @@ export declare class OrganizationApi extends BaseAPI {
4321
3225
  * @param {string} organizationId The Organization identifier
4322
3226
  * @param {*} [options] Override http request option.
4323
3227
  * @throws {RequiredError}
4324
- * @memberof OrganizationApi
4325
3228
  */
4326
3229
  listOrganizationSecurityUsers(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
4327
3230
  /**
@@ -4331,7 +3234,6 @@ export declare class OrganizationApi extends BaseAPI {
4331
3234
  * @param {number} [size] Amount of result by page
4332
3235
  * @param {*} [options] Override http request option.
4333
3236
  * @throws {RequiredError}
4334
- * @memberof OrganizationApi
4335
3237
  */
4336
3238
  listOrganizations(page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization[], any, {}>>;
4337
3239
  /**
@@ -4339,7 +3241,6 @@ export declare class OrganizationApi extends BaseAPI {
4339
3241
  * @summary Get all permissions per components
4340
3242
  * @param {*} [options] Override http request option.
4341
3243
  * @throws {RequiredError}
4342
- * @memberof OrganizationApi
4343
3244
  */
4344
3245
  listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ComponentRolePermissions[], any, {}>>;
4345
3246
  /**
@@ -4349,7 +3250,6 @@ export declare class OrganizationApi extends BaseAPI {
4349
3250
  * @param {OrganizationUpdateRequest} organizationUpdateRequest The new Organization details. This endpoint can\&#39;t be used to update security
4350
3251
  * @param {*} [options] Override http request option.
4351
3252
  * @throws {RequiredError}
4352
- * @memberof OrganizationApi
4353
3253
  */
4354
3254
  updateOrganization(organizationId: string, organizationUpdateRequest: OrganizationUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}>>;
4355
3255
  /**
@@ -4360,7 +3260,6 @@ export declare class OrganizationApi extends BaseAPI {
4360
3260
  * @param {OrganizationRole} organizationRole The new Organization Access Control
4361
3261
  * @param {*} [options] Override http request option.
4362
3262
  * @throws {RequiredError}
4363
- * @memberof OrganizationApi
4364
3263
  */
4365
3264
  updateOrganizationAccessControl(organizationId: string, identityId: string, organizationRole: OrganizationRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl, any, {}>>;
4366
3265
  /**
@@ -4370,22 +3269,20 @@ export declare class OrganizationApi extends BaseAPI {
4370
3269
  * @param {OrganizationRole} organizationRole This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.
4371
3270
  * @param {*} [options] Override http request option.
4372
3271
  * @throws {RequiredError}
4373
- * @memberof OrganizationApi
4374
3272
  */
4375
3273
  updateOrganizationDefaultSecurity(organizationId: string, organizationRole: OrganizationRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationSecurity, any, {}>>;
4376
3274
  }
4377
3275
  /**
4378
3276
  * RunApi - axios parameter creator
4379
- * @export
4380
3277
  */
4381
3278
  export declare const RunApiAxiosParamCreator: (configuration?: Configuration) => {
4382
3279
  /**
4383
3280
  *
4384
3281
  * @summary Delete a run
4385
- * @param {string} organizationId the Organization identifier
4386
- * @param {string} workspaceId the Workspace identifier
4387
- * @param {string} runnerId the Runner identifier
4388
- * @param {string} runId the Run identifier
3282
+ * @param {string} organizationId The Organization identifier
3283
+ * @param {string} workspaceId The Workspace identifier
3284
+ * @param {string} runnerId The Runner identifier
3285
+ * @param {string} runId The Run identifier
4389
3286
  * @param {*} [options] Override http request option.
4390
3287
  * @throws {RequiredError}
4391
3288
  */
@@ -4393,10 +3290,10 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4393
3290
  /**
4394
3291
  *
4395
3292
  * @summary Get the details of a run
4396
- * @param {string} organizationId the Organization identifier
4397
- * @param {string} workspaceId the Workspace identifier
4398
- * @param {string} runnerId the Runner identifier
4399
- * @param {string} runId the Run identifier
3293
+ * @param {string} organizationId The Organization identifier
3294
+ * @param {string} workspaceId The Workspace identifier
3295
+ * @param {string} runnerId The Runner identifier
3296
+ * @param {string} runId The Run identifier
4400
3297
  * @param {*} [options] Override http request option.
4401
3298
  * @throws {RequiredError}
4402
3299
  */
@@ -4404,10 +3301,10 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4404
3301
  /**
4405
3302
  *
4406
3303
  * @summary get the logs for the Run
4407
- * @param {string} organizationId the Organization identifier
4408
- * @param {string} workspaceId the Workspace identifier
4409
- * @param {string} runnerId the Runner identifier
4410
- * @param {string} runId the Run identifier
3304
+ * @param {string} organizationId The Organization identifier
3305
+ * @param {string} workspaceId The Workspace identifier
3306
+ * @param {string} runnerId The Runner identifier
3307
+ * @param {string} runId The Run identifier
4411
3308
  * @param {*} [options] Override http request option.
4412
3309
  * @throws {RequiredError}
4413
3310
  */
@@ -4415,10 +3312,10 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4415
3312
  /**
4416
3313
  *
4417
3314
  * @summary get the status for the Run
4418
- * @param {string} organizationId the Organization identifier
4419
- * @param {string} workspaceId the Workspace identifier
4420
- * @param {string} runnerId the Runner identifier
4421
- * @param {string} runId the Run identifier
3315
+ * @param {string} organizationId The Organization identifier
3316
+ * @param {string} workspaceId The Workspace identifier
3317
+ * @param {string} runnerId The Runner identifier
3318
+ * @param {string} runId The Run identifier
4422
3319
  * @param {*} [options] Override http request option.
4423
3320
  * @throws {RequiredError}
4424
3321
  */
@@ -4426,9 +3323,9 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4426
3323
  /**
4427
3324
  *
4428
3325
  * @summary get the list of Runs for the Runner
4429
- * @param {string} organizationId the Organization identifier
4430
- * @param {string} workspaceId the Workspace identifier
4431
- * @param {string} runnerId the Runner identifier
3326
+ * @param {string} organizationId The Organization identifier
3327
+ * @param {string} workspaceId The Workspace identifier
3328
+ * @param {string} runnerId The Runner identifier
4432
3329
  * @param {number} [page] page number to query (first page is at index 0)
4433
3330
  * @param {number} [size] amount of result by page
4434
3331
  * @param {*} [options] Override http request option.
@@ -4438,16 +3335,15 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
4438
3335
  };
4439
3336
  /**
4440
3337
  * RunApi - functional programming interface
4441
- * @export
4442
3338
  */
4443
3339
  export declare const RunApiFp: (configuration?: Configuration) => {
4444
3340
  /**
4445
3341
  *
4446
3342
  * @summary Delete a run
4447
- * @param {string} organizationId the Organization identifier
4448
- * @param {string} workspaceId the Workspace identifier
4449
- * @param {string} runnerId the Runner identifier
4450
- * @param {string} runId the Run identifier
3343
+ * @param {string} organizationId The Organization identifier
3344
+ * @param {string} workspaceId The Workspace identifier
3345
+ * @param {string} runnerId The Runner identifier
3346
+ * @param {string} runId The Run identifier
4451
3347
  * @param {*} [options] Override http request option.
4452
3348
  * @throws {RequiredError}
4453
3349
  */
@@ -4455,10 +3351,10 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4455
3351
  /**
4456
3352
  *
4457
3353
  * @summary Get the details of a run
4458
- * @param {string} organizationId the Organization identifier
4459
- * @param {string} workspaceId the Workspace identifier
4460
- * @param {string} runnerId the Runner identifier
4461
- * @param {string} runId the Run identifier
3354
+ * @param {string} organizationId The Organization identifier
3355
+ * @param {string} workspaceId The Workspace identifier
3356
+ * @param {string} runnerId The Runner identifier
3357
+ * @param {string} runId The Run identifier
4462
3358
  * @param {*} [options] Override http request option.
4463
3359
  * @throws {RequiredError}
4464
3360
  */
@@ -4466,10 +3362,10 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4466
3362
  /**
4467
3363
  *
4468
3364
  * @summary get the logs for the Run
4469
- * @param {string} organizationId the Organization identifier
4470
- * @param {string} workspaceId the Workspace identifier
4471
- * @param {string} runnerId the Runner identifier
4472
- * @param {string} runId the Run identifier
3365
+ * @param {string} organizationId The Organization identifier
3366
+ * @param {string} workspaceId The Workspace identifier
3367
+ * @param {string} runnerId The Runner identifier
3368
+ * @param {string} runId The Run identifier
4473
3369
  * @param {*} [options] Override http request option.
4474
3370
  * @throws {RequiredError}
4475
3371
  */
@@ -4477,10 +3373,10 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4477
3373
  /**
4478
3374
  *
4479
3375
  * @summary get the status for the Run
4480
- * @param {string} organizationId the Organization identifier
4481
- * @param {string} workspaceId the Workspace identifier
4482
- * @param {string} runnerId the Runner identifier
4483
- * @param {string} runId the Run identifier
3376
+ * @param {string} organizationId The Organization identifier
3377
+ * @param {string} workspaceId The Workspace identifier
3378
+ * @param {string} runnerId The Runner identifier
3379
+ * @param {string} runId The Run identifier
4484
3380
  * @param {*} [options] Override http request option.
4485
3381
  * @throws {RequiredError}
4486
3382
  */
@@ -4488,9 +3384,9 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4488
3384
  /**
4489
3385
  *
4490
3386
  * @summary get the list of Runs for the Runner
4491
- * @param {string} organizationId the Organization identifier
4492
- * @param {string} workspaceId the Workspace identifier
4493
- * @param {string} runnerId the Runner identifier
3387
+ * @param {string} organizationId The Organization identifier
3388
+ * @param {string} workspaceId The Workspace identifier
3389
+ * @param {string} runnerId The Runner identifier
4494
3390
  * @param {number} [page] page number to query (first page is at index 0)
4495
3391
  * @param {number} [size] amount of result by page
4496
3392
  * @param {*} [options] Override http request option.
@@ -4500,16 +3396,15 @@ export declare const RunApiFp: (configuration?: Configuration) => {
4500
3396
  };
4501
3397
  /**
4502
3398
  * RunApi - factory interface
4503
- * @export
4504
3399
  */
4505
3400
  export declare const RunApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4506
3401
  /**
4507
3402
  *
4508
3403
  * @summary Delete a run
4509
- * @param {string} organizationId the Organization identifier
4510
- * @param {string} workspaceId the Workspace identifier
4511
- * @param {string} runnerId the Runner identifier
4512
- * @param {string} runId the Run identifier
3404
+ * @param {string} organizationId The Organization identifier
3405
+ * @param {string} workspaceId The Workspace identifier
3406
+ * @param {string} runnerId The Runner identifier
3407
+ * @param {string} runId The Run identifier
4513
3408
  * @param {*} [options] Override http request option.
4514
3409
  * @throws {RequiredError}
4515
3410
  */
@@ -4517,10 +3412,10 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4517
3412
  /**
4518
3413
  *
4519
3414
  * @summary Get the details of a run
4520
- * @param {string} organizationId the Organization identifier
4521
- * @param {string} workspaceId the Workspace identifier
4522
- * @param {string} runnerId the Runner identifier
4523
- * @param {string} runId the Run identifier
3415
+ * @param {string} organizationId The Organization identifier
3416
+ * @param {string} workspaceId The Workspace identifier
3417
+ * @param {string} runnerId The Runner identifier
3418
+ * @param {string} runId The Run identifier
4524
3419
  * @param {*} [options] Override http request option.
4525
3420
  * @throws {RequiredError}
4526
3421
  */
@@ -4528,10 +3423,10 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4528
3423
  /**
4529
3424
  *
4530
3425
  * @summary get the logs for the Run
4531
- * @param {string} organizationId the Organization identifier
4532
- * @param {string} workspaceId the Workspace identifier
4533
- * @param {string} runnerId the Runner identifier
4534
- * @param {string} runId the Run identifier
3426
+ * @param {string} organizationId The Organization identifier
3427
+ * @param {string} workspaceId The Workspace identifier
3428
+ * @param {string} runnerId The Runner identifier
3429
+ * @param {string} runId The Run identifier
4535
3430
  * @param {*} [options] Override http request option.
4536
3431
  * @throws {RequiredError}
4537
3432
  */
@@ -4539,10 +3434,10 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4539
3434
  /**
4540
3435
  *
4541
3436
  * @summary get the status for the Run
4542
- * @param {string} organizationId the Organization identifier
4543
- * @param {string} workspaceId the Workspace identifier
4544
- * @param {string} runnerId the Runner identifier
4545
- * @param {string} runId the Run identifier
3437
+ * @param {string} organizationId The Organization identifier
3438
+ * @param {string} workspaceId The Workspace identifier
3439
+ * @param {string} runnerId The Runner identifier
3440
+ * @param {string} runId The Run identifier
4546
3441
  * @param {*} [options] Override http request option.
4547
3442
  * @throws {RequiredError}
4548
3443
  */
@@ -4550,9 +3445,9 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4550
3445
  /**
4551
3446
  *
4552
3447
  * @summary get the list of Runs for the Runner
4553
- * @param {string} organizationId the Organization identifier
4554
- * @param {string} workspaceId the Workspace identifier
4555
- * @param {string} runnerId the Runner identifier
3448
+ * @param {string} organizationId The Organization identifier
3449
+ * @param {string} workspaceId The Workspace identifier
3450
+ * @param {string} runnerId The Runner identifier
4556
3451
  * @param {number} [page] page number to query (first page is at index 0)
4557
3452
  * @param {number} [size] amount of result by page
4558
3453
  * @param {*} [options] Override http request option.
@@ -4562,76 +3457,67 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
4562
3457
  };
4563
3458
  /**
4564
3459
  * RunApi - object-oriented interface
4565
- * @export
4566
- * @class RunApi
4567
- * @extends {BaseAPI}
4568
3460
  */
4569
3461
  export declare class RunApi extends BaseAPI {
4570
3462
  /**
4571
3463
  *
4572
3464
  * @summary Delete a run
4573
- * @param {string} organizationId the Organization identifier
4574
- * @param {string} workspaceId the Workspace identifier
4575
- * @param {string} runnerId the Runner identifier
4576
- * @param {string} runId the Run identifier
3465
+ * @param {string} organizationId The Organization identifier
3466
+ * @param {string} workspaceId The Workspace identifier
3467
+ * @param {string} runnerId The Runner identifier
3468
+ * @param {string} runId The Run identifier
4577
3469
  * @param {*} [options] Override http request option.
4578
3470
  * @throws {RequiredError}
4579
- * @memberof RunApi
4580
3471
  */
4581
3472
  deleteRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
4582
3473
  /**
4583
3474
  *
4584
3475
  * @summary Get the details of a run
4585
- * @param {string} organizationId the Organization identifier
4586
- * @param {string} workspaceId the Workspace identifier
4587
- * @param {string} runnerId the Runner identifier
4588
- * @param {string} runId the Run identifier
3476
+ * @param {string} organizationId The Organization identifier
3477
+ * @param {string} workspaceId The Workspace identifier
3478
+ * @param {string} runnerId The Runner identifier
3479
+ * @param {string} runId The Run identifier
4589
3480
  * @param {*} [options] Override http request option.
4590
3481
  * @throws {RequiredError}
4591
- * @memberof RunApi
4592
3482
  */
4593
3483
  getRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Run, any, {}>>;
4594
3484
  /**
4595
3485
  *
4596
3486
  * @summary get the logs for the Run
4597
- * @param {string} organizationId the Organization identifier
4598
- * @param {string} workspaceId the Workspace identifier
4599
- * @param {string} runnerId the Runner identifier
4600
- * @param {string} runId the Run identifier
3487
+ * @param {string} organizationId The Organization identifier
3488
+ * @param {string} workspaceId The Workspace identifier
3489
+ * @param {string} runnerId The Runner identifier
3490
+ * @param {string} runId The Run identifier
4601
3491
  * @param {*} [options] Override http request option.
4602
3492
  * @throws {RequiredError}
4603
- * @memberof RunApi
4604
3493
  */
4605
3494
  getRunLogs(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
4606
3495
  /**
4607
3496
  *
4608
3497
  * @summary get the status for the Run
4609
- * @param {string} organizationId the Organization identifier
4610
- * @param {string} workspaceId the Workspace identifier
4611
- * @param {string} runnerId the Runner identifier
4612
- * @param {string} runId the Run identifier
3498
+ * @param {string} organizationId The Organization identifier
3499
+ * @param {string} workspaceId The Workspace identifier
3500
+ * @param {string} runnerId The Runner identifier
3501
+ * @param {string} runId The Run identifier
4613
3502
  * @param {*} [options] Override http request option.
4614
3503
  * @throws {RequiredError}
4615
- * @memberof RunApi
4616
3504
  */
4617
3505
  getRunStatus(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunStatus, any, {}>>;
4618
3506
  /**
4619
3507
  *
4620
3508
  * @summary get the list of Runs for the Runner
4621
- * @param {string} organizationId the Organization identifier
4622
- * @param {string} workspaceId the Workspace identifier
4623
- * @param {string} runnerId the Runner identifier
3509
+ * @param {string} organizationId The Organization identifier
3510
+ * @param {string} workspaceId The Workspace identifier
3511
+ * @param {string} runnerId The Runner identifier
4624
3512
  * @param {number} [page] page number to query (first page is at index 0)
4625
3513
  * @param {number} [size] amount of result by page
4626
3514
  * @param {*} [options] Override http request option.
4627
3515
  * @throws {RequiredError}
4628
- * @memberof RunApi
4629
3516
  */
4630
3517
  listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Run[], any, {}>>;
4631
3518
  }
4632
3519
  /**
4633
3520
  * RunnerApi - axios parameter creator
4634
- * @export
4635
3521
  */
4636
3522
  export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration) => {
4637
3523
  /**
@@ -4796,7 +3682,6 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
4796
3682
  };
4797
3683
  /**
4798
3684
  * RunnerApi - functional programming interface
4799
- * @export
4800
3685
  */
4801
3686
  export declare const RunnerApiFp: (configuration?: Configuration) => {
4802
3687
  /**
@@ -4961,7 +3846,6 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
4961
3846
  };
4962
3847
  /**
4963
3848
  * RunnerApi - factory interface
4964
- * @export
4965
3849
  */
4966
3850
  export declare const RunnerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4967
3851
  /**
@@ -5126,9 +4010,6 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
5126
4010
  };
5127
4011
  /**
5128
4012
  * RunnerApi - object-oriented interface
5129
- * @export
5130
- * @class RunnerApi
5131
- * @extends {BaseAPI}
5132
4013
  */
5133
4014
  export declare class RunnerApi extends BaseAPI {
5134
4015
  /**
@@ -5139,7 +4020,6 @@ export declare class RunnerApi extends BaseAPI {
5139
4020
  * @param {RunnerCreateRequest} runnerCreateRequest the Runner to create
5140
4021
  * @param {*} [options] Override http request option.
5141
4022
  * @throws {RequiredError}
5142
- * @memberof RunnerApi
5143
4023
  */
5144
4024
  createRunner(organizationId: string, workspaceId: string, runnerCreateRequest: RunnerCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
5145
4025
  /**
@@ -5151,7 +4031,6 @@ export declare class RunnerApi extends BaseAPI {
5151
4031
  * @param {RunnerAccessControl} runnerAccessControl the new Runner security access to add.
5152
4032
  * @param {*} [options] Override http request option.
5153
4033
  * @throws {RequiredError}
5154
- * @memberof RunnerApi
5155
4034
  */
5156
4035
  createRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, runnerAccessControl: RunnerAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerAccessControl, any, {}>>;
5157
4036
  /**
@@ -5162,7 +4041,6 @@ export declare class RunnerApi extends BaseAPI {
5162
4041
  * @param {string} runnerId the Runner identifier
5163
4042
  * @param {*} [options] Override http request option.
5164
4043
  * @throws {RequiredError}
5165
- * @memberof RunnerApi
5166
4044
  */
5167
4045
  deleteRunner(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
5168
4046
  /**
@@ -5174,7 +4052,6 @@ export declare class RunnerApi extends BaseAPI {
5174
4052
  * @param {string} identityId the User identifier
5175
4053
  * @param {*} [options] Override http request option.
5176
4054
  * @throws {RequiredError}
5177
- * @memberof RunnerApi
5178
4055
  */
5179
4056
  deleteRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
5180
4057
  /**
@@ -5185,7 +4062,6 @@ export declare class RunnerApi extends BaseAPI {
5185
4062
  * @param {string} runnerId the Runner identifier
5186
4063
  * @param {*} [options] Override http request option.
5187
4064
  * @throws {RequiredError}
5188
- * @memberof RunnerApi
5189
4065
  */
5190
4066
  getRunner(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
5191
4067
  /**
@@ -5197,7 +4073,6 @@ export declare class RunnerApi extends BaseAPI {
5197
4073
  * @param {string} identityId the User identifier
5198
4074
  * @param {*} [options] Override http request option.
5199
4075
  * @throws {RequiredError}
5200
- * @memberof RunnerApi
5201
4076
  */
5202
4077
  getRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerAccessControl, any, {}>>;
5203
4078
  /**
@@ -5208,7 +4083,6 @@ export declare class RunnerApi extends BaseAPI {
5208
4083
  * @param {string} runnerId the Runner identifier
5209
4084
  * @param {*} [options] Override http request option.
5210
4085
  * @throws {RequiredError}
5211
- * @memberof RunnerApi
5212
4086
  */
5213
4087
  getRunnerSecurity(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerSecurity, any, {}>>;
5214
4088
  /**
@@ -5220,7 +4094,6 @@ export declare class RunnerApi extends BaseAPI {
5220
4094
  * @param {string} role the Role
5221
4095
  * @param {*} [options] Override http request option.
5222
4096
  * @throws {RequiredError}
5223
- * @memberof RunnerApi
5224
4097
  */
5225
4098
  listRunnerPermissions(organizationId: string, workspaceId: string, runnerId: string, role: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
5226
4099
  /**
@@ -5231,7 +4104,6 @@ export declare class RunnerApi extends BaseAPI {
5231
4104
  * @param {string} runnerId the Runner identifier
5232
4105
  * @param {*} [options] Override http request option.
5233
4106
  * @throws {RequiredError}
5234
- * @memberof RunnerApi
5235
4107
  */
5236
4108
  listRunnerSecurityUsers(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
5237
4109
  /**
@@ -5243,7 +4115,6 @@ export declare class RunnerApi extends BaseAPI {
5243
4115
  * @param {number} [size] Amount of result by page
5244
4116
  * @param {*} [options] Override http request option.
5245
4117
  * @throws {RequiredError}
5246
- * @memberof RunnerApi
5247
4118
  */
5248
4119
  listRunners(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner[], any, {}>>;
5249
4120
  /**
@@ -5254,7 +4125,6 @@ export declare class RunnerApi extends BaseAPI {
5254
4125
  * @param {string} runnerId the Runner identifier
5255
4126
  * @param {*} [options] Override http request option.
5256
4127
  * @throws {RequiredError}
5257
- * @memberof RunnerApi
5258
4128
  */
5259
4129
  startRun(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatedRun, any, {}>>;
5260
4130
  /**
@@ -5265,7 +4135,6 @@ export declare class RunnerApi extends BaseAPI {
5265
4135
  * @param {string} runnerId the Runner identifier
5266
4136
  * @param {*} [options] Override http request option.
5267
4137
  * @throws {RequiredError}
5268
- * @memberof RunnerApi
5269
4138
  */
5270
4139
  stopRun(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
5271
4140
  /**
@@ -5277,7 +4146,6 @@ export declare class RunnerApi extends BaseAPI {
5277
4146
  * @param {RunnerUpdateRequest} runnerUpdateRequest the new Runner details. This endpoint can\&#39;t be used to update security
5278
4147
  * @param {*} [options] Override http request option.
5279
4148
  * @throws {RequiredError}
5280
- * @memberof RunnerApi
5281
4149
  */
5282
4150
  updateRunner(organizationId: string, workspaceId: string, runnerId: string, runnerUpdateRequest: RunnerUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
5283
4151
  /**
@@ -5290,7 +4158,6 @@ export declare class RunnerApi extends BaseAPI {
5290
4158
  * @param {RunnerRole} runnerRole The new Runner Access Control
5291
4159
  * @param {*} [options] Override http request option.
5292
4160
  * @throws {RequiredError}
5293
- * @memberof RunnerApi
5294
4161
  */
5295
4162
  updateRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, runnerRole: RunnerRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerAccessControl, any, {}>>;
5296
4163
  /**
@@ -5302,13 +4169,11 @@ export declare class RunnerApi extends BaseAPI {
5302
4169
  * @param {RunnerRole} runnerRole This change the runner default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the runner.
5303
4170
  * @param {*} [options] Override http request option.
5304
4171
  * @throws {RequiredError}
5305
- * @memberof RunnerApi
5306
4172
  */
5307
4173
  updateRunnerDefaultSecurity(organizationId: string, workspaceId: string, runnerId: string, runnerRole: RunnerRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerSecurity, any, {}>>;
5308
4174
  }
5309
4175
  /**
5310
4176
  * SolutionApi - axios parameter creator
5311
- * @export
5312
4177
  */
5313
4178
  export declare const SolutionApiAxiosParamCreator: (configuration?: Configuration) => {
5314
4179
  /**
@@ -5580,7 +4445,6 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
5580
4445
  };
5581
4446
  /**
5582
4447
  * SolutionApi - functional programming interface
5583
- * @export
5584
4448
  */
5585
4449
  export declare const SolutionApiFp: (configuration?: Configuration) => {
5586
4450
  /**
@@ -5852,7 +4716,6 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
5852
4716
  };
5853
4717
  /**
5854
4718
  * SolutionApi - factory interface
5855
- * @export
5856
4719
  */
5857
4720
  export declare const SolutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5858
4721
  /**
@@ -6124,9 +4987,6 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
6124
4987
  };
6125
4988
  /**
6126
4989
  * SolutionApi - object-oriented interface
6127
- * @export
6128
- * @class SolutionApi
6129
- * @extends {BaseAPI}
6130
4990
  */
6131
4991
  export declare class SolutionApi extends BaseAPI {
6132
4992
  /**
@@ -6136,7 +4996,6 @@ export declare class SolutionApi extends BaseAPI {
6136
4996
  * @param {SolutionCreateRequest} solutionCreateRequest The Solution to create
6137
4997
  * @param {*} [options] Override http request option.
6138
4998
  * @throws {RequiredError}
6139
- * @memberof SolutionApi
6140
4999
  */
6141
5000
  createSolution(organizationId: string, solutionCreateRequest: SolutionCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution, any, {}>>;
6142
5001
  /**
@@ -6147,7 +5006,6 @@ export declare class SolutionApi extends BaseAPI {
6147
5006
  * @param {SolutionAccessControl} solutionAccessControl Access control to create
6148
5007
  * @param {*} [options] Override http request option.
6149
5008
  * @throws {RequiredError}
6150
- * @memberof SolutionApi
6151
5009
  */
6152
5010
  createSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl, any, {}>>;
6153
5011
  /**
@@ -6158,7 +5016,6 @@ export declare class SolutionApi extends BaseAPI {
6158
5016
  * @param {RunTemplateParameterCreateRequest} runTemplateParameterCreateRequest Parameter to create
6159
5017
  * @param {*} [options] Override http request option.
6160
5018
  * @throws {RequiredError}
6161
- * @memberof SolutionApi
6162
5019
  */
6163
5020
  createSolutionParameter(organizationId: string, solutionId: string, runTemplateParameterCreateRequest: RunTemplateParameterCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameter, any, {}>>;
6164
5021
  /**
@@ -6169,7 +5026,6 @@ export declare class SolutionApi extends BaseAPI {
6169
5026
  * @param {RunTemplateParameterGroupCreateRequest} runTemplateParameterGroupCreateRequest Parameter group to create
6170
5027
  * @param {*} [options] Override http request option.
6171
5028
  * @throws {RequiredError}
6172
- * @memberof SolutionApi
6173
5029
  */
6174
5030
  createSolutionParameterGroup(organizationId: string, solutionId: string, runTemplateParameterGroupCreateRequest: RunTemplateParameterGroupCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameterGroup, any, {}>>;
6175
5031
  /**
@@ -6180,7 +5036,6 @@ export declare class SolutionApi extends BaseAPI {
6180
5036
  * @param {RunTemplateCreateRequest} runTemplateCreateRequest Run template to create
6181
5037
  * @param {*} [options] Override http request option.
6182
5038
  * @throws {RequiredError}
6183
- * @memberof SolutionApi
6184
5039
  */
6185
5040
  createSolutionRunTemplate(organizationId: string, solutionId: string, runTemplateCreateRequest: RunTemplateCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate, any, {}>>;
6186
5041
  /**
@@ -6190,7 +5045,6 @@ export declare class SolutionApi extends BaseAPI {
6190
5045
  * @param {string} solutionId the Solution identifier
6191
5046
  * @param {*} [options] Override http request option.
6192
5047
  * @throws {RequiredError}
6193
- * @memberof SolutionApi
6194
5048
  */
6195
5049
  deleteSolution(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
6196
5050
  /**
@@ -6201,7 +5055,6 @@ export declare class SolutionApi extends BaseAPI {
6201
5055
  * @param {string} identityId The User identifier
6202
5056
  * @param {*} [options] Override http request option.
6203
5057
  * @throws {RequiredError}
6204
- * @memberof SolutionApi
6205
5058
  */
6206
5059
  deleteSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
6207
5060
  /**
@@ -6212,7 +5065,6 @@ export declare class SolutionApi extends BaseAPI {
6212
5065
  * @param {string} parameterId The solution parameter identifier
6213
5066
  * @param {*} [options] Override http request option.
6214
5067
  * @throws {RequiredError}
6215
- * @memberof SolutionApi
6216
5068
  */
6217
5069
  deleteSolutionParameter(organizationId: string, solutionId: string, parameterId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
6218
5070
  /**
@@ -6223,7 +5075,6 @@ export declare class SolutionApi extends BaseAPI {
6223
5075
  * @param {string} parameterGroupId The parameter group identifier
6224
5076
  * @param {*} [options] Override http request option.
6225
5077
  * @throws {RequiredError}
6226
- * @memberof SolutionApi
6227
5078
  */
6228
5079
  deleteSolutionParameterGroup(organizationId: string, solutionId: string, parameterGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
6229
5080
  /**
@@ -6234,7 +5085,6 @@ export declare class SolutionApi extends BaseAPI {
6234
5085
  * @param {string} runTemplateId The Run Template identifier
6235
5086
  * @param {*} [options] Override http request option.
6236
5087
  * @throws {RequiredError}
6237
- * @memberof SolutionApi
6238
5088
  */
6239
5089
  deleteSolutionRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
6240
5090
  /**
@@ -6245,7 +5095,6 @@ export declare class SolutionApi extends BaseAPI {
6245
5095
  * @param {string} runTemplateId The Run Template identifier
6246
5096
  * @param {*} [options] Override http request option.
6247
5097
  * @throws {RequiredError}
6248
- * @memberof SolutionApi
6249
5098
  */
6250
5099
  getRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate, any, {}>>;
6251
5100
  /**
@@ -6255,7 +5104,6 @@ export declare class SolutionApi extends BaseAPI {
6255
5104
  * @param {string} solutionId the Solution identifier
6256
5105
  * @param {*} [options] Override http request option.
6257
5106
  * @throws {RequiredError}
6258
- * @memberof SolutionApi
6259
5107
  */
6260
5108
  getSolution(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution, any, {}>>;
6261
5109
  /**
@@ -6266,7 +5114,6 @@ export declare class SolutionApi extends BaseAPI {
6266
5114
  * @param {string} identityId The User identifier
6267
5115
  * @param {*} [options] Override http request option.
6268
5116
  * @throws {RequiredError}
6269
- * @memberof SolutionApi
6270
5117
  */
6271
5118
  getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl, any, {}>>;
6272
5119
  /**
@@ -6277,7 +5124,6 @@ export declare class SolutionApi extends BaseAPI {
6277
5124
  * @param {string} parameterId The solution parameter identifier
6278
5125
  * @param {*} [options] Override http request option.
6279
5126
  * @throws {RequiredError}
6280
- * @memberof SolutionApi
6281
5127
  */
6282
5128
  getSolutionParameter(organizationId: string, solutionId: string, parameterId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameter, any, {}>>;
6283
5129
  /**
@@ -6288,7 +5134,6 @@ export declare class SolutionApi extends BaseAPI {
6288
5134
  * @param {string} parameterGroupId The parameter group identifier
6289
5135
  * @param {*} [options] Override http request option.
6290
5136
  * @throws {RequiredError}
6291
- * @memberof SolutionApi
6292
5137
  */
6293
5138
  getSolutionParameterGroup(organizationId: string, solutionId: string, parameterGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameterGroup, any, {}>>;
6294
5139
  /**
@@ -6298,7 +5143,6 @@ export declare class SolutionApi extends BaseAPI {
6298
5143
  * @param {string} solutionId the Solution identifier
6299
5144
  * @param {*} [options] Override http request option.
6300
5145
  * @throws {RequiredError}
6301
- * @memberof SolutionApi
6302
5146
  */
6303
5147
  getSolutionSecurity(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity, any, {}>>;
6304
5148
  /**
@@ -6308,7 +5152,6 @@ export declare class SolutionApi extends BaseAPI {
6308
5152
  * @param {string} solutionId the Solution identifier
6309
5153
  * @param {*} [options] Override http request option.
6310
5154
  * @throws {RequiredError}
6311
- * @memberof SolutionApi
6312
5155
  */
6313
5156
  listRunTemplates(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate[], any, {}>>;
6314
5157
  /**
@@ -6318,7 +5161,6 @@ export declare class SolutionApi extends BaseAPI {
6318
5161
  * @param {string} solutionId the Solution identifier
6319
5162
  * @param {*} [options] Override http request option.
6320
5163
  * @throws {RequiredError}
6321
- * @memberof SolutionApi
6322
5164
  */
6323
5165
  listSolutionParameterGroups(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameterGroup[], any, {}>>;
6324
5166
  /**
@@ -6328,7 +5170,6 @@ export declare class SolutionApi extends BaseAPI {
6328
5170
  * @param {string} solutionId the Solution identifier
6329
5171
  * @param {*} [options] Override http request option.
6330
5172
  * @throws {RequiredError}
6331
- * @memberof SolutionApi
6332
5173
  */
6333
5174
  listSolutionParameters(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameter[], any, {}>>;
6334
5175
  /**
@@ -6338,7 +5179,6 @@ export declare class SolutionApi extends BaseAPI {
6338
5179
  * @param {string} solutionId the Solution identifier
6339
5180
  * @param {*} [options] Override http request option.
6340
5181
  * @throws {RequiredError}
6341
- * @memberof SolutionApi
6342
5182
  */
6343
5183
  listSolutionSecurityUsers(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
6344
5184
  /**
@@ -6349,7 +5189,6 @@ export declare class SolutionApi extends BaseAPI {
6349
5189
  * @param {number} [size] Amount of result by page
6350
5190
  * @param {*} [options] Override http request option.
6351
5191
  * @throws {RequiredError}
6352
- * @memberof SolutionApi
6353
5192
  */
6354
5193
  listSolutions(organizationId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution[], any, {}>>;
6355
5194
  /**
@@ -6360,7 +5199,6 @@ export declare class SolutionApi extends BaseAPI {
6360
5199
  * @param {SolutionUpdateRequest} solutionUpdateRequest The new Solution details. This endpoint can\&#39;t be used to update security
6361
5200
  * @param {*} [options] Override http request option.
6362
5201
  * @throws {RequiredError}
6363
- * @memberof SolutionApi
6364
5202
  */
6365
5203
  updateSolution(organizationId: string, solutionId: string, solutionUpdateRequest: SolutionUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution, any, {}>>;
6366
5204
  /**
@@ -6372,7 +5210,6 @@ export declare class SolutionApi extends BaseAPI {
6372
5210
  * @param {SolutionRole} solutionRole Access control updates
6373
5211
  * @param {*} [options] Override http request option.
6374
5212
  * @throws {RequiredError}
6375
- * @memberof SolutionApi
6376
5213
  */
6377
5214
  updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl, any, {}>>;
6378
5215
  /**
@@ -6383,7 +5220,6 @@ export declare class SolutionApi extends BaseAPI {
6383
5220
  * @param {SolutionRole} solutionRole This changes the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
6384
5221
  * @param {*} [options] Override http request option.
6385
5222
  * @throws {RequiredError}
6386
- * @memberof SolutionApi
6387
5223
  */
6388
5224
  updateSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity, any, {}>>;
6389
5225
  /**
@@ -6395,7 +5231,6 @@ export declare class SolutionApi extends BaseAPI {
6395
5231
  * @param {RunTemplateParameterUpdateRequest} runTemplateParameterUpdateRequest Parameter to update
6396
5232
  * @param {*} [options] Override http request option.
6397
5233
  * @throws {RequiredError}
6398
- * @memberof SolutionApi
6399
5234
  */
6400
5235
  updateSolutionParameter(organizationId: string, solutionId: string, parameterId: string, runTemplateParameterUpdateRequest: RunTemplateParameterUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameter, any, {}>>;
6401
5236
  /**
@@ -6407,7 +5242,6 @@ export declare class SolutionApi extends BaseAPI {
6407
5242
  * @param {RunTemplateParameterGroupUpdateRequest} runTemplateParameterGroupUpdateRequest Parameter groups to update
6408
5243
  * @param {*} [options] Override http request option.
6409
5244
  * @throws {RequiredError}
6410
- * @memberof SolutionApi
6411
5245
  */
6412
5246
  updateSolutionParameterGroup(organizationId: string, solutionId: string, parameterGroupId: string, runTemplateParameterGroupUpdateRequest: RunTemplateParameterGroupUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplateParameterGroup, any, {}>>;
6413
5247
  /**
@@ -6419,13 +5253,11 @@ export declare class SolutionApi extends BaseAPI {
6419
5253
  * @param {RunTemplateUpdateRequest} runTemplateUpdateRequest Run template updates
6420
5254
  * @param {*} [options] Override http request option.
6421
5255
  * @throws {RequiredError}
6422
- * @memberof SolutionApi
6423
5256
  */
6424
5257
  updateSolutionRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, runTemplateUpdateRequest: RunTemplateUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate, any, {}>>;
6425
5258
  }
6426
5259
  /**
6427
5260
  * WorkspaceApi - axios parameter creator
6428
- * @export
6429
5261
  */
6430
5262
  export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configuration) => {
6431
5263
  /**
@@ -6567,7 +5399,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
6567
5399
  *
6568
5400
  * @summary List all Workspaces
6569
5401
  * @param {string} organizationId The Organization identifier
6570
- * @param {number} [page] page number to query (first page is at index 0)
5402
+ * @param {number} [page] Page number to query (first page is at index 0)
6571
5403
  * @param {number} [size] Amount of result by page
6572
5404
  * @param {*} [options] Override http request option.
6573
5405
  * @throws {RequiredError}
@@ -6607,7 +5439,6 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
6607
5439
  };
6608
5440
  /**
6609
5441
  * WorkspaceApi - functional programming interface
6610
- * @export
6611
5442
  */
6612
5443
  export declare const WorkspaceApiFp: (configuration?: Configuration) => {
6613
5444
  /**
@@ -6749,7 +5580,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
6749
5580
  *
6750
5581
  * @summary List all Workspaces
6751
5582
  * @param {string} organizationId The Organization identifier
6752
- * @param {number} [page] page number to query (first page is at index 0)
5583
+ * @param {number} [page] Page number to query (first page is at index 0)
6753
5584
  * @param {number} [size] Amount of result by page
6754
5585
  * @param {*} [options] Override http request option.
6755
5586
  * @throws {RequiredError}
@@ -6789,7 +5620,6 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
6789
5620
  };
6790
5621
  /**
6791
5622
  * WorkspaceApi - factory interface
6792
- * @export
6793
5623
  */
6794
5624
  export declare const WorkspaceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6795
5625
  /**
@@ -6931,7 +5761,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
6931
5761
  *
6932
5762
  * @summary List all Workspaces
6933
5763
  * @param {string} organizationId The Organization identifier
6934
- * @param {number} [page] page number to query (first page is at index 0)
5764
+ * @param {number} [page] Page number to query (first page is at index 0)
6935
5765
  * @param {number} [size] Amount of result by page
6936
5766
  * @param {*} [options] Override http request option.
6937
5767
  * @throws {RequiredError}
@@ -6971,9 +5801,6 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
6971
5801
  };
6972
5802
  /**
6973
5803
  * WorkspaceApi - object-oriented interface
6974
- * @export
6975
- * @class WorkspaceApi
6976
- * @extends {BaseAPI}
6977
5804
  */
6978
5805
  export declare class WorkspaceApi extends BaseAPI {
6979
5806
  /**
@@ -6983,7 +5810,6 @@ export declare class WorkspaceApi extends BaseAPI {
6983
5810
  * @param {WorkspaceCreateRequest} workspaceCreateRequest The Workspace to create
6984
5811
  * @param {*} [options] Override http request option.
6985
5812
  * @throws {RequiredError}
6986
- * @memberof WorkspaceApi
6987
5813
  */
6988
5814
  createWorkspace(organizationId: string, workspaceCreateRequest: WorkspaceCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
6989
5815
  /**
@@ -6994,7 +5820,6 @@ export declare class WorkspaceApi extends BaseAPI {
6994
5820
  * @param {WorkspaceAccessControl} workspaceAccessControl The new Workspace security access to add.
6995
5821
  * @param {*} [options] Override http request option.
6996
5822
  * @throws {RequiredError}
6997
- * @memberof WorkspaceApi
6998
5823
  */
6999
5824
  createWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl, any, {}>>;
7000
5825
  /**
@@ -7007,7 +5832,6 @@ export declare class WorkspaceApi extends BaseAPI {
7007
5832
  * @param {string} [destination] Destination path. Must end with a \\\&#39;/\\\&#39; if specifying a folder. Note that paths may or may not start with a \\\&#39;/\\\&#39;, but they are always treated as relative to the Workspace root location.
7008
5833
  * @param {*} [options] Override http request option.
7009
5834
  * @throws {RequiredError}
7010
- * @memberof WorkspaceApi
7011
5835
  */
7012
5836
  createWorkspaceFile(organizationId: string, workspaceId: string, file: File, overwrite?: boolean, destination?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceFile, any, {}>>;
7013
5837
  /**
@@ -7017,7 +5841,6 @@ export declare class WorkspaceApi extends BaseAPI {
7017
5841
  * @param {string} workspaceId The Workspace identifier
7018
5842
  * @param {*} [options] Override http request option.
7019
5843
  * @throws {RequiredError}
7020
- * @memberof WorkspaceApi
7021
5844
  */
7022
5845
  deleteWorkspace(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7023
5846
  /**
@@ -7028,7 +5851,6 @@ export declare class WorkspaceApi extends BaseAPI {
7028
5851
  * @param {string} identityId The User identifier
7029
5852
  * @param {*} [options] Override http request option.
7030
5853
  * @throws {RequiredError}
7031
- * @memberof WorkspaceApi
7032
5854
  */
7033
5855
  deleteWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7034
5856
  /**
@@ -7039,7 +5861,6 @@ export declare class WorkspaceApi extends BaseAPI {
7039
5861
  * @param {string} fileName The file name
7040
5862
  * @param {*} [options] Override http request option.
7041
5863
  * @throws {RequiredError}
7042
- * @memberof WorkspaceApi
7043
5864
  */
7044
5865
  deleteWorkspaceFile(organizationId: string, workspaceId: string, fileName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7045
5866
  /**
@@ -7049,7 +5870,6 @@ export declare class WorkspaceApi extends BaseAPI {
7049
5870
  * @param {string} workspaceId The Workspace identifier
7050
5871
  * @param {*} [options] Override http request option.
7051
5872
  * @throws {RequiredError}
7052
- * @memberof WorkspaceApi
7053
5873
  */
7054
5874
  deleteWorkspaceFiles(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7055
5875
  /**
@@ -7059,7 +5879,6 @@ export declare class WorkspaceApi extends BaseAPI {
7059
5879
  * @param {string} workspaceId The Workspace identifier
7060
5880
  * @param {*} [options] Override http request option.
7061
5881
  * @throws {RequiredError}
7062
- * @memberof WorkspaceApi
7063
5882
  */
7064
5883
  getWorkspace(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
7065
5884
  /**
@@ -7070,7 +5889,6 @@ export declare class WorkspaceApi extends BaseAPI {
7070
5889
  * @param {string} identityId The User identifier
7071
5890
  * @param {*} [options] Override http request option.
7072
5891
  * @throws {RequiredError}
7073
- * @memberof WorkspaceApi
7074
5892
  */
7075
5893
  getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl, any, {}>>;
7076
5894
  /**
@@ -7081,7 +5899,6 @@ export declare class WorkspaceApi extends BaseAPI {
7081
5899
  * @param {string} fileName The file name
7082
5900
  * @param {*} [options] Override http request option.
7083
5901
  * @throws {RequiredError}
7084
- * @memberof WorkspaceApi
7085
5902
  */
7086
5903
  getWorkspaceFile(organizationId: string, workspaceId: string, fileName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
7087
5904
  /**
@@ -7091,7 +5908,6 @@ export declare class WorkspaceApi extends BaseAPI {
7091
5908
  * @param {string} workspaceId The Workspace identifier
7092
5909
  * @param {*} [options] Override http request option.
7093
5910
  * @throws {RequiredError}
7094
- * @memberof WorkspaceApi
7095
5911
  */
7096
5912
  getWorkspaceSecurity(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceSecurity, any, {}>>;
7097
5913
  /**
@@ -7101,7 +5917,6 @@ export declare class WorkspaceApi extends BaseAPI {
7101
5917
  * @param {string} workspaceId The Workspace identifier
7102
5918
  * @param {*} [options] Override http request option.
7103
5919
  * @throws {RequiredError}
7104
- * @memberof WorkspaceApi
7105
5920
  */
7106
5921
  listWorkspaceFiles(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceFile[], any, {}>>;
7107
5922
  /**
@@ -7112,7 +5927,6 @@ export declare class WorkspaceApi extends BaseAPI {
7112
5927
  * @param {string} role The Role
7113
5928
  * @param {*} [options] Override http request option.
7114
5929
  * @throws {RequiredError}
7115
- * @memberof WorkspaceApi
7116
5930
  */
7117
5931
  listWorkspaceRolePermissions(organizationId: string, workspaceId: string, role: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
7118
5932
  /**
@@ -7122,18 +5936,16 @@ export declare class WorkspaceApi extends BaseAPI {
7122
5936
  * @param {string} workspaceId The Workspace identifier
7123
5937
  * @param {*} [options] Override http request option.
7124
5938
  * @throws {RequiredError}
7125
- * @memberof WorkspaceApi
7126
5939
  */
7127
5940
  listWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
7128
5941
  /**
7129
5942
  *
7130
5943
  * @summary List all Workspaces
7131
5944
  * @param {string} organizationId The Organization identifier
7132
- * @param {number} [page] page number to query (first page is at index 0)
5945
+ * @param {number} [page] Page number to query (first page is at index 0)
7133
5946
  * @param {number} [size] Amount of result by page
7134
5947
  * @param {*} [options] Override http request option.
7135
5948
  * @throws {RequiredError}
7136
- * @memberof WorkspaceApi
7137
5949
  */
7138
5950
  listWorkspaces(organizationId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace[], any, {}>>;
7139
5951
  /**
@@ -7144,7 +5956,6 @@ export declare class WorkspaceApi extends BaseAPI {
7144
5956
  * @param {WorkspaceUpdateRequest} workspaceUpdateRequest The new Workspace details. This endpoint can\&#39;t be used to update security
7145
5957
  * @param {*} [options] Override http request option.
7146
5958
  * @throws {RequiredError}
7147
- * @memberof WorkspaceApi
7148
5959
  */
7149
5960
  updateWorkspace(organizationId: string, workspaceId: string, workspaceUpdateRequest: WorkspaceUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
7150
5961
  /**
@@ -7156,7 +5967,6 @@ export declare class WorkspaceApi extends BaseAPI {
7156
5967
  * @param {WorkspaceRole} workspaceRole The new Workspace Access Control
7157
5968
  * @param {*} [options] Override http request option.
7158
5969
  * @throws {RequiredError}
7159
- * @memberof WorkspaceApi
7160
5970
  */
7161
5971
  updateWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, workspaceRole: WorkspaceRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl, any, {}>>;
7162
5972
  /**
@@ -7167,7 +5977,6 @@ export declare class WorkspaceApi extends BaseAPI {
7167
5977
  * @param {WorkspaceRole} workspaceRole This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace.
7168
5978
  * @param {*} [options] Override http request option.
7169
5979
  * @throws {RequiredError}
7170
- * @memberof WorkspaceApi
7171
5980
  */
7172
5981
  updateWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, workspaceRole: WorkspaceRole, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceSecurity, any, {}>>;
7173
5982
  }