@cirrobio/api-client 0.0.15-alpha → 0.0.18-alpha

package/.openapi-generator/FILES

@@ -29,10 +29,14 @@ src/models/CustomerType.ts
 src/models/Dashboard.ts
 src/models/DashboardRequest.ts
 src/models/Dataset.ts
+src/models/DatasetAssetsManifest.ts
 src/models/DatasetDetail.ts
+src/models/DatasetFile.ts
+src/models/DatasetViz.ts
 src/models/Executor.ts
 src/models/FormSchema.ts
 src/models/GetExecutionLogsResponse.ts
+src/models/ImportDataRequest.ts
 src/models/LogEntry.ts
 src/models/MetricRecord.ts
 src/models/NotebookInstance.ts
@@ -51,8 +55,6 @@ src/models/ProjectSettings.ts
 src/models/ProjectUser.ts
 src/models/Reference.ts
 src/models/ReferenceType.ts
-src/models/RegisterDatasetRequest.ts
-src/models/RegisterPublicDataRequest.ts
 src/models/Sample.ts
 src/models/SampleRequest.ts
 src/models/ServiceConnection.ts
@@ -64,6 +66,8 @@ src/models/Tag.ts
 src/models/Task.ts
 src/models/UpdateDatasetRequest.ts
 src/models/UpdateUserRequest.ts
