@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/models/PaginatedResponseUserDto.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.PaginatedResponseUserDtoToJSON = exports.PaginatedResponseUserDtoFromJSONTyped = exports.PaginatedResponseUserDtoFromJSON = exports.instanceOfPaginatedResponseUserDto = void 0;
+const User_1 = require("./User");
+/**
+ * Check if a given object implements the PaginatedResponseUserDto interface.
+ */
+function instanceOfPaginatedResponseUserDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "data" in value;
+    isInstance = isInstance && "nextToken" in value;
+    return isInstance;
+}
+exports.instanceOfPaginatedResponseUserDto = instanceOfPaginatedResponseUserDto;
+function PaginatedResponseUserDtoFromJSON(json) {
+    return PaginatedResponseUserDtoFromJSONTyped(json, false);
+}
+exports.PaginatedResponseUserDtoFromJSON = PaginatedResponseUserDtoFromJSON;
+function PaginatedResponseUserDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(User_1.UserFromJSON)),
+        'nextToken': json['nextToken'],
+    };
+}
+exports.PaginatedResponseUserDtoFromJSONTyped = PaginatedResponseUserDtoFromJSONTyped;
+function PaginatedResponseUserDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': (value.data.map(User_1.UserToJSON)),
+        'nextToken': value.nextToken,
+    };
+}
+exports.PaginatedResponseUserDtoToJSON = PaginatedResponseUserDtoToJSON;

package/dist/models/PipelineCode.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { RepositoryType } from './RepositoryType';
+/**
+ * Used to describe the pipeline analysis code, not required for ingest processes
+ * @export
+ * @interface PipelineCode
+ */
+export interface PipelineCode {
+    /**
+     * GitHub repository which contains the workflow code
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    repositoryPath: string;
+    /**
+     * Branch, tag, or commit hash of the pipeline code
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    version: string;
+    /**
+     *
+     * @type {RepositoryType}
+     * @memberof PipelineCode
+     */
+    repositoryType: RepositoryType;
+    /**
+     * Main script for running the pipeline
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    entryPoint: string;
+}
+/**
+ * Check if a given object implements the PipelineCode interface.
+ */
+export declare function instanceOfPipelineCode(value: object): boolean;
+export declare function PipelineCodeFromJSON(json: any): PipelineCode;
+export declare function PipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCode;
+export declare function PipelineCodeToJSON(value?: PipelineCode | null): any;

package/dist/models/PipelineCode.js

@@ -0,0 +1,60 @@
+"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.PipelineCodeToJSON = exports.PipelineCodeFromJSONTyped = exports.PipelineCodeFromJSON = exports.instanceOfPipelineCode = void 0;
+const RepositoryType_1 = require("./RepositoryType");
+/**
+ * Check if a given object implements the PipelineCode interface.
+ */
+function instanceOfPipelineCode(value) {
+    let isInstance = true;
+    isInstance = isInstance && "repositoryPath" in value;
+    isInstance = isInstance && "version" in value;
+    isInstance = isInstance && "repositoryType" in value;
+    isInstance = isInstance && "entryPoint" in value;
+    return isInstance;
+}
+exports.instanceOfPipelineCode = instanceOfPipelineCode;
+function PipelineCodeFromJSON(json) {
+    return PipelineCodeFromJSONTyped(json, false);
+}
+exports.PipelineCodeFromJSON = PipelineCodeFromJSON;
+function PipelineCodeFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'repositoryPath': json['repositoryPath'],
+        'version': json['version'],
+        'repositoryType': (0, RepositoryType_1.RepositoryTypeFromJSON)(json['repositoryType']),
+        'entryPoint': json['entryPoint'],
+    };
+}
+exports.PipelineCodeFromJSONTyped = PipelineCodeFromJSONTyped;
+function PipelineCodeToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'repositoryPath': value.repositoryPath,
+        'version': value.version,
+        'repositoryType': (0, RepositoryType_1.RepositoryTypeToJSON)(value.repositoryType),
+        'entryPoint': value.entryPoint,
+    };
+}
+exports.PipelineCodeToJSON = PipelineCodeToJSON;

