@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/models/ProjectRequest.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 ProjectRequest
+ */
+export interface ProjectRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRequest
+     */
+    description: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ProjectRequest
+     */
+    classificationIds: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRequest
+     */
+    billingInfo: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRequest
+     */
+    adminUsername: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRequest
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the ProjectRequest interface.
+ */
+export declare function instanceOfProjectRequest(value: object): boolean;
+export declare function ProjectRequestFromJSON(json: any): ProjectRequest;
+export declare function ProjectRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectRequest;
+export declare function ProjectRequestToJSON(value?: ProjectRequest | null): any;

package/dist/models/ProjectRequest.js

@@ -0,0 +1,65 @@
+"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.ProjectRequestToJSON = exports.ProjectRequestFromJSONTyped = exports.ProjectRequestFromJSON = exports.instanceOfProjectRequest = void 0;
+/**
+ * Check if a given object implements the ProjectRequest interface.
+ */
+function instanceOfProjectRequest(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "billingInfo" in value;
+    isInstance = isInstance && "adminUsername" in value;
+    isInstance = isInstance && "message" in value;
+    return isInstance;
+}
+exports.instanceOfProjectRequest = instanceOfProjectRequest;
+function ProjectRequestFromJSON(json) {
+    return ProjectRequestFromJSONTyped(json, false);
+}
+exports.ProjectRequestFromJSON = ProjectRequestFromJSON;
+function ProjectRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'],
+        'classificationIds': json['classificationIds'],
+        'billingInfo': json['billingInfo'],
+        'adminUsername': json['adminUsername'],
+        'message': json['message'],
+    };
+}
+exports.ProjectRequestFromJSONTyped = ProjectRequestFromJSONTyped;
+function ProjectRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'classificationIds': value.classificationIds,
+        'billingInfo': value.billingInfo,
+        'adminUsername': value.adminUsername,
+        'message': value.message,
+    };
+}
+exports.ProjectRequestToJSON = ProjectRequestToJSON;

package/dist/models/ProjectRequirement.d.ts

