@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/esm/apis/NotebooksApi.js

@@ -0,0 +1,266 @@
+/* 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 { CreateNotebookInstanceRequestToJSON, CreateResponseFromJSON, NotebookInstanceFromJSON, NotebookInstanceStatusResponseFromJSON, OpenNotebookInstanceResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class NotebooksApi extends runtime.BaseAPI {
+    /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
+     */
+    createNotebookInstanceRaw(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 createNotebookInstance.');
+            }
+            if (requestParameters.createNotebookInstanceRequest === null || requestParameters.createNotebookInstanceRequest === undefined) {
+                throw new runtime.RequiredError('createNotebookInstanceRequest', 'Required parameter requestParameters.createNotebookInstanceRequest was null or undefined when calling createNotebookInstance.');
+            }
+            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}/notebook-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateNotebookInstanceRequestToJSON(requestParameters.createNotebookInstanceRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
+     */
+    createNotebookInstance(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createNotebookInstanceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
+     */
+    deleteNotebookInstanceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
+                throw new runtime.RequiredError('notebookInstanceId', 'Required parameter requestParameters.notebookInstanceId was null or undefined when calling deleteNotebookInstance.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling deleteNotebookInstance.');
+            }
+            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}/notebook-instances/{notebookInstanceId}`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
+     */
+    deleteNotebookInstance(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteNotebookInstanceRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
+     */
+    generateNotebookInstanceUrlRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
+                throw new runtime.RequiredError('notebookInstanceId', 'Required parameter requestParameters.notebookInstanceId was null or undefined when calling generateNotebookInstanceUrl.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling generateNotebookInstanceUrl.');
+            }
+            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}/notebook-instances/{notebookInstanceId}:generate-url`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => OpenNotebookInstanceResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
+     */
+    generateNotebookInstanceUrl(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateNotebookInstanceUrlRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
+     */
+    getNotebookInstanceStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
+                throw new runtime.RequiredError('notebookInstanceId', 'Required parameter requestParameters.notebookInstanceId was null or undefined when calling getNotebookInstanceStatus.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getNotebookInstanceStatus.');
+            }
+            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}/notebook-instances/{notebookInstanceId}:status`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => NotebookInstanceStatusResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
+     */
+    getNotebookInstanceStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getNotebookInstanceStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
+     */
+    getNotebookInstancesRaw(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 getNotebookInstances.');
+            }
+            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}/notebook-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(NotebookInstanceFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
+     */
+    getNotebookInstances(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getNotebookInstancesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
+     */
+    stopNotebookInstanceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
+                throw new runtime.RequiredError('notebookInstanceId', 'Required parameter requestParameters.notebookInstanceId was null or undefined when calling stopNotebookInstance.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling stopNotebookInstance.');
+            }
+            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}/notebook-instances/{notebookInstanceId}:stop`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
+     */
+    stopNotebookInstance(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.stopNotebookInstanceRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -0,0 +1,138 @@
+/**
+ * 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, CustomPipelineSettings, CustomProcessInput, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
+export interface ArchiveCustomProcessRequest {
+    processId: string;
+}
+export interface CalculatePipelineCostRequest {
+    processId: string;
+    body: object;
+}
+export interface CreateCustomProcessRequest {
+    customProcessInput: CustomProcessInput;
+}
+export interface GetProcessRequest {
+    processId: string;
+}
+export interface GetProcessParametersRequest {
+    processId: string;
+}
+export interface GetProcessesRequest {
+    includeArchived?: boolean;
+}
+export interface SyncCustomProcessRequest {
+    processId: string;
+}
+export interface UpdateCustomProcessRequest {
+    processId: string;
+    customProcessInput: CustomProcessInput;
+}
+export interface ValidateFileRequirementsOperationRequest {
+    processId: string;
+    validateFileRequirementsRequest: ValidateFileRequirementsRequest;
+}
+/**
+ *
+ */
+export declare class ProcessesApi extends runtime.BaseAPI {
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcessRaw(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the process from the list of available options
+     * Archive custom process
+     */
+    archiveCustomProcess(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCostRaw(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PipelineCost>>;
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    calculatePipelineCost(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PipelineCost>;
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcessRaw(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a custom data type or pipeline which you can use in the listed projects.
+     * Create custom process
+     */
+    createCustomProcess(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>>;
+    /**
+     * Retrieves detailed information on a process
+     * Get process
+     */
+    getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>>;
+    /**
+     * Retrieves the input parameters for a process
+     * Get process parameters
+     */
+    getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>>;
+    /**
+     * Retrieves a list of available processes
+     * List processes
+     */
+    getProcesses(requestParameters?: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>>;
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcessRaw(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomPipelineSettings>>;
+    /**
+     * Updates the process definition from the repository
+     * Sync custom process
+     */
+    syncCustomProcess(requestParameters: SyncCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomPipelineSettings>;
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcessRaw(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the custom process
+     * Update custom process
+     */
+    updateCustomProcess(requestParameters: UpdateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirementsRaw(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileRequirements>>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirements(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileRequirements>;
+}