@cirrobio/api-client 0.1.29 → 0.2.0

package/.openapi-generator/FILES

@@ -17,7 +17,9 @@ src/apis/ProcessesApi.ts
 src/apis/ProjectRequestsApi.ts
 src/apis/ProjectsApi.ts
 src/apis/ReferencesApi.ts
+src/apis/SharingApi.ts
 src/apis/SystemApi.ts
+src/apis/ToolsApi.ts
 src/apis/UsersApi.ts
 src/apis/index.ts
 src/index.ts
@@ -41,6 +43,7 @@ src/models/CloudAccount.ts
 src/models/CloudAccountType.ts
 src/models/ColumnDefinition.ts
 src/models/ComputeEnvironmentConfiguration.ts
+src/models/ComputeEnvironmentConfigurationInput.ts
 src/models/Contact.ts
 src/models/CreateNotebookInstanceRequest.ts
 src/models/CreateProjectAccessRequest.ts
@@ -52,6 +55,8 @@ src/models/Dashboard.ts
 src/models/DashboardRequest.ts
 src/models/Dataset.ts
 src/models/DatasetAssetsManifest.ts
+src/models/DatasetCondition.ts
+src/models/DatasetConditionField.ts
 src/models/DatasetDetail.ts
 src/models/DatasetViz.ts
 src/models/EnvironmentType.ts
@@ -73,6 +78,9 @@ src/models/InviteUserResponse.ts
 src/models/LogEntry.ts
 src/models/LoginProvider.ts
 src/models/MetricRecord.ts
+src/models/MoveDatasetInput.ts
+src/models/MoveDatasetResponse.ts
+src/models/NamedItem.ts
 src/models/NotebookInstance.ts
 src/models/NotebookInstanceStatusResponse.ts
 src/models/OpenNotebookInstanceResponse.ts
@@ -105,6 +113,10 @@ src/models/SampleRequest.ts
 src/models/ServiceConnection.ts
 src/models/SetUserProjectRoleRequest.ts
 src/models/SftpCredentials.ts
+src/models/Share.ts
+src/models/ShareDetail.ts
+src/models/ShareInput.ts
+src/models/ShareType.ts
 src/models/Status.ts
 src/models/StopExecutionResponse.ts
 src/models/SyncStatus.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.1.29 --save
+npm install @cirrobio/api-client@0.2.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ComputeEnvironmentApi.d.ts

@@ -10,13 +10,21 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AgentDetail, AgentInput, ComputeEnvironmentConfiguration, CreateResponse } from '../models/index';
+import type { AgentDetail, AgentInput, ComputeEnvironmentConfiguration, ComputeEnvironmentConfigurationInput, CreateResponse } from '../models/index';
 export interface CreateAgentRequest {
     agentInput: AgentInput;
 }
+export interface CreateComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentConfigurationInput: ComputeEnvironmentConfigurationInput;
+}
 export interface DeleteAgentRequest {
     agentId: string;
 }
+export interface DeleteComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentId: string;
+}
 export interface GetComputeEnvironmentsRequest {
     projectId: string;
 }
@@ -24,6 +32,11 @@ export interface UpdateAgentRequest {
     agentId: string;
     agentInput: AgentInput;
 }
+export interface UpdateComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentId: string;
+    computeEnvironmentConfigurationInput: ComputeEnvironmentConfigurationInput;
+}
 /**
  *
  */
