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

package/src/models/CustomPipelineSettingsDto1.ts

@@ -0,0 +1,111 @@
+/* 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,
+    };
+}
+

package/src/models/CustomProcessRequest.ts

@@ -0,0 +1,175 @@
+/* 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 { CustomProcessRequestPipelineCode } from './CustomProcessRequestPipelineCode';
+import {
+    CustomProcessRequestPipelineCodeFromJSON,
+    CustomProcessRequestPipelineCodeFromJSONTyped,
+    CustomProcessRequestPipelineCodeToJSON,
+} from './CustomProcessRequestPipelineCode';
+import type { Executor } from './Executor';
+import {
+    ExecutorFromJSON,
+    ExecutorFromJSONTyped,
+    ExecutorToJSON,
+} from './Executor';
+
+/**
+ * 
+ * @export
+ * @interface CustomProcessRequest
+ */
+export interface CustomProcessRequest {
+    /**
+     * Unique ID for the process
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    processId?: string;
+    /**
+     * Friendly name for the process
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    name?: string;
+    /**
+     * Describes the analysis performed by the process
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    description: string;
+    /**
+     * Link to pipeline documentation
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    documentationUrl?: string;
+    /**
+     * 
+     * @type {Executor}
+     * @memberof CustomProcessRequest
+     */
+    executor: Executor;
+    /**
+     * 
+     * @type {CustomProcessRequestPipelineCode}
+     * @memberof CustomProcessRequest
+     */
+    pipelineCode: CustomProcessRequestPipelineCode;
+    /**
+     * Downstream pipeline IDs, the pipelines which can be run off of the outputs to this pipeline
+     * @type {Array<string>}
+     * @memberof CustomProcessRequest
+     */
+    childProcessIds: Array<string>;
+    /**
+     * Upstream process IDs, these processes provide the type of input data required for this pipeline
+     * @type {Array<string>}
+     * @memberof CustomProcessRequest
+     */
+    parentProcessIds: Array<string>;
+    /**
+     * Projects that this process is linked to
+     * @type {Array<string>}
+     * @memberof CustomProcessRequest
+     */
+    projectIds: Array<string>;
+    /**
+     * GitHub repository that contains the process definition
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    definitionRepository: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    definitionBranch: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomProcessRequest
+     */
+    definitionFolder: string;
+}
+
+/**
+ * Check if a given object implements the CustomProcessRequest interface.
+ */
+export function instanceOfCustomProcessRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "executor" in value;
+    isInstance = isInstance && "pipelineCode" in value;
+    isInstance = isInstance && "childProcessIds" in value;
+    isInstance = isInstance && "parentProcessIds" in value;
+    isInstance = isInstance && "projectIds" in value;
+    isInstance = isInstance && "definitionRepository" in value;
+    isInstance = isInstance && "definitionBranch" in value;
+    isInstance = isInstance && "definitionFolder" in value;
+
+    return isInstance;
+}
+
+export function CustomProcessRequestFromJSON(json: any): CustomProcessRequest {
+    return CustomProcessRequestFromJSONTyped(json, false);
+}
+
+export function CustomProcessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'processId': !exists(json, 'processId') ? undefined : json['processId'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'description': json['description'],
+        'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
+        'executor': ExecutorFromJSON(json['executor']),
+        'pipelineCode': CustomProcessRequestPipelineCodeFromJSON(json['pipelineCode']),
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        'projectIds': json['projectIds'],
+        'definitionRepository': json['definitionRepository'],
+        'definitionBranch': json['definitionBranch'],
+        'definitionFolder': json['definitionFolder'],
+    };
+}
+
+export function CustomProcessRequestToJSON(value?: CustomProcessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'processId': value.processId,
+        'name': value.name,
+        'description': value.description,
+        'documentationUrl': value.documentationUrl,
+        'executor': ExecutorToJSON(value.executor),
+        'pipelineCode': CustomProcessRequestPipelineCodeToJSON(value.pipelineCode),
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'projectIds': value.projectIds,
+        'definitionRepository': value.definitionRepository,
+        'definitionBranch': value.definitionBranch,
+        'definitionFolder': value.definitionFolder,
+    };
+}
+

