@cirrobio/api-client 0.9.0 → 0.9.2

package/dist/models/ProcessDetail.d.ts

@@ -0,0 +1,161 @@
+/**
+ * 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 { CustomPipelineSettings } from './CustomPipelineSettings';
+import type { Executor } from './Executor';
+import type { FileMappingRule } from './FileMappingRule';
+import type { PipelineCode } from './PipelineCode';
+/**
+ * Identifies a data type or pipeline in Cirro
+ * @export
+ * @interface ProcessDetail
+ */
+export interface ProcessDetail {
+    /**
+     * Unique ID of the Process
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    id: string;
+    /**
+     * Friendly name for the process
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    name: string;
+    /**
+     * Description of the process
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    description: string;
+    /**
+     * Name of the data type this pipeline produces (if it is not defined, use the name)
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    dataType: string;
+    /**
+     *
+     * @type {Executor}
+     * @memberof ProcessDetail
+     */
+    executor: Executor;
+    /**
+     * Category of the process
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    category?: string;
+    /**
+     * Type of pipeline
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    pipelineType?: string;
+    /**
+     * IDs of pipelines that can be run downstream
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    childProcessIds: Array<string>;
+    /**
+     * IDs of processes that can run this pipeline
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    parentProcessIds: Array<string>;
+    /**
+     * Link to process documentation
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    documentationUrl?: string;
+    /**
+     * Description of the files to be uploaded (optional)
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    fileRequirementsMessage?: string;
+    /**
+     *
+     * @type {PipelineCode}
+     * @memberof ProcessDetail
+     */
+    pipelineCode?: PipelineCode | null;
+    /**
+     * Username of the pipeline creator (blank if Cirro curated)
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    owner?: string | null;
+    /**
+     * Projects that can run this process
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    linkedProjectIds: Array<string>;
+    /**
+     * Whether the process is shared with the tenant
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    isTenantWide: boolean;
+    /**
+     * Whether the pipeline is allowed to have multiple dataset sources
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    allowMultipleSources: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    usesSampleSheet: boolean;
+    /**
+     * Whether the process is marked as archived
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    isArchived: boolean;
+    /**
+     *
+     * @type {CustomPipelineSettings}
+     * @memberof ProcessDetail
+     */
+    customSettings?: CustomPipelineSettings | null;
+    /**
+     *
+     * @type {Array<FileMappingRule>}
+     * @memberof ProcessDetail
+     */
+    fileMappingRules?: Array<FileMappingRule> | null;
+    /**
+     * When the process was created (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof ProcessDetail
+     */
+    createdAt?: Date;
+    /**
+     * When the process was updated (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof ProcessDetail
+     */
+    updatedAt?: Date;
+}
+/**
+ * Check if a given object implements the ProcessDetail interface.
+ */
+export declare function instanceOfProcessDetail(value: object): boolean;
+export declare function ProcessDetailFromJSON(json: any): ProcessDetail;
+export declare function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDetail;
+export declare function ProcessDetailToJSON(value?: ProcessDetail | null): any;

package/dist/models/ProcessDetail.js

