@cirrobio/api-client 0.9.0 → 0.9.2

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

@@ -0,0 +1,88 @@
+/**
+ * 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, Dashboard, DashboardRequest } from '../models/index';
+export interface CreateDashboardRequest {
+    projectId: string;
+    dashboardRequest: DashboardRequest;
+}
+export interface DeleteDashboardRequest {
+    projectId: string;
+    dashboardId: string;
+}
+export interface GetDashboardRequest {
+    projectId: string;
+    dashboardId: string;
+}
+export interface GetDashboardsRequest {
+    projectId: string;
+}
+export interface UpdateDashboardRequest {
+    projectId: string;
+    dashboardId: string;
+    dashboardRequest: DashboardRequest;
+}
+/**
+ *
+ */
+export declare class DashboardsApi extends runtime.BaseAPI {
+    /**
+     * Creates a dashboard
+     * Create dashboard
+     */
+    createDashboardRaw(requestParameters: CreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a dashboard
+     * Create dashboard
+     */
+    createDashboard(requestParameters: CreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Deletes a dashboard
+     * Delete dashboard
+     */
+    deleteDashboardRaw(requestParameters: DeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>>;
+    /**
+     * Deletes a dashboard
+     * Delete dashboard
+     */
+    deleteDashboard(requestParameters: DeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard>;
+    /**
+     * Retrieves a dashboard
+     * Get dashboard
+     */
+    getDashboardRaw(requestParameters: GetDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>>;
+    /**
+     * Retrieves a dashboard
+     * Get dashboard
+     */
+    getDashboard(requestParameters: GetDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard>;
+    /**
+     * Retrieves a list of dashboards for a given project
+     * List dashboards
+     */
+    getDashboardsRaw(requestParameters: GetDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Dashboard>>>;
+    /**
+     * Retrieves a list of dashboards for a given project
+     * List dashboards
+     */
+    getDashboards(requestParameters: GetDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Dashboard>>;
+    /**
+     * Updates a dashboard
+     * Update dashboard
+     */
+    updateDashboardRaw(requestParameters: UpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>>;
+    /**
+     * Updates a dashboard
+     * Update dashboard
+     */
+    updateDashboard(requestParameters: UpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard>;
+}

package/dist/esm/apis/DashboardsApi.js

@@ -0,0 +1,233 @@
+/* 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, DashboardFromJSON, DashboardRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class DashboardsApi extends runtime.BaseAPI {
+    /**
+     * Creates a dashboard
+     * Create dashboard
+     */
+    createDashboardRaw(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 createDashboard.');
+            }
+            if (requestParameters.dashboardRequest === null || requestParameters.dashboardRequest === undefined) {
+                throw new runtime.RequiredError('dashboardRequest', 'Required parameter requestParameters.dashboardRequest was null or undefined when calling createDashboard.');
+            }
+            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}/dashboards`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardRequestToJSON(requestParameters.dashboardRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a dashboard
+     * Create dashboard
+     */
+    createDashboard(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDashboardRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a dashboard
+     * Delete dashboard
+     */
+    deleteDashboardRaw(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 deleteDashboard.');
+            }
+            if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
+                throw new runtime.RequiredError('dashboardId', 'Required parameter requestParameters.dashboardId was null or undefined when calling deleteDashboard.');
+            }
+            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}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Deletes a dashboard
+     * Delete dashboard
+     */
+    deleteDashboard(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteDashboardRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a dashboard
+     * Get dashboard
+     */
+    getDashboardRaw(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 getDashboard.');
+            }
+            if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
+                throw new runtime.RequiredError('dashboardId', 'Required parameter requestParameters.dashboardId was null or undefined when calling getDashboard.');
+            }
+            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}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a dashboard
+     * Get dashboard
+     */
+    getDashboard(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDashboardRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a list of dashboards for a given project
+     * List dashboards
+     */
+    getDashboardsRaw(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 getDashboards.');
+            }
+            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}/dashboards`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(DashboardFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of dashboards for a given project
+     * List dashboards
+     */
+    getDashboards(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDashboardsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates a dashboard
+     * Update dashboard
+     */
+    updateDashboardRaw(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 updateDashboard.');
+            }
+            if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
+                throw new runtime.RequiredError('dashboardId', 'Required parameter requestParameters.dashboardId was null or undefined when calling updateDashboard.');
+            }
+            if (requestParameters.dashboardRequest === null || requestParameters.dashboardRequest === undefined) {
+                throw new runtime.RequiredError('dashboardRequest', 'Required parameter requestParameters.dashboardRequest was null or undefined when calling updateDashboard.');
+            }
+            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}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardRequestToJSON(requestParameters.dashboardRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates a dashboard
+     * Update dashboard
+     */
+    updateDashboard(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDashboardRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,162 @@
+/**
+ * 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, DatasetAssetsManifest, DatasetDetail, ImportDataRequest, PaginatedResponseDatasetListDto, UpdateDatasetRequest, UploadDatasetCreateResponse, UploadDatasetRequest } from '../models/index';
+export interface DeleteDatasetRequest {
+    projectId: string;
+    datasetId: string;
+}
+export interface GetDatasetRequest {
+    datasetId: string;
+    projectId: string;
+}
+export interface GetDatasetManifestRequest {
+    datasetId: string;
+    projectId: string;
+    fileOffset?: number;
+    fileLimit?: number;
+}
+export interface GetDatasetsRequest {
+    projectId: string;
+    limit?: number;
+    nextToken?: string;
+}
+export interface ImportPublicDatasetRequest {
+    projectId: string;
+    importDataRequest: ImportDataRequest;
+}
+export interface IngestSamplesRequest {
+    projectId: string;
+    datasetId: string;
+}
+export interface RegenerateManifestRequest {
+    projectId: string;
+    datasetId: string;
+}
+export interface RerunTransformRequest {
+    projectId: string;
+    datasetId: string;
+}
+export interface UpdateDatasetOperationRequest {
+    projectId: string;
+    datasetId: string;
+    updateDatasetRequest: UpdateDatasetRequest;
+}
+export interface UploadDatasetOperationRequest {
+    projectId: string;
+    uploadDatasetRequest: UploadDatasetRequest;
+}
+/**
+ *
+ */
+export declare class DatasetsApi extends runtime.BaseAPI {
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    deleteDatasetRaw(requestParameters: DeleteDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    deleteDataset(requestParameters: DeleteDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    getDatasetRaw(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetDetail>>;
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    getDataset(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetDetail>;
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    getDatasetManifestRaw(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetAssetsManifest>>;
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    getDatasetManifest(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetAssetsManifest>;
+    /**
+     * Retrieves a list of datasets for a given project
+     * List datasets
+     */
+    getDatasetsRaw(requestParameters: GetDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDatasetListDto>>;
+    /**
+     * Retrieves a list of datasets for a given project
+     * List datasets
+     */
+    getDatasets(requestParameters: GetDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDatasetListDto>;
+    /**
+     * Download data from public repositories
+     * Import public dataset
+     */
+    importPublicDatasetRaw(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Download data from public repositories
+     * Import public dataset
+     */
+    importPublicDataset(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Rerun sample ingest.
+     * Rerun sample ingest
+     */
+    ingestSamplesRaw(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Rerun sample ingest.
+     * Rerun sample ingest
+     */
+    ingestSamples(requestParameters: IngestSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Regenerate dataset file listing.
+     * Regenerate dataset manifest
+     */
+    regenerateManifestRaw(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Regenerate dataset file listing.
+     * Regenerate dataset manifest
+     */
+    regenerateManifest(requestParameters: RegenerateManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Rerun data transforms and web optimization.
+     * Rerun data transforms
+     */
+    rerunTransformRaw(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Rerun data transforms and web optimization.
+     * Rerun data transforms
+     */
+    rerunTransform(requestParameters: RerunTransformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    updateDatasetRaw(requestParameters: UpdateDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetDetail>>;
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    updateDataset(requestParameters: UpdateDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetDetail>;
+    /**
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
+     */
+    uploadDatasetRaw(requestParameters: UploadDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadDatasetCreateResponse>>;
+    /**
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
+     */
+    uploadDataset(requestParameters: UploadDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDatasetCreateResponse>;
+}