@cirrobio/api-client 0.1.11 → 0.1.13

package/dist/models/ApproveProjectAccessRequest.js

@@ -0,0 +1,51 @@
+"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.ApproveProjectAccessRequestToJSON = exports.ApproveProjectAccessRequestFromJSONTyped = exports.ApproveProjectAccessRequestFromJSON = exports.instanceOfApproveProjectAccessRequest = void 0;
+var ProjectRole_1 = require("./ProjectRole");
+/**
+ * Check if a given object implements the ApproveProjectAccessRequest interface.
+ */
+function instanceOfApproveProjectAccessRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "role" in value;
+    return isInstance;
+}
+exports.instanceOfApproveProjectAccessRequest = instanceOfApproveProjectAccessRequest;
+function ApproveProjectAccessRequestFromJSON(json) {
+    return ApproveProjectAccessRequestFromJSONTyped(json, false);
+}
+exports.ApproveProjectAccessRequestFromJSON = ApproveProjectAccessRequestFromJSON;
+function ApproveProjectAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'role': (0, ProjectRole_1.ProjectRoleFromJSON)(json['role']),
+    };
+}
+exports.ApproveProjectAccessRequestFromJSONTyped = ApproveProjectAccessRequestFromJSONTyped;
+function ApproveProjectAccessRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'role': (0, ProjectRole_1.ProjectRoleToJSON)(value.role),
+    };
+}
+exports.ApproveProjectAccessRequestToJSON = ApproveProjectAccessRequestToJSON;

package/dist/models/CreateProjectAccessRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 type { ProjectRole } from './ProjectRole';
+/**
+ *
+ * @export
+ * @interface CreateProjectAccessRequest
+ */
+export interface CreateProjectAccessRequest {
+    /**
+     *
+     * @type {ProjectRole}
+     * @memberof CreateProjectAccessRequest
+     */
+    role: ProjectRole;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateProjectAccessRequest
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the CreateProjectAccessRequest interface.
+ */
+export declare function instanceOfCreateProjectAccessRequest(value: object): boolean;
+export declare function CreateProjectAccessRequestFromJSON(json: any): CreateProjectAccessRequest;
+export declare function CreateProjectAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProjectAccessRequest;
+export declare function CreateProjectAccessRequestToJSON(value?: CreateProjectAccessRequest | null): any;

package/dist/models/CreateProjectAccessRequest.js

@@ -0,0 +1,54 @@
+"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.CreateProjectAccessRequestToJSON = exports.CreateProjectAccessRequestFromJSONTyped = exports.CreateProjectAccessRequestFromJSON = exports.instanceOfCreateProjectAccessRequest = void 0;
+var ProjectRole_1 = require("./ProjectRole");
+/**
+ * Check if a given object implements the CreateProjectAccessRequest interface.
+ */
+function instanceOfCreateProjectAccessRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "role" in value;
+    isInstance = isInstance && "message" in value;
+    return isInstance;
+}
+exports.instanceOfCreateProjectAccessRequest = instanceOfCreateProjectAccessRequest;
+function CreateProjectAccessRequestFromJSON(json) {
+    return CreateProjectAccessRequestFromJSONTyped(json, false);
+}
+exports.CreateProjectAccessRequestFromJSON = CreateProjectAccessRequestFromJSON;
+function CreateProjectAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'role': (0, ProjectRole_1.ProjectRoleFromJSON)(json['role']),
+        'message': json['message'],
+    };
+}
+exports.CreateProjectAccessRequestFromJSONTyped = CreateProjectAccessRequestFromJSONTyped;
+function CreateProjectAccessRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'role': (0, ProjectRole_1.ProjectRoleToJSON)(value.role),
+        'message': value.message,
+    };
+}
+exports.CreateProjectAccessRequestToJSON = CreateProjectAccessRequestToJSON;

package/dist/models/PipelineCost.d.ts

