@cirrobio/api-client 0.0.39-alpha → 0.1.0

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.0.39-alpha --save
+npm install @cirrobio/api-client@0.1.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/models/CloudAccount.d.ts

@@ -22,7 +22,7 @@ export interface CloudAccount {
      */
     accountId?: string;
     /**
-     * Name used to describe the account
+     * Name used to describe the account, useful when the account hosts multiple projects
      * @type {string}
      * @memberof CloudAccount
      */

package/dist/models/ImportDataRequest.d.ts

@@ -16,17 +16,17 @@
  */
 export interface ImportDataRequest {
     /**
-     *
+     * Name of the dataset
      * @type {string}
      * @memberof ImportDataRequest
      */
     name: string;
     /**
-     *
+     * Description of the dataset
      * @type {string}
      * @memberof ImportDataRequest
      */
-    description: string;
+    description?: string;
     /**
      *
      * @type {Array<string>}

package/dist/models/ImportDataRequest.js

@@ -14,13 +14,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportDataRequestToJSON = exports.ImportDataRequestFromJSONTyped = exports.ImportDataRequestFromJSON = exports.instanceOfImportDataRequest = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the ImportDataRequest interface.
  */
 function instanceOfImportDataRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "publicIds" in value;
     return isInstance;
 }
@@ -35,7 +35,7 @@ function ImportDataRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'description': json['description'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'publicIds': json['publicIds'],
     };
 }

package/dist/models/PipelineCode.d.ts

