@cirrobio/api-client 0.0.4-alpha → 0.0.5-alpha

package/.openapi-generator/FILES

@@ -10,6 +10,7 @@ src/apis/MetricsApi.ts
 src/apis/NotebooksApi.ts
 src/apis/ProcessesApi.ts
 src/apis/ProjectsApi.ts
+src/apis/ReferencesApi.ts
 src/apis/SystemApi.ts
 src/apis/UsersApi.ts
 src/apis/index.ts
@@ -40,6 +41,7 @@ src/models/ProjectMetrics.ts
 src/models/ProjectRequest.ts
 src/models/ProjectRole.ts
 src/models/ProjectSettings.ts
+src/models/Reference.ts
 src/models/ReferenceType.ts
 src/models/Region.ts
 src/models/RegisterDatasetRequest.ts

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.0.4-alpha --save
+npm install @cirrobio/api-client@0.0.5-alpha --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ProcessesApi.d.ts

@@ -26,32 +26,32 @@ export interface GetProcessesRequest {
 export declare class ProcessesApi extends runtime.BaseAPI {
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>>;
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>>;
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema>;
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>>;
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     getProcesses(requestParameters?: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>>;
 }

package/dist/apis/ProcessesApi.js

@@ -77,7 +77,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     }
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     ProcessesApi.prototype.getProcessRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -114,7 +114,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     ProcessesApi.prototype.getProcess = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -132,7 +132,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     ProcessesApi.prototype.getProcessParametersRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -169,7 +169,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     ProcessesApi.prototype.getProcessParameters = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -187,7 +187,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     ProcessesApi.prototype.getProcessesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -224,7 +224,7 @@ var ProcessesApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     ProcessesApi.prototype.getProcesses = function (requestParameters, initOverrides) {
         if (requestParameters === void 0) { requestParameters = {}; }

package/dist/apis/ProjectsApi.d.ts

@@ -46,22 +46,22 @@ export declare class ProjectsApi extends runtime.BaseAPI {
     createProject(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectDetail>>;
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectDetail>;
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     getProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     getProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
     /**

package/dist/apis/ProjectsApi.js

@@ -134,7 +134,7 @@ var ProjectsApi = /** @class */ (function (_super) {
     };
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     ProjectsApi.prototype.getProjectRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -171,7 +171,7 @@ var ProjectsApi = /** @class */ (function (_super) {
     };
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     ProjectsApi.prototype.getProject = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -189,7 +189,7 @@ var ProjectsApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     ProjectsApi.prototype.getProjectsRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -223,7 +223,7 @@ var ProjectsApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     ProjectsApi.prototype.getProjects = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/apis/ReferencesApi.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { Reference, ReferenceType } from '../models/index';
+export interface GetReferencesForProjectRequest {
+    projectId: string;
+}
+/**
+ *
+ */
+export declare class ReferencesApi extends runtime.BaseAPI {
+    /**
+     * 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<Reference>>;
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Reference>;
+}

package/dist/apis/ReferencesApi.js

@@ -0,0 +1,239 @@
+"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 __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferencesApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var ReferencesApi = /** @class */ (function (_super) {
+    __extends(ReferencesApi, _super);
+    function ReferencesApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    ReferencesApi.prototype.getReferenceTypesRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/reference-types",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.ReferenceTypeFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    ReferencesApi.prototype.getReferenceTypes = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getReferenceTypesRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    ReferencesApi.prototype.getReferencesRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/references",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.ReferenceFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    ReferencesApi.prototype.getReferences = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getReferencesRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    ReferencesApi.prototype.getReferencesForProjectRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getReferencesForProject.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/projects/{projectId}/references".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ReferenceFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    ReferencesApi.prototype.getReferencesForProject = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getReferencesForProjectRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return ReferencesApi;
+}(runtime.BaseAPI));
+exports.ReferencesApi = ReferencesApi;

package/dist/apis/SystemApi.d.ts

@@ -10,21 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ReferenceType, ServiceConnection, SystemInfoResponse } from '../models/index';
+import type { ServiceConnection, SystemInfoResponse } from '../models/index';
 /**
  *
  */
 export declare class SystemApi extends runtime.BaseAPI {
-    /**
-     * 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 service connections
      * Get service connections

package/dist/apis/SystemApi.js

@@ -75,58 +75,6 @@ var SystemApi = /** @class */ (function (_super) {
     function SystemApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
-    /**
-     * List available reference types
-     * Get reference types
-     */
-    SystemApi.prototype.getReferenceTypesRaw = function (initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        queryParameters = {};
-                        headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
-                        token = this.configuration.accessToken;
-                        return [4 /*yield*/, token("accessToken", [])];
-                    case 1:
-                        tokenString = _a.sent();
-                        if (tokenString) {
-                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
-                        }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
-                            path: "/reference-types",
-                            method: 'GET',
-                            headers: headerParameters,
-                            query: queryParameters,
-                        }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.ReferenceTypeFromJSON); })];
-                }
-            });
-        });
-    };
-    /**
-     * List available reference types
-     * Get reference types
-     */
-    SystemApi.prototype.getReferenceTypes = function (initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getReferenceTypesRaw(initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [4 /*yield*/, response.value()];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
     /**
      * List available service connections
      * Get service connections

package/dist/apis/index.d.ts

@@ -6,5 +6,6 @@ export * from './MetricsApi';
 export * from './NotebooksApi';
 export * from './ProcessesApi';
 export * from './ProjectsApi';
+export * from './ReferencesApi';
 export * from './SystemApi';
 export * from './UsersApi';

package/dist/apis/index.js

@@ -24,5 +24,6 @@ __exportStar(require("./MetricsApi"), exports);
 __exportStar(require("./NotebooksApi"), exports);
 __exportStar(require("./ProcessesApi"), exports);
 __exportStar(require("./ProjectsApi"), exports);
+__exportStar(require("./ReferencesApi"), exports);
 __exportStar(require("./SystemApi"), exports);
 __exportStar(require("./UsersApi"), exports);

package/dist/models/Reference.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface Reference
+ */
+export interface Reference {
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    referenceType: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Reference
+     */
+    files: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Reference
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the Reference interface.
+ */
+export declare function instanceOfReference(value: object): boolean;
+export declare function ReferenceFromJSON(json: any): Reference;
+export declare function ReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Reference;
+export declare function ReferenceToJSON(value?: Reference | null): any;

package/dist/models/Reference.js

@@ -0,0 +1,62 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceToJSON = exports.ReferenceFromJSONTyped = exports.ReferenceFromJSON = exports.instanceOfReference = void 0;
+/**
+ * Check if a given object implements the Reference interface.
+ */
+function instanceOfReference(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "referenceType" in value;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    return isInstance;
+}
+exports.instanceOfReference = instanceOfReference;
+function ReferenceFromJSON(json) {
+    return ReferenceFromJSONTyped(json, false);
+}
+exports.ReferenceFromJSON = ReferenceFromJSON;
+function ReferenceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'referenceType': json['referenceType'],
+        'files': json['files'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+exports.ReferenceFromJSONTyped = ReferenceFromJSONTyped;
+function ReferenceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'referenceType': value.referenceType,
+        'files': value.files,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+    };
+}
+exports.ReferenceToJSON = ReferenceToJSON;

package/dist/models/ServiceConnection.d.ts

@@ -21,6 +21,12 @@ export interface ServiceConnection {
      * @memberof ServiceConnection
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceConnection
+     */
+    description: string;
 }
 /**
  * Check if a given object implements the ServiceConnection interface.

package/dist/models/ServiceConnection.js

@@ -20,6 +20,7 @@ exports.ServiceConnectionToJSON = exports.ServiceConnectionFromJSONTyped = expor
 function instanceOfServiceConnection(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
     return isInstance;
 }
 exports.instanceOfServiceConnection = instanceOfServiceConnection;
@@ -33,6 +34,7 @@ function ServiceConnectionFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
+        'description': json['description'],
     };
 }
 exports.ServiceConnectionFromJSONTyped = ServiceConnectionFromJSONTyped;
@@ -45,6 +47,7 @@ function ServiceConnectionToJSON(value) {
     }
     return {
         'name': value.name,
+        'description': value.description,
     };
 }
 exports.ServiceConnectionToJSON = ServiceConnectionToJSON;

package/dist/models/index.d.ts

@@ -24,6 +24,7 @@ export * from './ProjectMetrics';
 export * from './ProjectRequest';
 export * from './ProjectRole';
 export * from './ProjectSettings';
+export * from './Reference';
 export * from './ReferenceType';
 export * from './Region';
 export * from './RegisterDatasetRequest';

package/dist/models/index.js

@@ -42,6 +42,7 @@ __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectRequest"), exports);
 __exportStar(require("./ProjectRole"), exports);
 __exportStar(require("./ProjectSettings"), exports);
+__exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./Region"), exports);
 __exportStar(require("./RegisterDatasetRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.0.4-alpha",
+  "version": "0.0.5-alpha",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/apis/ProcessesApi.ts

@@ -47,7 +47,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     async getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>> {
         if (requestParameters.processId === null || requestParameters.processId === undefined) {
@@ -78,7 +78,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves detailed information on a process
-     * Get Process
+     * Get process
      */
     async getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail> {
         const response = await this.getProcessRaw(requestParameters, initOverrides);
@@ -87,7 +87,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     async getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>> {
         if (requestParameters.processId === null || requestParameters.processId === undefined) {
@@ -118,7 +118,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * Get process parameters
      */
     async getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema> {
         const response = await this.getProcessParametersRaw(requestParameters, initOverrides);
@@ -127,7 +127,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     async getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>> {
         const queryParameters: any = {};
@@ -158,7 +158,7 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves a list of available processes
-     * List Processes
+     * List processes
      */
     async getProcesses(requestParameters: GetProcessesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>> {
         const response = await this.getProcessesRaw(requestParameters, initOverrides);

package/src/apis/ProjectsApi.ts

@@ -111,7 +111,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     async getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectDetail>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
@@ -142,7 +142,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     async getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectDetail> {
         const response = await this.getProjectRaw(requestParameters, initOverrides);
@@ -151,7 +151,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     async getProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>> {
         const queryParameters: any = {};
@@ -178,7 +178,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     async getProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>> {
         const response = await this.getProjectsRaw(initOverrides);

package/src/apis/ReferencesApi.ts

@@ -0,0 +1,149 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  Reference,
+  ReferenceType,
+} from '../models/index';
+import {
+    ReferenceFromJSON,
+    ReferenceToJSON,
+    ReferenceTypeFromJSON,
+    ReferenceTypeToJSON,
+} from '../models/index';
+
+export interface GetReferencesForProjectRequest {
+    projectId: string;
+}
+
+/**
+ * 
+ */
+export class ReferencesApi extends runtime.BaseAPI {
+
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    async getReferenceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReferenceType>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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
+     */
+    async getReferenceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReferenceType>> {
+        const response = await this.getReferenceTypesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    async getReferencesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Reference>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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
+     */
+    async getReferences(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Reference>> {
+        const response = await this.getReferencesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    async getReferencesForProjectRaw(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Reference>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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) => ReferenceFromJSON(jsonValue));
+    }
+
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    async getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Reference> {
+        const response = await this.getReferencesForProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/SystemApi.ts

@@ -15,13 +15,10 @@
 
 import * as runtime from '../runtime';
 import type {
-  ReferenceType,
   ServiceConnection,
   SystemInfoResponse,
 } from '../models/index';
 import {
-    ReferenceTypeFromJSON,
-    ReferenceTypeToJSON,
     ServiceConnectionFromJSON,
     ServiceConnectionToJSON,
     SystemInfoResponseFromJSON,
@@ -33,42 +30,6 @@ import {
  */
 export class SystemApi extends runtime.BaseAPI {
 
-    /**
-     * List available reference types
-     * Get reference types
-     */
-    async getReferenceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReferenceType>>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("accessToken", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await 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
-     */
-    async getReferenceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReferenceType>> {
-        const response = await this.getReferenceTypesRaw(initOverrides);
-        return await response.value();
-    }
-
     /**
      * List available service connections
      * Get service connections

package/src/apis/index.ts

@@ -8,5 +8,6 @@ export * from './MetricsApi';
 export * from './NotebooksApi';
 export * from './ProcessesApi';
 export * from './ProjectsApi';
+export * from './ReferencesApi';
 export * from './SystemApi';
 export * from './UsersApi';

package/src/models/Reference.ts

@@ -0,0 +1,102 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface Reference
+ */
+export interface Reference {
+    /**
+     * 
+     * @type {string}
+     * @memberof Reference
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Reference
+     */
+    referenceType: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof Reference
+     */
+    files: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof Reference
+     */
+    createdBy: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Reference
+     */
+    createdAt: Date;
+}
+
+/**
+ * Check if a given object implements the Reference interface.
+ */
+export function instanceOfReference(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "referenceType" in value;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+
+    return isInstance;
+}
+
+export function ReferenceFromJSON(json: any): Reference {
+    return ReferenceFromJSONTyped(json, false);
+}
+
+export function ReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Reference {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'referenceType': json['referenceType'],
+        'files': json['files'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function ReferenceToJSON(value?: Reference | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'referenceType': value.referenceType,
+        'files': value.files,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+    };
+}
+

package/src/models/ServiceConnection.ts

@@ -25,6 +25,12 @@ export interface ServiceConnection {
      * @memberof ServiceConnection
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ServiceConnection
+     */
+    description: string;
 }
 
 /**
@@ -33,6 +39,7 @@ export interface ServiceConnection {
 export function instanceOfServiceConnection(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
 
     return isInstance;
 }
@@ -48,6 +55,7 @@ export function ServiceConnectionFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'name': json['name'],
+        'description': json['description'],
     };
 }
 
@@ -61,6 +69,7 @@ export function ServiceConnectionToJSON(value?: ServiceConnection | null): any {
     return {
         
         'name': value.name,
+        'description': value.description,
     };
 }
 

package/src/models/index.ts

@@ -26,6 +26,7 @@ export * from './ProjectMetrics';
 export * from './ProjectRequest';
 export * from './ProjectRole';
 export * from './ProjectSettings';
+export * from './Reference';
 export * from './ReferenceType';
 export * from './Region';
 export * from './RegisterDatasetRequest';