@cirrobio/api-client 0.2.20 → 0.2.21
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/.openapi-generator/FILES +1 -0
- package/README.md +1 -1
- package/dist/apis/MetadataApi.d.ts +14 -0
- package/dist/apis/MetadataApi.js +58 -0
- package/dist/models/DataFile.d.ts +39 -0
- package/dist/models/DataFile.js +53 -0
- package/dist/models/Process.d.ts +6 -0
- package/dist/models/Process.js +2 -0
- package/dist/models/ProcessDetail.d.ts +6 -0
- package/dist/models/ProcessDetail.js +2 -0
- package/dist/models/RunAnalysisRequest.d.ts +6 -0
- package/dist/models/RunAnalysisRequest.js +2 -0
- package/dist/models/Sample.d.ts +7 -0
- package/dist/models/Sample.js +3 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/MetadataApi.ts +49 -0
- package/src/models/DataFile.ts +75 -0
- package/src/models/Process.ts +8 -0
- package/src/models/ProcessDetail.ts +8 -0
- package/src/models/RunAnalysisRequest.ts +8 -0
- package/src/models/Sample.ts +15 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
package/README.md
CHANGED
|
@@ -11,6 +11,10 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { FormSchema, PaginatedResponseSampleDto, Sample, SampleRequest } from '../models/index';
|
|
14
|
+
export interface GetDatasetSamplesRequest {
|
|
15
|
+
projectId: string;
|
|
16
|
+
datasetId: string;
|
|
17
|
+
}
|
|
14
18
|
export interface GetProjectSamplesRequest {
|
|
15
19
|
projectId: string;
|
|
16
20
|
limit?: number;
|
|
@@ -32,6 +36,16 @@ export interface UpdateSampleRequest {
|
|
|
32
36
|
*
|
|
33
37
|
*/
|
|
34
38
|
export declare class MetadataApi extends runtime.BaseAPI {
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
41
|
+
* Get dataset samples
|
|
42
|
+
*/
|
|
43
|
+
getDatasetSamplesRaw(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sample>>>;
|
|
44
|
+
/**
|
|
45
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
46
|
+
* Get dataset samples
|
|
47
|
+
*/
|
|
48
|
+
getDatasetSamples(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sample>>;
|
|
35
49
|
/**
|
|
36
50
|
* Retrieves a list of samples associated with a project along with their metadata
|
|
37
51
|
* Get project samples
|
package/dist/apis/MetadataApi.js
CHANGED
|
@@ -75,6 +75,64 @@ var MetadataApi = /** @class */ (function (_super) {
|
|
|
75
75
|
function MetadataApi() {
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
80
|
+
* Get dataset samples
|
|
81
|
+
*/
|
|
82
|
+
MetadataApi.prototype.getDatasetSamplesRaw = function (requestParameters, initOverrides) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
84
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
85
|
+
return __generator(this, function (_a) {
|
|
86
|
+
switch (_a.label) {
|
|
87
|
+
case 0:
|
|
88
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
89
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getDatasetSamples.');
|
|
90
|
+
}
|
|
91
|
+
if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
|
|
92
|
+
throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getDatasetSamples.');
|
|
93
|
+
}
|
|
94
|
+
queryParameters = {};
|
|
95
|
+
headerParameters = {};
|
|
96
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
97
|
+
token = this.configuration.accessToken;
|
|
98
|
+
return [4 /*yield*/, token("accessToken", [])];
|
|
99
|
+
case 1:
|
|
100
|
+
tokenString = _a.sent();
|
|
101
|
+
if (tokenString) {
|
|
102
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
103
|
+
}
|
|
104
|
+
_a.label = 2;
|
|
105
|
+
case 2: return [4 /*yield*/, this.request({
|
|
106
|
+
path: "/projects/{projectId}/datasets/{datasetId}/samples".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
|
|
107
|
+
method: 'GET',
|
|
108
|
+
headers: headerParameters,
|
|
109
|
+
query: queryParameters,
|
|
110
|
+
}, initOverrides)];
|
|
111
|
+
case 3:
|
|
112
|
+
response = _a.sent();
|
|
113
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.SampleFromJSON); })];
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
});
|
|
117
|
+
};
|
|
118
|
+
/**
|
|
119
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
120
|
+
* Get dataset samples
|
|
121
|
+
*/
|
|
122
|
+
MetadataApi.prototype.getDatasetSamples = function (requestParameters, initOverrides) {
|
|
123
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
124
|
+
var response;
|
|
125
|
+
return __generator(this, function (_a) {
|
|
126
|
+
switch (_a.label) {
|
|
127
|
+
case 0: return [4 /*yield*/, this.getDatasetSamplesRaw(requestParameters, initOverrides)];
|
|
128
|
+
case 1:
|
|
129
|
+
response = _a.sent();
|
|
130
|
+
return [4 /*yield*/, response.value()];
|
|
131
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
132
|
+
}
|
|
133
|
+
});
|
|
134
|
+
});
|
|
135
|
+
};
|
|
78
136
|
/**
|
|
79
137
|
* Retrieves a list of samples associated with a project along with their metadata
|
|
80
138
|
* Get project samples
|
|
@@ -0,0 +1,39 @@
|
|
|
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 DataFile
|
|
16
|
+
*/
|
|
17
|
+
export interface DataFile {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof DataFile
|
|
22
|
+
*/
|
|
23
|
+
path: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {{ [key: string]: any; }}
|
|
27
|
+
* @memberof DataFile
|
|
28
|
+
*/
|
|
29
|
+
metadata: {
|
|
30
|
+
[key: string]: any;
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the DataFile interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfDataFile(value: object): boolean;
|
|
37
|
+
export declare function DataFileFromJSON(json: any): DataFile;
|
|
38
|
+
export declare function DataFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataFile;
|
|
39
|
+
export declare function DataFileToJSON(value?: DataFile | null): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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.DataFileToJSON = exports.DataFileFromJSONTyped = exports.DataFileFromJSON = exports.instanceOfDataFile = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the DataFile interface.
|
|
19
|
+
*/
|
|
20
|
+
function instanceOfDataFile(value) {
|
|
21
|
+
var isInstance = true;
|
|
22
|
+
isInstance = isInstance && "path" in value;
|
|
23
|
+
isInstance = isInstance && "metadata" in value;
|
|
24
|
+
return isInstance;
|
|
25
|
+
}
|
|
26
|
+
exports.instanceOfDataFile = instanceOfDataFile;
|
|
27
|
+
function DataFileFromJSON(json) {
|
|
28
|
+
return DataFileFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
exports.DataFileFromJSON = DataFileFromJSON;
|
|
31
|
+
function DataFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if ((json === undefined) || (json === null)) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'path': json['path'],
|
|
37
|
+
'metadata': json['metadata'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
exports.DataFileFromJSONTyped = DataFileFromJSONTyped;
|
|
41
|
+
function DataFileToJSON(value) {
|
|
42
|
+
if (value === undefined) {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
if (value === null) {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'path': value.path,
|
|
50
|
+
'metadata': value.metadata,
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
exports.DataFileToJSON = DataFileToJSON;
|
package/dist/models/Process.d.ts
CHANGED
|
@@ -100,6 +100,12 @@ export interface Process {
|
|
|
100
100
|
* @memberof Process
|
|
101
101
|
*/
|
|
102
102
|
allowMultipleSources?: boolean;
|
|
103
|
+
/**
|
|
104
|
+
* Whether the pipeline uses the Cirro-provided sample sheet
|
|
105
|
+
* @type {boolean}
|
|
106
|
+
* @memberof Process
|
|
107
|
+
*/
|
|
108
|
+
usesSampleSheet?: boolean;
|
|
103
109
|
/**
|
|
104
110
|
* Whether the pipeline is marked as archived
|
|
105
111
|
* @type {boolean}
|
package/dist/models/Process.js
CHANGED
|
@@ -52,6 +52,7 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
52
|
'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
|
|
53
53
|
'linkedProjectIds': !(0, runtime_1.exists)(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
|
|
54
54
|
'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
|
|
55
|
+
'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
|
|
55
56
|
'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
|
|
56
57
|
};
|
|
57
58
|
}
|
|
@@ -78,6 +79,7 @@ function ProcessToJSON(value) {
|
|
|
78
79
|
'owner': value.owner,
|
|
79
80
|
'linkedProjectIds': value.linkedProjectIds,
|
|
80
81
|
'allowMultipleSources': value.allowMultipleSources,
|
|
82
|
+
'usesSampleSheet': value.usesSampleSheet,
|
|
81
83
|
'isArchived': value.isArchived,
|
|
82
84
|
};
|
|
83
85
|
}
|
|
@@ -115,6 +115,12 @@ export interface ProcessDetail {
|
|
|
115
115
|
* @memberof ProcessDetail
|
|
116
116
|
*/
|
|
117
117
|
allowMultipleSources?: boolean;
|
|
118
|
+
/**
|
|
119
|
+
* Whether the pipeline uses the Cirro-provided sample sheet
|
|
120
|
+
* @type {boolean}
|
|
121
|
+
* @memberof ProcessDetail
|
|
122
|
+
*/
|
|
123
|
+
usesSampleSheet?: boolean;
|
|
118
124
|
/**
|
|
119
125
|
*
|
|
120
126
|
* @type {CustomPipelineSettings}
|
|
@@ -59,6 +59,7 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
59
59
|
'linkedProjectIds': json['linkedProjectIds'],
|
|
60
60
|
'isTenantWide': !(0, runtime_1.exists)(json, 'isTenantWide') ? undefined : json['isTenantWide'],
|
|
61
61
|
'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
|
|
62
|
+
'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
|
|
62
63
|
'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
|
|
63
64
|
'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
|
|
64
65
|
'fileMappingRules': !(0, runtime_1.exists)(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRule_1.FileMappingRuleFromJSON)),
|
|
@@ -89,6 +90,7 @@ function ProcessDetailToJSON(value) {
|
|
|
89
90
|
'linkedProjectIds': value.linkedProjectIds,
|
|
90
91
|
'isTenantWide': value.isTenantWide,
|
|
91
92
|
'allowMultipleSources': value.allowMultipleSources,
|
|
93
|
+
'usesSampleSheet': value.usesSampleSheet,
|
|
92
94
|
'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
|
|
93
95
|
'isArchived': value.isArchived,
|
|
94
96
|
'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRule_1.FileMappingRuleToJSON)),
|
|
@@ -39,6 +39,12 @@ export interface RunAnalysisRequest {
|
|
|
39
39
|
* @memberof RunAnalysisRequest
|
|
40
40
|
*/
|
|
41
41
|
sourceDatasetIds: Array<string>;
|
|
42
|
+
/**
|
|
43
|
+
* Samples within the source datasets that will be used as inputs to this workflow. If not specified, all samples will be used.
|
|
44
|
+
* @type {Array<string>}
|
|
45
|
+
* @memberof RunAnalysisRequest
|
|
46
|
+
*/
|
|
47
|
+
sourceSampleIds?: Array<string> | null;
|
|
42
48
|
/**
|
|
43
49
|
* Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
|
|
44
50
|
* @type {string}
|
|
@@ -41,6 +41,7 @@ function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
41
|
'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
|
|
42
42
|
'processId': json['processId'],
|
|
43
43
|
'sourceDatasetIds': json['sourceDatasetIds'],
|
|
44
|
+
'sourceSampleIds': !(0, runtime_1.exists)(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
|
|
44
45
|
'resumeDatasetId': !(0, runtime_1.exists)(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
|
|
45
46
|
'params': json['params'],
|
|
46
47
|
'notificationEmails': json['notificationEmails'],
|
|
@@ -60,6 +61,7 @@ function RunAnalysisRequestToJSON(value) {
|
|
|
60
61
|
'description': value.description,
|
|
61
62
|
'processId': value.processId,
|
|
62
63
|
'sourceDatasetIds': value.sourceDatasetIds,
|
|
64
|
+
'sourceSampleIds': value.sourceSampleIds,
|
|
63
65
|
'resumeDatasetId': value.resumeDatasetId,
|
|
64
66
|
'params': value.params,
|
|
65
67
|
'notificationEmails': value.notificationEmails,
|
package/dist/models/Sample.d.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { DataFile } from './DataFile';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -35,6 +36,12 @@ export interface Sample {
|
|
|
35
36
|
metadata?: {
|
|
36
37
|
[key: string]: any;
|
|
37
38
|
} | null;
|
|
39
|
+
/**
|
|
40
|
+
* Files associated with this sample
|
|
41
|
+
* @type {Array<DataFile>}
|
|
42
|
+
* @memberof Sample
|
|
43
|
+
*/
|
|
44
|
+
files?: Array<DataFile> | null;
|
|
38
45
|
/**
|
|
39
46
|
*
|
|
40
47
|
* @type {Array<string>}
|
package/dist/models/Sample.js
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.SampleToJSON = exports.SampleFromJSONTyped = exports.SampleFromJSON = exports.instanceOfSample = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
|
+
var DataFile_1 = require("./DataFile");
|
|
18
19
|
/**
|
|
19
20
|
* Check if a given object implements the Sample interface.
|
|
20
21
|
*/
|
|
@@ -37,6 +38,7 @@ function SampleFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
38
|
'id': json['id'],
|
|
38
39
|
'name': json['name'],
|
|
39
40
|
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
|
|
41
|
+
'files': !(0, runtime_1.exists)(json, 'files') ? undefined : (json['files'] === null ? null : json['files'].map(DataFile_1.DataFileFromJSON)),
|
|
40
42
|
'datasetIds': !(0, runtime_1.exists)(json, 'datasetIds') ? undefined : json['datasetIds'],
|
|
41
43
|
'createdAt': !(0, runtime_1.exists)(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
|
|
42
44
|
'updatedAt': !(0, runtime_1.exists)(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
|
|
@@ -54,6 +56,7 @@ function SampleToJSON(value) {
|
|
|
54
56
|
'id': value.id,
|
|
55
57
|
'name': value.name,
|
|
56
58
|
'metadata': value.metadata,
|
|
59
|
+
'files': value.files === undefined ? undefined : (value.files === null ? null : value.files.map(DataFile_1.DataFileToJSON)),
|
|
57
60
|
'datasetIds': value.datasetIds,
|
|
58
61
|
'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
|
|
59
62
|
'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),
|
package/dist/models/index.d.ts
CHANGED
|
@@ -30,6 +30,7 @@ export * from './CustomPipelineSettings';
|
|
|
30
30
|
export * from './CustomerType';
|
|
31
31
|
export * from './Dashboard';
|
|
32
32
|
export * from './DashboardRequest';
|
|
33
|
+
export * from './DataFile';
|
|
33
34
|
export * from './Dataset';
|
|
34
35
|
export * from './DatasetAssetsManifest';
|
|
35
36
|
export * from './DatasetCondition';
|
package/dist/models/index.js
CHANGED
|
@@ -48,6 +48,7 @@ __exportStar(require("./CustomPipelineSettings"), exports);
|
|
|
48
48
|
__exportStar(require("./CustomerType"), exports);
|
|
49
49
|
__exportStar(require("./Dashboard"), exports);
|
|
50
50
|
__exportStar(require("./DashboardRequest"), exports);
|
|
51
|
+
__exportStar(require("./DataFile"), exports);
|
|
51
52
|
__exportStar(require("./Dataset"), exports);
|
|
52
53
|
__exportStar(require("./DatasetAssetsManifest"), exports);
|
|
53
54
|
__exportStar(require("./DatasetCondition"), exports);
|
package/package.json
CHANGED
package/src/apis/MetadataApi.ts
CHANGED
|
@@ -31,6 +31,11 @@ import {
|
|
|
31
31
|
SampleRequestToJSON,
|
|
32
32
|
} from '../models/index';
|
|
33
33
|
|
|
34
|
+
export interface GetDatasetSamplesRequest {
|
|
35
|
+
projectId: string;
|
|
36
|
+
datasetId: string;
|
|
37
|
+
}
|
|
38
|
+
|
|
34
39
|
export interface GetProjectSamplesRequest {
|
|
35
40
|
projectId: string;
|
|
36
41
|
limit?: number;
|
|
@@ -57,6 +62,50 @@ export interface UpdateSampleRequest {
|
|
|
57
62
|
*/
|
|
58
63
|
export class MetadataApi extends runtime.BaseAPI {
|
|
59
64
|
|
|
65
|
+
/**
|
|
66
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
67
|
+
* Get dataset samples
|
|
68
|
+
*/
|
|
69
|
+
async getDatasetSamplesRaw(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sample>>> {
|
|
70
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
71
|
+
throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getDatasetSamples.');
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
|
|
75
|
+
throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getDatasetSamples.');
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
const queryParameters: any = {};
|
|
79
|
+
|
|
80
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
81
|
+
|
|
82
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
83
|
+
const token = this.configuration.accessToken;
|
|
84
|
+
const tokenString = await token("accessToken", []);
|
|
85
|
+
|
|
86
|
+
if (tokenString) {
|
|
87
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
const response = await this.request({
|
|
91
|
+
path: `/projects/{projectId}/datasets/{datasetId}/samples`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
|
|
92
|
+
method: 'GET',
|
|
93
|
+
headers: headerParameters,
|
|
94
|
+
query: queryParameters,
|
|
95
|
+
}, initOverrides);
|
|
96
|
+
|
|
97
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SampleFromJSON));
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Retrieves a list of samples associated with a dataset along with their metadata
|
|
102
|
+
* Get dataset samples
|
|
103
|
+
*/
|
|
104
|
+
async getDatasetSamples(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sample>> {
|
|
105
|
+
const response = await this.getDatasetSamplesRaw(requestParameters, initOverrides);
|
|
106
|
+
return await response.value();
|
|
107
|
+
}
|
|
108
|
+
|
|
60
109
|
/**
|
|
61
110
|
* Retrieves a list of samples associated with a project along with their metadata
|
|
62
111
|
* Get project samples
|
|
@@ -0,0 +1,75 @@
|
|
|
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 DataFile
|
|
20
|
+
*/
|
|
21
|
+
export interface DataFile {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof DataFile
|
|
26
|
+
*/
|
|
27
|
+
path: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {{ [key: string]: any; }}
|
|
31
|
+
* @memberof DataFile
|
|
32
|
+
*/
|
|
33
|
+
metadata: { [key: string]: any; };
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the DataFile interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfDataFile(value: object): boolean {
|
|
40
|
+
let isInstance = true;
|
|
41
|
+
isInstance = isInstance && "path" in value;
|
|
42
|
+
isInstance = isInstance && "metadata" in value;
|
|
43
|
+
|
|
44
|
+
return isInstance;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function DataFileFromJSON(json: any): DataFile {
|
|
48
|
+
return DataFileFromJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function DataFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataFile {
|
|
52
|
+
if ((json === undefined) || (json === null)) {
|
|
53
|
+
return json;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
|
|
57
|
+
'path': json['path'],
|
|
58
|
+
'metadata': json['metadata'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function DataFileToJSON(value?: DataFile | null): any {
|
|
63
|
+
if (value === undefined) {
|
|
64
|
+
return undefined;
|
|
65
|
+
}
|
|
66
|
+
if (value === null) {
|
|
67
|
+
return null;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'path': value.path,
|
|
72
|
+
'metadata': value.metadata,
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
package/src/models/Process.ts
CHANGED
|
@@ -110,6 +110,12 @@ export interface Process {
|
|
|
110
110
|
* @memberof Process
|
|
111
111
|
*/
|
|
112
112
|
allowMultipleSources?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Whether the pipeline uses the Cirro-provided sample sheet
|
|
115
|
+
* @type {boolean}
|
|
116
|
+
* @memberof Process
|
|
117
|
+
*/
|
|
118
|
+
usesSampleSheet?: boolean;
|
|
113
119
|
/**
|
|
114
120
|
* Whether the pipeline is marked as archived
|
|
115
121
|
* @type {boolean}
|
|
@@ -156,6 +162,7 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
|
|
|
156
162
|
'owner': !exists(json, 'owner') ? undefined : json['owner'],
|
|
157
163
|
'linkedProjectIds': !exists(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
|
|
158
164
|
'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
|
|
165
|
+
'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
|
|
159
166
|
'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
|
|
160
167
|
};
|
|
161
168
|
}
|
|
@@ -183,6 +190,7 @@ export function ProcessToJSON(value?: Process | null): any {
|
|
|
183
190
|
'owner': value.owner,
|
|
184
191
|
'linkedProjectIds': value.linkedProjectIds,
|
|
185
192
|
'allowMultipleSources': value.allowMultipleSources,
|
|
193
|
+
'usesSampleSheet': value.usesSampleSheet,
|
|
186
194
|
'isArchived': value.isArchived,
|
|
187
195
|
};
|
|
188
196
|
}
|
|
@@ -140,6 +140,12 @@ export interface ProcessDetail {
|
|
|
140
140
|
* @memberof ProcessDetail
|
|
141
141
|
*/
|
|
142
142
|
allowMultipleSources?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* Whether the pipeline uses the Cirro-provided sample sheet
|
|
145
|
+
* @type {boolean}
|
|
146
|
+
* @memberof ProcessDetail
|
|
147
|
+
*/
|
|
148
|
+
usesSampleSheet?: boolean;
|
|
143
149
|
/**
|
|
144
150
|
*
|
|
145
151
|
* @type {CustomPipelineSettings}
|
|
@@ -202,6 +208,7 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
202
208
|
'linkedProjectIds': json['linkedProjectIds'],
|
|
203
209
|
'isTenantWide': !exists(json, 'isTenantWide') ? undefined : json['isTenantWide'],
|
|
204
210
|
'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
|
|
211
|
+
'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
|
|
205
212
|
'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
|
|
206
213
|
'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
|
|
207
214
|
'fileMappingRules': !exists(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : (json['fileMappingRules'] as Array<any>).map(FileMappingRuleFromJSON)),
|
|
@@ -233,6 +240,7 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
|
|
|
233
240
|
'linkedProjectIds': value.linkedProjectIds,
|
|
234
241
|
'isTenantWide': value.isTenantWide,
|
|
235
242
|
'allowMultipleSources': value.allowMultipleSources,
|
|
243
|
+
'usesSampleSheet': value.usesSampleSheet,
|
|
236
244
|
'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
|
|
237
245
|
'isArchived': value.isArchived,
|
|
238
246
|
'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : (value.fileMappingRules as Array<any>).map(FileMappingRuleToJSON)),
|
|
@@ -43,6 +43,12 @@ export interface RunAnalysisRequest {
|
|
|
43
43
|
* @memberof RunAnalysisRequest
|
|
44
44
|
*/
|
|
45
45
|
sourceDatasetIds: Array<string>;
|
|
46
|
+
/**
|
|
47
|
+
* Samples within the source datasets that will be used as inputs to this workflow. If not specified, all samples will be used.
|
|
48
|
+
* @type {Array<string>}
|
|
49
|
+
* @memberof RunAnalysisRequest
|
|
50
|
+
*/
|
|
51
|
+
sourceSampleIds?: Array<string> | null;
|
|
46
52
|
/**
|
|
47
53
|
* Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
|
|
48
54
|
* @type {string}
|
|
@@ -97,6 +103,7 @@ export function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
97
103
|
'description': !exists(json, 'description') ? undefined : json['description'],
|
|
98
104
|
'processId': json['processId'],
|
|
99
105
|
'sourceDatasetIds': json['sourceDatasetIds'],
|
|
106
|
+
'sourceSampleIds': !exists(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
|
|
100
107
|
'resumeDatasetId': !exists(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
|
|
101
108
|
'params': json['params'],
|
|
102
109
|
'notificationEmails': json['notificationEmails'],
|
|
@@ -117,6 +124,7 @@ export function RunAnalysisRequestToJSON(value?: RunAnalysisRequest | null): any
|
|
|
117
124
|
'description': value.description,
|
|
118
125
|
'processId': value.processId,
|
|
119
126
|
'sourceDatasetIds': value.sourceDatasetIds,
|
|
127
|
+
'sourceSampleIds': value.sourceSampleIds,
|
|
120
128
|
'resumeDatasetId': value.resumeDatasetId,
|
|
121
129
|
'params': value.params,
|
|
122
130
|
'notificationEmails': value.notificationEmails,
|
package/src/models/Sample.ts
CHANGED
|
@@ -13,6 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import type { DataFile } from './DataFile';
|
|
17
|
+
import {
|
|
18
|
+
DataFileFromJSON,
|
|
19
|
+
DataFileFromJSONTyped,
|
|
20
|
+
DataFileToJSON,
|
|
21
|
+
} from './DataFile';
|
|
22
|
+
|
|
16
23
|
/**
|
|
17
24
|
*
|
|
18
25
|
* @export
|
|
@@ -37,6 +44,12 @@ export interface Sample {
|
|
|
37
44
|
* @memberof Sample
|
|
38
45
|
*/
|
|
39
46
|
metadata?: { [key: string]: any; } | null;
|
|
47
|
+
/**
|
|
48
|
+
* Files associated with this sample
|
|
49
|
+
* @type {Array<DataFile>}
|
|
50
|
+
* @memberof Sample
|
|
51
|
+
*/
|
|
52
|
+
files?: Array<DataFile> | null;
|
|
40
53
|
/**
|
|
41
54
|
*
|
|
42
55
|
* @type {Array<string>}
|
|
@@ -81,6 +94,7 @@ export function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sa
|
|
|
81
94
|
'id': json['id'],
|
|
82
95
|
'name': json['name'],
|
|
83
96
|
'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
|
|
97
|
+
'files': !exists(json, 'files') ? undefined : (json['files'] === null ? null : (json['files'] as Array<any>).map(DataFileFromJSON)),
|
|
84
98
|
'datasetIds': !exists(json, 'datasetIds') ? undefined : json['datasetIds'],
|
|
85
99
|
'createdAt': !exists(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
|
|
86
100
|
'updatedAt': !exists(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
|
|
@@ -99,6 +113,7 @@ export function SampleToJSON(value?: Sample | null): any {
|
|
|
99
113
|
'id': value.id,
|
|
100
114
|
'name': value.name,
|
|
101
115
|
'metadata': value.metadata,
|
|
116
|
+
'files': value.files === undefined ? undefined : (value.files === null ? null : (value.files as Array<any>).map(DataFileToJSON)),
|
|
102
117
|
'datasetIds': value.datasetIds,
|
|
103
118
|
'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
|
|
104
119
|
'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),
|
package/src/models/index.ts
CHANGED
|
@@ -32,6 +32,7 @@ export * from './CustomPipelineSettings';
|
|
|
32
32
|
export * from './CustomerType';
|
|
33
33
|
export * from './Dashboard';
|
|
34
34
|
export * from './DashboardRequest';
|
|
35
|
+
export * from './DataFile';
|
|
35
36
|
export * from './Dataset';
|
|
36
37
|
export * from './DatasetAssetsManifest';
|
|
37
38
|
export * from './DatasetCondition';
|