@cirrobio/api-client 0.9.0 → 0.9.2

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

@@ -0,0 +1,91 @@
+/**
+ * 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 { CreateReferenceRequest, Reference, ReferenceType } from '../models/index';
+export interface CreateProjectReferenceRequest {
+    projectId: string;
+    createReferenceRequest: CreateReferenceRequest;
+}
+export interface DeleteProjectReferenceRequest {
+    projectId: string;
+}
+export interface GetReferencesForProjectRequest {
+    projectId: string;
+}
+export interface RefreshProjectReferencesRequest {
+    projectId: string;
+}
+/**
+ *
+ */
+export declare class ReferencesApi extends runtime.BaseAPI {
+    /**
+     * Creates a reference
+     * Create project reference
+     */
+    createProjectReferenceRaw(requestParameters: CreateProjectReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Reference>>;
+    /**
+     * Creates a reference
+     * Create project reference
+     */
+    createProjectReference(requestParameters: CreateProjectReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Reference>;
+    /**
+     * Deletes a reference
+     * Delete project reference
+     */
+    deleteProjectReferenceRaw(requestParameters: DeleteProjectReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a reference
+     * Delete project reference
+     */
+    deleteProjectReference(requestParameters: DeleteProjectReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    getReferenceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReferenceType>>>;
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    getReferenceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReferenceType>>;
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    getReferencesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Reference>>>;
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    getReferences(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Reference>>;
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    getReferencesForProjectRaw(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Reference>>>;
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Reference>>;
+    /**
+     * Refresh project references (internal)
+     * Refresh project references
+     */
+    refreshProjectReferencesRaw(requestParameters: RefreshProjectReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Refresh project references (internal)
+     * Refresh project references
+     */
+    refreshProjectReferences(requestParameters: RefreshProjectReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/esm/apis/ReferencesApi.js

@@ -0,0 +1,248 @@
+/* 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 { CreateReferenceRequestToJSON, ReferenceFromJSON, ReferenceTypeFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class ReferencesApi extends runtime.BaseAPI {
+    /**
+     * Creates a reference
+     * Create project reference
+     */
+    createProjectReferenceRaw(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 createProjectReference.');
+            }
+            if (requestParameters.createReferenceRequest === null || requestParameters.createReferenceRequest === undefined) {
+                throw new runtime.RequiredError('createReferenceRequest', 'Required parameter requestParameters.createReferenceRequest was null or undefined when calling createProjectReference.');
+            }
+            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}/references`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateReferenceRequestToJSON(requestParameters.createReferenceRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReferenceFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a reference
+     * Create project reference
+     */
+    createProjectReference(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createProjectReferenceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a reference
+     * Delete project reference
+     */
+    deleteProjectReferenceRaw(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 deleteProjectReference.');
+            }
+            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}/references`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a reference
+     * Delete project reference
+     */
+    deleteProjectReference(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteProjectReferenceRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    getReferenceTypesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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: `/reference-types`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceTypeFromJSON));
+        });
+    }
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    getReferenceTypes(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReferenceTypesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    getReferencesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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: `/references`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceFromJSON));
+        });
+    }
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    getReferences(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReferencesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    getReferencesForProjectRaw(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 getReferencesForProject.');
+            }
+            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}/references`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceFromJSON));
+        });
+    }
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    getReferencesForProject(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReferencesForProjectRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Refresh project references (internal)
+     * Refresh project references
+     */
+    refreshProjectReferencesRaw(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 refreshProjectReferences.');
+            }
+            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}/references`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Refresh project references (internal)
+     * Refresh project references
+     */
+    refreshProjectReferences(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.refreshProjectReferencesRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -0,0 +1,145 @@
+/**
+ * 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, PaginatedResponseDatasetListDto, Share, ShareDetail, ShareInput } from '../models/index';
+export interface CreateShareRequest {
+    projectId: string;
+    shareInput: ShareInput;
+}
+export interface DeleteShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface GetDiscoverableSharesRequest {
+    projectId: string;
+}
+export interface GetShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface GetSharedDatasetsRequest {
+    projectId: string;
+    shareId: string;
+    limit?: number;
+    nextToken?: string;
+}
+export interface GetSharesRequest {
+    projectId: string;
+}
+export interface SubscribeShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface UnsubscribeShareRequest {
+    projectId: string;
+    shareId: string;
+}
+export interface UpdateShareRequest {
+    projectId: string;
+    shareId: string;
+    shareInput: ShareInput;
+}
+/**
+ *
+ */
+export declare class SharingApi extends runtime.BaseAPI {
+    /**
+     * Create a new share to publish to other projects
+     * Create share
+     */
+    createShareRaw(requestParameters: CreateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Create a new share to publish to other projects
+     * Create share
+     */
+    createShare(requestParameters: CreateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Delete a share that you\'ve published
+     * Delete share
+     */
+    deleteShareRaw(requestParameters: DeleteShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a share that you\'ve published
+     * Delete share
+     */
+    deleteShare(requestParameters: DeleteShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get shares that the project can request access to
+     * Get discoverable shares
+     */
+    getDiscoverableSharesRaw(requestParameters: GetDiscoverableSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Share>>>;
+    /**
+     * Get shares that the project can request access to
+     * Get discoverable shares
+     */
+    getDiscoverableShares(requestParameters: GetDiscoverableSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Share>>;
+    /**
+     * Get details on a share that you\'ve published or subscribed to
+     * Get share
+     */
+    getShareRaw(requestParameters: GetShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShareDetail>>;
+    /**
+     * Get details on a share that you\'ve published or subscribed to
+     * Get share
+     */
+    getShare(requestParameters: GetShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareDetail>;
+    /**
+     * Get dataset listing for a share
+     * Get share datasets
+     */
+    getSharedDatasetsRaw(requestParameters: GetSharedDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDatasetListDto>>;
+    /**
+     * Get dataset listing for a share
+     * Get share datasets
+     */
+    getSharedDatasets(requestParameters: GetSharedDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDatasetListDto>;
+    /**
+     * Get shares for a project (both published and shared with the project)
+     * Get shares
+     */
+    getSharesRaw(requestParameters: GetSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Share>>>;
+    /**
+     * Get shares for a project (both published and shared with the project)
+     * Get shares
+     */
+    getShares(requestParameters: GetSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Share>>;
+    /**
+     * Subscribe to a share that has been shared with your project
+     * Subscribe to share
+     */
+    subscribeShareRaw(requestParameters: SubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Subscribe to a share that has been shared with your project
+     * Subscribe to share
+     */
+    subscribeShare(requestParameters: SubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Unsubscribe from a share that has been shared with your project
+     * Unsubscribe from share
+     */
+    unsubscribeShareRaw(requestParameters: UnsubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unsubscribe from a share that has been shared with your project
+     * Unsubscribe from share
+     */
+    unsubscribeShare(requestParameters: UnsubscribeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update a share that you\'ve published
+     * Update share
+     */
+    updateShareRaw(requestParameters: UpdateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update a share that you\'ve published
+     * Update share
+     */
+    updateShare(requestParameters: UpdateShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}