@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/esm/models/PortalErrorResponse.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+import { ErrorMessageFromJSON, ErrorMessageToJSON, } from './ErrorMessage';
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+export 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;
+}
+export function PortalErrorResponseFromJSON(json) {
+    return PortalErrorResponseFromJSONTyped(json, false);
+}
+export 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(ErrorMessageFromJSON)),
+    };
+}
+export 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(ErrorMessageToJSON)),
+    };
+}

package/dist/esm/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/{src/models/Process.ts → dist/esm/models/Process.js}

@@ -11,141 +11,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-import { exists, mapValues } from '../runtime';
-import type { Executor } from './Executor';
-import {
-    ExecutorFromJSON,
-    ExecutorFromJSONTyped,
-    ExecutorToJSON,
-} 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;
-}
-
+import { exists } from '../runtime';
+import { ExecutorFromJSON, ExecutorToJSON, } from './Executor';
 /**
  * Check if a given object implements the Process interface.
  */
-export function instanceOfProcess(value: object): boolean {
+export function instanceOfProcess(value) {
     let isInstance = true;
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
@@ -159,20 +30,16 @@ export function instanceOfProcess(value: object): boolean {
     isInstance = isInstance && "allowMultipleSources" in value;
     isInstance = isInstance && "usesSampleSheet" in value;
     isInstance = isInstance && "isArchived" in value;
-
     return isInstance;
 }
-
-export function ProcessFromJSON(json: any): Process {
+export function ProcessFromJSON(json) {
     return ProcessFromJSONTyped(json, false);
 }
-
-export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): Process {
+export function ProcessFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
-        
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
@@ -194,8 +61,7 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
     };
 }
-
-export function ProcessToJSON(value?: Process | null): any {
+export function ProcessToJSON(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -203,7 +69,6 @@ export function ProcessToJSON(value?: Process | null): any {
         return null;
     }
     return {
-        
         'id': value.id,
         'name': value.name,
         'description': value.description,
@@ -225,4 +90,3 @@ export function ProcessToJSON(value?: Process | null): any {
         'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
     };
 }
-

package/dist/esm/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/esm/models/ProcessDetail.js

@@ -0,0 +1,101 @@
+/* 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.
+ */
+import { exists } from '../runtime';
+import { CustomPipelineSettingsFromJSON, CustomPipelineSettingsToJSON, } from './CustomPipelineSettings';
+import { ExecutorFromJSON, ExecutorToJSON, } from './Executor';
+import { FileMappingRuleFromJSON, FileMappingRuleToJSON, } from './FileMappingRule';
+import { PipelineCodeFromJSON, PipelineCodeToJSON, } from './PipelineCode';
+/**
+ * Check if a given object implements the ProcessDetail interface.
+ */
+export 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;
+}
+export function ProcessDetailFromJSON(json) {
+    return ProcessDetailFromJSONTyped(json, false);
+}
+export 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': ExecutorFromJSON(json['executor']),
+        'category': !exists(json, 'category') ? undefined : json['category'],
+        'pipelineType': !exists(json, 'pipelineType') ? undefined : json['pipelineType'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
+        'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
+        'pipelineCode': !exists(json, 'pipelineCode') ? undefined : PipelineCodeFromJSON(json['pipelineCode']),
+        'owner': !exists(json, 'owner') ? undefined : json['owner'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
+        'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
+        'fileMappingRules': !exists(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRuleFromJSON)),
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+export 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': ExecutorToJSON(value.executor),
+        'category': value.category,
+        'pipelineType': value.pipelineType,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'pipelineCode': PipelineCodeToJSON(value.pipelineCode),
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
+        'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
+        'isArchived': value.isArchived,
+        'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
+        'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRuleToJSON)),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+    };
+}