@cirrobio/api-client 0.0.20-alpha → 0.0.22-alpha

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.
@@ -55,6 +55,7 @@ src/models/ProjectSettings.ts
55
55
  src/models/ProjectUser.ts
56
56
  src/models/Reference.ts
57
57
  src/models/ReferenceType.ts
58
+ src/models/RunAnalysisRequest.ts
58
59
  src/models/Sample.ts
59
60
  src/models/SampleRequest.ts
60
61
  src/models/ServiceConnection.ts
package/README.md CHANGED
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cirrobio/api-client@0.0.20-alpha --save
39
+ npm install @cirrobio/api-client@0.0.22-alpha --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -32,10 +32,22 @@ export interface ImportPublicDatasetRequest {
32
32
  projectId: string;
33
33
  importDataRequest: ImportDataRequest;
34
34
  }
35
+ export interface IngestSamplesRequest {
36
+ projectId: string;
37
+ datasetId: string;
38
+ }
39
+ export interface RegenerateManifestRequest {
40
+ projectId: string;
41
+ datasetId: string;
42
+ }
35
43
  export interface RegisterDatasetRequest {
36
44
  projectId: string;
37
45
  uploadDatasetRequest: UploadDatasetRequest;
38
46
  }
47
+ export interface RerunTransformRequest {
48
+ projectId: string;
49
+ datasetId: string;
50
+ }
39
51
  export interface UpdateDatasetOperationRequest {
40
52
  projectId: string;
41
53
  datasetId: string;
@@ -95,6 +107,26 @@ export declare class DatasetsApi extends runtime.BaseAPI {
95
107
  * Import public dataset
96
108
  */
97
109
  importPublicDataset(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
110
+ /**
111
+ * Rerun sample ingest (TODO).
112
+ * Rerun sample ingest
113
+ */
114
+ ingestSamplesRaw(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
115
+ /**
116
+ * Rerun sample ingest (TODO).
117
+ * Rerun sample ingest
118
+ */
119
+ ingestSamples(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
120
+ /**
121
+ * Regenerate dataset manifest (TODO).
122
+ * Regenerate dataset manifest
123
+ */
124
+ regenerateManifestRaw(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
125
+ /**
126
+ * Regenerate dataset manifest (TODO).
127
+ * Regenerate dataset manifest
128
+ */
129
+ regenerateManifest(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
98
130
  /**
99
131
  * Registers a dataset in the system that you upload files into
100
132
  * Upload private dataset
@@ -105,6 +137,16 @@ export declare class DatasetsApi extends runtime.BaseAPI {
105
137
  * Upload private dataset
106
138
  */
107
139
  registerDataset(requestParameters: RegisterDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDatasetCreateResponse>;
140
+ /**
141
+ * Rerun data transforms (TODO).
142
+ * Rerun data transforms
143
+ */
144
+ rerunTransformRaw(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
145
+ /**
146
+ * Rerun data transforms (TODO).
147
+ * Rerun data transforms
148
+ */
149
+ rerunTransform(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
108
150
  /**
109
151
  * Update info on a dataset
110
152
  * Update dataset
@@ -376,6 +376,118 @@ var DatasetsApi = /** @class */ (function (_super) {
376
376
  });
377
377
  });
378
378
  };
379
+ /**
380
+ * Rerun sample ingest (TODO).
381
+ * Rerun sample ingest
382
+ */
383
+ DatasetsApi.prototype.ingestSamplesRaw = function (requestParameters, initOverrides) {
384
+ return __awaiter(this, void 0, void 0, function () {
385
+ var queryParameters, headerParameters, token, tokenString, response;
386
+ return __generator(this, function (_a) {
387
+ switch (_a.label) {
388
+ case 0:
389
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
390
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling ingestSamples.');
391
+ }
392
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
393
+ throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling ingestSamples.');
394
+ }
395
+ queryParameters = {};
396
+ headerParameters = {};
397
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
398
+ token = this.configuration.accessToken;
399
+ return [4 /*yield*/, token("accessToken", [])];
400
+ case 1:
401
+ tokenString = _a.sent();
402
+ if (tokenString) {
403
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
404
+ }
405
+ _a.label = 2;
406
+ case 2: return [4 /*yield*/, this.request({
407
+ path: "/projects/{projectId}/datasets/{datasetId}/ingest-samples".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
408
+ method: 'PUT',
409
+ headers: headerParameters,
410
+ query: queryParameters,
411
+ }, initOverrides)];
412
+ case 3:
413
+ response = _a.sent();
414
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
415
+ }
416
+ });
417
+ });
418
+ };
419
+ /**
420
+ * Rerun sample ingest (TODO).
421
+ * Rerun sample ingest
422
+ */
423
+ DatasetsApi.prototype.ingestSamples = function (requestParameters, initOverrides) {
424
+ return __awaiter(this, void 0, void 0, function () {
425
+ return __generator(this, function (_a) {
426
+ switch (_a.label) {
427
+ case 0: return [4 /*yield*/, this.ingestSamplesRaw(requestParameters, initOverrides)];
428
+ case 1:
429
+ _a.sent();
430
+ return [2 /*return*/];
431
+ }
432
+ });
433
+ });
434
+ };
435
+ /**
436
+ * Regenerate dataset manifest (TODO).
437
+ * Regenerate dataset manifest
438
+ */
439
+ DatasetsApi.prototype.regenerateManifestRaw = function (requestParameters, initOverrides) {
440
+ return __awaiter(this, void 0, void 0, function () {
441
+ var queryParameters, headerParameters, token, tokenString, response;
442
+ return __generator(this, function (_a) {
443
+ switch (_a.label) {
444
+ case 0:
445
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
446
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling regenerateManifest.');
447
+ }
448
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
449
+ throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling regenerateManifest.');
450
+ }
451
+ queryParameters = {};
452
+ headerParameters = {};
453
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
454
+ token = this.configuration.accessToken;
455
+ return [4 /*yield*/, token("accessToken", [])];
456
+ case 1:
457
+ tokenString = _a.sent();
458
+ if (tokenString) {
459
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
460
+ }
461
+ _a.label = 2;
462
+ case 2: return [4 /*yield*/, this.request({
463
+ path: "/projects/{projectId}/datasets/{datasetId}/regenerate-manifest".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
464
+ method: 'PUT',
465
+ headers: headerParameters,
466
+ query: queryParameters,
467
+ }, initOverrides)];
468
+ case 3:
469
+ response = _a.sent();
470
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
471
+ }
472
+ });
473
+ });
474
+ };
475
+ /**
476
+ * Regenerate dataset manifest (TODO).
477
+ * Regenerate dataset manifest
478
+ */
479
+ DatasetsApi.prototype.regenerateManifest = function (requestParameters, initOverrides) {
480
+ return __awaiter(this, void 0, void 0, function () {
481
+ return __generator(this, function (_a) {
482
+ switch (_a.label) {
483
+ case 0: return [4 /*yield*/, this.regenerateManifestRaw(requestParameters, initOverrides)];
484
+ case 1:
485
+ _a.sent();
486
+ return [2 /*return*/];
487
+ }
488
+ });
489
+ });
490
+ };
379
491
  /**
380
492
  * Registers a dataset in the system that you upload files into
381
493
  * Upload private dataset
@@ -436,6 +548,62 @@ var DatasetsApi = /** @class */ (function (_super) {
436
548
  });
437
549
  });
438
550
  };