@@ -33,7 +33,7 @@ export interface PipelineCode {
      * @type {RepositoryType}
      * @memberof PipelineCode
      */
-    repositoryType?: RepositoryType;
+    repositoryType: RepositoryType;
     /**
      * Main script for running the pipeline
      * @type {string}

package/dist/models/PipelineCode.js

@@ -14,7 +14,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PipelineCodeToJSON = exports.PipelineCodeFromJSONTyped = exports.PipelineCodeFromJSON = exports.instanceOfPipelineCode = void 0;
-var runtime_1 = require("../runtime");
 var RepositoryType_1 = require("./RepositoryType");
 /**
  * Check if a given object implements the PipelineCode interface.
@@ -23,6 +22,7 @@ function instanceOfPipelineCode(value) {
     var isInstance = true;
     isInstance = isInstance && "repositoryPath" in value;
     isInstance = isInstance && "version" in value;
+    isInstance = isInstance && "repositoryType" in value;
     isInstance = isInstance && "entryPoint" in value;
     return isInstance;
 }
@@ -38,7 +38,7 @@ function PipelineCodeFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'repositoryPath': json['repositoryPath'],
         'version': json['version'],
-        'repositoryType': !(0, runtime_1.exists)(json, 'repositoryType') ? undefined : (0, RepositoryType_1.RepositoryTypeFromJSON)(json['repositoryType']),
+        'repositoryType': (0, RepositoryType_1.RepositoryTypeFromJSON)(json['repositoryType']),
         'entryPoint': json['entryPoint'],
     };
 }

package/dist/models/Process.d.ts

@@ -27,19 +27,25 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    name?: string;
+    name: string;
     /**
      *
      * @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 | null;
     /**
      *
      * @type {Executor}
      * @memberof Process
      */
-    executor?: Executor;
+    executor: Executor;
     /**
      * Link to pipeline documentation
      * @type {string}
@@ -53,7 +59,7 @@ export interface Process {
      */
     fileRequirementsMessage?: string;
     /**
-     * IDs of pipelines that can be ran downstream
+     * IDs of pipelines that can be run downstream
      * @type {Array<string>}
      * @memberof Process
      */
@@ -76,6 +82,12 @@ export interface Process {
      * @memberof Process
      */
     linkedProjectIds?: Array<string>;
+    /**
+     * Whether the pipeline is marked as archived
+     * @type {boolean}
+     * @memberof Process
+     */
+    isArchived?: boolean;
 }
 /**
  * Check if a given object implements the Process interface.

package/dist/models/Process.js

@@ -22,6 +22,8 @@ var Executor_1 = require("./Executor");
 function instanceOfProcess(value) {
     var isInstance = true;
     isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "executor" in value;
     return isInstance;
 }
 exports.instanceOfProcess = instanceOfProcess;
@@ -35,15 +37,17 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'id': json['id'],
-        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'name': json['name'],
         'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
-        'executor': !(0, runtime_1.exists)(json, 'executor') ? undefined : (0, Executor_1.ExecutorFromJSON)(json['executor']),
+        'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
+        'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
         'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
         'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
         'childProcessIds': !(0, runtime_1.exists)(json, 'childProcessIds') ? undefined : json['childProcessIds'],
         'parentProcessIds': !(0, runtime_1.exists)(json, 'parentProcessIds') ? undefined : json['parentProcessIds'],
         'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': !(0, runtime_1.exists)(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
+        'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
 exports.ProcessFromJSONTyped = ProcessFromJSONTyped;
@@ -58,6 +62,7 @@ function ProcessToJSON(value) {
         'id': value.id,
         'name': value.name,
         'description': value.description,
+        'dataType': value.dataType,
         'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
         'documentationUrl': value.documentationUrl,
         'fileRequirementsMessage': value.fileRequirementsMessage,
@@ -65,6 +70,7 @@ function ProcessToJSON(value) {
         'parentProcessIds': value.parentProcessIds,
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
+        'isArchived': value.isArchived,
     };
 }
 exports.ProcessToJSON = ProcessToJSON;

package/dist/models/ProcessDetail.d.ts

@@ -19,13 +19,13 @@ import type { PipelineCode } from './PipelineCode';
  */
 export interface ProcessDetail {
     /**
-     *
+     * Unique ID of the Process
      * @type {string}
      * @memberof ProcessDetail
      */
     id: string;
     /**
-     *
+     * Friendly name for the process
      * @type {string}
      * @memberof ProcessDetail
      */
@@ -37,59 +37,65 @@ export interface ProcessDetail {
      */
     description: string;
     /**
-     *
-     * @type {Executor}
-     * @memberof ProcessDetail
-     */
-    executor: Executor;
-    /**
-     *
+     * Name of the data type this pipeline produces (if it is not defined, use the name)
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl?: string | null;
+    dataType?: string | null;
     /**
      *
-     * @type {string}
+     * @type {Executor}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage?: string | null;
+    executor: Executor;
     /**
-     *
+     * IDs of pipelines that can be run downstream
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     childProcessIds: Array<string>;
     /**
-     *
+     * IDs of pipelines that can run this pipeline
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     parentProcessIds: Array<string>;
     /**
-     *
+     * Link to pipeline documentation
      * @type {string}
      * @memberof ProcessDetail
      */
-    owner?: string;
+    documentationUrl?: string | null;
     /**
-     *
-     * @type {Array<string>}
+     * Description of the files to be uploaded (optional)
+     * @type {string}
      * @memberof ProcessDetail
      */
-    linkedProjectIds: Array<string>;
+    fileRequirementsMessage?: string | null;
     /**
      *
      * @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 pipeline
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    linkedProjectIds: Array<string>;
     /**
      *
      * @type {CustomPipelineSettings}
      * @memberof ProcessDetail
      */
-    customSettings: CustomPipelineSettings;
+    customSettings?: CustomPipelineSettings | null;
     /**
      * Whether the process is marked for removal
      * @type {boolean}

package/dist/models/ProcessDetail.js

@@ -30,7 +30,6 @@ function instanceOfProcessDetail(value) {
     isInstance = isInstance && "childProcessIds" in value;
     isInstance = isInstance && "parentProcessIds" in value;
     isInstance = isInstance && "linkedProjectIds" in value;
-    isInstance = isInstance && "customSettings" in value;
     return isInstance;
 }
 exports.instanceOfProcessDetail = instanceOfProcessDetail;
@@ -46,15 +45,16 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
+        'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
         'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
-        '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'],
+        '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'],
-        'pipelineCode': !(0, runtime_1.exists)(json, 'pipelineCode') ? undefined : (0, PipelineCode_1.PipelineCodeFromJSON)(json['pipelineCode']),
-        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
+        'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
         'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
@@ -70,14 +70,15 @@ function ProcessDetailToJSON(value) {
         'id': value.id,
         'name': value.name,
         'description': value.description,
+        'dataType': value.dataType,
         'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
-        'documentationUrl': value.documentationUrl,
-        'fileRequirementsMessage': value.fileRequirementsMessage,
         '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,
-        'pipelineCode': (0, PipelineCode_1.PipelineCodeToJSON)(value.pipelineCode),
         'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
         'isArchived': value.isArchived,
     };

package/dist/models/ProjectSettings.d.ts

@@ -27,7 +27,7 @@ export interface ProjectSettings {
      * @type {BudgetPeriod}
      * @memberof ProjectSettings
      */
-    budgetPeriod?: BudgetPeriod;
+    budgetPeriod: BudgetPeriod;
     /**
      * AMI ID for the DRAGEN compute environment (if enabled)
      * @type {string}

package/dist/models/ProjectSettings.js

@@ -21,6 +21,7 @@ var BudgetPeriod_1 = require("./BudgetPeriod");
  */
 function instanceOfProjectSettings(value) {
     var isInstance = true;
+    isInstance = isInstance && "budgetPeriod" in value;
     isInstance = isInstance && "serviceConnections" in value;
     return isInstance;
 }
@@ -35,7 +36,7 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'budgetAmount': !(0, runtime_1.exists)(json, 'budgetAmount') ? undefined : json['budgetAmount'],
-        'budgetPeriod': !(0, runtime_1.exists)(json, 'budgetPeriod') ? undefined : (0, BudgetPeriod_1.BudgetPeriodFromJSON)(json['budgetPeriod']),
+        'budgetPeriod': (0, BudgetPeriod_1.BudgetPeriodFromJSON)(json['budgetPeriod']),
         'dragenAmi': !(0, runtime_1.exists)(json, 'dragenAmi') ? undefined : json['dragenAmi'],
         'enableCompute': !(0, runtime_1.exists)(json, 'enableCompute') ? undefined : json['enableCompute'],
         'enableDragen': !(0, runtime_1.exists)(json, 'enableDragen') ? undefined : json['enableDragen'],

package/dist/models/RunAnalysisRequest.d.ts

@@ -16,37 +16,37 @@
  */
 export interface RunAnalysisRequest {
     /**
-     *
+     * Name of the dataset
      * @type {string}
      * @memberof RunAnalysisRequest
      */
     name: string;
     /**
-     *
+     * Description of the dataset (optional)
      * @type {string}
      * @memberof RunAnalysisRequest
      */
-    description: string;
+    description?: string | null;
     /**
-     *
+     * Process ID of the workflow
      * @type {string}
      * @memberof RunAnalysisRequest
      */
     processId: string;
     /**
-     *
+     * These datasets contain files that are inputs to this workflow.
      * @type {Array<string>}
      * @memberof RunAnalysisRequest
      */
     sourceDatasetIds: Array<string>;
     /**
-     *
+     * Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
      * @type {string}
      * @memberof RunAnalysisRequest
      */
-    resumeDatasetId: string;
+    resumeDatasetId?: string | null;
     /**
-     *
+     * Parameters used in workflow (can be empty)
      * @type {{ [key: string]: any; }}
      * @memberof RunAnalysisRequest
      */
@@ -54,7 +54,7 @@ export interface RunAnalysisRequest {
         [key: string]: any;
     };
     /**
-     *
+     * Emails to notify upon workflow success or failure
      * @type {Array<string>}
      * @memberof RunAnalysisRequest
      */

package/dist/models/RunAnalysisRequest.js

@@ -14,16 +14,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunAnalysisRequestToJSON = exports.RunAnalysisRequestFromJSONTyped = exports.RunAnalysisRequestFromJSON = exports.instanceOfRunAnalysisRequest = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the RunAnalysisRequest interface.
  */
 function instanceOfRunAnalysisRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processId" in value;
     isInstance = isInstance && "sourceDatasetIds" in value;
-    isInstance = isInstance && "resumeDatasetId" in value;
     isInstance = isInstance && "params" in value;
     isInstance = isInstance && "notificationEmails" in value;
     return isInstance;
@@ -39,10 +38,10 @@ function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'description': json['description'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'sourceDatasetIds': json['sourceDatasetIds'],
-        'resumeDatasetId': json['resumeDatasetId'],
+        'resumeDatasetId': !(0, runtime_1.exists)(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
         'params': json['params'],
         'notificationEmails': json['notificationEmails'],
     };

package/dist/models/UploadDatasetRequest.d.ts

@@ -16,19 +16,19 @@
  */
 export interface UploadDatasetRequest {
     /**
-     *
+     * Name of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
     name: string;
     /**
-     *
+     * Description of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
-    description: string;
+    description?: string;
     /**
-     *
+     * ID of the ingest process
      * @type {string}
      * @memberof UploadDatasetRequest
      */

package/dist/models/UploadDatasetRequest.js

@@ -14,13 +14,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UploadDatasetRequestToJSON = exports.UploadDatasetRequestFromJSONTyped = exports.UploadDatasetRequestFromJSON = exports.instanceOfUploadDatasetRequest = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the UploadDatasetRequest interface.
  */
 function instanceOfUploadDatasetRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processId" in value;
     isInstance = isInstance && "expectedFiles" in value;
     return isInstance;
@@ -36,7 +36,7 @@ function UploadDatasetRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'description': json['description'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'expectedFiles': json['expectedFiles'],
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.0.39-alpha",
+  "version": "0.1.0",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/models/CloudAccount.ts

@@ -26,7 +26,7 @@ export interface CloudAccount {
      */
     accountId?: string;
     /**
-     * Name used to describe the account
+     * Name used to describe the account, useful when the account hosts multiple projects
      * @type {string}
      * @memberof CloudAccount
      */

package/src/models/ImportDataRequest.ts

@@ -20,17 +20,17 @@ import { exists, mapValues } from '../runtime';
  */
 export interface ImportDataRequest {
     /**
-     * 
+     * Name of the dataset
      * @type {string}
      * @memberof ImportDataRequest
      */
     name: string;
     /**
-     * 
+     * Description of the dataset
      * @type {string}
      * @memberof ImportDataRequest
      */
-    description: string;
+    description?: string;
     /**
      * 
      * @type {Array<string>}
@@ -45,7 +45,6 @@ export interface ImportDataRequest {
 export function instanceOfImportDataRequest(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "publicIds" in value;
 
     return isInstance;
@@ -62,7 +61,7 @@ export function ImportDataRequestFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'name': json['name'],
-        'description': json['description'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
         'publicIds': json['publicIds'],
     };
 }

package/src/models/PipelineCode.ts

@@ -43,7 +43,7 @@ export interface PipelineCode {
      * @type {RepositoryType}
      * @memberof PipelineCode
      */
-    repositoryType?: RepositoryType;
+    repositoryType: RepositoryType;
     /**
      * Main script for running the pipeline
      * @type {string}
@@ -59,6 +59,7 @@ export function instanceOfPipelineCode(value: object): boolean {
     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;
@@ -76,7 +77,7 @@ export function PipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolea
         
         'repositoryPath': json['repositoryPath'],
         'version': json['version'],
-        'repositoryType': !exists(json, 'repositoryType') ? undefined : RepositoryTypeFromJSON(json['repositoryType']),
+        'repositoryType': RepositoryTypeFromJSON(json['repositoryType']),
         'entryPoint': json['entryPoint'],
     };
 }

package/src/models/Process.ts

@@ -37,19 +37,25 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    name?: string;
+    name: string;
     /**
      * 
      * @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 | null;
     /**
      * 
      * @type {Executor}
      * @memberof Process
      */
-    executor?: Executor;
+    executor: Executor;
     /**
      * Link to pipeline documentation
      * @type {string}
@@ -63,7 +69,7 @@ export interface Process {
      */
     fileRequirementsMessage?: string;
     /**
-     * IDs of pipelines that can be ran downstream
+     * IDs of pipelines that can be run downstream
      * @type {Array<string>}
      * @memberof Process
      */
@@ -86,6 +92,12 @@ export interface Process {
      * @memberof Process
      */
     linkedProjectIds?: Array<string>;
+    /**
+     * Whether the pipeline is marked as archived
+     * @type {boolean}
+     * @memberof Process
+     */
+    isArchived?: boolean;
 }
 
 /**
@@ -94,6 +106,8 @@ export interface Process {
 export function instanceOfProcess(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "executor" in value;
 
     return isInstance;
 }
@@ -109,15 +123,17 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
     return {
         
         'id': json['id'],
-        'name': !exists(json, 'name') ? undefined : json['name'],
+        'name': json['name'],
         'description': !exists(json, 'description') ? undefined : json['description'],
-        'executor': !exists(json, 'executor') ? undefined : ExecutorFromJSON(json['executor']),
+        'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
+        'executor': ExecutorFromJSON(json['executor']),
         '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'],
         'owner': !exists(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': !exists(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
+        'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
 
@@ -133,6 +149,7 @@ export function ProcessToJSON(value?: Process | null): any {
         'id': value.id,
         'name': value.name,
         'description': value.description,
+        'dataType': value.dataType,
         'executor': ExecutorToJSON(value.executor),
         'documentationUrl': value.documentationUrl,
         'fileRequirementsMessage': value.fileRequirementsMessage,
@@ -140,6 +157,7 @@ export function ProcessToJSON(value?: Process | null): any {
         'parentProcessIds': value.parentProcessIds,
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
+        'isArchived': value.isArchived,
     };
 }
 

package/src/models/ProcessDetail.ts

@@ -39,13 +39,13 @@ import {
  */
 export interface ProcessDetail {
     /**
-     * 
+     * Unique ID of the Process
      * @type {string}
      * @memberof ProcessDetail
      */
     id: string;
     /**
-     * 
+     * Friendly name for the process
      * @type {string}
      * @memberof ProcessDetail
      */
@@ -57,59 +57,65 @@ export interface ProcessDetail {
      */
     description: string;
     /**
-     * 
-     * @type {Executor}
-     * @memberof ProcessDetail
-     */
-    executor: Executor;
-    /**
-     * 
+     * Name of the data type this pipeline produces (if it is not defined, use the name)
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl?: string | null;
+    dataType?: string | null;
     /**
      * 
-     * @type {string}
+     * @type {Executor}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage?: string | null;
+    executor: Executor;
     /**
-     * 
+     * IDs of pipelines that can be run downstream
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     childProcessIds: Array<string>;
     /**
-     * 
+     * IDs of pipelines that can run this pipeline
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     parentProcessIds: Array<string>;
     /**
-     * 
+     * Link to pipeline documentation
      * @type {string}
      * @memberof ProcessDetail
      */
-    owner?: string;
+    documentationUrl?: string | null;
     /**
-     * 
-     * @type {Array<string>}
+     * Description of the files to be uploaded (optional)
+     * @type {string}
      * @memberof ProcessDetail
      */
-    linkedProjectIds: Array<string>;
+    fileRequirementsMessage?: string | null;
     /**
      * 
      * @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 pipeline
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    linkedProjectIds: Array<string>;
     /**
      * 
      * @type {CustomPipelineSettings}
      * @memberof ProcessDetail
      */
-    customSettings: CustomPipelineSettings;
+    customSettings?: CustomPipelineSettings | null;
     /**
      * Whether the process is marked for removal
      * @type {boolean}
@@ -130,7 +136,6 @@ export function instanceOfProcessDetail(value: object): boolean {
     isInstance = isInstance && "childProcessIds" in value;
     isInstance = isInstance && "parentProcessIds" in value;
     isInstance = isInstance && "linkedProjectIds" in value;
-    isInstance = isInstance && "customSettings" in value;
 
     return isInstance;
 }
@@ -148,15 +153,16 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
+        'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
         'executor': ExecutorFromJSON(json['executor']),
-        'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
-        'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
         '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'],
-        'pipelineCode': !exists(json, 'pipelineCode') ? undefined : PipelineCodeFromJSON(json['pipelineCode']),
-        'customSettings': CustomPipelineSettingsFromJSON(json['customSettings']),
+        'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
         'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
@@ -173,14 +179,15 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
         'id': value.id,
         'name': value.name,
         'description': value.description,
+        'dataType': value.dataType,
         'executor': ExecutorToJSON(value.executor),
-        'documentationUrl': value.documentationUrl,
-        'fileRequirementsMessage': value.fileRequirementsMessage,
         'childProcessIds': value.childProcessIds,
         'parentProcessIds': value.parentProcessIds,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'pipelineCode': PipelineCodeToJSON(value.pipelineCode),
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
-        'pipelineCode': PipelineCodeToJSON(value.pipelineCode),
         'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
         'isArchived': value.isArchived,
     };

package/src/models/ProjectSettings.ts

@@ -37,7 +37,7 @@ export interface ProjectSettings {
      * @type {BudgetPeriod}
      * @memberof ProjectSettings
      */
-    budgetPeriod?: BudgetPeriod;
+    budgetPeriod: BudgetPeriod;
     /**
      * AMI ID for the DRAGEN compute environment (if enabled)
      * @type {string}
@@ -123,6 +123,7 @@ export interface ProjectSettings {
  */
 export function instanceOfProjectSettings(value: object): boolean {
     let isInstance = true;
+    isInstance = isInstance && "budgetPeriod" in value;
     isInstance = isInstance && "serviceConnections" in value;
 
     return isInstance;
@@ -139,7 +140,7 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
     return {
         
         'budgetAmount': !exists(json, 'budgetAmount') ? undefined : json['budgetAmount'],
-        'budgetPeriod': !exists(json, 'budgetPeriod') ? undefined : BudgetPeriodFromJSON(json['budgetPeriod']),
+        'budgetPeriod': BudgetPeriodFromJSON(json['budgetPeriod']),
         'dragenAmi': !exists(json, 'dragenAmi') ? undefined : json['dragenAmi'],
         'enableCompute': !exists(json, 'enableCompute') ? undefined : json['enableCompute'],
         'enableDragen': !exists(json, 'enableDragen') ? undefined : json['enableDragen'],

package/src/models/RunAnalysisRequest.ts

@@ -20,43 +20,43 @@ import { exists, mapValues } from '../runtime';
  */
 export interface RunAnalysisRequest {
     /**
-     * 
+     * Name of the dataset
      * @type {string}
      * @memberof RunAnalysisRequest
      */
     name: string;
     /**
-     * 
+     * Description of the dataset (optional)
      * @type {string}
      * @memberof RunAnalysisRequest
      */
-    description: string;
+    description?: string | null;
     /**
-     * 
+     * Process ID of the workflow
      * @type {string}
      * @memberof RunAnalysisRequest
      */
     processId: string;
     /**
-     * 
+     * These datasets contain files that are inputs to this workflow.
      * @type {Array<string>}
      * @memberof RunAnalysisRequest
      */
     sourceDatasetIds: Array<string>;
     /**
-     * 
+     * Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
      * @type {string}
      * @memberof RunAnalysisRequest
      */
-    resumeDatasetId: string;
+    resumeDatasetId?: string | null;
     /**
-     * 
+     * Parameters used in workflow (can be empty)
      * @type {{ [key: string]: any; }}
      * @memberof RunAnalysisRequest
      */
     params: { [key: string]: any; };
     /**
-     * 
+     * Emails to notify upon workflow success or failure
      * @type {Array<string>}
      * @memberof RunAnalysisRequest
      */
@@ -69,10 +69,8 @@ export interface RunAnalysisRequest {
 export function instanceOfRunAnalysisRequest(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processId" in value;
     isInstance = isInstance && "sourceDatasetIds" in value;
-    isInstance = isInstance && "resumeDatasetId" in value;
     isInstance = isInstance && "params" in value;
     isInstance = isInstance && "notificationEmails" in value;
 
@@ -90,10 +88,10 @@ export function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'name': json['name'],
-        'description': json['description'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'sourceDatasetIds': json['sourceDatasetIds'],
-        'resumeDatasetId': json['resumeDatasetId'],
+        'resumeDatasetId': !exists(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
         'params': json['params'],
         'notificationEmails': json['notificationEmails'],
     };

package/src/models/UploadDatasetRequest.ts

@@ -20,19 +20,19 @@ import { exists, mapValues } from '../runtime';
  */
 export interface UploadDatasetRequest {
     /**
-     * 
+     * Name of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
     name: string;
     /**
-     * 
+     * Description of the dataset
      * @type {string}
      * @memberof UploadDatasetRequest
      */
-    description: string;
+    description?: string;
     /**
-     * 
+     * ID of the ingest process
      * @type {string}
      * @memberof UploadDatasetRequest
      */
@@ -51,7 +51,6 @@ export interface UploadDatasetRequest {
 export function instanceOfUploadDatasetRequest(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processId" in value;
     isInstance = isInstance && "expectedFiles" in value;
 
@@ -69,7 +68,7 @@ export function UploadDatasetRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'name': json['name'],
-        'description': json['description'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'expectedFiles': json['expectedFiles'],
     };