@@ -20,7 +20,7 @@ export interface PipelineCost {
      * @type {number}
      * @memberof PipelineCost
      */
-    totalCost?: number;
+    totalCost?: number | null;
     /**
      * Is this an estimate of the cost?
      * @type {boolean}

package/dist/models/ProjectAccessRequest.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 type { ProjectRole } from './ProjectRole';
+import type { RequestStatus } from './RequestStatus';
+/**
+ *
+ * @export
+ * @interface ProjectAccessRequest
+ */
+export interface ProjectAccessRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAccessRequest
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAccessRequest
+     */
+    username: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAccessRequest
+     */
+    projectId: string;
+    /**
+     *
+     * @type {ProjectRole}
+     * @memberof ProjectAccessRequest
+     */
+    role: ProjectRole;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAccessRequest
+     */
+    message: string;
+    /**
+     *
+     * @type {RequestStatus}
+     * @memberof ProjectAccessRequest
+     */
+    status: RequestStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAccessRequest
+     */
+    reviewerUsername: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ProjectAccessRequest
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof ProjectAccessRequest
+     */
+    expiry: Date;
+}
+/**
+ * Check if a given object implements the ProjectAccessRequest interface.
+ */
+export declare function instanceOfProjectAccessRequest(value: object): boolean;
+export declare function ProjectAccessRequestFromJSON(json: any): ProjectAccessRequest;
+export declare function ProjectAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectAccessRequest;
+export declare function ProjectAccessRequestToJSON(value?: ProjectAccessRequest | null): any;

package/dist/models/ProjectAccessRequest.js

@@ -0,0 +1,76 @@
+"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.ProjectAccessRequestToJSON = exports.ProjectAccessRequestFromJSONTyped = exports.ProjectAccessRequestFromJSON = exports.instanceOfProjectAccessRequest = void 0;
+var ProjectRole_1 = require("./ProjectRole");
+var RequestStatus_1 = require("./RequestStatus");
+/**
+ * Check if a given object implements the ProjectAccessRequest interface.
+ */
+function instanceOfProjectAccessRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "username" in value;
+    isInstance = isInstance && "projectId" in value;
+    isInstance = isInstance && "role" in value;
+    isInstance = isInstance && "message" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "reviewerUsername" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "expiry" in value;
+    return isInstance;
+}
+exports.instanceOfProjectAccessRequest = instanceOfProjectAccessRequest;
+function ProjectAccessRequestFromJSON(json) {
+    return ProjectAccessRequestFromJSONTyped(json, false);
+}
+exports.ProjectAccessRequestFromJSON = ProjectAccessRequestFromJSON;
+function ProjectAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'username': json['username'],
+        'projectId': json['projectId'],
+        'role': (0, ProjectRole_1.ProjectRoleFromJSON)(json['role']),
+        'message': json['message'],
+        'status': (0, RequestStatus_1.RequestStatusFromJSON)(json['status']),
+        'reviewerUsername': json['reviewerUsername'],
+        'createdAt': (new Date(json['createdAt'])),
+        'expiry': (new Date(json['expiry'])),
+    };
+}
+exports.ProjectAccessRequestFromJSONTyped = ProjectAccessRequestFromJSONTyped;
+function ProjectAccessRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'username': value.username,
+        'projectId': value.projectId,
+        'role': (0, ProjectRole_1.ProjectRoleToJSON)(value.role),
+        'message': value.message,
+        'status': (0, RequestStatus_1.RequestStatusToJSON)(value.status),
+        'reviewerUsername': value.reviewerUsername,
+        'createdAt': (value.createdAt.toISOString()),
+        'expiry': (value.expiry.toISOString()),
+    };
+}
+exports.ProjectAccessRequestToJSON = ProjectAccessRequestToJSON;

package/dist/models/ProjectSettings.d.ts

