@cirrobio/api-client 0.0.15-alpha → 0.0.16-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.
- package/README.md +1 -1
- package/dist/apis/MetadataApi.d.ts +16 -0
- package/dist/apis/MetadataApi.js +60 -0
- package/dist/apis/NotebooksApi.d.ts +24 -0
- package/dist/apis/NotebooksApi.js +24 -0
- package/dist/models/NotebookInstance.d.ts +6 -0
- package/dist/models/NotebookInstance.js +3 -0
- package/dist/models/NotebookInstanceStatusResponse.d.ts +6 -0
- package/dist/models/NotebookInstanceStatusResponse.js +3 -0
- package/dist/models/Status.d.ts +1 -0
- package/dist/models/Status.js +1 -0
- package/package.json +1 -1
- package/src/apis/MetadataApi.ts +53 -0
- package/src/apis/NotebooksApi.ts +24 -0
- package/src/models/NotebookInstance.ts +9 -0
- package/src/models/NotebookInstanceStatusResponse.ts +9 -0
- package/src/models/Status.ts +1 -0
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.
|
|
39
|
+
npm install @cirrobio/api-client@0.0.16-alpha --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -19,6 +19,10 @@ export interface GetProjectSamplesRequest {
|
|
|
19
19
|
export interface GetProjectSchemaRequest {
|
|
20
20
|
projectId: string;
|
|
21
21
|
}
|
|
22
|
+
export interface UpdateProjectSchemaRequest {
|
|
23
|
+
projectId: string;
|
|
24
|
+
formSchema: FormSchema;
|
|
25
|
+
}
|
|
22
26
|
export interface UpdateSampleRequest {
|
|
23
27
|
projectId: string;
|
|
24
28
|
sampleId: string;
|
|
@@ -29,10 +33,12 @@ export interface UpdateSampleRequest {
|
|
|
29
33
|
*/
|
|
30
34
|
export declare class MetadataApi extends runtime.BaseAPI {
|
|
31
35
|
/**
|
|
36
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
32
37
|
* Get project samples
|
|
33
38
|
*/
|
|
34
39
|
getProjectSamplesRaw(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseSampleDto>>;
|
|
35
40
|
/**
|
|
41
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
36
42
|
* Get project samples
|
|
37
43
|
*/
|
|
38
44
|
getProjectSamples(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseSampleDto>;
|
|
@@ -45,10 +51,20 @@ export declare class MetadataApi extends runtime.BaseAPI {
|
|
|
45
51
|
*/
|
|
46
52
|
getProjectSchema(requestParameters: GetProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
|
|
47
53
|
/**
|
|
54
|
+
* Update project metadata schema
|
|
55
|
+
*/
|
|
56
|
+
updateProjectSchemaRaw(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
57
|
+
/**
|
|
58
|
+
* Update project metadata schema
|
|
59
|
+
*/
|
|
60
|
+
updateProjectSchema(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
61
|
+
/**
|
|
62
|
+
* Updates metadata on a sample
|
|
48
63
|
* Update sample
|
|
49
64
|
*/
|
|
50
65
|
updateSampleRaw(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Sample>>;
|
|
51
66
|
/**
|
|
67
|
+
* Updates metadata on a sample
|
|
52
68
|
* Update sample
|
|
53
69
|
*/
|
|
54
70
|
updateSample(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Sample>;
|
package/dist/apis/MetadataApi.js
CHANGED
|
@@ -76,6 +76,7 @@ var MetadataApi = /** @class */ (function (_super) {
|
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
79
80
|
* Get project samples
|
|
80
81
|
*/
|
|
81
82
|
MetadataApi.prototype.getProjectSamplesRaw = function (requestParameters, initOverrides) {
|
|
@@ -118,6 +119,7 @@ var MetadataApi = /** @class */ (function (_super) {
|
|
|
118
119
|
});
|
|
119
120
|
};
|
|
120
121
|
/**
|
|
122
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
121
123
|
* Get project samples
|
|
122
124
|
*/
|
|
123
125
|
MetadataApi.prototype.getProjectSamples = function (requestParameters, initOverrides) {
|
|
@@ -188,6 +190,63 @@ var MetadataApi = /** @class */ (function (_super) {
|
|
|
188
190
|
});
|
|
189
191
|
};
|
|
190
192
|
/**
|
|
193
|
+
* Update project metadata schema
|
|
194
|
+
*/
|
|
195
|
+
MetadataApi.prototype.updateProjectSchemaRaw = function (requestParameters, initOverrides) {
|
|
196
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
197
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
198
|
+
return __generator(this, function (_a) {
|
|
199
|
+
switch (_a.label) {
|
|
200
|
+
case 0:
|
|
201
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
202
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling updateProjectSchema.');
|
|
203
|
+
}
|
|
204
|
+
if (requestParameters.formSchema === null || requestParameters.formSchema === undefined) {
|
|
205
|
+
throw new runtime.RequiredError('formSchema', 'Required parameter requestParameters.formSchema was null or undefined when calling updateProjectSchema.');
|
|
206
|
+
}
|
|
207
|
+
queryParameters = {};
|
|
208
|
+
headerParameters = {};
|
|
209
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
210
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
211
|
+
token = this.configuration.accessToken;
|
|
212
|
+
return [4 /*yield*/, token("accessToken", [])];
|
|
213
|
+
case 1:
|
|
214
|
+
tokenString = _a.sent();
|
|
215
|
+
if (tokenString) {
|
|
216
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
217
|
+
}
|
|
218
|
+
_a.label = 2;
|
|
219
|
+
case 2: return [4 /*yield*/, this.request({
|
|
220
|
+
path: "/projects/{projectId}/schema".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
|
|
221
|
+
method: 'PUT',
|
|
222
|
+
headers: headerParameters,
|
|
223
|
+
query: queryParameters,
|
|
224
|
+
body: (0, index_1.FormSchemaToJSON)(requestParameters.formSchema),
|
|
225
|
+
}, initOverrides)];
|
|
226
|
+
case 3:
|
|
227
|
+
response = _a.sent();
|
|
228
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
229
|
+
}
|
|
230
|
+
});
|
|
231
|
+
});
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Update project metadata schema
|
|
235
|
+
*/
|
|
236
|
+
MetadataApi.prototype.updateProjectSchema = function (requestParameters, initOverrides) {
|
|
237
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
238
|
+
return __generator(this, function (_a) {
|
|
239
|
+
switch (_a.label) {
|
|
240
|
+
case 0: return [4 /*yield*/, this.updateProjectSchemaRaw(requestParameters, initOverrides)];
|
|
241
|
+
case 1:
|
|
242
|
+
_a.sent();
|
|
243
|
+
return [2 /*return*/];
|
|
244
|
+
}
|
|
245
|
+
});
|
|
246
|
+
});
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* Updates metadata on a sample
|
|
191
250
|
* Update sample
|
|
192
251
|
*/
|
|
193
252
|
MetadataApi.prototype.updateSampleRaw = function (requestParameters, initOverrides) {
|
|
@@ -232,6 +291,7 @@ var MetadataApi = /** @class */ (function (_super) {
|
|
|
232
291
|
});
|
|
233
292
|
};
|
|
234
293
|
/**
|
|
294
|
+
* Updates metadata on a sample
|
|
235
295
|
* Update sample
|
|
236
296
|
*/
|
|
237
297
|
MetadataApi.prototype.updateSample = function (requestParameters, initOverrides) {
|
|
@@ -39,39 +39,63 @@ export interface StopNotebookInstanceRequest {
|
|
|
39
39
|
*/
|
|
40
40
|
export declare class NotebooksApi extends runtime.BaseAPI {
|
|
41
41
|
/**
|
|
42
|
+
* Creates a notebook instance within the project
|
|
43
|
+
* Create notebook instance
|
|
42
44
|
*/
|
|
43
45
|
createNotebookInstanceRaw(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
|
|
44
46
|
/**
|
|
47
|
+
* Creates a notebook instance within the project
|
|
48
|
+
* Create notebook instance
|
|
45
49
|
*/
|
|
46
50
|
createNotebookInstance(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
|
|
47
51
|
/**
|
|
52
|
+
* Triggers a deletion of the notebook instance
|
|
53
|
+
* Delete notebook instance
|
|
48
54
|
*/
|
|
49
55
|
deleteNotebookInstanceRaw(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
50
56
|
/**
|
|
57
|
+
* Triggers a deletion of the notebook instance
|
|
58
|
+
* Delete notebook instance
|
|
51
59
|
*/
|
|
52
60
|
deleteNotebookInstance(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
53
61
|
/**
|
|
62
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
63
|
+
* Generate notebook instance URL
|
|
54
64
|
*/
|
|
55
65
|
generateNotebookInstanceUrlRaw(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenNotebookInstanceResponse>>;
|
|
56
66
|
/**
|
|
67
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
68
|
+
* Generate notebook instance URL
|
|
57
69
|
*/
|
|
58
70
|
generateNotebookInstanceUrl(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenNotebookInstanceResponse>;
|
|
59
71
|
/**
|
|
72
|
+
* Retrieves the status of the instance
|
|
73
|
+
* Get notebook instance status
|
|
60
74
|
*/
|
|
61
75
|
getNotebookInstanceStatusRaw(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotebookInstanceStatusResponse>>;
|
|
62
76
|
/**
|
|
77
|
+
* Retrieves the status of the instance
|
|
78
|
+
* Get notebook instance status
|
|
63
79
|
*/
|
|
64
80
|
getNotebookInstanceStatus(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotebookInstanceStatusResponse>;
|
|
65
81
|
/**
|
|
82
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
83
|
+
* Get notebook instances
|
|
66
84
|
*/
|
|
67
85
|
getNotebookInstancesRaw(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotebookInstance>>>;
|
|
68
86
|
/**
|
|
87
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
88
|
+
* Get notebook instances
|
|
69
89
|
*/
|
|
70
90
|
getNotebookInstances(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotebookInstance>>;
|
|
71
91
|
/**
|
|
92
|
+
* Shuts down a running notebook instance
|
|
93
|
+
* Stop notebook instance
|
|
72
94
|
*/
|
|
73
95
|
stopNotebookInstanceRaw(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
74
96
|
/**
|
|
97
|
+
* Shuts down a running notebook instance
|
|
98
|
+
* Stop notebook instance
|
|
75
99
|
*/
|
|
76
100
|
stopNotebookInstance(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
77
101
|
}
|
|
@@ -76,6 +76,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
+
* Creates a notebook instance within the project
|
|
80
|
+
* Create notebook instance
|
|
79
81
|
*/
|
|
80
82
|
NotebooksApi.prototype.createNotebookInstanceRaw = function (requestParameters, initOverrides) {
|
|
81
83
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -116,6 +118,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
116
118
|
});
|
|
117
119
|
};
|
|
118
120
|
/**
|
|
121
|
+
* Creates a notebook instance within the project
|
|
122
|
+
* Create notebook instance
|
|
119
123
|
*/
|
|
120
124
|
NotebooksApi.prototype.createNotebookInstance = function (requestParameters, initOverrides) {
|
|
121
125
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -132,6 +136,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
132
136
|
});
|
|
133
137
|
};
|
|
134
138
|
/**
|
|
139
|
+
* Triggers a deletion of the notebook instance
|
|
140
|
+
* Delete notebook instance
|
|
135
141
|
*/
|
|
136
142
|
NotebooksApi.prototype.deleteNotebookInstanceRaw = function (requestParameters, initOverrides) {
|
|
137
143
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -170,6 +176,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
170
176
|
});
|
|
171
177
|
};
|
|
172
178
|
/**
|
|
179
|
+
* Triggers a deletion of the notebook instance
|
|
180
|
+
* Delete notebook instance
|
|
173
181
|
*/
|
|
174
182
|
NotebooksApi.prototype.deleteNotebookInstance = function (requestParameters, initOverrides) {
|
|
175
183
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -184,6 +192,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
184
192
|
});
|
|
185
193
|
};
|
|
186
194
|
/**
|
|
195
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
196
|
+
* Generate notebook instance URL
|
|
187
197
|
*/
|
|
188
198
|
NotebooksApi.prototype.generateNotebookInstanceUrlRaw = function (requestParameters, initOverrides) {
|
|
189
199
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -222,6 +232,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
222
232
|
});
|
|
223
233
|
};
|
|
224
234
|
/**
|
|
235
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
236
|
+
* Generate notebook instance URL
|
|
225
237
|
*/
|
|
226
238
|
NotebooksApi.prototype.generateNotebookInstanceUrl = function (requestParameters, initOverrides) {
|
|
227
239
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -238,6 +250,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
238
250
|
});
|
|
239
251
|
};
|
|
240
252
|
/**
|
|
253
|
+
* Retrieves the status of the instance
|
|
254
|
+
* Get notebook instance status
|
|
241
255
|
*/
|
|
242
256
|
NotebooksApi.prototype.getNotebookInstanceStatusRaw = function (requestParameters, initOverrides) {
|
|
243
257
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -276,6 +290,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
276
290
|
});
|
|
277
291
|
};
|
|
278
292
|
/**
|
|
293
|
+
* Retrieves the status of the instance
|
|
294
|
+
* Get notebook instance status
|
|
279
295
|
*/
|
|
280
296
|
NotebooksApi.prototype.getNotebookInstanceStatus = function (requestParameters, initOverrides) {
|
|
281
297
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -292,6 +308,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
292
308
|
});
|
|
293
309
|
};
|
|
294
310
|
/**
|
|
311
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
312
|
+
* Get notebook instances
|
|
295
313
|
*/
|
|
296
314
|
NotebooksApi.prototype.getNotebookInstancesRaw = function (requestParameters, initOverrides) {
|
|
297
315
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -327,6 +345,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
327
345
|
});
|
|
328
346
|
};
|
|
329
347
|
/**
|
|
348
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
349
|
+
* Get notebook instances
|
|
330
350
|
*/
|
|
331
351
|
NotebooksApi.prototype.getNotebookInstances = function (requestParameters, initOverrides) {
|
|
332
352
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -343,6 +363,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
343
363
|
});
|
|
344
364
|
};
|
|
345
365
|
/**
|
|
366
|
+
* Shuts down a running notebook instance
|
|
367
|
+
* Stop notebook instance
|
|
346
368
|
*/
|
|
347
369
|
NotebooksApi.prototype.stopNotebookInstanceRaw = function (requestParameters, initOverrides) {
|
|
348
370
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -381,6 +403,8 @@ var NotebooksApi = /** @class */ (function (_super) {
|
|
|
381
403
|
});
|
|
382
404
|
};
|
|
383
405
|
/**
|
|
406
|
+
* Shuts down a running notebook instance
|
|
407
|
+
* Stop notebook instance
|
|
384
408
|
*/
|
|
385
409
|
NotebooksApi.prototype.stopNotebookInstance = function (requestParameters, initOverrides) {
|
|
386
410
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -58,6 +58,12 @@ export interface NotebookInstance {
|
|
|
58
58
|
* @memberof NotebookInstance
|
|
59
59
|
*/
|
|
60
60
|
createdBy: string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @type {Date}
|
|
64
|
+
* @memberof NotebookInstance
|
|
65
|
+
*/
|
|
66
|
+
createdAt: Date;
|
|
61
67
|
}
|
|
62
68
|
/**
|
|
63
69
|
* Check if a given object implements the NotebookInstance interface.
|
|
@@ -27,6 +27,7 @@ function instanceOfNotebookInstance(value) {
|
|
|
27
27
|
isInstance = isInstance && "acceleratorTypes" in value;
|
|
28
28
|
isInstance = isInstance && "volumeSizeGB" in value;
|
|
29
29
|
isInstance = isInstance && "createdBy" in value;
|
|
30
|
+
isInstance = isInstance && "createdAt" in value;
|
|
30
31
|
return isInstance;
|
|
31
32
|
}
|
|
32
33
|
exports.instanceOfNotebookInstance = instanceOfNotebookInstance;
|
|
@@ -46,6 +47,7 @@ function NotebookInstanceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
46
47
|
'acceleratorTypes': json['acceleratorTypes'],
|
|
47
48
|
'volumeSizeGB': json['volumeSizeGB'],
|
|
48
49
|
'createdBy': json['createdBy'],
|
|
50
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
49
51
|
};
|
|
50
52
|
}
|
|
51
53
|
exports.NotebookInstanceFromJSONTyped = NotebookInstanceFromJSONTyped;
|
|
@@ -64,6 +66,7 @@ function NotebookInstanceToJSON(value) {
|
|
|
64
66
|
'acceleratorTypes': value.acceleratorTypes,
|
|
65
67
|
'volumeSizeGB': value.volumeSizeGB,
|
|
66
68
|
'createdBy': value.createdBy,
|
|
69
|
+
'createdAt': (value.createdAt.toISOString()),
|
|
67
70
|
};
|
|
68
71
|
}
|
|
69
72
|
exports.NotebookInstanceToJSON = NotebookInstanceToJSON;
|
|
@@ -21,6 +21,12 @@ export interface NotebookInstanceStatusResponse {
|
|
|
21
21
|
* @memberof NotebookInstanceStatusResponse
|
|
22
22
|
*/
|
|
23
23
|
status: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof NotebookInstanceStatusResponse
|
|
28
|
+
*/
|
|
29
|
+
statusMessage: string;
|
|
24
30
|
}
|
|
25
31
|
/**
|
|
26
32
|
* Check if a given object implements the NotebookInstanceStatusResponse interface.
|
|
@@ -20,6 +20,7 @@ exports.NotebookInstanceStatusResponseToJSON = exports.NotebookInstanceStatusRes
|
|
|
20
20
|
function instanceOfNotebookInstanceStatusResponse(value) {
|
|
21
21
|
var isInstance = true;
|
|
22
22
|
isInstance = isInstance && "status" in value;
|
|
23
|
+
isInstance = isInstance && "statusMessage" in value;
|
|
23
24
|
return isInstance;
|
|
24
25
|
}
|
|
25
26
|
exports.instanceOfNotebookInstanceStatusResponse = instanceOfNotebookInstanceStatusResponse;
|
|
@@ -33,6 +34,7 @@ function NotebookInstanceStatusResponseFromJSONTyped(json, ignoreDiscriminator)
|
|
|
33
34
|
}
|
|
34
35
|
return {
|
|
35
36
|
'status': json['status'],
|
|
37
|
+
'statusMessage': json['statusMessage'],
|
|
36
38
|
};
|
|
37
39
|
}
|
|
38
40
|
exports.NotebookInstanceStatusResponseFromJSONTyped = NotebookInstanceStatusResponseFromJSONTyped;
|
|
@@ -45,6 +47,7 @@ function NotebookInstanceStatusResponseToJSON(value) {
|
|
|
45
47
|
}
|
|
46
48
|
return {
|
|
47
49
|
'status': value.status,
|
|
50
|
+
'statusMessage': value.statusMessage,
|
|
48
51
|
};
|
|
49
52
|
}
|
|
50
53
|
exports.NotebookInstanceStatusResponseToJSON = NotebookInstanceStatusResponseToJSON;
|
package/dist/models/Status.d.ts
CHANGED
package/dist/models/Status.js
CHANGED
|
@@ -27,6 +27,7 @@ var Status;
|
|
|
27
27
|
Status["Archived"] = "ARCHIVED";
|
|
28
28
|
Status["Deleted"] = "DELETED";
|
|
29
29
|
Status["Deleting"] = "DELETING";
|
|
30
|
+
Status["Suspended"] = "SUSPENDED";
|
|
30
31
|
Status["Delete"] = "DELETE";
|
|
31
32
|
Status["Failed"] = "FAILED";
|
|
32
33
|
})(Status = exports.Status || (exports.Status = {}));
|
package/package.json
CHANGED
package/src/apis/MetadataApi.ts
CHANGED
|
@@ -41,6 +41,11 @@ export interface GetProjectSchemaRequest {
|
|
|
41
41
|
projectId: string;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
|
+
export interface UpdateProjectSchemaRequest {
|
|
45
|
+
projectId: string;
|
|
46
|
+
formSchema: FormSchema;
|
|
47
|
+
}
|
|
48
|
+
|
|
44
49
|
export interface UpdateSampleRequest {
|
|
45
50
|
projectId: string;
|
|
46
51
|
sampleId: string;
|
|
@@ -53,6 +58,7 @@ export interface UpdateSampleRequest {
|
|
|
53
58
|
export class MetadataApi extends runtime.BaseAPI {
|
|
54
59
|
|
|
55
60
|
/**
|
|
61
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
56
62
|
* Get project samples
|
|
57
63
|
*/
|
|
58
64
|
async getProjectSamplesRaw(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseSampleDto>> {
|
|
@@ -91,6 +97,7 @@ export class MetadataApi extends runtime.BaseAPI {
|
|
|
91
97
|
}
|
|
92
98
|
|
|
93
99
|
/**
|
|
100
|
+
* Retrieves a list of samples associated with a project along with their metadata
|
|
94
101
|
* Get project samples
|
|
95
102
|
*/
|
|
96
103
|
async getProjectSamples(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseSampleDto> {
|
|
@@ -137,6 +144,51 @@ export class MetadataApi extends runtime.BaseAPI {
|
|
|
137
144
|
}
|
|
138
145
|
|
|
139
146
|
/**
|
|
147
|
+
* Update project metadata schema
|
|
148
|
+
*/
|
|
149
|
+
async updateProjectSchemaRaw(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
150
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
151
|
+
throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling updateProjectSchema.');
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
if (requestParameters.formSchema === null || requestParameters.formSchema === undefined) {
|
|
155
|
+
throw new runtime.RequiredError('formSchema','Required parameter requestParameters.formSchema was null or undefined when calling updateProjectSchema.');
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
const queryParameters: any = {};
|
|
159
|
+
|
|
160
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
161
|
+
|
|
162
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
163
|
+
|
|
164
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
165
|
+
const token = this.configuration.accessToken;
|
|
166
|
+
const tokenString = await token("accessToken", []);
|
|
167
|
+
|
|
168
|
+
if (tokenString) {
|
|
169
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
const response = await this.request({
|
|
173
|
+
path: `/projects/{projectId}/schema`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
|
|
174
|
+
method: 'PUT',
|
|
175
|
+
headers: headerParameters,
|
|
176
|
+
query: queryParameters,
|
|
177
|
+
body: FormSchemaToJSON(requestParameters.formSchema),
|
|
178
|
+
}, initOverrides);
|
|
179
|
+
|
|
180
|
+
return new runtime.VoidApiResponse(response);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Update project metadata schema
|
|
185
|
+
*/
|
|
186
|
+
async updateProjectSchema(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
187
|
+
await this.updateProjectSchemaRaw(requestParameters, initOverrides);
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* Updates metadata on a sample
|
|
140
192
|
* Update sample
|
|
141
193
|
*/
|
|
142
194
|
async updateSampleRaw(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Sample>> {
|
|
@@ -178,6 +230,7 @@ export class MetadataApi extends runtime.BaseAPI {
|
|
|
178
230
|
}
|
|
179
231
|
|
|
180
232
|
/**
|
|
233
|
+
* Updates metadata on a sample
|
|
181
234
|
* Update sample
|
|
182
235
|
*/
|
|
183
236
|
async updateSample(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Sample> {
|
package/src/apis/NotebooksApi.ts
CHANGED
|
@@ -69,6 +69,8 @@ export interface StopNotebookInstanceRequest {
|
|
|
69
69
|
export class NotebooksApi extends runtime.BaseAPI {
|
|
70
70
|
|
|
71
71
|
/**
|
|
72
|
+
* Creates a notebook instance within the project
|
|
73
|
+
* Create notebook instance
|
|
72
74
|
*/
|
|
73
75
|
async createNotebookInstanceRaw(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
|
|
74
76
|
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
@@ -105,6 +107,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
105
107
|
}
|
|
106
108
|
|
|
107
109
|
/**
|
|
110
|
+
* Creates a notebook instance within the project
|
|
111
|
+
* Create notebook instance
|
|
108
112
|
*/
|
|
109
113
|
async createNotebookInstance(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
|
|
110
114
|
const response = await this.createNotebookInstanceRaw(requestParameters, initOverrides);
|
|
@@ -112,6 +116,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
112
116
|
}
|
|
113
117
|
|
|
114
118
|
/**
|
|
119
|
+
* Triggers a deletion of the notebook instance
|
|
120
|
+
* Delete notebook instance
|
|
115
121
|
*/
|
|
116
122
|
async deleteNotebookInstanceRaw(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
117
123
|
if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
|
|
@@ -145,12 +151,16 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
145
151
|
}
|
|
146
152
|
|
|
147
153
|
/**
|
|
154
|
+
* Triggers a deletion of the notebook instance
|
|
155
|
+
* Delete notebook instance
|
|
148
156
|
*/
|
|
149
157
|
async deleteNotebookInstance(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
150
158
|
await this.deleteNotebookInstanceRaw(requestParameters, initOverrides);
|
|
151
159
|
}
|
|
152
160
|
|
|
153
161
|
/**
|
|
162
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
163
|
+
* Generate notebook instance URL
|
|
154
164
|
*/
|
|
155
165
|
async generateNotebookInstanceUrlRaw(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenNotebookInstanceResponse>> {
|
|
156
166
|
if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
|
|
@@ -184,6 +194,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
184
194
|
}
|
|
185
195
|
|
|
186
196
|
/**
|
|
197
|
+
* Creates an authenticated URL to open up the notebook instance in your browser
|
|
198
|
+
* Generate notebook instance URL
|
|
187
199
|
*/
|
|
188
200
|
async generateNotebookInstanceUrl(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenNotebookInstanceResponse> {
|
|
189
201
|
const response = await this.generateNotebookInstanceUrlRaw(requestParameters, initOverrides);
|
|
@@ -191,6 +203,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
191
203
|
}
|
|
192
204
|
|
|
193
205
|
/**
|
|
206
|
+
* Retrieves the status of the instance
|
|
207
|
+
* Get notebook instance status
|
|
194
208
|
*/
|
|
195
209
|
async getNotebookInstanceStatusRaw(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotebookInstanceStatusResponse>> {
|
|
196
210
|
if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
|
|
@@ -224,6 +238,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
224
238
|
}
|
|
225
239
|
|
|
226
240
|
/**
|
|
241
|
+
* Retrieves the status of the instance
|
|
242
|
+
* Get notebook instance status
|
|
227
243
|
*/
|
|
228
244
|
async getNotebookInstanceStatus(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotebookInstanceStatusResponse> {
|
|
229
245
|
const response = await this.getNotebookInstanceStatusRaw(requestParameters, initOverrides);
|
|
@@ -231,6 +247,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
231
247
|
}
|
|
232
248
|
|
|
233
249
|
/**
|
|
250
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
251
|
+
* Get notebook instances
|
|
234
252
|
*/
|
|
235
253
|
async getNotebookInstancesRaw(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotebookInstance>>> {
|
|
236
254
|
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
@@ -260,6 +278,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
260
278
|
}
|
|
261
279
|
|
|
262
280
|
/**
|
|
281
|
+
* Retrieves a list of notebook instances that the user has access to
|
|
282
|
+
* Get notebook instances
|
|
263
283
|
*/
|
|
264
284
|
async getNotebookInstances(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotebookInstance>> {
|
|
265
285
|
const response = await this.getNotebookInstancesRaw(requestParameters, initOverrides);
|
|
@@ -267,6 +287,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
267
287
|
}
|
|
268
288
|
|
|
269
289
|
/**
|
|
290
|
+
* Shuts down a running notebook instance
|
|
291
|
+
* Stop notebook instance
|
|
270
292
|
*/
|
|
271
293
|
async stopNotebookInstanceRaw(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
272
294
|
if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
|
|
@@ -300,6 +322,8 @@ export class NotebooksApi extends runtime.BaseAPI {
|
|
|
300
322
|
}
|
|
301
323
|
|
|
302
324
|
/**
|
|
325
|
+
* Shuts down a running notebook instance
|
|
326
|
+
* Stop notebook instance
|
|
303
327
|
*/
|
|
304
328
|
async stopNotebookInstance(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
305
329
|
await this.stopNotebookInstanceRaw(requestParameters, initOverrides);
|
|
@@ -68,6 +68,12 @@ export interface NotebookInstance {
|
|
|
68
68
|
* @memberof NotebookInstance
|
|
69
69
|
*/
|
|
70
70
|
createdBy: string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {Date}
|
|
74
|
+
* @memberof NotebookInstance
|
|
75
|
+
*/
|
|
76
|
+
createdAt: Date;
|
|
71
77
|
}
|
|
72
78
|
|
|
73
79
|
/**
|
|
@@ -82,6 +88,7 @@ export function instanceOfNotebookInstance(value: object): boolean {
|
|
|
82
88
|
isInstance = isInstance && "acceleratorTypes" in value;
|
|
83
89
|
isInstance = isInstance && "volumeSizeGB" in value;
|
|
84
90
|
isInstance = isInstance && "createdBy" in value;
|
|
91
|
+
isInstance = isInstance && "createdAt" in value;
|
|
85
92
|
|
|
86
93
|
return isInstance;
|
|
87
94
|
}
|
|
@@ -103,6 +110,7 @@ export function NotebookInstanceFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
103
110
|
'acceleratorTypes': json['acceleratorTypes'],
|
|
104
111
|
'volumeSizeGB': json['volumeSizeGB'],
|
|
105
112
|
'createdBy': json['createdBy'],
|
|
113
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
106
114
|
};
|
|
107
115
|
}
|
|
108
116
|
|
|
@@ -122,6 +130,7 @@ export function NotebookInstanceToJSON(value?: NotebookInstance | null): any {
|
|
|
122
130
|
'acceleratorTypes': value.acceleratorTypes,
|
|
123
131
|
'volumeSizeGB': value.volumeSizeGB,
|
|
124
132
|
'createdBy': value.createdBy,
|
|
133
|
+
'createdAt': (value.createdAt.toISOString()),
|
|
125
134
|
};
|
|
126
135
|
}
|
|
127
136
|
|
|
@@ -25,6 +25,12 @@ export interface NotebookInstanceStatusResponse {
|
|
|
25
25
|
* @memberof NotebookInstanceStatusResponse
|
|
26
26
|
*/
|
|
27
27
|
status: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof NotebookInstanceStatusResponse
|
|
32
|
+
*/
|
|
33
|
+
statusMessage: string;
|
|
28
34
|
}
|
|
29
35
|
|
|
30
36
|
/**
|
|
@@ -33,6 +39,7 @@ export interface NotebookInstanceStatusResponse {
|
|
|
33
39
|
export function instanceOfNotebookInstanceStatusResponse(value: object): boolean {
|
|
34
40
|
let isInstance = true;
|
|
35
41
|
isInstance = isInstance && "status" in value;
|
|
42
|
+
isInstance = isInstance && "statusMessage" in value;
|
|
36
43
|
|
|
37
44
|
return isInstance;
|
|
38
45
|
}
|
|
@@ -48,6 +55,7 @@ export function NotebookInstanceStatusResponseFromJSONTyped(json: any, ignoreDis
|
|
|
48
55
|
return {
|
|
49
56
|
|
|
50
57
|
'status': json['status'],
|
|
58
|
+
'statusMessage': json['statusMessage'],
|
|
51
59
|
};
|
|
52
60
|
}
|
|
53
61
|
|
|
@@ -61,6 +69,7 @@ export function NotebookInstanceStatusResponseToJSON(value?: NotebookInstanceSta
|
|
|
61
69
|
return {
|
|
62
70
|
|
|
63
71
|
'status': value.status,
|
|
72
|
+
'statusMessage': value.statusMessage,
|
|
64
73
|
};
|
|
65
74
|
}
|
|
66
75
|
|