@@ -0,0 +1,108 @@
+"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.ProcessDetailToJSON = exports.ProcessDetailFromJSONTyped = exports.ProcessDetailFromJSON = exports.instanceOfProcessDetail = void 0;
+const runtime_1 = require("../runtime");
+const CustomPipelineSettings_1 = require("./CustomPipelineSettings");
+const Executor_1 = require("./Executor");
+const FileMappingRule_1 = require("./FileMappingRule");
+const PipelineCode_1 = require("./PipelineCode");
+/**
+ * Check if a given object implements the ProcessDetail interface.
+ */
+function instanceOfProcessDetail(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "dataType" in value;
+    isInstance = isInstance && "executor" in value;
+    isInstance = isInstance && "childProcessIds" in value;
+    isInstance = isInstance && "parentProcessIds" in value;
+    isInstance = isInstance && "linkedProjectIds" in value;
+    isInstance = isInstance && "isTenantWide" in value;
+    isInstance = isInstance && "allowMultipleSources" in value;
+    isInstance = isInstance && "usesSampleSheet" in value;
+    isInstance = isInstance && "isArchived" in value;
+    return isInstance;
+}
+exports.instanceOfProcessDetail = instanceOfProcessDetail;
+function ProcessDetailFromJSON(json) {
+    return ProcessDetailFromJSONTyped(json, false);
+}
+exports.ProcessDetailFromJSON = ProcessDetailFromJSON;
+function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'dataType': json['dataType'],
+        'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
+        'category': !(0, runtime_1.exists)(json, 'category') ? undefined : json['category'],
+        'pipelineType': !(0, runtime_1.exists)(json, 'pipelineType') ? undefined : json['pipelineType'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
+        'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
+        'pipelineCode': !(0, runtime_1.exists)(json, 'pipelineCode') ? undefined : (0, PipelineCode_1.PipelineCodeFromJSON)(json['pipelineCode']),
+        'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
+        'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
+        'fileMappingRules': !(0, runtime_1.exists)(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRule_1.FileMappingRuleFromJSON)),
+        'createdAt': !(0, runtime_1.exists)(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !(0, runtime_1.exists)(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+exports.ProcessDetailFromJSONTyped = ProcessDetailFromJSONTyped;
+function ProcessDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'dataType': value.dataType,
+        'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
+        'category': value.category,
+        'pipelineType': value.pipelineType,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'pipelineCode': (0, PipelineCode_1.PipelineCodeToJSON)(value.pipelineCode),
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
+        'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
+        'isArchived': value.isArchived,
+        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
+        'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRule_1.FileMappingRuleToJSON)),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+    };
+}
+exports.ProcessDetailToJSON = ProcessDetailToJSON;

package/dist/models/Project.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 { Status } from './Status';
+import type { Tag } from './Tag';
+/**
+ *
+ * @export
+ * @interface Project
+ */
+export interface Project {
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    description: string;
+    /**
+     *
+     * @type {Status}
+     * @memberof Project
+     */
+    status: Status;
+    /**
+     *
+     * @type {Array<Tag>}
+     * @memberof Project
+     */
+    tags: Array<Tag>;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    organization: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Project
+     */
+    classificationIds: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    billingAccountId: string;
+}
+/**
+ * Check if a given object implements the Project interface.
+ */
+export declare function instanceOfProject(value: object): boolean;
+export declare function ProjectFromJSON(json: any): Project;
+export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
+export declare function ProjectToJSON(value?: Project | null): any;

package/dist/models/Project.js

@@ -0,0 +1,73 @@
+"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.ProjectToJSON = exports.ProjectFromJSONTyped = exports.ProjectFromJSON = exports.instanceOfProject = void 0;
+const Status_1 = require("./Status");
+const Tag_1 = require("./Tag");
+/**
+ * Check if a given object implements the Project interface.
+ */
+function instanceOfProject(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "tags" in value;
+    isInstance = isInstance && "organization" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "billingAccountId" in value;
+    return isInstance;
+}
+exports.instanceOfProject = instanceOfProject;
+function ProjectFromJSON(json) {
+    return ProjectFromJSONTyped(json, false);
+}
+exports.ProjectFromJSON = ProjectFromJSON;
+function ProjectFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'status': (0, Status_1.StatusFromJSON)(json['status']),
+        'tags': (json['tags'].map(Tag_1.TagFromJSON)),
+        'organization': json['organization'],
+        'classificationIds': json['classificationIds'],
+        'billingAccountId': json['billingAccountId'],
+    };
+}
+exports.ProjectFromJSONTyped = ProjectFromJSONTyped;
+function ProjectToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'status': (0, Status_1.StatusToJSON)(value.status),
+        'tags': (value.tags.map(Tag_1.TagToJSON)),
+        'organization': value.organization,
+        'classificationIds': value.classificationIds,
+        'billingAccountId': value.billingAccountId,
+    };
+}
+exports.ProjectToJSON = ProjectToJSON;

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;
+const ProjectRole_1 = require("./ProjectRole");
+const RequestStatus_1 = require("./RequestStatus");
+/**
+ * Check if a given object implements the ProjectAccessRequest interface.
+ */
+function instanceOfProjectAccessRequest(value) {
+    let 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/ProjectAccessType.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 ProjectAccessType {
+    DatasetUpload = "DATASET_UPLOAD",
+    SharedDatasetDownload = "SHARED_DATASET_DOWNLOAD",
+    SamplesheetUpload = "SAMPLESHEET_UPLOAD",
+    ReferenceUpload = "REFERENCE_UPLOAD",
+    ProjectDownload = "PROJECT_DOWNLOAD"
+}
+export declare function ProjectAccessTypeFromJSON(json: any): ProjectAccessType;
+export declare function ProjectAccessTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectAccessType;
+export declare function ProjectAccessTypeToJSON(value?: ProjectAccessType | null): any;

package/dist/models/ProjectAccessType.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.ProjectAccessTypeToJSON = exports.ProjectAccessTypeFromJSONTyped = exports.ProjectAccessTypeFromJSON = exports.ProjectAccessType = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var ProjectAccessType;
+(function (ProjectAccessType) {
+    ProjectAccessType["DatasetUpload"] = "DATASET_UPLOAD";
+    ProjectAccessType["SharedDatasetDownload"] = "SHARED_DATASET_DOWNLOAD";
+    ProjectAccessType["SamplesheetUpload"] = "SAMPLESHEET_UPLOAD";
+    ProjectAccessType["ReferenceUpload"] = "REFERENCE_UPLOAD";
+    ProjectAccessType["ProjectDownload"] = "PROJECT_DOWNLOAD";
+})(ProjectAccessType = exports.ProjectAccessType || (exports.ProjectAccessType = {}));
+function ProjectAccessTypeFromJSON(json) {
+    return ProjectAccessTypeFromJSONTyped(json, false);
+}
+exports.ProjectAccessTypeFromJSON = ProjectAccessTypeFromJSON;
+function ProjectAccessTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.ProjectAccessTypeFromJSONTyped = ProjectAccessTypeFromJSONTyped;
+function ProjectAccessTypeToJSON(value) {
+    return value;
+}
+exports.ProjectAccessTypeToJSON = ProjectAccessTypeToJSON;