@@ -106,6 +106,12 @@ export interface ProjectSettings {
      * @memberof ProjectSettings
      */
     kmsArn?: string | null;
+    /**
+     * Enables the project to be discoverable by other users
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    isDiscoverable?: boolean | null;
 }
 /**
  * Check if a given object implements the ProjectSettings interface.

package/dist/models/ProjectSettings.js

@@ -50,6 +50,7 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
         'batchSubnets': !(0, runtime_1.exists)(json, 'batchSubnets') ? undefined : json['batchSubnets'],
         'sagemakerSubnets': !(0, runtime_1.exists)(json, 'sagemakerSubnets') ? undefined : json['sagemakerSubnets'],
         'kmsArn': !(0, runtime_1.exists)(json, 'kmsArn') ? undefined : json['kmsArn'],
+        'isDiscoverable': !(0, runtime_1.exists)(json, 'isDiscoverable') ? undefined : json['isDiscoverable'],
     };
 }
 exports.ProjectSettingsFromJSONTyped = ProjectSettingsFromJSONTyped;
@@ -76,6 +77,7 @@ function ProjectSettingsToJSON(value) {
         'batchSubnets': value.batchSubnets,
         'sagemakerSubnets': value.sagemakerSubnets,
         'kmsArn': value.kmsArn,
+        'isDiscoverable': value.isDiscoverable,
     };
 }
 exports.ProjectSettingsToJSON = ProjectSettingsToJSON;

package/dist/models/RequestStatus.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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
+ * @enum {string}
+ */
+export declare enum RequestStatus {
+    Pending = "PENDING",
+    Accepted = "ACCEPTED",
+    Denied = "DENIED"
+}
+export declare function RequestStatusFromJSON(json: any): RequestStatus;
+export declare function RequestStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequestStatus;
+export declare function RequestStatusToJSON(value?: RequestStatus | null): any;

package/dist/models/RequestStatus.js

@@ -0,0 +1,39 @@
+"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.RequestStatusToJSON = exports.RequestStatusFromJSONTyped = exports.RequestStatusFromJSON = exports.RequestStatus = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var RequestStatus;
+(function (RequestStatus) {
+    RequestStatus["Pending"] = "PENDING";
+    RequestStatus["Accepted"] = "ACCEPTED";
+    RequestStatus["Denied"] = "DENIED";
+})(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
+function RequestStatusFromJSON(json) {
+    return RequestStatusFromJSONTyped(json, false);
+}
+exports.RequestStatusFromJSON = RequestStatusFromJSON;
+function RequestStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.RequestStatusFromJSONTyped = RequestStatusFromJSONTyped;
+function RequestStatusToJSON(value) {
+    return value;
+}
+exports.RequestStatusToJSON = RequestStatusToJSON;

package/dist/models/Sample.d.ts

@@ -32,27 +32,27 @@ export interface Sample {
      * @type {{ [key: string]: any; }}
      * @memberof Sample
      */
-    metadata: {
+    metadata?: {
         [key: string]: any;
-    };
+    } | null;
     /**
      *
      * @type {Array<string>}
      * @memberof Sample
      */
-    datasetIds: Array<string>;
+    datasetIds?: Array<string> | null;
     /**
      *
      * @type {Date}
      * @memberof Sample
      */
-    createdAt: Date;
+    createdAt?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof Sample
      */
-    updatedAt: Date;
+    updatedAt?: Date | null;
 }
 /**
  * Check if a given object implements the Sample interface.

package/dist/models/Sample.js

@@ -14,6 +14,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SampleToJSON = exports.SampleFromJSONTyped = exports.SampleFromJSON = exports.instanceOfSample = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the Sample interface.
  */
@@ -21,10 +22,6 @@ function instanceOfSample(value) {
     var isInstance = true;
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "metadata" in value;
-    isInstance = isInstance && "datasetIds" in value;
-    isInstance = isInstance && "createdAt" in value;
-    isInstance = isInstance && "updatedAt" in value;
     return isInstance;
 }
 exports.instanceOfSample = instanceOfSample;
@@ -39,10 +36,10 @@ function SampleFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
-        'metadata': json['metadata'],
-        'datasetIds': json['datasetIds'],
-        'createdAt': (new Date(json['createdAt'])),
-        'updatedAt': (new Date(json['updatedAt'])),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+        'datasetIds': !(0, runtime_1.exists)(json, 'datasetIds') ? undefined : json['datasetIds'],
+        'createdAt': !(0, runtime_1.exists)(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
+        'updatedAt': !(0, runtime_1.exists)(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
     };
 }
 exports.SampleFromJSONTyped = SampleFromJSONTyped;
@@ -58,8 +55,8 @@ function SampleToJSON(value) {
         'name': value.name,
         'metadata': value.metadata,
         'datasetIds': value.datasetIds,
-        'createdAt': (value.createdAt.toISOString()),
-        'updatedAt': (value.updatedAt.toISOString()),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),
     };
 }
 exports.SampleToJSON = SampleToJSON;

package/dist/models/index.d.ts

@@ -1,6 +1,7 @@
 export * from './AWSCredentials';
 export * from './AccessType';
 export * from './AllowedDataType';
+export * from './ApproveProjectAccessRequest';
 export * from './AuditEvent';
 export * from './AuthInfo';
 export * from './BillingAccount';
