@cirrobio/api-client 0.3.0 → 0.4.0

package/src/models/Process.ts

@@ -21,7 +21,7 @@ import {
 } from './Executor';
 
 /**
- * 
+ * Identifies a data type or pipeline in Cirro
  * @export
  * @interface Process
  */
@@ -39,17 +39,17 @@ export interface Process {
      */
     name: string;
     /**
-     * 
+     * Description of the process
      * @type {string}
      * @memberof Process
      */
-    description?: string;
+    description: string;
     /**
      * Name of the data type this pipeline produces (if it is not defined, use the name)
      * @type {string}
      * @memberof Process
      */
-    dataType?: string | null;
+    dataType: string;
     /**
      * 
      * @type {Executor}
@@ -61,15 +61,15 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    category: string;
+    category?: string;
     /**
      * Type of pipeline
      * @type {string}
      * @memberof Process
      */
-    pipelineType: string;
+    pipelineType?: string;
     /**
-     * Link to pipeline documentation
+     * Link to process documentation
      * @type {string}
      * @memberof Process
      */
@@ -85,43 +85,61 @@ export interface Process {
      * @type {Array<string>}
      * @memberof Process
      */
-    childProcessIds?: Array<string>;
+    childProcessIds: Array<string>;
     /**
-     * IDs of pipelines that can run this pipeline
+     * IDs of processes that can run this pipeline
      * @type {Array<string>}
      * @memberof Process
      */
-    parentProcessIds?: Array<string>;
+    parentProcessIds: Array<string>;
     /**
      * Username of the pipeline creator (blank if Cirro curated)
      * @type {string}
      * @memberof Process
      */
-    owner?: string;
+    owner?: string | null;
     /**
-     * Projects that can run this pipeline
+     * Projects that can run this process
      * @type {Array<string>}
      * @memberof Process
      */
-    linkedProjectIds?: Array<string>;
+    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;
+    allowMultipleSources: boolean;
     /**
      * Whether the pipeline uses the Cirro-provided sample sheet
      * @type {boolean}
      * @memberof Process
      */
-    usesSampleSheet?: boolean;
+    usesSampleSheet: boolean;
     /**
-     * Whether the pipeline is marked as archived
+     * Whether the process is marked as archived
      * @type {boolean}
      * @memberof Process
      */
-    isArchived?: boolean;
+    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;
 }
 
 /**
@@ -131,9 +149,16 @@ export function instanceOfProcess(value: object): boolean {
     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 && "category" in value;
-    isInstance = isInstance && "pipelineType" 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;
 }
@@ -150,20 +175,23 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         
         'id': json['id'],
         'name': json['name'],
-        'description': !exists(json, 'description') ? undefined : json['description'],
-        'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
+        'description': json['description'],
+        'dataType': json['dataType'],
         'executor': ExecutorFromJSON(json['executor']),
-        'category': json['category'],
-        'pipelineType': json['pipelineType'],
+        'category': !exists(json, 'category') ? undefined : json['category'],
+        'pipelineType': !exists(json, 'pipelineType') ? undefined : json['pipelineType'],
         'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
         'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
-        'childProcessIds': !exists(json, 'childProcessIds') ? undefined : json['childProcessIds'],
-        'parentProcessIds': !exists(json, 'parentProcessIds') ? undefined : json['parentProcessIds'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
         'owner': !exists(json, 'owner') ? undefined : json['owner'],
-        'linkedProjectIds': !exists(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
-        'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
-        'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
-        'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
     };
 }
 
@@ -189,9 +217,12 @@ export function ProcessToJSON(value?: Process | null): any {
         '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()),
     };
 }
 

package/src/models/ProcessDetail.ts

@@ -39,7 +39,7 @@ import {
 } from './PipelineCode';
 
 /**
- * 
+ * Identifies a data type or pipeline in Cirro
  * @export
  * @interface ProcessDetail
  */
@@ -57,7 +57,7 @@ export interface ProcessDetail {
      */
     name: string;
     /**
-     * 
+     * Description of the process
      * @type {string}
      * @memberof ProcessDetail
      */
@@ -67,7 +67,7 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    dataType?: string | null;
+    dataType: string;
     /**
      * 
      * @type {Executor}
@@ -93,23 +93,23 @@ export interface ProcessDetail {
      */
     childProcessIds: Array<string>;
     /**
-     * IDs of pipelines that can run this pipeline
+     * IDs of processes that can run this pipeline
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     parentProcessIds: Array<string>;
     /**
-     * Link to pipeline documentation
+     * Link to process documentation
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl?: string | null;
+    documentationUrl?: string;
     /**
      * Description of the files to be uploaded (optional)
      * @type {string}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage?: string | null;
+    fileRequirementsMessage?: string;
     /**
      * 
      * @type {PipelineCode}
@@ -123,29 +123,35 @@ export interface ProcessDetail {
      */
     owner?: string | null;
     /**
-     * Projects that can run this pipeline
+     * Projects that can run this process
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     linkedProjectIds: Array<string>;
     /**
-     * Whether the pipeline is available to all projects in the organization
+     * Whether the process is shared with the tenant
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    isTenantWide?: boolean;
+    isTenantWide: boolean;
     /**
      * Whether the pipeline is allowed to have multiple dataset sources
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    allowMultipleSources?: boolean;
+    allowMultipleSources: boolean;
     /**
      * Whether the pipeline uses the Cirro-provided sample sheet
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    usesSampleSheet?: boolean;
+    usesSampleSheet: boolean;
+    /**
+     * Whether the process is marked as archived
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    isArchived: boolean;
     /**
      * 
      * @type {CustomPipelineSettings}
@@ -153,17 +159,23 @@ export interface ProcessDetail {
      */
     customSettings?: CustomPipelineSettings | null;
     /**
-     * Whether the process is marked for removal
-     * @type {boolean}
+     * 
+     * @type {Array<FileMappingRule>}
      * @memberof ProcessDetail
      */
-    isArchived?: boolean;
+    fileMappingRules?: Array<FileMappingRule> | null;
     /**
-     * Describes the files that this dataset type expects.
-     * @type {Array<FileMappingRule>}
+     * When the process was created (does not reflect the pipeline code)
+     * @type {Date}
      * @memberof ProcessDetail
      */
-    fileMappingRules?: Array<FileMappingRule> | null;
+    createdAt?: Date;
+    /**
+     * When the process was updated (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof ProcessDetail
+     */
+    updatedAt?: Date;
 }
 
 /**
@@ -174,10 +186,15 @@ export function instanceOfProcessDetail(value: object): boolean {
     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;
 }
@@ -195,7 +212,7 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
-        'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
+        'dataType': json['dataType'],
         'executor': ExecutorFromJSON(json['executor']),
         'category': !exists(json, 'category') ? undefined : json['category'],
         'pipelineType': !exists(json, 'pipelineType') ? undefined : json['pipelineType'],
@@ -206,12 +223,14 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'pipelineCode': !exists(json, 'pipelineCode') ? undefined : PipelineCodeFromJSON(json['pipelineCode']),
         'owner': !exists(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': json['linkedProjectIds'],
-        'isTenantWide': !exists(json, 'isTenantWide') ? undefined : json['isTenantWide'],
-        'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
-        'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
         'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
-        'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
         'fileMappingRules': !exists(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : (json['fileMappingRules'] as Array<any>).map(FileMappingRuleFromJSON)),
+        'createdAt': !exists(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
     };
 }
 
@@ -241,9 +260,11 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
         'isTenantWide': value.isTenantWide,
         'allowMultipleSources': value.allowMultipleSources,
         'usesSampleSheet': value.usesSampleSheet,
-        'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
         'isArchived': value.isArchived,
+        'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
         'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : (value.fileMappingRules as Array<any>).map(FileMappingRuleToJSON)),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
     };
 }
 

package/src/models/index.ts

@@ -29,6 +29,7 @@ export * from './CreateProjectAccessRequest';
 export * from './CreateReferenceRequest';
 export * from './CreateResponse';
 export * from './CustomPipelineSettings';
+export * from './CustomProcessInput';
 export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';