@@ -0,0 +1,163 @@
+/**
+ * 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 { GovernanceContact } from './GovernanceContact';
+import type { GovernanceExpiryType } from './GovernanceExpiryType';
+import type { GovernanceFile } from './GovernanceFile';
+import type { GovernanceScope } from './GovernanceScope';
+import type { GovernanceTrainingVerification } from './GovernanceTrainingVerification';
+import type { GovernanceType } from './GovernanceType';
+/**
+ *
+ * @export
+ * @interface ProjectRequirement
+ */
+export interface ProjectRequirement {
+    /**
+     * The unique identifier for the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    id: string;
+    /**
+     * The name of the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    name: string;
+    /**
+     * A brief description of the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    description: string;
+    /**
+     *
+     * @type {GovernanceType}
+     * @memberof ProjectRequirement
+     */
+    type: GovernanceType;
+    /**
+     * 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}
+     * @memberof ProjectRequirement
+     */
+    scope: GovernanceScope;
+    /**
+     *
+     * @type {GovernanceScope}
+     * @memberof ProjectRequirement
+     */
+    acceptance?: GovernanceScope | null;
+    /**
+     * The governance contacts assigned to the requirement.
+     * @type {Array<GovernanceContact>}
+     * @memberof ProjectRequirement
+     */
+    contacts: Array<GovernanceContact>;
+    /**
+     * The date of enactment for the requirement
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    enactmentDate?: Date | null;
+    /**
+     *
+     * @type {GovernanceExpiryType}
+     * @memberof ProjectRequirement
+     */
+    expirationType?: GovernanceExpiryType;
+    /**
+     * The number of days for a relative to completion expiration
+     * @type {number}
+     * @memberof ProjectRequirement
+     */
+    expirationDaysAfterCompletion?: number | null;
+    /**
+     * The date of expiration for the requirement
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    expirationDate?: Date | null;
+    /**
+     * Optional files with extra information, e.g. templates for documents, links, etc
+     * @type {Array<GovernanceFile>}
+     * @memberof ProjectRequirement
+     */
+    supplementalDocs?: Array<GovernanceFile> | null;
+    /**
+     *
+     * @type {GovernanceFile}
+     * @memberof ProjectRequirement
+     */
+    file?: GovernanceFile | null;
+    /**
+     *
+     * @type {GovernanceScope}
+     * @memberof ProjectRequirement
+     */
+    authorship?: GovernanceScope | null;
+    /**
+     *
+     * @type {GovernanceTrainingVerification}
+     * @memberof ProjectRequirement
+     */
+    verificationMethod?: GovernanceTrainingVerification | null;
+    /**
+     * Whether the current user has fulfilled the requirement for this project
+     * @type {boolean}
+     * @memberof ProjectRequirement
+     */
+    isFulfilled: boolean;
+    /**
+     * The id for the requirement fulfillment
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentId?: string | null;
+    /**
+     * The date the requirement was fulfilled by the user
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentDate?: Date | null;
+    /**
+     * The optional file uploaded to fulfill the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentFile?: string | null;
+    /**
+     * The path to the optional fulfillment file
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentPath?: string | null;
+}
+/**
+ * Check if a given object implements the ProjectRequirement interface.
+ */
+export declare function instanceOfProjectRequirement(value: object): boolean;
+export declare function ProjectRequirementFromJSON(json: any): ProjectRequirement;
+export declare function ProjectRequirementFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectRequirement;
+export declare function ProjectRequirementToJSON(value?: ProjectRequirement | null): any;

package/dist/models/ProjectRequirement.js

@@ -0,0 +1,107 @@
+"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.ProjectRequirementToJSON = exports.ProjectRequirementFromJSONTyped = exports.ProjectRequirementFromJSON = exports.instanceOfProjectRequirement = void 0;
+const runtime_1 = require("../runtime");
+const GovernanceContact_1 = require("./GovernanceContact");
+const GovernanceExpiryType_1 = require("./GovernanceExpiryType");
+const GovernanceFile_1 = require("./GovernanceFile");
+const GovernanceScope_1 = require("./GovernanceScope");
+const GovernanceTrainingVerification_1 = require("./GovernanceTrainingVerification");
+const GovernanceType_1 = require("./GovernanceType");
+/**
+ * Check if a given object implements the ProjectRequirement interface.
+ */
+function instanceOfProjectRequirement(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    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;
+    return isInstance;
+}
+exports.instanceOfProjectRequirement = instanceOfProjectRequirement;
+function ProjectRequirementFromJSON(json) {
+    return ProjectRequirementFromJSONTyped(json, false);
+}
+exports.ProjectRequirementFromJSON = ProjectRequirementFromJSON;
+function ProjectRequirementFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'type': (0, GovernanceType_1.GovernanceTypeFromJSON)(json['type']),
+        'path': json['path'],
+        'supplementalPath': json['supplementalPath'],
+        'scope': (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['scope']),
+        'acceptance': !(0, runtime_1.exists)(json, 'acceptance') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['acceptance']),
+        'contacts': (json['contacts'].map(GovernanceContact_1.GovernanceContactFromJSON)),
+        'enactmentDate': !(0, runtime_1.exists)(json, 'enactmentDate') ? undefined : (json['enactmentDate'] === null ? null : new Date(json['enactmentDate'])),
+        'expirationType': !(0, runtime_1.exists)(json, 'expirationType') ? undefined : (0, GovernanceExpiryType_1.GovernanceExpiryTypeFromJSON)(json['expirationType']),
+        'expirationDaysAfterCompletion': !(0, runtime_1.exists)(json, 'expirationDaysAfterCompletion') ? undefined : json['expirationDaysAfterCompletion'],
+        'expirationDate': !(0, runtime_1.exists)(json, 'expirationDate') ? undefined : (json['expirationDate'] === null ? null : new Date(json['expirationDate'])),
+        'supplementalDocs': !(0, runtime_1.exists)(json, 'supplementalDocs') ? undefined : (json['supplementalDocs'] === null ? null : json['supplementalDocs'].map(GovernanceFile_1.GovernanceFileFromJSON)),
+        'file': !(0, runtime_1.exists)(json, 'file') ? undefined : (0, GovernanceFile_1.GovernanceFileFromJSON)(json['file']),
+        'authorship': !(0, runtime_1.exists)(json, 'authorship') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['authorship']),
+        'verificationMethod': !(0, runtime_1.exists)(json, 'verificationMethod') ? undefined : (0, GovernanceTrainingVerification_1.GovernanceTrainingVerificationFromJSON)(json['verificationMethod']),
+        'isFulfilled': json['isFulfilled'],
+        'fulfillmentId': !(0, runtime_1.exists)(json, 'fulfillmentId') ? undefined : json['fulfillmentId'],
+        'fulfillmentDate': !(0, runtime_1.exists)(json, 'fulfillmentDate') ? undefined : (json['fulfillmentDate'] === null ? null : new Date(json['fulfillmentDate'])),
+        'fulfillmentFile': !(0, runtime_1.exists)(json, 'fulfillmentFile') ? undefined : json['fulfillmentFile'],
+        'fulfillmentPath': !(0, runtime_1.exists)(json, 'fulfillmentPath') ? undefined : json['fulfillmentPath'],
+    };
+}
+exports.ProjectRequirementFromJSONTyped = ProjectRequirementFromJSONTyped;
+function ProjectRequirementToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'type': (0, GovernanceType_1.GovernanceTypeToJSON)(value.type),
+        'path': value.path,
+        'supplementalPath': value.supplementalPath,
+        'scope': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.scope),
+        'acceptance': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.acceptance),
+        'contacts': (value.contacts.map(GovernanceContact_1.GovernanceContactToJSON)),
+        'enactmentDate': value.enactmentDate === undefined ? undefined : (value.enactmentDate === null ? null : value.enactmentDate.toISOString()),
+        'expirationType': (0, GovernanceExpiryType_1.GovernanceExpiryTypeToJSON)(value.expirationType),
+        'expirationDaysAfterCompletion': value.expirationDaysAfterCompletion,
+        'expirationDate': value.expirationDate === undefined ? undefined : (value.expirationDate === null ? null : value.expirationDate.toISOString()),
+        'supplementalDocs': value.supplementalDocs === undefined ? undefined : (value.supplementalDocs === null ? null : value.supplementalDocs.map(GovernanceFile_1.GovernanceFileToJSON)),
+        'file': (0, GovernanceFile_1.GovernanceFileToJSON)(value.file),
+        'authorship': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.authorship),
+        'verificationMethod': (0, GovernanceTrainingVerification_1.GovernanceTrainingVerificationToJSON)(value.verificationMethod),
+        'isFulfilled': value.isFulfilled,
+        'fulfillmentId': value.fulfillmentId,
+        'fulfillmentDate': value.fulfillmentDate === undefined ? undefined : (value.fulfillmentDate === null ? null : value.fulfillmentDate.toISOString()),
+        'fulfillmentFile': value.fulfillmentFile,
+        'fulfillmentPath': value.fulfillmentPath,
+    };
+}
+exports.ProjectRequirementToJSON = ProjectRequirementToJSON;