@@ -12,6 +13,7 @@ export * from './CloudAccountType';
 export * from './ColumnDefinition';
 export * from './Contact';
 export * from './CreateNotebookInstanceRequest';
+export * from './CreateProjectAccessRequest';
 export * from './CreateReferenceRequest';
 export * from './CreateResponse';
 export * from './CustomPipelineSettings';
@@ -49,6 +51,7 @@ export * from './PortalErrorResponse';
 export * from './Process';
 export * from './ProcessDetail';
 export * from './Project';
+export * from './ProjectAccessRequest';
 export * from './ProjectDetail';
 export * from './ProjectMetrics';
 export * from './ProjectRequest';
@@ -58,6 +61,7 @@ export * from './ProjectUser';
 export * from './Reference';
 export * from './ReferenceType';
 export * from './RepositoryType';
+export * from './RequestStatus';
 export * from './ResourcesInfo';
 export * from './RunAnalysisRequest';
 export * from './Sample';

package/dist/models/index.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AWSCredentials"), exports);
 __exportStar(require("./AccessType"), exports);
 __exportStar(require("./AllowedDataType"), exports);
+__exportStar(require("./ApproveProjectAccessRequest"), exports);
 __exportStar(require("./AuditEvent"), exports);
 __exportStar(require("./AuthInfo"), exports);
 __exportStar(require("./BillingAccount"), exports);
@@ -30,6 +31,7 @@ __exportStar(require("./CloudAccountType"), exports);
 __exportStar(require("./ColumnDefinition"), exports);
 __exportStar(require("./Contact"), exports);
 __exportStar(require("./CreateNotebookInstanceRequest"), exports);
+__exportStar(require("./CreateProjectAccessRequest"), exports);
 __exportStar(require("./CreateReferenceRequest"), exports);
 __exportStar(require("./CreateResponse"), exports);
 __exportStar(require("./CustomPipelineSettings"), exports);
@@ -67,6 +69,7 @@ __exportStar(require("./PortalErrorResponse"), exports);
 __exportStar(require("./Process"), exports);
 __exportStar(require("./ProcessDetail"), exports);
 __exportStar(require("./Project"), exports);
+__exportStar(require("./ProjectAccessRequest"), exports);
 __exportStar(require("./ProjectDetail"), exports);
 __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectRequest"), exports);
@@ -76,6 +79,7 @@ __exportStar(require("./ProjectUser"), exports);
 __exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./RepositoryType"), exports);
+__exportStar(require("./RequestStatus"), exports);
 __exportStar(require("./ResourcesInfo"), exports);
 __exportStar(require("./RunAnalysisRequest"), exports);
 __exportStar(require("./Sample"), exports);

package/package.json

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

package/src/apis/AuditApi.ts

@@ -27,7 +27,9 @@ export interface GetEventRequest {
 }
 
 export interface ListEventsRequest {
-    username: string;
+    username?: string;
+    entityType?: ListEventsEntityTypeEnum;
+    entityId?: string;
 }
 
 /**
@@ -72,16 +74,20 @@ export class AuditApi extends runtime.BaseAPI {
      * List audit events
      */
     async listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AuditEvent>>> {
-        if (requestParameters.username === null || requestParameters.username === undefined) {
-            throw new runtime.RequiredError('username','Required parameter requestParameters.username was null or undefined when calling listEvents.');
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters.username !== undefined) {
             queryParameters['username'] = requestParameters.username;
         }
 
+        if (requestParameters.entityType !== undefined) {
+            queryParameters['entityType'] = requestParameters.entityType;
+        }
+
+        if (requestParameters.entityId !== undefined) {
+            queryParameters['entityId'] = requestParameters.entityId;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
@@ -98,9 +104,24 @@ export class AuditApi extends runtime.BaseAPI {
      * Gets a list of audit events
      * List audit events
      */
-    async listEvents(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEvent>> {
+    async listEvents(requestParameters: ListEventsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEvent>> {
         const response = await this.listEventsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
 }
+
+/**
+  * @export
+  * @enum {string}
+  */
+export enum ListEventsEntityTypeEnum {
+    Project = 'Project',
+    Sample = 'Sample',
+    Dataset = 'Dataset',
+    User = 'User',
+    BillingAccount = 'BillingAccount',
+    Process = 'Process',
+    NotebookInstance = 'NotebookInstance',
+    UserProjectAssignment = 'UserProjectAssignment'
+}