551
+ /**
552
+ * Rerun data transforms (TODO).
553
+ * Rerun data transforms
554
+ */
555
+ DatasetsApi.prototype.rerunTransformRaw = function (requestParameters, initOverrides) {
556
+ return __awaiter(this, void 0, void 0, function () {
557
+ var queryParameters, headerParameters, token, tokenString, response;
558
+ return __generator(this, function (_a) {
559
+ switch (_a.label) {
560
+ case 0:
561
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
562
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling rerunTransform.');
563
+ }
564
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
565
+ throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling rerunTransform.');
566
+ }
567
+ queryParameters = {};
568
+ headerParameters = {};
569
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
570
+ token = this.configuration.accessToken;
571
+ return [4 /*yield*/, token("accessToken", [])];
572
+ case 1:
573
+ tokenString = _a.sent();
574
+ if (tokenString) {
575
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
576
+ }
577
+ _a.label = 2;
578
+ case 2: return [4 /*yield*/, this.request({
579
+ path: "/projects/{projectId}/datasets/{datasetId}/rerun-transform".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
580
+ method: 'PUT',
581
+ headers: headerParameters,
582
+ query: queryParameters,
583
+ }, initOverrides)];
584
+ case 3:
585
+ response = _a.sent();
586
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
587
+ }
588
+ });
589
+ });
590
+ };
591
+ /**
592
+ * Rerun data transforms (TODO).
593
+ * Rerun data transforms
594
+ */
595
+ DatasetsApi.prototype.rerunTransform = function (requestParameters, initOverrides) {
596
+ return __awaiter(this, void 0, void 0, function () {
597
+ return __generator(this, function (_a) {
598
+ switch (_a.label) {
599
+ case 0: return [4 /*yield*/, this.rerunTransformRaw(requestParameters, initOverrides)];
600
+ case 1:
601
+ _a.sent();
602
+ return [2 /*return*/];
603
+ }
604
+ });
605
+ });
606
+ };
439
607
  /**
440
608
  * Update info on a dataset
441
609
  * Update dataset
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetExecutionLogsResponse, StopExecutionResponse, Task } from '../models/index';
13
+ import type { CreateResponse, GetExecutionLogsResponse, RunAnalysisRequest, StopExecutionResponse, Task } from '../models/index';
14
14
  export interface GetExecutionLogsRequest {
15
15
  datasetId: string;
16
16
  projectId: string;
@@ -31,6 +31,10 @@ export interface GetTasksForExecutionRequest {
31
31
  projectId: string;
32
32
  forceLive?: boolean;
33
33
  }
34
+ export interface RunAnalysisOperationRequest {
35
+ projectId: string;
36
+ runAnalysisRequest: RunAnalysisRequest;
37
+ }
34
38
  export interface StopAnalysisRequest {
35
39
  datasetId: string;
36
40
  projectId: string;
@@ -83,6 +87,16 @@ export declare class ExecutionApi extends runtime.BaseAPI {
83
87
  * Get execution tasks
84
88
  */
