@cirrobio/api-client 0.0.39-alpha → 0.1.1

package/src/models/DatasetAssetsManifest.ts

@@ -25,6 +25,12 @@ import {
     FileEntryFromJSONTyped,
     FileEntryToJSON,
 } from './FileEntry';
+import type { Table } from './Table';
+import {
+    TableFromJSON,
+    TableFromJSONTyped,
+    TableToJSON,
+} from './Table';
 
 /**
  * 
@@ -50,6 +56,12 @@ export interface DatasetAssetsManifest {
      * @memberof DatasetAssetsManifest
      */
     viz?: Array<DatasetViz>;
+    /**
+     * List of web optimized tables for the dataset
+     * @type {Array<Table>}
+     * @memberof DatasetAssetsManifest
+     */
+    tables?: Array<Table>;
 }
 
 /**
@@ -74,6 +86,7 @@ export function DatasetAssetsManifestFromJSONTyped(json: any, ignoreDiscriminato
         'domain': !exists(json, 'domain') ? undefined : json['domain'],
         'files': !exists(json, 'files') ? undefined : ((json['files'] as Array<any>).map(FileEntryFromJSON)),
         'viz': !exists(json, 'viz') ? undefined : ((json['viz'] as Array<any>).map(DatasetVizFromJSON)),
+        'tables': !exists(json, 'tables') ? undefined : ((json['tables'] as Array<any>).map(TableFromJSON)),
     };
 }
 
@@ -89,6 +102,7 @@ export function DatasetAssetsManifestToJSON(value?: DatasetAssetsManifest | null
         'domain': value.domain,
         'files': value.files === undefined ? undefined : ((value.files as Array<any>).map(FileEntryToJSON)),
         'viz': value.viz === undefined ? undefined : ((value.viz as Array<any>).map(DatasetVizToJSON)),
+        'tables': value.tables === undefined ? undefined : ((value.tables as Array<any>).map(TableToJSON)),
     };
 }
 

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/LoginProvider.ts

@@ -0,0 +1,93 @@
+/* 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, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface LoginProvider
+ */
+export interface LoginProvider {
+    /**
+     * 
+     * @type {string}
+     * @memberof LoginProvider
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LoginProvider
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LoginProvider
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LoginProvider
+     */
+    logoUrl: string;
+}
+
+/**
+ * Check if a given object implements the LoginProvider interface.
+ */
+export function instanceOfLoginProvider(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "logoUrl" in value;
+
+    return isInstance;
+}
+
+export function LoginProviderFromJSON(json: any): LoginProvider {
+    return LoginProviderFromJSONTyped(json, false);
+}
+
+export function LoginProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): LoginProvider {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+    };
+}
+
+export function LoginProviderToJSON(value?: LoginProvider | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'logoUrl': value.logoUrl,
+    };
+}
+

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,18 @@ export interface Process {
      * @memberof Process
      */
     linkedProjectIds?: Array<string>;
+    /**
+     * Whether the pipeline is allowed to have multiple dataset sources
+     * @type {boolean}
+     * @memberof Process
+     */
+    allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline is marked as archived
+     * @type {boolean}
+     * @memberof Process
+     */
+    isArchived?: boolean;
 }
 
 /**
@@ -94,6 +112,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 +129,18 @@ 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'],
+        'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
 
@@ -133,6 +156,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 +164,8 @@ export function ProcessToJSON(value?: Process | null): any {
         'parentProcessIds': value.parentProcessIds,
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
+        'allowMultipleSources': value.allowMultipleSources,
+        '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
      */