package/src/models/CustomProcessRequestPipelineCode.ts

@@ -0,0 +1,97 @@
+/* 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 { RepositoryType } from './RepositoryType';
+import {
+    RepositoryTypeFromJSON,
+    RepositoryTypeFromJSONTyped,
+    RepositoryTypeToJSON,
+} from './RepositoryType';
+
+/**
+ * 
+ * @export
+ * @interface CustomProcessRequestPipelineCode
+ */
+export interface CustomProcessRequestPipelineCode {
+    /**
+     * GitHub repository which contains the workflow code
+     * @type {string}
+     * @memberof CustomProcessRequestPipelineCode
+     */
+    repositoryPath: string;
+    /**
+     * Branch, tag, or commit hash of the pipeline code
+     * @type {string}
+     * @memberof CustomProcessRequestPipelineCode
+     */
+    version?: string;
+    /**
+     * 
+     * @type {RepositoryType}
+     * @memberof CustomProcessRequestPipelineCode
+     */
+    repositoryType?: RepositoryType;
+    /**
+     * Main script for running the pipeline
+     * @type {string}
+     * @memberof CustomProcessRequestPipelineCode
+     */
+    entryPoint?: string;
+}
+
+/**
+ * Check if a given object implements the CustomProcessRequestPipelineCode interface.
+ */
+export function instanceOfCustomProcessRequestPipelineCode(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "repositoryPath" in value;
+
+    return isInstance;
+}
+
+export function CustomProcessRequestPipelineCodeFromJSON(json: any): CustomProcessRequestPipelineCode {
+    return CustomProcessRequestPipelineCodeFromJSONTyped(json, false);
+}
+
+export function CustomProcessRequestPipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessRequestPipelineCode {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    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'],
+    };
+}
+
+export function CustomProcessRequestPipelineCodeToJSON(value?: CustomProcessRequestPipelineCode | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'repositoryPath': value.repositoryPath,
+        'version': value.version,
+        'repositoryType': RepositoryTypeToJSON(value.repositoryType),
+        'entryPoint': value.entryPoint,
+    };
+}
+

package/src/models/FileNamePattern.ts

@@ -31,12 +31,6 @@ export interface FileNamePattern {
      * @memberof FileNamePattern
      */
     description: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof FileNamePattern
-     */
-    sampleMatchingPattern: string;
 }
 
 /**
@@ -46,7 +40,6 @@ export function instanceOfFileNamePattern(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "exampleName" in value;
     isInstance = isInstance && "description" in value;
-    isInstance = isInstance && "sampleMatchingPattern" in value;
 
     return isInstance;
 }
@@ -63,7 +56,6 @@ export function FileNamePatternFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'exampleName': json['exampleName'],
         'description': json['description'],
-        'sampleMatchingPattern': json['sampleMatchingPattern'],
     };
 }
 
@@ -78,7 +70,6 @@ export function FileNamePatternToJSON(value?: FileNamePattern | null): any {
         
         'exampleName': value.exampleName,
         'description': value.description,
-        'sampleMatchingPattern': value.sampleMatchingPattern,
     };
 }
 

package/src/models/GenerateSftpCredentialsRequest.ts

@@ -20,11 +20,11 @@ import { exists, mapValues } from '../runtime';
  */
 export interface GenerateSftpCredentialsRequest {
     /**
-     * 
+     * Number of days the credentials are valid for
      * @type {number}
      * @memberof GenerateSftpCredentialsRequest
      */
-    lifetimeDays: number;
+    lifetimeDays?: number;
 }
 
 /**
@@ -32,7 +32,6 @@ export interface GenerateSftpCredentialsRequest {
  */
 export function instanceOfGenerateSftpCredentialsRequest(value: object): boolean {
     let isInstance = true;
-    isInstance = isInstance && "lifetimeDays" in value;
 
     return isInstance;
 }