package/dist/models/ProjectRole.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 ProjectRole {
+    Owner = "OWNER",
+    Admin = "ADMIN",
+    Contributor = "CONTRIBUTOR",
+    Collaborator = "COLLABORATOR",
+    None = "NONE"
+}
+export declare function ProjectRoleFromJSON(json: any): ProjectRole;
+export declare function ProjectRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectRole;
+export declare function ProjectRoleToJSON(value?: ProjectRole | null): any;

package/dist/models/ProjectRole.js

@@ -0,0 +1,41 @@
+"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.ProjectRoleToJSON = exports.ProjectRoleFromJSONTyped = exports.ProjectRoleFromJSON = exports.ProjectRole = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var ProjectRole;
+(function (ProjectRole) {
+    ProjectRole["Owner"] = "OWNER";
+    ProjectRole["Admin"] = "ADMIN";
+    ProjectRole["Contributor"] = "CONTRIBUTOR";
+    ProjectRole["Collaborator"] = "COLLABORATOR";
+    ProjectRole["None"] = "NONE";
+})(ProjectRole = exports.ProjectRole || (exports.ProjectRole = {}));
+function ProjectRoleFromJSON(json) {
+    return ProjectRoleFromJSONTyped(json, false);
+}
+exports.ProjectRoleFromJSON = ProjectRoleFromJSON;
+function ProjectRoleFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.ProjectRoleFromJSONTyped = ProjectRoleFromJSONTyped;
+function ProjectRoleToJSON(value) {
+    return value;
+}
+exports.ProjectRoleToJSON = ProjectRoleToJSON;