@@ -38,6 +51,16 @@ export declare class ComputeEnvironmentApi extends runtime.BaseAPI {
      * Create agent
      */
     createAgent(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    createComputeEnvironmentRaw(requestParameters: CreateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    createComputeEnvironment(requestParameters: CreateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
     /**
      * Delete an agent
      * Delete agent
@@ -48,6 +71,16 @@ export declare class ComputeEnvironmentApi extends runtime.BaseAPI {
      * Delete agent
      */
     deleteAgent(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    deleteComputeEnvironmentRaw(requestParameters: DeleteComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    deleteComputeEnvironment(requestParameters: DeleteComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Get a list of agents
      * Get agents
@@ -78,4 +111,14 @@ export declare class ComputeEnvironmentApi extends runtime.BaseAPI {
      * Update agent
      */
     updateAgent(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    updateComputeEnvironmentRaw(requestParameters: UpdateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    updateComputeEnvironment(requestParameters: UpdateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/ComputeEnvironmentApi.js

@@ -132,6 +132,66 @@ var ComputeEnvironmentApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    ComputeEnvironmentApi.prototype.createComputeEnvironmentRaw = 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 createComputeEnvironment.');
+                        }
+                        if (requestParameters.computeEnvironmentConfigurationInput === null || requestParameters.computeEnvironmentConfigurationInput === undefined) {
+                            throw new runtime.RequiredError('computeEnvironmentConfigurationInput', 'Required parameter requestParameters.computeEnvironmentConfigurationInput was null or undefined when calling createComputeEnvironment.');
+                        }
+                        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}/compute-environments".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.ComputeEnvironmentConfigurationInputToJSON)(requestParameters.computeEnvironmentConfigurationInput),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    ComputeEnvironmentApi.prototype.createComputeEnvironment = 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.createComputeEnvironmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Delete an agent
      * Delete agent
@@ -185,6 +245,62 @@ var ComputeEnvironmentApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    ComputeEnvironmentApi.prototype.deleteComputeEnvironmentRaw = 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 deleteComputeEnvironment.');
+                        }
+                        if (requestParameters.computeEnvironmentId === null || requestParameters.computeEnvironmentId === undefined) {
+                            throw new runtime.RequiredError('computeEnvironmentId', 'Required parameter requestParameters.computeEnvironmentId was null or undefined when calling deleteComputeEnvironment.');
+                        }
+                        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}/compute-environments/{computeEnvironmentId}".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("computeEnvironmentId", "}"), encodeURIComponent(String(requestParameters.computeEnvironmentId))),
+                            method: 'DELETE',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    ComputeEnvironmentApi.prototype.deleteComputeEnvironment = 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.deleteComputeEnvironmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Get a list of agents
      * Get agents
@@ -350,6 +466,67 @@ var ComputeEnvironmentApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    ComputeEnvironmentApi.prototype.updateComputeEnvironmentRaw = 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 updateComputeEnvironment.');
+                        }
+                        if (requestParameters.computeEnvironmentId === null || requestParameters.computeEnvironmentId === undefined) {
+                            throw new runtime.RequiredError('computeEnvironmentId', 'Required parameter requestParameters.computeEnvironmentId was null or undefined when calling updateComputeEnvironment.');
+                        }
+                        if (requestParameters.computeEnvironmentConfigurationInput === null || requestParameters.computeEnvironmentConfigurationInput === undefined) {
+                            throw new runtime.RequiredError('computeEnvironmentConfigurationInput', 'Required parameter requestParameters.computeEnvironmentConfigurationInput was null or undefined when calling updateComputeEnvironment.');
+                        }
+                        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}/compute-environments/{computeEnvironmentId}".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("computeEnvironmentId", "}"), encodeURIComponent(String(requestParameters.computeEnvironmentId))),
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.ComputeEnvironmentConfigurationInputToJSON)(requestParameters.computeEnvironmentConfigurationInput),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    ComputeEnvironmentApi.prototype.updateComputeEnvironment = 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.updateComputeEnvironmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     return ComputeEnvironmentApi;
 }(runtime.BaseAPI));
 exports.ComputeEnvironmentApi = ComputeEnvironmentApi;

package/dist/apis/SharingApi.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateResponse, Dataset, Share, ShareDetail, ShareInput } from '../models/index';
+export interface CreateShareRequest {
+    projectId: string;
+    shareInput: ShareInput;
+}
+export interface DeleteShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface GetDiscoverableSharesRequest {
+    projectId: string;
+}
+export interface GetShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface GetSharedDatasetsRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface GetSharesRequest {
+    projectId: string;
+}
+export interface SubscribeShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface UpdateShareRequest {
+    projectId: string;
+    shareId: string;
+    shareInput: ShareInput;
+}
+/**
+ *
+ */
+export declare class SharingApi extends runtime.BaseAPI {
+    /**
+     * Create a new share to publish to other projects
+     * Create share
+     */
+    createShareRaw(requestParameters: CreateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Create a new share to publish to other projects
+     * Create share
+     */
+    createShare(requestParameters: CreateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Delete a share that you\'ve published
+     * Delete share
+     */
+    deleteShareRaw(requestParameters: DeleteShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a share that you\'ve published
+     * Delete share
+     */
+    deleteShare(requestParameters: DeleteShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get shares that the project can request access to
+     * Get discoverable shares
+     */
+    getDiscoverableSharesRaw(requestParameters: GetDiscoverableSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Share>>>;
+    /**
+     * Get shares that the project can request access to
+     * Get discoverable shares
+     */
+    getDiscoverableShares(requestParameters: GetDiscoverableSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Share>>;
+    /**
+     * Get details on a share that you\'ve published or subscribed to
+     * Get share
+     */
+    getShareRaw(requestParameters: GetShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShareDetail>>;
+    /**
+     * Get details on a share that you\'ve published or subscribed to
+     * Get share
+     */
+    getShare(requestParameters: GetShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareDetail>;
+    /**
+     * Get dataset listing for a share
+     * Get share datasets
+     */
+    getSharedDatasetsRaw(requestParameters: GetSharedDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Dataset>>>;
+    /**
+     * Get dataset listing for a share
+     * Get share datasets
+     */
+    getSharedDatasets(requestParameters: GetSharedDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Dataset>>;
+    /**
+     * Get shares for a project (both published and shared with the project)
+     * Get shares
+     */
+    getSharesRaw(requestParameters: GetSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Share>>>;
+    /**
+     * Get shares for a project (both published and shared with the project)
+     * Get shares
+     */
+    getShares(requestParameters: GetSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Share>>;
+    /**
+     * Subscribe to a share that has been shared with your project
+     * Subscribe to share
+     */
+    subscribeShareRaw(requestParameters: SubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Subscribe to a share that has been shared with your project
+     * Subscribe to share
+     */
+    subscribeShare(requestParameters: SubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update a share that you\'ve published
+     * Update share
+     */
+    updateShareRaw(requestParameters: UpdateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update a share that you\'ve published
+     * Update share
+     */
+    updateShare(requestParameters: UpdateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}