@cirrobio/api-client 0.4.2 → 0.9.0

package/.openapi-generator/FILES

@@ -157,4 +157,5 @@ src/models/UserSettings.ts
 src/models/ValidateFileRequirementsRequest.ts
 src/models/index.ts
 src/runtime.ts
+tsconfig.esm.json
 tsconfig.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.4.2",
+  "version": "0.9.0",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {
@@ -12,8 +12,10 @@
   "homepage": "https://cirro.bio",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc -p tsconfig.esm.json",
     "prepare": "npm run build"
   },
   "devDependencies": {

package/src/models/ProjectRequirement.ts

@@ -81,11 +81,17 @@ export interface ProjectRequirement {
      */
     type: GovernanceType;
     /**
-     * S3 prefix where files for the requirement are saved
+     * S3 prefix where the main file for the requirement is saved
      * @type {string}
      * @memberof ProjectRequirement
      */
     path: string;
+    /**
+     * S3 prefix where supplemental files for the requirement are saved
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    supplementalPath: string;
     /**
      * 
      * @type {GovernanceScope}
@@ -194,6 +200,7 @@ export function instanceOfProjectRequirement(value: object): boolean {
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "type" in value;
     isInstance = isInstance && "path" in value;
+    isInstance = isInstance && "supplementalPath" in value;
     isInstance = isInstance && "scope" in value;
     isInstance = isInstance && "contacts" in value;
     isInstance = isInstance && "isFulfilled" in value;
@@ -216,6 +223,7 @@ export function ProjectRequirementFromJSONTyped(json: any, ignoreDiscriminator:
         'description': json['description'],
         'type': GovernanceTypeFromJSON(json['type']),
         'path': json['path'],
+        'supplementalPath': json['supplementalPath'],
         'scope': GovernanceScopeFromJSON(json['scope']),
         'acceptance': !exists(json, 'acceptance') ? undefined : GovernanceScopeFromJSON(json['acceptance']),
         'contacts': ((json['contacts'] as Array<any>).map(GovernanceContactFromJSON)),
@@ -249,6 +257,7 @@ export function ProjectRequirementToJSON(value?: ProjectRequirement | null): any
         'description': value.description,
         'type': GovernanceTypeToJSON(value.type),
         'path': value.path,
+        'supplementalPath': value.supplementalPath,
         'scope': GovernanceScopeToJSON(value.scope),
         'acceptance': GovernanceScopeToJSON(value.acceptance),
         'contacts': ((value.contacts as Array<any>).map(GovernanceContactToJSON)),

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "target": "es5",
+    "target": "es6",
     "module": "commonjs",
     "moduleResolution": "node",
     "outDir": "dist",
-    "lib": [
-      "es6",
-      "dom"
-    ],
     "typeRoots": [
       "node_modules/@types"
     ]

package/dist/apis/AuditApi.d.ts

@@ -1,60 +0,0 @@
-/**
- * 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 { AuditEvent } from '../models/index';
-export interface GetEventRequest {
-    auditEventId: string;
-}
-export interface ListEventsRequest {
-    username?: string;
-    entityType?: ListEventsEntityTypeEnum;
-    entityId?: string;
-}
-/**
- *
- */
-export declare class AuditApi extends runtime.BaseAPI {
-    /**
-     * Get audit event detailed information
-     * Get audit event
-     */
-    getEventRaw(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuditEvent>>;
-    /**
-     * Get audit event detailed information
-     * Get audit event
-     */
-    getEvent(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuditEvent>;
-    /**
-     * Gets a list of audit events
-     * List audit events
-     */
-    listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AuditEvent>>>;
-    /**
-     * Gets a list of audit events
-     * List audit events
-     */
-    listEvents(requestParameters?: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEvent>>;
-}
-/**
-  * @export
-  * @enum {string}
-  */
-export declare enum ListEventsEntityTypeEnum {
-    Project = "Project",
-    Sample = "Sample",
-    Dataset = "Dataset",
-    User = "User",
-    BillingAccount = "BillingAccount",
-    Process = "Process",
-    NotebookInstance = "NotebookInstance",
-    UserProjectAssignment = "UserProjectAssignment"
-}

package/dist/apis/AuditApi.js

@@ -1,194 +0,0 @@
-"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.ListEventsEntityTypeEnum = exports.AuditApi = void 0;
-var runtime = require("../runtime");
-var index_1 = require("../models/index");
-/**
- *
- */
-var AuditApi = /** @class */ (function (_super) {
-    __extends(AuditApi, _super);
-    function AuditApi() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Get audit event detailed information
-     * Get audit event
-     */
-    AuditApi.prototype.getEventRaw = function (requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (requestParameters.auditEventId === null || requestParameters.auditEventId === undefined) {
-                            throw new runtime.RequiredError('auditEventId', 'Required parameter requestParameters.auditEventId was null or undefined when calling getEvent.');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        return [4 /*yield*/, this.request({
-                                path: "/audit-events/{auditEventId}".replace("{".concat("auditEventId", "}"), encodeURIComponent(String(requestParameters.auditEventId))),
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.AuditEventFromJSON)(jsonValue); })];
-                }
-            });
-        });
-    };
-    /**
-     * Get audit event detailed information
-     * Get audit event
-     */
-    AuditApi.prototype.getEvent = 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.getEventRaw(requestParameters, initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [4 /*yield*/, response.value()];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Gets a list of audit events
-     * List audit events
-     */
-    AuditApi.prototype.listEventsRaw = function (requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        queryParameters = {};
-                        if (requestParameters.username !== undefined) {
-                            queryParameters['username'] = requestParameters.username;
-                        }
-                        if (requestParameters.entityType !== undefined) {
-                            queryParameters['entityType'] = requestParameters.entityType;
-                        }
-                        if (requestParameters.entityId !== undefined) {
-                            queryParameters['entityId'] = requestParameters.entityId;
-                        }
-                        headerParameters = {};
-                        return [4 /*yield*/, this.request({
-                                path: "/audit-events",
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.AuditEventFromJSON); })];
-                }
-            });
-        });
-    };
-    /**
-     * Gets a list of audit events
-     * List audit events
-     */
-    AuditApi.prototype.listEvents = function (requestParameters, initOverrides) {
-        if (requestParameters === void 0) { requestParameters = {}; }
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.listEventsRaw(requestParameters, initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [4 /*yield*/, response.value()];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    return AuditApi;
-}(runtime.BaseAPI));
-exports.AuditApi = AuditApi;
-/**
-  * @export
-  * @enum {string}
-  */
-var ListEventsEntityTypeEnum;
-(function (ListEventsEntityTypeEnum) {
-    ListEventsEntityTypeEnum["Project"] = "Project";
-    ListEventsEntityTypeEnum["Sample"] = "Sample";
-    ListEventsEntityTypeEnum["Dataset"] = "Dataset";
-    ListEventsEntityTypeEnum["User"] = "User";
-    ListEventsEntityTypeEnum["BillingAccount"] = "BillingAccount";
-    ListEventsEntityTypeEnum["Process"] = "Process";
-    ListEventsEntityTypeEnum["NotebookInstance"] = "NotebookInstance";
-    ListEventsEntityTypeEnum["UserProjectAssignment"] = "UserProjectAssignment";
-})(ListEventsEntityTypeEnum = exports.ListEventsEntityTypeEnum || (exports.ListEventsEntityTypeEnum = {}));