+src/models/UploadDatasetCreateResponse.ts
+src/models/UploadDatasetRequest.ts
 src/models/User.ts
 src/models/index.ts
 src/runtime.ts

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.0.15-alpha --save
+npm install @cirrobio/api-client@0.0.18-alpha --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/DatasetsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, DatasetDetail, PaginatedResponseDatasetListDto, RegisterDatasetRequest, RegisterPublicDataRequest, UpdateDatasetRequest } from '../models/index';
+import type { CreateResponse, DatasetAssetsManifest, DatasetDetail, ImportDataRequest, PaginatedResponseDatasetListDto, UpdateDatasetRequest, UploadDatasetCreateResponse, UploadDatasetRequest } from '../models/index';
 export interface DeleteDatasetRequest {
     projectId: string;
     datasetId: string;
@@ -19,16 +19,22 @@ export interface GetDatasetRequest {
     datasetId: string;
     projectId: string;
 }
+export interface GetDatasetManifestRequest {
+    datasetId: string;
+    projectId: string;
+}
 export interface GetDatasetsRequest {
     projectId: string;
+    limit?: number;
+    nextToken?: string;
 }
-export interface RegisterDatasetOperationRequest {
+export interface ImportPublicDatasetRequest {
     projectId: string;
-    registerDatasetRequest: RegisterDatasetRequest;
+    importDataRequest: ImportDataRequest;
 }
-export interface RegisterPublicDatasetRequest {
+export interface RegisterDatasetRequest {
     projectId: string;
-    registerPublicDataRequest: RegisterPublicDataRequest;
+    uploadDatasetRequest: UploadDatasetRequest;
 }
 export interface UpdateDatasetOperationRequest {
     projectId: string;
@@ -59,6 +65,16 @@ export declare class DatasetsApi extends runtime.BaseAPI {
      * Get dataset
      */
     getDataset(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetDetail>;
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    getDatasetManifestRaw(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetAssetsManifest>>;
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    getDatasetManifest(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetAssetsManifest>;
     /**
      * Retrieves a list of datasets for a given project
      * List datasets
@@ -70,25 +86,25 @@ export declare class DatasetsApi extends runtime.BaseAPI {
      */
     getDatasets(requestParameters: GetDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDatasetListDto>;
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    registerDatasetRaw(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    importPublicDatasetRaw(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    registerDataset(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    importPublicDataset(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    registerPublicDatasetRaw(requestParameters: RegisterPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    registerDatasetRaw(requestParameters: RegisterDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadDatasetCreateResponse>>;
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    registerPublicDataset(requestParameters: RegisterPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    registerDataset(requestParameters: RegisterDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDatasetCreateResponse>;
     /**
      * Update info on a dataset
      * Update dataset

package/dist/apis/DatasetsApi.js

@@ -197,6 +197,64 @@ var DatasetsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    DatasetsApi.prototype.getDatasetManifestRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                            throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getDatasetManifest.');
+                        }
+                        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getDatasetManifest.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/projects/{projectId}/datasets/{datasetId}/files".replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))).replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DatasetAssetsManifestFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    DatasetsApi.prototype.getDatasetManifest = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getDatasetManifestRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a list of datasets for a given project
      * List datasets
@@ -211,6 +269,12 @@ var DatasetsApi = /** @class */ (function (_super) {
                             throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getDatasets.');
                         }
                         queryParameters = {};
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.nextToken !== undefined) {
+                            queryParameters['nextToken'] = requestParameters.nextToken;
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -253,20 +317,20 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    DatasetsApi.prototype.registerDatasetRaw = function (requestParameters, initOverrides) {
+    DatasetsApi.prototype.importPublicDatasetRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParameters, headerParameters, token, tokenString, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling registerDataset.');
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling importPublicDataset.');
                         }
-                        if (requestParameters.registerDatasetRequest === null || requestParameters.registerDatasetRequest === undefined) {
-                            throw new runtime.RequiredError('registerDatasetRequest', 'Required parameter requestParameters.registerDatasetRequest was null or undefined when calling registerDataset.');
+                        if (requestParameters.importDataRequest === null || requestParameters.importDataRequest === undefined) {
+                            throw new runtime.RequiredError('importDataRequest', 'Required parameter requestParameters.importDataRequest was null or undefined when calling importPublicDataset.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -281,11 +345,11 @@ var DatasetsApi = /** @class */ (function (_super) {
                         }
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
-                            path: "/projects/{projectId}/datasets/upload".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            path: "/projects/{projectId}/datasets/import".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
-                            body: (0, index_1.RegisterDatasetRequestToJSON)(requestParameters.registerDatasetRequest),
+                            body: (0, index_1.ImportDataRequestToJSON)(requestParameters.importDataRequest),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
@@ -295,15 +359,15 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    DatasetsApi.prototype.registerDataset = function (requestParameters, initOverrides) {
+    DatasetsApi.prototype.importPublicDataset = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.registerDatasetRaw(requestParameters, initOverrides)];
+                    case 0: return [4 /*yield*/, this.importPublicDatasetRaw(requestParameters, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];
@@ -313,20 +377,20 @@ var DatasetsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    DatasetsApi.prototype.registerPublicDatasetRaw = function (requestParameters, initOverrides) {
+    DatasetsApi.prototype.registerDatasetRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParameters, headerParameters, token, tokenString, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling registerPublicDataset.');
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling registerDataset.');
                         }
-                        if (requestParameters.registerPublicDataRequest === null || requestParameters.registerPublicDataRequest === undefined) {
-                            throw new runtime.RequiredError('registerPublicDataRequest', 'Required parameter requestParameters.registerPublicDataRequest was null or undefined when calling registerPublicDataset.');
+                        if (requestParameters.uploadDatasetRequest === null || requestParameters.uploadDatasetRequest === undefined) {
+                            throw new runtime.RequiredError('uploadDatasetRequest', 'Required parameter requestParameters.uploadDatasetRequest was null or undefined when calling registerDataset.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -341,29 +405,29 @@ var DatasetsApi = /** @class */ (function (_super) {
                         }
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
-                            path: "/projects/{projectId}/datasets/public".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            path: "/projects/{projectId}/datasets/upload".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
-                            body: (0, index_1.RegisterPublicDataRequestToJSON)(requestParameters.registerPublicDataRequest),
+                            body: (0, index_1.UploadDatasetRequestToJSON)(requestParameters.uploadDatasetRequest),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UploadDatasetCreateResponseFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    DatasetsApi.prototype.registerPublicDataset = function (requestParameters, initOverrides) {
+    DatasetsApi.prototype.registerDataset = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.registerPublicDatasetRaw(requestParameters, initOverrides)];
+                    case 0: return [4 /*yield*/, this.registerDatasetRaw(requestParameters, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];

package/dist/apis/MetadataApi.d.ts

@@ -19,6 +19,10 @@ export interface GetProjectSamplesRequest {
 export interface GetProjectSchemaRequest {
     projectId: string;
 }
+export interface UpdateProjectSchemaRequest {
+    projectId: string;
+    formSchema: FormSchema;
+}
 export interface UpdateSampleRequest {
     projectId: string;
     sampleId: string;
@@ -29,10 +33,12 @@ export interface UpdateSampleRequest {
  */
 export declare class MetadataApi extends runtime.BaseAPI {
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     getProjectSamplesRaw(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseSampleDto>>;
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     getProjectSamples(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseSampleDto>;
@@ -45,10 +51,20 @@ export declare class MetadataApi extends runtime.BaseAPI {
      */
     getProjectSchema(requestParameters: GetProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
     /**
+     * Update project metadata schema
+     */
+    updateProjectSchemaRaw(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update project metadata schema
+     */
+    updateProjectSchema(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Updates metadata on a sample
      * Update sample
      */
     updateSampleRaw(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Sample>>;
     /**
+     * Updates metadata on a sample
      * Update sample
      */
     updateSample(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Sample>;

package/dist/apis/MetadataApi.js

@@ -76,6 +76,7 @@ var MetadataApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     MetadataApi.prototype.getProjectSamplesRaw = function (requestParameters, initOverrides) {
@@ -118,6 +119,7 @@ var MetadataApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     MetadataApi.prototype.getProjectSamples = function (requestParameters, initOverrides) {
@@ -188,6 +190,63 @@ var MetadataApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Update project metadata schema
+     */
+    MetadataApi.prototype.updateProjectSchemaRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling updateProjectSchema.');
+                        }
+                        if (requestParameters.formSchema === null || requestParameters.formSchema === undefined) {
+                            throw new runtime.RequiredError('formSchema', 'Required parameter requestParameters.formSchema was null or undefined when calling updateProjectSchema.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/projects/{projectId}/schema".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.FormSchemaToJSON)(requestParameters.formSchema),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Update project metadata schema
+     */
+    MetadataApi.prototype.updateProjectSchema = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateProjectSchemaRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Updates metadata on a sample
      * Update sample
      */
     MetadataApi.prototype.updateSampleRaw = function (requestParameters, initOverrides) {
@@ -232,6 +291,7 @@ var MetadataApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Updates metadata on a sample
      * Update sample
      */
     MetadataApi.prototype.updateSample = function (requestParameters, initOverrides) {

package/dist/apis/NotebooksApi.d.ts

@@ -39,39 +39,63 @@ export interface StopNotebookInstanceRequest {
  */
 export declare class NotebooksApi extends runtime.BaseAPI {
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     createNotebookInstanceRaw(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     createNotebookInstance(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     deleteNotebookInstanceRaw(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     deleteNotebookInstance(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     generateNotebookInstanceUrlRaw(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenNotebookInstanceResponse>>;
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     generateNotebookInstanceUrl(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenNotebookInstanceResponse>;
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     getNotebookInstanceStatusRaw(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotebookInstanceStatusResponse>>;
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     getNotebookInstanceStatus(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotebookInstanceStatusResponse>;
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     getNotebookInstancesRaw(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotebookInstance>>>;
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     getNotebookInstances(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotebookInstance>>;
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     stopNotebookInstanceRaw(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     stopNotebookInstance(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/NotebooksApi.js

@@ -76,6 +76,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     NotebooksApi.prototype.createNotebookInstanceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -116,6 +118,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     NotebooksApi.prototype.createNotebookInstance = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -132,6 +136,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     NotebooksApi.prototype.deleteNotebookInstanceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -170,6 +176,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     NotebooksApi.prototype.deleteNotebookInstance = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -184,6 +192,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     NotebooksApi.prototype.generateNotebookInstanceUrlRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -222,6 +232,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     NotebooksApi.prototype.generateNotebookInstanceUrl = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -238,6 +250,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     NotebooksApi.prototype.getNotebookInstanceStatusRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -276,6 +290,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     NotebooksApi.prototype.getNotebookInstanceStatus = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -292,6 +308,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     NotebooksApi.prototype.getNotebookInstancesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -327,6 +345,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     NotebooksApi.prototype.getNotebookInstances = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -343,6 +363,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     NotebooksApi.prototype.stopNotebookInstanceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -381,6 +403,8 @@ var NotebooksApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     NotebooksApi.prototype.stopNotebookInstance = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {