@cirrobio/api-client 0.0.1

package/dist/apis/DatasetsApi.js

@@ -0,0 +1,335 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatasetsApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var DatasetsApi = /** @class */ (function (_super) {
+    __extends(DatasetsApi, _super);
+    function DatasetsApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    DatasetsApi.prototype.deleteDatasetRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, 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 deleteDataset.');
+                        }
+                        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                            throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling deleteDataset.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        return [4 /*yield*/, this.request({
+                                path: "/projects/{projectId}/datasets/{datasetId}".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
+                                method: 'DELETE',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        if (this.isJsonMime(response.headers.get('content-type'))) {
+                            return [2 /*return*/, new runtime.JSONApiResponse(response)];
+                        }
+                        else {
+                            return [2 /*return*/, new runtime.TextApiResponse(response)];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    DatasetsApi.prototype.deleteDataset = 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.deleteDatasetRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    DatasetsApi.prototype.getDatasetRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, 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 getDataset.');
+                        }
+                        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getDataset.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        return [4 /*yield*/, this.request({
+                                path: "/projects/{projectId}/datasets/{datasetId}".replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))).replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DatasetDetailFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    DatasetsApi.prototype.getDataset = 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.getDatasetRaw(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
+     */
+    DatasetsApi.prototype.getDatasetsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, 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 getDatasets.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        return [4 /*yield*/, this.request({
+                                path: "/projects/{projectId}/datasets".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.DatasetFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves a list of datasets for a given project
+     * List datasets
+     */
+    DatasetsApi.prototype.getDatasets = 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.getDatasetsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Registers a dataset in the system
+     * Register dataset
+     */
+    DatasetsApi.prototype.registerDatasetRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, 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.');
+                        }
+                        if (requestParameters.registerDatasetRequest === null || requestParameters.registerDatasetRequest === undefined) {
+                            throw new runtime.RequiredError('registerDatasetRequest', 'Required parameter requestParameters.registerDatasetRequest was null or undefined when calling registerDataset.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        return [4 /*yield*/, this.request({
+                                path: "/projects/{projectId}/datasets".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, index_1.RegisterDatasetRequestToJSON)(requestParameters.registerDatasetRequest),
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Registers a dataset in the system
+     * Register dataset
+     */
+    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.registerDatasetRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    DatasetsApi.prototype.updateDatasetRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, 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 updateDataset.');
+                        }
+                        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                            throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling updateDataset.');
+                        }
+                        if (requestParameters.updateDatasetRequest === null || requestParameters.updateDatasetRequest === undefined) {
+                            throw new runtime.RequiredError('updateDatasetRequest', 'Required parameter requestParameters.updateDatasetRequest was null or undefined when calling updateDataset.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        return [4 /*yield*/, this.request({
+                                path: "/projects/{projectId}/datasets/{datasetId}".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, index_1.UpdateDatasetRequestToJSON)(requestParameters.updateDatasetRequest),
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DatasetDetailFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    DatasetsApi.prototype.updateDataset = 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.updateDatasetRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return DatasetsApi;
+}(runtime.BaseAPI));
+exports.DatasetsApi = DatasetsApi;

package/dist/apis/ExecutionApi.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 { GetExecutionLogsResponse, StopExecutionResponse, Task } from '../models/index';
+export interface GetExecutionLogsRequest {
+    datasetId: string;
+    projectId: string;
+    forceLive: boolean;
+}
+export interface GetProjectSummaryRequest {
+    projectId: string;
+    numberOfDays: number;
+}
+export interface GetTaskLogsRequest {
+    datasetId: string;
+    projectId: string;
+    taskId: string;
+    forceLive: boolean;
+}
+export interface GetTasksForExecutionRequest {
+    datasetId: string;
+    projectId: string;
+    forceLive: boolean;
+}
+export interface StopAnalysisRequest {
+    datasetId: string;
+    projectId: string;
+}
+/**
+ *
+ */
+export declare class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Gets live logs from main execution task
+     * Get execution logs
+     */
+    getExecutionLogsRaw(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>>;
+    /**
+     * Gets live logs from main execution task
+     * Get execution logs
+     */
+    getExecutionLogs(requestParameters: GetExecutionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse>;
+    /**
+     * Gets an overview of the executions currently running in the project
+     * Get execution summary
+     */
+    getProjectSummaryRaw(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: Array<Task>;
+    }>>;
+    /**
+     * Gets an overview of the executions currently running in the project
+     * Get execution summary
+     */
+    getProjectSummary(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: Array<Task>;
+    }>;
+    /**
+     * Gets the log output from an individual task
+     * Get task logs
+     */
+    getTaskLogsRaw(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExecutionLogsResponse>>;
+    /**
+     * Gets the log output from an individual task
+     * Get task logs
+     */
+    getTaskLogs(requestParameters: GetTaskLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExecutionLogsResponse>;
+    /**
+     * Gets the tasks submitted by the workflow execution
+     * Get execution tasks
+     */
+    getTasksForExecutionRaw(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Task>>>;
+    /**
+     * Gets the tasks submitted by the workflow execution
+     * Get execution tasks
+     */
+    getTasksForExecution(requestParameters: GetTasksForExecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Task>>;
+    /**
+     * Terminates all analysis jobs related to this execution
+     * Stop execution
+     */
+    stopAnalysisRaw(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopExecutionResponse>>;
+    /**
+     * Terminates all analysis jobs related to this execution
+     * Stop execution
+     */
+    stopAnalysis(requestParameters: StopAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopExecutionResponse>;
+}