@cirrobio/api-client 0.9.0 → 0.9.2

package/dist/esm/apis/ExecutionApi.js

@@ -0,0 +1,283 @@
+/* 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 __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());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateResponseFromJSON, GetExecutionLogsResponseFromJSON, RunAnalysisRequestToJSON, StopExecutionResponseFromJSON, TaskFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Gets live logs from main execution task
+     * Get execution logs
+     */
+    getExecutionLogsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getExecutionLogs.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getExecutionLogs.');
+            }
+            const queryParameters = {};
+            if (requestParameters.forceLive !== undefined) {
+                queryParameters['forceLive'] = requestParameters.forceLive;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/logs`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Gets live logs from main execution task
+     * Get execution logs
+     */
+    getExecutionLogs(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getExecutionLogsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Gets an overview of the executions currently running in the project
+     * Get execution summary
+     */
+    getProjectSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getProjectSummary.');
+            }
+            const queryParameters = {};
+            if (requestParameters.numberOfDays !== undefined) {
+                queryParameters['numberOfDays'] = requestParameters.numberOfDays;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Gets an overview of the executions currently running in the project
+     * Get execution summary
+     */
+    getProjectSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProjectSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Gets the log output from an individual task
+     * Get task logs
+     */
+    getTaskLogsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getTaskLogs.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getTaskLogs.');
+            }
+            if (requestParameters.taskId === null || requestParameters.taskId === undefined) {
+                throw new runtime.RequiredError('taskId', 'Required parameter requestParameters.taskId was null or undefined when calling getTaskLogs.');
+            }
+            const queryParameters = {};
+            if (requestParameters.forceLive !== undefined) {
+                queryParameters['forceLive'] = requestParameters.forceLive;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters.taskId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetExecutionLogsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Gets the log output from an individual task
+     * Get task logs
+     */
+    getTaskLogs(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaskLogsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Gets the tasks submitted by the workflow execution
+     * Get execution tasks
+     */
+    getTasksForExecutionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getTasksForExecution.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getTasksForExecution.');
+            }
+            const queryParameters = {};
+            if (requestParameters.forceLive !== undefined) {
+                queryParameters['forceLive'] = requestParameters.forceLive;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/tasks`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TaskFromJSON));
+        });
+    }
+    /**
+     * Gets the tasks submitted by the workflow execution
+     * Get execution tasks
+     */
+    getTasksForExecution(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTasksForExecutionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Run analysis
+     * Run analysis
+     */
+    runAnalysisRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling runAnalysis.');
+            }
+            if (requestParameters.runAnalysisRequest === null || requestParameters.runAnalysisRequest === undefined) {
+                throw new runtime.RequiredError('runAnalysisRequest', 'Required parameter requestParameters.runAnalysisRequest was null or undefined when calling runAnalysis.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: RunAnalysisRequestToJSON(requestParameters.runAnalysisRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Run analysis
+     * Run analysis
+     */
+    runAnalysis(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.runAnalysisRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Terminates all analysis jobs related to this execution
+     * Stop execution
+     */
+    stopAnalysisRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling stopAnalysis.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling stopAnalysis.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/stop`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StopExecutionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Terminates all analysis jobs related to this execution
+     * Stop execution
+     */
+    stopAnalysis(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.stopAnalysisRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/FileApi.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { AWSCredentials, GenerateSftpCredentialsRequest, GovernanceFileAccessRequest, ProjectFileAccessRequest, SftpCredentials } from '../models/index';
+export interface GenerateGovernanceFileAccessTokenRequest {
+    requirementId: string;
+    governanceFileAccessRequest: GovernanceFileAccessRequest;
+}
+export interface GenerateProjectFileAccessTokenRequest {
+    projectId: string;
+    projectFileAccessRequest: ProjectFileAccessRequest;
+}
+export interface GenerateProjectSftpTokenRequest {
+    projectId: string;
+    generateSftpCredentialsRequest: GenerateSftpCredentialsRequest;
+}
+/**
+ *
+ */
+export declare class FileApi extends runtime.BaseAPI {
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessTokenRaw(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>>;
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessToken(requestParameters: GenerateGovernanceFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials>;
+    /**
+     * Generates credentials used for connecting via S3
+     * Create project file access token
+     */
+    generateProjectFileAccessTokenRaw(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AWSCredentials>>;
+    /**
+     * Generates credentials used for connecting via S3
+     * Create project file access token
+     */
+    generateProjectFileAccessToken(requestParameters: GenerateProjectFileAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AWSCredentials>;
+    /**
+     * Generates credentials used for connecting via SFTP
+     * Create project SFTP Token
+     */
+    generateProjectSftpTokenRaw(requestParameters: GenerateProjectSftpTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SftpCredentials>>;
+    /**
+     * Generates credentials used for connecting via SFTP
+     * Create project SFTP Token
+     */
+    generateProjectSftpToken(requestParameters: GenerateProjectSftpTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SftpCredentials>;
+}

package/dist/esm/apis/FileApi.js

@@ -0,0 +1,155 @@
+/* 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 __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());
+    });
+};
+import * as runtime from '../runtime';
+import { AWSCredentialsFromJSON, GenerateSftpCredentialsRequestToJSON, GovernanceFileAccessRequestToJSON, ProjectFileAccessRequestToJSON, SftpCredentialsFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class FileApi extends runtime.BaseAPI {
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.requirementId === null || requestParameters.requirementId === undefined) {
+                throw new runtime.RequiredError('requirementId', 'Required parameter requestParameters.requirementId was null or undefined when calling generateGovernanceFileAccessToken.');
+            }
+            if (requestParameters.governanceFileAccessRequest === null || requestParameters.governanceFileAccessRequest === undefined) {
+                throw new runtime.RequiredError('governanceFileAccessRequest', 'Required parameter requestParameters.governanceFileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/governance/requirements/{requirementId}/s3-token`.replace(`{${"requirementId"}}`, encodeURIComponent(String(requestParameters.requirementId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: GovernanceFileAccessRequestToJSON(requestParameters.governanceFileAccessRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates credentials used for connecting via S3
+     * Create governance file access token
+     */
+    generateGovernanceFileAccessToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateGovernanceFileAccessTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Generates credentials used for connecting via S3
+     * Create project file access token
+     */
+    generateProjectFileAccessTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling generateProjectFileAccessToken.');
+            }
+            if (requestParameters.projectFileAccessRequest === null || requestParameters.projectFileAccessRequest === undefined) {
+                throw new runtime.RequiredError('projectFileAccessRequest', 'Required parameter requestParameters.projectFileAccessRequest was null or undefined when calling generateProjectFileAccessToken.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/s3-token`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ProjectFileAccessRequestToJSON(requestParameters.projectFileAccessRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates credentials used for connecting via S3
+     * Create project file access token
+     */
+    generateProjectFileAccessToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateProjectFileAccessTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Generates credentials used for connecting via SFTP
+     * Create project SFTP Token
+     */
+    generateProjectSftpTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling generateProjectSftpToken.');
+            }
+            if (requestParameters.generateSftpCredentialsRequest === null || requestParameters.generateSftpCredentialsRequest === undefined) {
+                throw new runtime.RequiredError('generateSftpCredentialsRequest', 'Required parameter requestParameters.generateSftpCredentialsRequest was null or undefined when calling generateProjectSftpToken.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/sftp-token`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: GenerateSftpCredentialsRequestToJSON(requestParameters.generateSftpCredentialsRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SftpCredentialsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates credentials used for connecting via SFTP
+     * Create project SFTP Token
+     */
+    generateProjectSftpToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateProjectSftpTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}