package/dist/models/ProjectSettings.d.ts

@@ -0,0 +1,140 @@
+/**
+ * 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 { BudgetPeriod } from './BudgetPeriod';
+/**
+ *
+ * @export
+ * @interface ProjectSettings
+ */
+export interface ProjectSettings {
+    /**
+     * Total allowed cost for the budget period
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    budgetAmount: number;
+    /**
+     *
+     * @type {BudgetPeriod}
+     * @memberof ProjectSettings
+     */
+    budgetPeriod: BudgetPeriod;
+    /**
+     * AMI ID for the DRAGEN compute environment (if enabled)
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    dragenAmi?: string | null;
+    /**
+     * Enables the default compute environment
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    enableCompute?: boolean;
+    /**
+     * Enables the DRAGEN compute environment
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    enableDragen?: boolean;
+    /**
+     * Enables the AWS Backup service for S3
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    enableBackup?: boolean;
+    /**
+     * Enables access to files over SFTP
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    enableSftp?: boolean;
+    /**
+     * Service quota limit for On Demand F1 instances
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    maxF1VCPU?: number;
+    /**
+     * Service quota limit for Spot instances
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    maxSpotVCPU?: number;
+    /**
+     * Service quota limit for GPU Spot instances
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    maxGPUVCPU?: number;
+    /**
+     * Days to keep deleted datasets before being permanently erased
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    retentionPolicyDays?: number;
+    /**
+     * Days to keep temporary storage space (workflow executor cache)
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    temporaryStorageLifetimeDays?: number;
+    /**
+     * List of service connections to enable
+     * @type {Array<string>}
+     * @memberof ProjectSettings
+     */
+    serviceConnections?: Array<string>;
+    /**
+     * VPC that the compute environment will use
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    vpcId?: string | null;
+    /**
+     * List of subnets that the compute environment will use
+     * @type {Array<string>}
+     * @memberof ProjectSettings
+     */
+    batchSubnets?: Array<string> | null;
+    /**
+     * List of subnets that the sagemaker instances will use
+     * @type {Array<string>}
+     * @memberof ProjectSettings
+     */
+    sagemakerSubnets?: Array<string> | null;
+    /**
+     * KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption will be used
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    kmsArn?: string | null;
+    /**
+     * Enables the project to be discoverable by other users
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    isDiscoverable?: boolean | null;
+    /**
+     * Enables the project to be shared with other projects
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    isShareable?: boolean | null;
+}
+/**
+ * Check if a given object implements the ProjectSettings interface.
+ */
+export declare function instanceOfProjectSettings(value: object): boolean;
+export declare function ProjectSettingsFromJSON(json: any): ProjectSettings;
+export declare function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectSettings;
+export declare function ProjectSettingsToJSON(value?: ProjectSettings | null): any;