@cirrobio/api-client 0.12.23 → 0.12.24

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.12.22 --save
+npm install @cirrobio/api-client@0.12.24 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/SheetsApi.d.ts

@@ -0,0 +1,102 @@
+/**
+ * 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, CreateSheetRequest, Sheet, SheetDetail, SheetJob, TriggerIngestRequest } from '../models/index';
+export interface CreateSheetOperationRequest {
+    projectId: string;
+    createSheetRequest: CreateSheetRequest;
+}
+export interface DeleteSheetRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetJobsRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetSheetRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetSheetsRequest {
+    projectId: string;
+}
+export interface TriggerIngestOperationRequest {
+    projectId: string;
+    sheetId: string;
+    triggerIngestRequest: TriggerIngestRequest;
+}
+/**
+ *
+ */
+export declare class SheetsApi extends runtime.BaseAPI {
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheetRaw(requestParameters: CreateSheetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheet(requestParameters: CreateSheetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheetRaw(requestParameters: DeleteSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheet(requestParameters: DeleteSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobsRaw(requestParameters: GetJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SheetJob>>>;
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobs(requestParameters: GetJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SheetJob>>;
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheetRaw(requestParameters: GetSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SheetDetail>>;
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheet(requestParameters: GetSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SheetDetail>;
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheetsRaw(requestParameters: GetSheetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sheet>>>;
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheets(requestParameters: GetSheetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sheet>>;
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngestRaw(requestParameters: TriggerIngestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngest(requestParameters: TriggerIngestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+}

package/dist/apis/SheetsApi.js

@@ -0,0 +1,276 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SheetsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class SheetsApi extends runtime.BaseAPI {
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheetRaw(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 createSheet.');
+            }
+            if (requestParameters.createSheetRequest === null || requestParameters.createSheetRequest === undefined) {
+                throw new runtime.RequiredError('createSheetRequest', 'Required parameter requestParameters.createSheetRequest was null or undefined when calling createSheet.');
+            }
+            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}/sheets`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateSheetRequestToJSON)(requestParameters.createSheetRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheet(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createSheetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheetRaw(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 deleteSheet.');
+            }
+            if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
+                throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling deleteSheet.');
+            }
+            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}/sheets/{sheetId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheet(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteSheetRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobsRaw(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 getJobs.');
+            }
+            if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
+                throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling getJobs.');
+            }
+            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}/sheets/{sheetId}/jobs`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SheetJobFromJSON));
+        });
+    }
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobs(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getJobsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheetRaw(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 getSheet.');
+            }
+            if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
+                throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling getSheet.');
+            }
+            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}/sheets/{sheetId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SheetDetailFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheet(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSheetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheetsRaw(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 getSheets.');
+            }
+            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}/sheets`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SheetFromJSON));
+        });
+    }
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheets(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSheetsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngestRaw(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 triggerIngest.');
+            }
+            if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
+                throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling triggerIngest.');
+            }
+            if (requestParameters.triggerIngestRequest === null || requestParameters.triggerIngestRequest === undefined) {
+                throw new runtime.RequiredError('triggerIngestRequest', 'Required parameter requestParameters.triggerIngestRequest was null or undefined when calling triggerIngest.');
+            }
+            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}/sheets/{sheetId}/ingest`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.TriggerIngestRequestToJSON)(requestParameters.triggerIngestRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngest(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.triggerIngestRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.SheetsApi = SheetsApi;

package/dist/apis/index.d.ts

@@ -16,6 +16,7 @@ export * from './ProjectRequestsApi';
 export * from './ProjectsApi';
 export * from './ReferencesApi';
 export * from './SharingApi';
+export * from './SheetsApi';
 export * from './SystemApi';
 export * from './ToolsApi';
 export * from './UsersApi';

package/dist/apis/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./ProjectRequestsApi"), exports);
 __exportStar(require("./ProjectsApi"), exports);
 __exportStar(require("./ReferencesApi"), exports);
 __exportStar(require("./SharingApi"), exports);
+__exportStar(require("./SheetsApi"), exports);
 __exportStar(require("./SystemApi"), exports);
 __exportStar(require("./ToolsApi"), exports);
 __exportStar(require("./UsersApi"), exports);

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

@@ -0,0 +1,102 @@
+/**
+ * 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, CreateSheetRequest, Sheet, SheetDetail, SheetJob, TriggerIngestRequest } from '../models/index';
+export interface CreateSheetOperationRequest {
+    projectId: string;
+    createSheetRequest: CreateSheetRequest;
+}
+export interface DeleteSheetRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetJobsRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetSheetRequest {
+    projectId: string;
+    sheetId: string;
+}
+export interface GetSheetsRequest {
+    projectId: string;
+}
+export interface TriggerIngestOperationRequest {
+    projectId: string;
+    sheetId: string;
+    triggerIngestRequest: TriggerIngestRequest;
+}
+/**
+ *
+ */
+export declare class SheetsApi extends runtime.BaseAPI {
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheetRaw(requestParameters: CreateSheetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a sheet
+     * Create sheet
+     */
+    createSheet(requestParameters: CreateSheetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheetRaw(requestParameters: DeleteSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a sheet
+     * Delete sheet
+     */
+    deleteSheet(requestParameters: DeleteSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobsRaw(requestParameters: GetJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SheetJob>>>;
+    /**
+     * Retrieves ingest jobs for a sheet
+     * List jobs
+     */
+    getJobs(requestParameters: GetJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SheetJob>>;
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheetRaw(requestParameters: GetSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SheetDetail>>;
+    /**
+     * Retrieves a sheet
+     * Get sheet
+     */
+    getSheet(requestParameters: GetSheetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SheetDetail>;
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheetsRaw(requestParameters: GetSheetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sheet>>>;
+    /**
+     * Retrieves sheets for a project
+     * List sheets
+     */
+    getSheets(requestParameters: GetSheetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sheet>>;
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngestRaw(requestParameters: TriggerIngestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Triggers an async file ingest into the sheet
+     * Trigger ingest
+     */
+    triggerIngest(requestParameters: TriggerIngestOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+}