package/dist/apis/BillingApi.d.ts

@@ -1,71 +0,0 @@
-/**
- * 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 { BillingAccount, BillingAccountRequest, CreateResponse } from '../models/index';
-export interface CreateBillingAccountRequest {
-    billingAccountRequest: BillingAccountRequest;
-}
-export interface DeleteBillingAccountRequest {
-    billingAccountId: string;
-}
-export interface GetBillingAccountsRequest {
-    includeArchived?: boolean;
-}
-export interface UpdateBillingAccountRequest {
-    billingAccountId: string;
-    billingAccountRequest: BillingAccountRequest;
-}
-/**
- *
- */
-export declare class BillingApi extends runtime.BaseAPI {
-    /**
-     * Creates a billing account
-     * Create billing account
-     */
-    createBillingAccountRaw(requestParameters: CreateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
-    /**
-     * Creates a billing account
-     * Create billing account
-     */
-    createBillingAccount(requestParameters: CreateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
-    /**
-     * Deletes a billing account
-     * Delete billing account
-     */
-    deleteBillingAccountRaw(requestParameters: DeleteBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Deletes a billing account
-     * Delete billing account
-     */
-    deleteBillingAccount(requestParameters: DeleteBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets a list of billing accounts the current user has access to
-     * List billing accounts
-     */
-    getBillingAccountsRaw(requestParameters: GetBillingAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BillingAccount>>>;
-    /**
-     * Gets a list of billing accounts the current user has access to
-     * List billing accounts
-     */
-    getBillingAccounts(requestParameters?: GetBillingAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BillingAccount>>;
-    /**
-     * Updates a billing account
-     * Update billing account
-     */
-    updateBillingAccountRaw(requestParameters: UpdateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Updates a billing account
-     * Update billing account
-     */
-    updateBillingAccount(requestParameters: UpdateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-}