85
89
  getTasksForExecution(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Task>>;
90
+ /**
91
+ * Run analysis
92
+ * Run analysis
93
+ */
94
+ runAnalysisRaw(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
95
+ /**
96
+ * Run analysis
97
+ * Run analysis
98
+ */
99
+ runAnalysis(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
86
100
  /**
87
101
  * Terminates all analysis jobs related to this execution
88
102
  * Stop execution
@@ -319,6 +319,66 @@ var ExecutionApi = /** @class */ (function (_super) {
319
319
  });
320
320
  });
321
321
  };
322
+ /**
323
+ * Run analysis
324
+ * Run analysis
325
+ */
326
+ ExecutionApi.prototype.runAnalysisRaw = function (requestParameters, initOverrides) {
327
+ return __awaiter(this, void 0, void 0, function () {
328
+ var queryParameters, headerParameters, token, tokenString, response;
329
+ return __generator(this, function (_a) {
330
+ switch (_a.label) {
331
+ case 0:
332
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
333
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling runAnalysis.');
334
+ }
335
+ if (requestParameters.runAnalysisRequest === null || requestParameters.runAnalysisRequest === undefined) {
336
+ throw new runtime.RequiredError('runAnalysisRequest', 'Required parameter requestParameters.runAnalysisRequest was null or undefined when calling runAnalysis.');
337
+ }
338
+ queryParameters = {};
339
+ headerParameters = {};
340
+ headerParameters['Content-Type'] = 'application/json';
341
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
342
+ token = this.configuration.accessToken;
343
+ return [4 /*yield*/, token("accessToken", [])];
344
+ case 1:
345
+ tokenString = _a.sent();
346
+ if (tokenString) {
347
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
348
+ }
349
+ _a.label = 2;
350
+ case 2: return [4 /*yield*/, this.request({
351
+ path: "/projects/{projectId}/execution".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
352
+ method: 'POST',
353
+ headers: headerParameters,
354
+ query: queryParameters,
355
+ body: (0, index_1.RunAnalysisRequestToJSON)(requestParameters.runAnalysisRequest),
356
+ }, initOverrides)];
357
+ case 3:
358
+ response = _a.sent();
359
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
360
+ }
361
+ });
362
+ });
363
+ };
364
+ /**
365
+ * Run analysis
366
+ * Run analysis
367
+ */
368
+ ExecutionApi.prototype.runAnalysis = function (requestParameters, initOverrides) {
369
+ return __awaiter(this, void 0, void 0, function () {
370
+ var response;
371
+ return __generator(this, function (_a) {
372
+ switch (_a.label) {
373
+ case 0: return [4 /*yield*/, this.runAnalysisRaw(requestParameters, initOverrides)];
374
+ case 1:
375
+ response = _a.sent();
376
+ return [4 /*yield*/, response.value()];
377
+ case 2: return [2 /*return*/, _a.sent()];
378
+ }
379
+ });
380
+ });
381
+ };
322
382
  /**
323
383
  * Terminates all analysis jobs related to this execution
324
384
  * Stop execution
@@ -17,6 +17,12 @@ import type { DatasetViz } from './DatasetViz';
17
17
  * @interface DatasetAssetsManifest
18
18
  */
