@cirrobio/api-client 0.0.28-alpha → 0.0.30-alpha

package/src/models/PipelineCode.ts

@@ -21,7 +21,7 @@ import {
 } from './RepositoryType';
 
 /**
- * Used to describe the pipeline analysis code
+ * Used to describe the pipeline analysis code, not required for ingest processes
  * @export
  * @interface PipelineCode
  */
@@ -37,19 +37,19 @@ export interface PipelineCode {
      * @type {string}
      * @memberof PipelineCode
      */
-    version?: string;
+    version: string;
     /**
      * 
      * @type {RepositoryType}
      * @memberof PipelineCode
      */
-    repositoryType?: RepositoryType;
+    repositoryType: RepositoryType;
     /**
      * Main script for running the pipeline
      * @type {string}
      * @memberof PipelineCode
      */
-    entryPoint?: string;
+    entryPoint: string;
 }
 
 /**
@@ -58,6 +58,9 @@ export interface PipelineCode {
 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;
 }
@@ -73,9 +76,9 @@ export function PipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolea
     return {
         
         'repositoryPath': json['repositoryPath'],
-        'version': !exists(json, 'version') ? undefined : json['version'],
-        'repositoryType': !exists(json, 'repositoryType') ? undefined : RepositoryTypeFromJSON(json['repositoryType']),
-        'entryPoint': !exists(json, 'entryPoint') ? undefined : json['entryPoint'],
+        'version': json['version'],
+        'repositoryType': RepositoryTypeFromJSON(json['repositoryType']),
+        'entryPoint': json['entryPoint'],
     };
 }
 

package/src/models/PortalErrorResponse.ts

@@ -0,0 +1,100 @@
+/* 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';
+import type { ErrorMessage } from './ErrorMessage';
+import {
+    ErrorMessageFromJSON,
+    ErrorMessageFromJSONTyped,
+    ErrorMessageToJSON,
+} from './ErrorMessage';
+
+/**
+ * 
+ * @export
+ * @interface PortalErrorResponse
+ */
+export interface PortalErrorResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof PortalErrorResponse
+     */
+    statusCode: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorDetail: string;
+    /**
+     * 
+     * @type {Array<ErrorMessage>}
+     * @memberof PortalErrorResponse
+     */
+    errors: Array<ErrorMessage>;
+}
+
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+export function instanceOfPortalErrorResponse(value: object): boolean {
+    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: any): PortalErrorResponse {
+    return PortalErrorResponseFromJSONTyped(json, false);
+}
+
+export function PortalErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalErrorResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'statusCode': json['statusCode'],
+        'errorCode': json['errorCode'],
+        'errorDetail': json['errorDetail'],
+        'errors': ((json['errors'] as Array<any>).map(ErrorMessageFromJSON)),
+    };
+}
+
+export function PortalErrorResponseToJSON(value?: PortalErrorResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'statusCode': value.statusCode,
+        'errorCode': value.errorCode,
+        'errorDetail': value.errorDetail,
+        'errors': ((value.errors as Array<any>).map(ErrorMessageToJSON)),
+    };
+}
+

package/src/models/Process.ts