@@ -47,7 +46,7 @@ export function GenerateSftpCredentialsRequestFromJSONTyped(json: any, ignoreDis
     }
     return {
         
-        'lifetimeDays': json['lifetimeDays'],
+        'lifetimeDays': !exists(json, 'lifetimeDays') ? undefined : json['lifetimeDays'],
     };
 }
 

package/src/models/PipelineCode.ts

@@ -0,0 +1,97 @@
+/* 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 { RepositoryType } from './RepositoryType';
+import {
+    RepositoryTypeFromJSON,
+    RepositoryTypeFromJSONTyped,
+    RepositoryTypeToJSON,
+} from './RepositoryType';
+
+/**
+ * Used to describe the pipeline analysis code
+ * @export
+ * @interface PipelineCode
+ */
+export interface PipelineCode {
+    /**
+     * GitHub repository which contains the workflow code
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    repositoryPath: string;
+    /**
+     * Branch, tag, or commit hash of the pipeline code
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    version?: string;
+    /**
+     * 
+     * @type {RepositoryType}
+     * @memberof PipelineCode
+     */
+    repositoryType?: RepositoryType;
+    /**
+     * Main script for running the pipeline
+     * @type {string}
+     * @memberof PipelineCode
+     */
+    entryPoint?: string;
+}
+
+/**
+ * Check if a given object implements the PipelineCode interface.
+ */
+export function instanceOfPipelineCode(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "repositoryPath" in value;
+
+    return isInstance;
+}
+
+export function PipelineCodeFromJSON(json: any): PipelineCode {
+    return PipelineCodeFromJSONTyped(json, false);
+}
+
+export function PipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCode {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    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'],
+    };
+}
+
+export function PipelineCodeToJSON(value?: PipelineCode | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'repositoryPath': value.repositoryPath,
+        'version': value.version,
+        'repositoryType': RepositoryTypeToJSON(value.repositoryType),
+        'entryPoint': value.entryPoint,
+    };
+}
+

package/src/models/ProcessDetail.ts

@@ -33,7 +33,7 @@ import {
  */
 export interface ProcessDetail {
     /**
-     * Unique ID of the Process
+     * 
      * @type {string}
      * @memberof ProcessDetail
      */

package/src/models/RepositoryType.ts

@@ -0,0 +1,39 @@
+/* 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.
+ */
+
+/**
+ * Type of repository
+ * @export
+ * @enum {string}
+ */
+export enum RepositoryType {
+    None = 'NONE',
+    Aws = 'AWS',
+    GithubPublic = 'GITHUB_PUBLIC',
+    GithubPrivate = 'GITHUB_PRIVATE'
+}
+
+
+export function RepositoryTypeFromJSON(json: any): RepositoryType {
+    return RepositoryTypeFromJSONTyped(json, false);
+}
+
+export function RepositoryTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepositoryType {
+    return json as RepositoryType;
+}
+
+export function RepositoryTypeToJSON(value?: RepositoryType | null): any {
+    return value as any;
+}
+

package/src/models/index.ts

@@ -10,6 +10,9 @@ 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';
@@ -34,6 +37,7 @@ export * from './NotebookInstanceStatusResponse';
 export * from './OpenNotebookInstanceResponse';
 export * from './PaginatedResponseDatasetListDto';
 export * from './PaginatedResponseSampleDto';
+export * from './PipelineCode';
 export * from './Process';
 export * from './ProcessDetail';
 export * from './Project';
@@ -45,6 +49,7 @@ export * from './ProjectSettings';
 export * from './ProjectUser';
 export * from './Reference';
 export * from './ReferenceType';
+export * from './RepositoryType';
 export * from './RunAnalysisRequest';
 export * from './S3Credentials';
 export * from './Sample';