19
19
  export interface DatasetAssetsManifest {
20
+ /**
21
+ * Base URL for files
22
+ * @type {string}
23
+ * @memberof DatasetAssetsManifest
24
+ */
25
+ domain?: string;
20
26
  /**
21
27
  * List of files in the dataset, including metadata
22
28
  * @type {Array<DatasetFile>}
@@ -34,6 +34,7 @@ function DatasetAssetsManifestFromJSONTyped(json, ignoreDiscriminator) {
34
34
  return json;
35
35
  }
36
36
  return {
37
+ 'domain': !(0, runtime_1.exists)(json, 'domain') ? undefined : json['domain'],
37
38
  'files': !(0, runtime_1.exists)(json, 'files') ? undefined : (json['files'].map(DatasetFile_1.DatasetFileFromJSON)),
38
39
  'viz': !(0, runtime_1.exists)(json, 'viz') ? undefined : (json['viz'].map(DatasetViz_1.DatasetVizFromJSON)),
39
40
  };
@@ -47,6 +48,7 @@ function DatasetAssetsManifestToJSON(value) {
47
48
  return null;
48
49
  }
49
50
  return {
51
+ 'domain': value.domain,
50
52
  'files': value.files === undefined ? undefined : (value.files.map(DatasetFile_1.DatasetFileToJSON)),
51
53
  'viz': value.viz === undefined ? undefined : (value.viz.map(DatasetViz_1.DatasetVizToJSON)),
52
54
  };
@@ -0,0 +1,69 @@
1
+ /**
2
+ * Cirro Data
3
+ * Cirro Data Platform service API
4
+ *
5
+ * The version of the OpenAPI document: latest
6
+ * Contact: support@cirro.bio
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RunAnalysisRequest
16
+ */
17
+ export interface RunAnalysisRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RunAnalysisRequest
22
+ */
23
+ name: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof RunAnalysisRequest
28
+ */
29
+ description: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof RunAnalysisRequest
34
+ */
35
+ processId: string;
36
+ /**
37
+ *
38
+ * @type {Array<string>}
39
+ * @memberof RunAnalysisRequest
40
+ */
41
+ sourceDatasetIds: Array<string>;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof RunAnalysisRequest
46
+ */
47
+ resumeDatasetId: string;
48
+ /**
49
+ *
50
+ * @type {{ [key: string]: any; }}
51
+ * @memberof RunAnalysisRequest
52
+ */
53
+ params: {
54
+ [key: string]: any;
55
+ };
56
+ /**
57
+ *
58
+ * @type {Array<string>}
59
+ * @memberof RunAnalysisRequest
60
+ */
61
+ notificationEmails: Array<string>;
62
+ }
63
+ /**
64
+ * Check if a given object implements the RunAnalysisRequest interface.
65
+ */
66
+ export declare function instanceOfRunAnalysisRequest(value: object): boolean;
67
+ export declare function RunAnalysisRequestFromJSON(json: any): RunAnalysisRequest;
68
+ export declare function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunAnalysisRequest;
69
+ export declare function RunAnalysisRequestToJSON(value?: RunAnalysisRequest | null): any;
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Cirro Data
6
+ * Cirro Data Platform service API
7
+ *
8
+ * The version of the OpenAPI document: latest
9
+ * Contact: support@cirro.bio
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.RunAnalysisRequestToJSON = exports.RunAnalysisRequestFromJSONTyped = exports.RunAnalysisRequestFromJSON = exports.instanceOfRunAnalysisRequest = void 0;
17
+ /**
18
+ * Check if a given object implements the RunAnalysisRequest interface.
19
+ */
20
+ function instanceOfRunAnalysisRequest(value) {
21
+ var isInstance = true;
22
+ isInstance = isInstance && "name" in value;
23
+ isInstance = isInstance && "description" in value;
24
+ isInstance = isInstance && "processId" in value;
25
+ isInstance = isInstance && "sourceDatasetIds" in value;
26
+ isInstance = isInstance && "resumeDatasetId" in value;
27
+ isInstance = isInstance && "params" in value;
28
+ isInstance = isInstance && "notificationEmails" in value;
29
+ return isInstance;
30
+ }
31
+ exports.instanceOfRunAnalysisRequest = instanceOfRunAnalysisRequest;
32
+ function RunAnalysisRequestFromJSON(json) {
33
+ return RunAnalysisRequestFromJSONTyped(json, false);
34
+ }
35
+ exports.RunAnalysisRequestFromJSON = RunAnalysisRequestFromJSON;
36
+ function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
37
+ if ((json === undefined) || (json === null)) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'name': json['name'],
42
+ 'description': json['description'],
43
+ 'processId': json['processId'],
44
+ 'sourceDatasetIds': json['sourceDatasetIds'],
45
+ 'resumeDatasetId': json['resumeDatasetId'],
46
+ 'params': json['params'],
47
+ 'notificationEmails': json['notificationEmails'],
48
+ };
49
+ }
50
+ exports.RunAnalysisRequestFromJSONTyped = RunAnalysisRequestFromJSONTyped;
51
+ function RunAnalysisRequestToJSON(value) {
52
+ if (value === undefined) {
53
+ return undefined;
54
+ }
55
+ if (value === null) {
56
+ return null;
57
+ }
58
+ return {
59
+ 'name': value.name,
60
+ 'description': value.description,
61
+ 'processId': value.processId,
62
+ 'sourceDatasetIds': value.sourceDatasetIds,
63
+ 'resumeDatasetId': value.resumeDatasetId,
64
+ 'params': value.params,
65
+ 'notificationEmails': value.notificationEmails,
66
+ };
67
+ }
68
+ exports.RunAnalysisRequestToJSON = RunAnalysisRequestToJSON;
@@ -37,6 +37,7 @@ export * from './ProjectSettings';
37
37
  export * from './ProjectUser';