@@ -56,6 +56,12 @@ export interface ProcessDetail {
      * @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 | null;
     /**
      * 
      * @type {Executor}
@@ -63,53 +69,59 @@ export interface ProcessDetail {
      */
     executor: Executor;
     /**
-     * 
-     * @type {string}
+     * IDs of pipelines that can be run downstream
+     * @type {Array<string>}
      * @memberof ProcessDetail
      */
-    documentationUrl?: string | null;
+    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
      */
-    fileRequirementsMessage?: string | null;
+    documentationUrl?: string | null;
     /**
-     * 
-     * @type {Array<string>}
+     * Description of the files to be uploaded (optional)
+     * @type {string}
      * @memberof ProcessDetail
      */
-    childProcessIds: Array<string>;
+    fileRequirementsMessage?: string | null;
     /**
      * 
-     * @type {Array<string>}
+     * @type {PipelineCode}
      * @memberof ProcessDetail
      */
-    parentProcessIds: Array<string>;
+    pipelineCode?: PipelineCode | null;
     /**
-     * 
+     * Username of the pipeline creator (blank if Cirro curated)
      * @type {string}
      * @memberof ProcessDetail
      */
-    owner?: string;
+    owner?: string | null;
     /**
-     * 
+     * Projects that can run this pipeline
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     linkedProjectIds: Array<string>;
     /**
-     * 
-     * @type {PipelineCode}
+     * Whether the pipeline is allowed to have multiple dataset sources
+     * @type {boolean}
      * @memberof ProcessDetail
      */
-    pipelineCode?: PipelineCode | null;
+    allowMultipleSources?: boolean;
     /**
      * 
      * @type {CustomPipelineSettings}
      * @memberof ProcessDetail
      */
-    customSettings: CustomPipelineSettings;
+    customSettings?: CustomPipelineSettings | null;
     /**
      * Whether the process is marked for removal
      * @type {boolean}
@@ -130,7 +142,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 +159,17 @@ 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']),
+        'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
         'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
@@ -173,14 +186,16 @@ 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),
+        'allowMultipleSources': value.allowMultipleSources,
         '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/SystemInfoResponse.ts

@@ -19,6 +19,12 @@ import {
     ResourcesInfoFromJSONTyped,
     ResourcesInfoToJSON,
 } from './ResourcesInfo';
+import type { TenantInfo } from './TenantInfo';
+import {
+    TenantInfoFromJSON,
+    TenantInfoFromJSONTyped,
+    TenantInfoToJSON,
+} from './TenantInfo';
 
 /**
  * 
@@ -43,7 +49,7 @@ export interface SystemInfoResponse {
      * @type {string}
      * @memberof SystemInfoResponse
      */
-    dataEndpoint: string;
+    referencesBucket: string;
     /**
      * 
      * @type {string}
@@ -74,6 +80,12 @@ export interface SystemInfoResponse {
      * @memberof SystemInfoResponse
      */
     resourcesInfo: ResourcesInfo;
+    /**
+     * 
+     * @type {TenantInfo}
+     * @memberof SystemInfoResponse
+     */
+    tenantInfo: TenantInfo;
 }
 
 /**
@@ -83,12 +95,13 @@ export function instanceOfSystemInfoResponse(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "sdkAppId" in value;
     isInstance = isInstance && "resourcesBucket" in value;
-    isInstance = isInstance && "dataEndpoint" in value;
+    isInstance = isInstance && "referencesBucket" in value;
     isInstance = isInstance && "region" in value;
     isInstance = isInstance && "systemMessage" in value;
     isInstance = isInstance && "commitHash" in value;
     isInstance = isInstance && "version" in value;
     isInstance = isInstance && "resourcesInfo" in value;
+    isInstance = isInstance && "tenantInfo" in value;
 
     return isInstance;
 }
@@ -105,12 +118,13 @@ export function SystemInfoResponseFromJSONTyped(json: any, ignoreDiscriminator:
         
         'sdkAppId': json['sdkAppId'],
         'resourcesBucket': json['resourcesBucket'],
-        'dataEndpoint': json['dataEndpoint'],
+        'referencesBucket': json['referencesBucket'],
         'region': json['region'],
         'systemMessage': json['systemMessage'],
         'commitHash': json['commitHash'],
         'version': json['version'],
         'resourcesInfo': ResourcesInfoFromJSON(json['resourcesInfo']),
+        'tenantInfo': TenantInfoFromJSON(json['tenantInfo']),
     };
 }
 
@@ -125,12 +139,13 @@ export function SystemInfoResponseToJSON(value?: SystemInfoResponse | null): any
         
         'sdkAppId': value.sdkAppId,
         'resourcesBucket': value.resourcesBucket,
-        'dataEndpoint': value.dataEndpoint,
+        'referencesBucket': value.referencesBucket,
         'region': value.region,
         'systemMessage': value.systemMessage,
         'commitHash': value.commitHash,
         'version': value.version,
         'resourcesInfo': ResourcesInfoToJSON(value.resourcesInfo),
+        'tenantInfo': TenantInfoToJSON(value.tenantInfo),
     };
 }