package/dist/models/PipelineCost.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 PipelineCost
+ */
+export interface PipelineCost {
+    /**
+     * The total cost of running the pipeline
+     * @type {number}
+     * @memberof PipelineCost
+     */
+    totalCost?: number | null;
+    /**
+     * Is this an estimate of the cost?
+     * @type {boolean}
+     * @memberof PipelineCost
+     */
+    isEstimate?: boolean;
+    /**
+     * Description of the cost calculation
+     * @type {string}
+     * @memberof PipelineCost
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the PipelineCost interface.
+ */
+export declare function instanceOfPipelineCost(value: object): boolean;
+export declare function PipelineCostFromJSON(json: any): PipelineCost;
+export declare function PipelineCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCost;
+export declare function PipelineCostToJSON(value?: PipelineCost | null): any;

package/dist/models/PipelineCost.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.PipelineCostToJSON = exports.PipelineCostFromJSONTyped = exports.PipelineCostFromJSON = exports.instanceOfPipelineCost = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the PipelineCost interface.
+ */
+function instanceOfPipelineCost(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfPipelineCost = instanceOfPipelineCost;
+function PipelineCostFromJSON(json) {
+    return PipelineCostFromJSONTyped(json, false);
+}
+exports.PipelineCostFromJSON = PipelineCostFromJSON;
+function PipelineCostFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'totalCost': !(0, runtime_1.exists)(json, 'totalCost') ? undefined : json['totalCost'],
+        'isEstimate': !(0, runtime_1.exists)(json, 'isEstimate') ? undefined : json['isEstimate'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+    };
+}
+exports.PipelineCostFromJSONTyped = PipelineCostFromJSONTyped;
+function PipelineCostToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'totalCost': value.totalCost,
+        'isEstimate': value.isEstimate,
+        'description': value.description,
+    };
+}
+exports.PipelineCostToJSON = PipelineCostToJSON;

package/dist/models/PortalErrorResponse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { ErrorMessage } from './ErrorMessage';
+/**
+ *
+ * @export
+ * @interface PortalErrorResponse
+ */
+export interface PortalErrorResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PortalErrorResponse
+     */
+    statusCode: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorDetail: string;
+    /**
+     *
+     * @type {Array<ErrorMessage>}
+     * @memberof PortalErrorResponse
+     */
+    errors: Array<ErrorMessage>;
+}
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+export declare function instanceOfPortalErrorResponse(value: object): boolean;
+export declare function PortalErrorResponseFromJSON(json: any): PortalErrorResponse;
+export declare function PortalErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalErrorResponse;
+export declare function PortalErrorResponseToJSON(value?: PortalErrorResponse | null): any;

package/dist/models/PortalErrorResponse.js

@@ -0,0 +1,60 @@
+"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.PortalErrorResponseToJSON = exports.PortalErrorResponseFromJSONTyped = exports.PortalErrorResponseFromJSON = exports.instanceOfPortalErrorResponse = void 0;
+const ErrorMessage_1 = require("./ErrorMessage");
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+function instanceOfPortalErrorResponse(value) {
+    let isInstance = true;
+    isInstance = isInstance && "statusCode" in value;
+    isInstance = isInstance && "errorCode" in value;
+    isInstance = isInstance && "errorDetail" in value;
+    isInstance = isInstance && "errors" in value;
+    return isInstance;
+}
+exports.instanceOfPortalErrorResponse = instanceOfPortalErrorResponse;
+function PortalErrorResponseFromJSON(json) {
+    return PortalErrorResponseFromJSONTyped(json, false);
+}
+exports.PortalErrorResponseFromJSON = PortalErrorResponseFromJSON;
+function PortalErrorResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'statusCode': json['statusCode'],
+        'errorCode': json['errorCode'],
+        'errorDetail': json['errorDetail'],
+        'errors': (json['errors'].map(ErrorMessage_1.ErrorMessageFromJSON)),
+    };
+}
+exports.PortalErrorResponseFromJSONTyped = PortalErrorResponseFromJSONTyped;
+function PortalErrorResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'statusCode': value.statusCode,
+        'errorCode': value.errorCode,
+        'errorDetail': value.errorDetail,
+        'errors': (value.errors.map(ErrorMessage_1.ErrorMessageToJSON)),
+    };
+}
+exports.PortalErrorResponseToJSON = PortalErrorResponseToJSON;

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

package/dist/models/Process.js

@@ -0,0 +1,99 @@
+"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.ProcessToJSON = exports.ProcessFromJSONTyped = exports.ProcessFromJSON = exports.instanceOfProcess = void 0;
+const runtime_1 = require("../runtime");
+const Executor_1 = require("./Executor");
+/**
+ * Check if a given object implements the Process interface.
+ */
+function instanceOfProcess(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.instanceOfProcess = instanceOfProcess;
+function ProcessFromJSON(json) {
+    return ProcessFromJSONTyped(json, false);
+}
+exports.ProcessFromJSON = ProcessFromJSON;
+function ProcessFromJSONTyped(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'],
+        'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
+        'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        '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'],
+        '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.ProcessFromJSONTyped = ProcessFromJSONTyped;
+function ProcessToJSON(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,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
+        'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
+        'isArchived': value.isArchived,
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+    };
+}
+exports.ProcessToJSON = ProcessToJSON;