38
38
  export * from './Reference';
39
39
  export * from './ReferenceType';
40
+ export * from './RunAnalysisRequest';
40
41
  export * from './Sample';
41
42
  export * from './SampleRequest';
42
43
  export * from './ServiceConnection';
@@ -55,6 +55,7 @@ __exportStar(require("./ProjectSettings"), exports);
55
55
  __exportStar(require("./ProjectUser"), exports);
56
56
  __exportStar(require("./Reference"), exports);
57
57
  __exportStar(require("./ReferenceType"), exports);
58
+ __exportStar(require("./RunAnalysisRequest"), exports);
58
59
  __exportStar(require("./Sample"), exports);
59
60
  __exportStar(require("./SampleRequest"), exports);
60
61
  __exportStar(require("./ServiceConnection"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.0.20-alpha",
3
+ "version": "0.0.22-alpha",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {
@@ -69,11 +69,26 @@ export interface ImportPublicDatasetRequest {
69
69
  importDataRequest: ImportDataRequest;
70
70
  }
71
71
 
72
+ export interface IngestSamplesRequest {
73
+ projectId: string;
74
+ datasetId: string;
75
+ }
76
+
77
+ export interface RegenerateManifestRequest {
78
+ projectId: string;
79
+ datasetId: string;
80
+ }
81
+
72
82
  export interface RegisterDatasetRequest {
73
83
  projectId: string;
74
84
  uploadDatasetRequest: UploadDatasetRequest;
75
85
  }
76
86
 
87
+ export interface RerunTransformRequest {
88
+ projectId: string;
89
+ datasetId: string;
90
+ }
91
+
77
92
  export interface UpdateDatasetOperationRequest {
78
93
  projectId: string;
79
94
  datasetId: string;
@@ -316,6 +331,92 @@ export class DatasetsApi extends runtime.BaseAPI {
316
331
  return await response.value();
317
332
  }
318
333
 
334
+ /**
335
+ * Rerun sample ingest (TODO).
336
+ * Rerun sample ingest
337
+ */
338
+ async ingestSamplesRaw(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
339
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
340
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling ingestSamples.');
341
+ }
342
+
343
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
344
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling ingestSamples.');
345
+ }
346
+
347
+ const queryParameters: any = {};
348
+
349
+ const headerParameters: runtime.HTTPHeaders = {};
350
+
351
+ if (this.configuration && this.configuration.accessToken) {
352
+ const token = this.configuration.accessToken;
353
+ const tokenString = await token("accessToken", []);
354
+
355
+ if (tokenString) {
356
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
357
+ }
358
+ }
359
+ const response = await this.request({
360
+ path: `/projects/{projectId}/datasets/{datasetId}/ingest-samples`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
361
+ method: 'PUT',
362
+ headers: headerParameters,
363
+ query: queryParameters,
364
+ }, initOverrides);
365
+
366
+ return new runtime.VoidApiResponse(response);
367
+ }
368
+
369
+ /**
370
+ * Rerun sample ingest (TODO).
371
+ * Rerun sample ingest
372
+ */
373
+ async ingestSamples(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
374
+ await this.ingestSamplesRaw(requestParameters, initOverrides);
375
+ }
376
+
377
+ /**
378
+ * Regenerate dataset manifest (TODO).
379
+ * Regenerate dataset manifest
380
+ */
381
+ async regenerateManifestRaw(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
382
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
383
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling regenerateManifest.');
384
+ }
385
+
386
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
387
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling regenerateManifest.');
388
+ }
389
+
390
+ const queryParameters: any = {};
391
+
392
+ const headerParameters: runtime.HTTPHeaders = {};
393
+
394
+ if (this.configuration && this.configuration.accessToken) {
395
+ const token = this.configuration.accessToken;
396
+ const tokenString = await token("accessToken", []);
397
+
398
+ if (tokenString) {
399
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
400
+ }
401
+ }
402
+ const response = await this.request({
403
+ path: `/projects/{projectId}/datasets/{datasetId}/regenerate-manifest`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
404
+ method: 'PUT',
405
+ headers: headerParameters,
406
+ query: queryParameters,
407
+ }, initOverrides);
408
+
409
+ return new runtime.VoidApiResponse(response);
410
+ }
411
+
412
+ /**
413
+ * Regenerate dataset manifest (TODO).
414
+ * Regenerate dataset manifest
415
+ */
416
+ async regenerateManifest(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
417
+ await this.regenerateManifestRaw(requestParameters, initOverrides);
418
+ }
419
+
319
420
  /**
320
421
  * Registers a dataset in the system that you upload files into
321
422
  * Upload private dataset
@@ -363,6 +464,49 @@ export class DatasetsApi extends runtime.BaseAPI {
363
464
  return await response.value();
364
465
  }
365
466
 
467
+ /**
468
+ * Rerun data transforms (TODO).
469
+ * Rerun data transforms
470
+ */
471
+ async rerunTransformRaw(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
472
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
473
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling rerunTransform.');
474
+ }
475
+
476
+ if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
477
+ throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling rerunTransform.');
478
+ }
479
+
480
+ const queryParameters: any = {};
481
+
482
+ const headerParameters: runtime.HTTPHeaders = {};
483
+
484
+ if (this.configuration && this.configuration.accessToken) {
485
+ const token = this.configuration.accessToken;
486
+ const tokenString = await token("accessToken", []);
487
+
488
+ if (tokenString) {
489
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
490
+ }
491
+ }
492
+ const response = await this.request({
493
+ path: `/projects/{projectId}/datasets/{datasetId}/rerun-transform`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
494
+ method: 'PUT',
495
+ headers: headerParameters,
496
+ query: queryParameters,
497
+ }, initOverrides);
498
+
499
+ return new runtime.VoidApiResponse(response);
500
+ }
501
+
502
+ /**
503
+ * Rerun data transforms (TODO).
504
+ * Rerun data transforms
505
+ */
506
+ async rerunTransform(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
507
+ await this.rerunTransformRaw(requestParameters, initOverrides);
508
+ }
509
+
366
510
  /**
367
511
  * Update info on a dataset
368
512
  * Update dataset
@@ -15,13 +15,19 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ CreateResponse,
18
19
  GetExecutionLogsResponse,
20
+ RunAnalysisRequest,
19
21
  StopExecutionResponse,
20
22
  Task,
21
23
  } from '../models/index';
22
24
  import {
25
+ CreateResponseFromJSON,
26
+ CreateResponseToJSON,
23
27
  GetExecutionLogsResponseFromJSON,
24
28
  GetExecutionLogsResponseToJSON,
29
+ RunAnalysisRequestFromJSON,
30
+ RunAnalysisRequestToJSON,
25
31
  StopExecutionResponseFromJSON,
26
32
  StopExecutionResponseToJSON,
27
33
  TaskFromJSON,
@@ -52,6 +58,11 @@ export interface GetTasksForExecutionRequest {
52
58
  forceLive?: boolean;
53
59
  }
54
60
 
61
+ export interface RunAnalysisOperationRequest {
62
+ projectId: string;
63
+ runAnalysisRequest: RunAnalysisRequest;
64
+ }
65
+
55
66
  export interface StopAnalysisRequest {
56
67
  datasetId: string;
57
68
  projectId: string;
@@ -254,6 +265,53 @@ export class ExecutionApi extends runtime.BaseAPI {
254
265
  return await response.value();
255
266
  }
256
267
 
268
+ /**
269
+ * Run analysis
270
+ * Run analysis
271
+ */
272
+ async runAnalysisRaw(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
273
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
274
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling runAnalysis.');
275
+ }
276
+
277
+ if (requestParameters.runAnalysisRequest === null || requestParameters.runAnalysisRequest === undefined) {
278
+ throw new runtime.RequiredError('runAnalysisRequest','Required parameter requestParameters.runAnalysisRequest was null or undefined when calling runAnalysis.');
279
+ }
280
+
281
+ const queryParameters: any = {};
282
+
283
+ const headerParameters: runtime.HTTPHeaders = {};
284
+
285
+ headerParameters['Content-Type'] = 'application/json';
286
+
287
+ if (this.configuration && this.configuration.accessToken) {
288
+ const token = this.configuration.accessToken;
289
+ const tokenString = await token("accessToken", []);
290
+
291
+ if (tokenString) {
292
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
293
+ }
294
+ }
295
+ const response = await this.request({
296
+ path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
297
+ method: 'POST',
298
+ headers: headerParameters,
299
+ query: queryParameters,
300
+ body: RunAnalysisRequestToJSON(requestParameters.runAnalysisRequest),
301
+ }, initOverrides);
302
+
303
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
304
+ }
305
+
306
+ /**
307
+ * Run analysis
308
+ * Run analysis
309
+ */
310
+ async runAnalysis(requestParameters: RunAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
311
+ const response = await this.runAnalysisRaw(requestParameters, initOverrides);
312
+ return await response.value();
313
+ }
314
+
257
315
  /**
258
316
  * Terminates all analysis jobs related to this execution
259
317
  * Stop execution
@@ -32,6 +32,12 @@ import {
32
32
  * @interface DatasetAssetsManifest
33
33
  */