@@ -33,7 +33,7 @@ export interface Process {
      */
     id: string;
     /**
-     * 
+     * Friendly name for the process
      * @type {string}
      * @memberof Process
      */
@@ -69,7 +69,7 @@ export interface Process {
      */
     childProcessIds?: Array<string>;
     /**
-     * IDs of pipelines that can be ran upstream
+     * IDs of pipelines that can run this pipeline
      * @type {Array<string>}
      * @memberof Process
      */

package/src/models/ProcessDetail.ts

@@ -25,6 +25,12 @@ import {
     ExecutorFromJSONTyped,
     ExecutorToJSON,
 } from './Executor';
+import type { PipelineCode } from './PipelineCode';
+import {
+    PipelineCodeFromJSON,
+    PipelineCodeFromJSONTyped,
+    PipelineCodeToJSON,
+} from './PipelineCode';
 
 /**
  * 
@@ -61,13 +67,13 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl: string;
+    documentationUrl?: string | null;
     /**
-     * Description of the files to be uploaded (optional)
+     * 
      * @type {string}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage?: string;
+    fileRequirementsMessage?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -85,13 +91,19 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    owner: string;
+    owner?: string;
     /**
      * 
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     linkedProjectIds: Array<string>;
+    /**
+     * 
+     * @type {PipelineCode}
+     * @memberof ProcessDetail
+     */
+    pipelineCode?: PipelineCode | null;
     /**
      * 
      * @type {CustomPipelineSettings}
@@ -99,11 +111,11 @@ export interface ProcessDetail {
      */
     customSettings: CustomPipelineSettings;
     /**
-     * 
+     * Whether the process is marked for removal
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    isArchived: boolean;
+    isArchived?: boolean;
 }
 
 /**
@@ -115,13 +127,10 @@ export function instanceOfProcessDetail(value: object): boolean {
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "executor" in value;
-    isInstance = isInstance && "documentationUrl" in value;
     isInstance = isInstance && "childProcessIds" in value;
     isInstance = isInstance && "parentProcessIds" in value;
-    isInstance = isInstance && "owner" in value;
     isInstance = isInstance && "linkedProjectIds" in value;
     isInstance = isInstance && "customSettings" in value;
-    isInstance = isInstance && "isArchived" in value;
 
     return isInstance;
 }
@@ -140,14 +149,15 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'name': json['name'],
         'description': json['description'],
         'executor': ExecutorFromJSON(json['executor']),
-        'documentationUrl': json['documentationUrl'],
+        'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
         'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
         'childProcessIds': json['childProcessIds'],
         'parentProcessIds': json['parentProcessIds'],
-        'owner': json['owner'],
+        'owner': !exists(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': json['linkedProjectIds'],
+        'pipelineCode': !exists(json, 'pipelineCode') ? undefined : PipelineCodeFromJSON(json['pipelineCode']),
         'customSettings': CustomPipelineSettingsFromJSON(json['customSettings']),
-        'isArchived': json['isArchived'],
+        'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
 
@@ -170,6 +180,7 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
         'parentProcessIds': value.parentProcessIds,
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
+        'pipelineCode': PipelineCodeToJSON(value.pipelineCode),
         'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
         'isArchived': value.isArchived,
     };

package/src/models/ProjectRequest.ts

@@ -79,13 +79,13 @@ export interface ProjectRequest {
      * @type {CloudAccount}
      * @memberof ProjectRequest
      */
-    account: CloudAccount | null;
+    account?: CloudAccount | null;
     /**
      * 
      * @type {Array<Tag>}
      * @memberof ProjectRequest
      */
-    tags: Array<Tag> | null;
+    tags?: Array<Tag> | null;
 }
 
 /**
@@ -98,8 +98,6 @@ export function instanceOfProjectRequest(value: object): boolean {
     isInstance = isInstance && "billingAccountId" in value;
     isInstance = isInstance && "settings" in value;
     isInstance = isInstance && "contacts" in value;
-    isInstance = isInstance && "account" in value;
-    isInstance = isInstance && "tags" in value;
 
     return isInstance;
 }
@@ -119,8 +117,8 @@ export function ProjectRequestFromJSONTyped(json: any, ignoreDiscriminator: bool
         'billingAccountId': json['billingAccountId'],
         'settings': ProjectSettingsFromJSON(json['settings']),
         'contacts': ((json['contacts'] as Array<any>).map(ContactFromJSON)),
-        'account': CloudAccountFromJSON(json['account']),
-        'tags': (json['tags'] === null ? null : (json['tags'] as Array<any>).map(TagFromJSON)),
+        'account': !exists(json, 'account') ? undefined : CloudAccountFromJSON(json['account']),
+        'tags': !exists(json, 'tags') ? undefined : (json['tags'] === null ? null : (json['tags'] as Array<any>).map(TagFromJSON)),
     };
 }
 
@@ -139,7 +137,7 @@ export function ProjectRequestToJSON(value?: ProjectRequest | null): any {
         'settings': ProjectSettingsToJSON(value.settings),
         'contacts': ((value.contacts as Array<any>).map(ContactToJSON)),
         'account': CloudAccountToJSON(value.account),
-        'tags': (value.tags === null ? null : (value.tags as Array<any>).map(TagToJSON)),
+        'tags': value.tags === undefined ? undefined : (value.tags === null ? null : (value.tags as Array<any>).map(TagToJSON)),
     };
 }
 

package/src/models/{DatasetType.ts → SyncStatus.ts}

@@ -13,25 +13,25 @@
  */
 
 /**
- * 
+ * Status of last sync
  * @export
  * @enum {string}
  */
-export enum DatasetType {
-    Upload = 'UPLOAD',
-    Public = 'PUBLIC'
+export enum SyncStatus {
+    Successful = 'SUCCESSFUL',
+    Failed = 'FAILED'
 }
 
 
-export function DatasetTypeFromJSON(json: any): DatasetType {
-    return DatasetTypeFromJSONTyped(json, false);
+export function SyncStatusFromJSON(json: any): SyncStatus {
+    return SyncStatusFromJSONTyped(json, false);
 }
 
-export function DatasetTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DatasetType {
-    return json as DatasetType;
+export function SyncStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncStatus {
+    return json as SyncStatus;
 }
 
-export function DatasetTypeToJSON(value?: DatasetType | null): any {
+export function SyncStatusToJSON(value?: SyncStatus | null): any {
     return value as any;
 }
 

package/src/models/ValidateFileRequirementsRequest.ts

@@ -21,16 +21,16 @@ import { exists, mapValues } from '../runtime';
 export interface ValidateFileRequirementsRequest {
     /**
      * 
-     * @type {string}
+     * @type {Array<string>}
      * @memberof ValidateFileRequirementsRequest
      */
-    sampleSheet: string;
+    fileNames: Array<string>;
     /**
      * 
-     * @type {Array<string>}
+     * @type {string}
      * @memberof ValidateFileRequirementsRequest
      */
-    fileNames: Array<string>;
+    sampleSheet: string;
 }
 
 /**
@@ -38,8 +38,8 @@ export interface ValidateFileRequirementsRequest {
  */
 export function instanceOfValidateFileRequirementsRequest(value: object): boolean {
     let isInstance = true;
-    isInstance = isInstance && "sampleSheet" in value;
     isInstance = isInstance && "fileNames" in value;
+    isInstance = isInstance && "sampleSheet" in value;
 
     return isInstance;
 }
@@ -54,8 +54,8 @@ export function ValidateFileRequirementsRequestFromJSONTyped(json: any, ignoreDi
     }
     return {
         
-        'sampleSheet': json['sampleSheet'],
         'fileNames': json['fileNames'],
+        'sampleSheet': json['sampleSheet'],
     };
 }
 
@@ -68,8 +68,8 @@ export function ValidateFileRequirementsRequestToJSON(value?: ValidateFileRequir
     }
     return {
         
-        'sampleSheet': value.sampleSheet,
         'fileNames': value.fileNames,
+        'sampleSheet': value.sampleSheet,
     };
 }
 

package/src/models/index.ts

@@ -10,9 +10,6 @@ export * from './Contact';
 export * from './CreateNotebookInstanceRequest';
 export * from './CreateResponse';
 export * from './CustomPipelineSettings';
-export * from './CustomPipelineSettingsDto1';
-export * from './CustomProcessRequest';
-export * from './CustomProcessRequestPipelineCode';
 export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';
@@ -21,6 +18,7 @@ export * from './DatasetAssetsManifest';
 export * from './DatasetDetail';
 export * from './DatasetFile';
 export * from './DatasetViz';
+export * from './ErrorMessage';
 export * from './Executor';
 export * from './FileNamePattern';
 export * from './FileRequirements';
@@ -38,6 +36,7 @@ export * from './OpenNotebookInstanceResponse';
 export * from './PaginatedResponseDatasetListDto';
 export * from './PaginatedResponseSampleDto';
 export * from './PipelineCode';
+export * from './PortalErrorResponse';
 export * from './Process';
 export * from './ProcessDetail';
 export * from './Project';
@@ -59,6 +58,7 @@ export * from './SetUserProjectRoleRequest';
 export * from './SftpCredentials';
 export * from './Status';
 export * from './StopExecutionResponse';
+export * from './SyncStatus';
 export * from './SystemInfoResponse';
 export * from './Tag';
 export * from './Task';

package/src/models/CreateDashboardRequest.ts

@@ -1,65 +0,0 @@
-/* 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 CreateDashboardRequest
- */
-export interface CreateDashboardRequest {
-    /**
-     * 
-     * @type {object}
-     * @memberof CreateDashboardRequest
-     */
-    dashboardRequest?: object;
-}
-
-/**
- * Check if a given object implements the CreateDashboardRequest interface.
- */
-export function instanceOfCreateDashboardRequest(value: object): boolean {
-    let isInstance = true;
-
-    return isInstance;
-}
-
-export function CreateDashboardRequestFromJSON(json: any): CreateDashboardRequest {
-    return CreateDashboardRequestFromJSONTyped(json, false);
-}
-
-export function CreateDashboardRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDashboardRequest {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'dashboardRequest': !exists(json, 'dashboardRequest') ? undefined : json['dashboardRequest'],
-    };
-}
-
-export function CreateDashboardRequestToJSON(value?: CreateDashboardRequest | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'dashboardRequest': value.dashboardRequest,
-    };
-}
-

package/src/models/CustomPipelineSettingsDto1.ts

@@ -1,111 +0,0 @@
-/* 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 CustomPipelineSettingsDto1
- */
-export interface CustomPipelineSettingsDto1 {
-    /**
-     * 
-     * @type {string}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    repository: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    branch: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    folder: string;
-    /**
-     * 
-     * @type {Date}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    lastSync: Date;
-    /**
-     * 
-     * @type {string}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    syncStatus: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof CustomPipelineSettingsDto1
-     */
-    commitHash: string;
-}
-
-/**
- * Check if a given object implements the CustomPipelineSettingsDto1 interface.
- */
-export function instanceOfCustomPipelineSettingsDto1(value: object): boolean {
-    let isInstance = true;
-    isInstance = isInstance && "repository" in value;
-    isInstance = isInstance && "branch" in value;
-    isInstance = isInstance && "folder" in value;
-    isInstance = isInstance && "lastSync" in value;
-    isInstance = isInstance && "syncStatus" in value;
-    isInstance = isInstance && "commitHash" in value;
-
-    return isInstance;
-}
-
-export function CustomPipelineSettingsDto1FromJSON(json: any): CustomPipelineSettingsDto1 {
-    return CustomPipelineSettingsDto1FromJSONTyped(json, false);
-}
-
-export function CustomPipelineSettingsDto1FromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomPipelineSettingsDto1 {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'repository': json['repository'],
-        'branch': json['branch'],
-        'folder': json['folder'],
-        'lastSync': (new Date(json['lastSync'])),
-        'syncStatus': json['syncStatus'],
-        'commitHash': json['commitHash'],
-    };
-}
-
-export function CustomPipelineSettingsDto1ToJSON(value?: CustomPipelineSettingsDto1 | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'repository': value.repository,
-        'branch': value.branch,
-        'folder': value.folder,
-        'lastSync': (value.lastSync.toISOString()),
-        'syncStatus': value.syncStatus,
-        'commitHash': value.commitHash,
-    };
-}
-