@cirrobio/api-client 0.9.0 → 0.9.2

package/dist/esm/apis/ProcessesApi.js

@@ -0,0 +1,377 @@
+/* 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, CustomPipelineSettingsFromJSON, CustomProcessInputToJSON, FileRequirementsFromJSON, FormSchemaFromJSON, PipelineCostFromJSON, ProcessFromJSON, ProcessDetailFromJSON, ValidateFileRequirementsRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ProcessesApi extends runtime.BaseAPI {
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling archiveCustomProcess.');
+            }
+            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: `/processes/{processId}`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.archiveCustomProcessRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCostRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling calculatePipelineCost.');
+            }
+            if (requestParameters.body === null || requestParameters.body === undefined) {
+                throw new runtime.RequiredError('body', 'Required parameter requestParameters.body was null or undefined when calling calculatePipelineCost.');
+            }
+            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: `/processes/{processId}/cost`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters.body,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PipelineCostFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCost(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.calculatePipelineCostRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.customProcessInput === null || requestParameters.customProcessInput === undefined) {
+                throw new runtime.RequiredError('customProcessInput', 'Required parameter requestParameters.customProcessInput was null or undefined when calling createCustomProcess.');
+            }
+            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: `/processes`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CustomProcessInputToJSON(requestParameters.customProcessInput),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createCustomProcessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling getProcess.');
+            }
+            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: `/processes/{processId}`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ProcessDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProcessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParametersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling getProcessParameters.');
+            }
+            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: `/processes/{processId}/parameters`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => FormSchemaFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParameters(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProcessParametersRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcessesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters.includeArchived !== undefined) {
+                queryParameters['includeArchived'] = requestParameters.includeArchived;
+            }
+            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: `/processes`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProcessFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcesses(requestParameters = {}, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProcessesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling syncCustomProcess.');
+            }
+            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: `/processes/{processId}:sync`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CustomPipelineSettingsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.syncCustomProcessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling updateCustomProcess.');
+            }
+            if (requestParameters.customProcessInput === null || requestParameters.customProcessInput === undefined) {
+                throw new runtime.RequiredError('customProcessInput', 'Required parameter requestParameters.customProcessInput was null or undefined when calling updateCustomProcess.');
+            }
+            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: `/processes/{processId}`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CustomProcessInputToJSON(requestParameters.customProcessInput),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateCustomProcessRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirementsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling validateFileRequirements.');
+            }
+            if (requestParameters.validateFileRequirementsRequest === null || requestParameters.validateFileRequirementsRequest === undefined) {
+                throw new runtime.RequiredError('validateFileRequirementsRequest', 'Required parameter requestParameters.validateFileRequirementsRequest was null or undefined when calling validateFileRequirements.');
+            }
+            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: `/processes/{processId}/validate-files`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ValidateFileRequirementsRequestToJSON(requestParameters.validateFileRequirementsRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => FileRequirementsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirements(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.validateFileRequirementsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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, ProjectRequest } from '../models/index';
+export interface CreateProjectRequestRequest {
+    projectRequest: ProjectRequest;
+}
+/**
+ *
+ */
+export declare class ProjectRequestsApi extends runtime.BaseAPI {
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    createProjectRequestRaw(requestParameters: CreateProjectRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    createProjectRequest(requestParameters: CreateProjectRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+}

package/dist/esm/apis/ProjectRequestsApi.js

@@ -0,0 +1,68 @@
+/* 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, ProjectRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ProjectRequestsApi extends runtime.BaseAPI {
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    createProjectRequestRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectRequest === null || requestParameters.projectRequest === undefined) {
+                throw new runtime.RequiredError('projectRequest', 'Required parameter requestParameters.projectRequest was null or undefined when calling createProjectRequest.');
+            }
+            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: `/project-requests`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ProjectRequestToJSON(requestParameters.projectRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    createProjectRequest(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createProjectRequestRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}