34
34
  export interface DatasetAssetsManifest {
35
+ /**
36
+ * Base URL for files
37
+ * @type {string}
38
+ * @memberof DatasetAssetsManifest
39
+ */
40
+ domain?: string;
35
41
  /**
36
42
  * List of files in the dataset, including metadata
37
43
  * @type {Array<DatasetFile>}
@@ -65,6 +71,7 @@ export function DatasetAssetsManifestFromJSONTyped(json: any, ignoreDiscriminato
65
71
  }
66
72
  return {
67
73
 
74
+ 'domain': !exists(json, 'domain') ? undefined : json['domain'],
68
75
  'files': !exists(json, 'files') ? undefined : ((json['files'] as Array<any>).map(DatasetFileFromJSON)),
69
76
  'viz': !exists(json, 'viz') ? undefined : ((json['viz'] as Array<any>).map(DatasetVizFromJSON)),
70
77
  };
@@ -79,6 +86,7 @@ export function DatasetAssetsManifestToJSON(value?: DatasetAssetsManifest | null
79
86
  }
80
87
  return {
81
88
 
89
+ 'domain': value.domain,
82
90
  'files': value.files === undefined ? undefined : ((value.files as Array<any>).map(DatasetFileToJSON)),
83
91
  'viz': value.viz === undefined ? undefined : ((value.viz as Array<any>).map(DatasetVizToJSON)),
84
92
  };
@@ -0,0 +1,120 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface RunAnalysisRequest
20
+ */
21
+ export interface RunAnalysisRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof RunAnalysisRequest
26
+ */
27
+ name: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof RunAnalysisRequest
32
+ */
33
+ description: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof RunAnalysisRequest
38
+ */
39
+ processId: string;
40
+ /**
41
+ *
42
+ * @type {Array<string>}
43
+ * @memberof RunAnalysisRequest
44
+ */
45
+ sourceDatasetIds: Array<string>;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof RunAnalysisRequest
50
+ */
51
+ resumeDatasetId: string;
52
+ /**
53
+ *
54
+ * @type {{ [key: string]: any; }}
55
+ * @memberof RunAnalysisRequest
56
+ */
57
+ params: { [key: string]: any; };
58
+ /**
59
+ *
60
+ * @type {Array<string>}
61
+ * @memberof RunAnalysisRequest
62
+ */
63
+ notificationEmails: Array<string>;
64
+ }
65
+
66
+ /**
67
+ * Check if a given object implements the RunAnalysisRequest interface.
68
+ */
69
+ export function instanceOfRunAnalysisRequest(value: object): boolean {
70
+ let isInstance = true;
71
+ isInstance = isInstance && "name" in value;
72
+ isInstance = isInstance && "description" in value;
73
+ isInstance = isInstance && "processId" in value;
74
+ isInstance = isInstance && "sourceDatasetIds" in value;
75
+ isInstance = isInstance && "resumeDatasetId" in value;
76
+ isInstance = isInstance && "params" in value;
77
+ isInstance = isInstance && "notificationEmails" in value;
78
+
79
+ return isInstance;
80
+ }
81
+
82
+ export function RunAnalysisRequestFromJSON(json: any): RunAnalysisRequest {
83
+ return RunAnalysisRequestFromJSONTyped(json, false);
84
+ }
85
+
86
+ export function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunAnalysisRequest {
87
+ if ((json === undefined) || (json === null)) {
88
+ return json;
89
+ }
90
+ return {
91
+
92
+ 'name': json['name'],
93
+ 'description': json['description'],
94
+ 'processId': json['processId'],
95
+ 'sourceDatasetIds': json['sourceDatasetIds'],
96
+ 'resumeDatasetId': json['resumeDatasetId'],
97
+ 'params': json['params'],
98
+ 'notificationEmails': json['notificationEmails'],
99
+ };
100
+ }
101
+
102
+ export function RunAnalysisRequestToJSON(value?: RunAnalysisRequest | null): any {
103
+ if (value === undefined) {
104
+ return undefined;
105
+ }
106
+ if (value === null) {
107
+ return null;
108
+ }
109
+ return {
110
+
111
+ 'name': value.name,
112
+ 'description': value.description,
113
+ 'processId': value.processId,
114
+ 'sourceDatasetIds': value.sourceDatasetIds,
115
+ 'resumeDatasetId': value.resumeDatasetId,
116
+ 'params': value.params,
117
+ 'notificationEmails': value.notificationEmails,
118
+ };
119
+ }
120
+
@@ -39,6 +39,7 @@ export * from './ProjectSettings';
39
39
  export * from './ProjectUser';
40
40
  export * from './Reference';
41
41
  export * from './ReferenceType';
42
+ export * from './RunAnalysisRequest';
42
43
  export * from './Sample';
43
44
  export * from './SampleRequest';
44
45
  export * from './ServiceConnection';