@cirrobio/api-client 0.1.9 → 0.1.11

package/package.json

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

package/src/apis/ProcessesApi.ts

@@ -20,6 +20,7 @@ import type {
   ErrorMessage,
   FileRequirements,
   FormSchema,
+  PipelineCost,
   PortalErrorResponse,
   Process,
   ProcessDetail,
@@ -36,6 +37,8 @@ import {
     FileRequirementsToJSON,
     FormSchemaFromJSON,
     FormSchemaToJSON,
+    PipelineCostFromJSON,
+    PipelineCostToJSON,
     PortalErrorResponseFromJSON,
     PortalErrorResponseToJSON,
     ProcessFromJSON,
@@ -50,6 +53,11 @@ export interface ArchiveCustomProcessRequest {
     processId: string;
 }
 
+export interface CalculatePipelineCostRequest {
+    processId: string;
+    body: object;
+}
+
 export interface CreateCustomProcessRequest {
     processDetail: ProcessDetail;
 }
@@ -124,6 +132,53 @@ export class ProcessesApi extends runtime.BaseAPI {
         await this.archiveCustomProcessRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    async calculatePipelineCostRaw(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PipelineCost>> {
+        if (requestParameters.processId === null || requestParameters.processId === undefined) {
+            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling calculatePipelineCost.');
+        }
+
+        if (requestParameters.body === null || requestParameters.body === undefined) {
+            throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling calculatePipelineCost.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/processes/{processId}/cost`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters.body as any,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PipelineCostFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the cost of running the pipeline
+     * Calculate pipeline cost
+     */
+    async calculatePipelineCost(requestParameters: CalculatePipelineCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PipelineCost> {
+        const response = await this.calculatePipelineCostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates a custom data type or pipeline which you can use in the listed projects.
      * Create custom process

package/src/models/Executor.ts

@@ -20,7 +20,8 @@
 export enum Executor {
     Ingest = 'INGEST',
     Nextflow = 'NEXTFLOW',
-    Cromwell = 'CROMWELL'
+    Cromwell = 'CROMWELL',
+    OmicsReady2Run = 'OMICS_READY2RUN'
 }
 
 

package/src/models/PipelineCost.ts

@@ -0,0 +1,81 @@
+/* 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 PipelineCost
+ */
+export interface PipelineCost {
+    /**
+     * The total cost of running the pipeline
+     * @type {number}
+     * @memberof PipelineCost
+     */
+    totalCost?: number;
+    /**
+     * Is this an estimate of the cost?
+     * @type {boolean}
+     * @memberof PipelineCost
+     */
+    isEstimate?: boolean;
+    /**
+     * Description of the cost calculation
+     * @type {string}
+     * @memberof PipelineCost
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the PipelineCost interface.
+ */
+export function instanceOfPipelineCost(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function PipelineCostFromJSON(json: any): PipelineCost {
+    return PipelineCostFromJSONTyped(json, false);
+}
+
+export function PipelineCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCost {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'totalCost': !exists(json, 'totalCost') ? undefined : json['totalCost'],
+        'isEstimate': !exists(json, 'isEstimate') ? undefined : json['isEstimate'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+    };
+}
+
+export function PipelineCostToJSON(value?: PipelineCost | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'totalCost': value.totalCost,
+        'isEstimate': value.isEstimate,
+        'description': value.description,
+    };
+}
+

package/src/models/index.ts

@@ -46,6 +46,7 @@ export * from './OpenNotebookInstanceResponse';
 export * from './PaginatedResponseDatasetListDto';
 export * from './PaginatedResponseSampleDto';
 export * from './PipelineCode';
+export * from './PipelineCost';
 export * from './PortalErrorResponse';
 export * from './Process';
 export * from './ProcessDetail';

package/dist/models/CreateDashboardRequest.d.ts

@@ -1,31 +0,0 @@
-/**
- * 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.
- */
-/**
- *
- * @export
- * @interface CreateDashboardRequest
- */
-export interface CreateDashboardRequest {
-    /**
-     *
-     * @type {object}
-     * @memberof CreateDashboardRequest
-     */
-    dashboardRequest?: object;
-}
-/**
- * Check if a given object implements the CreateDashboardRequest interface.
- */
-export declare function instanceOfCreateDashboardRequest(value: object): boolean;
-export declare function CreateDashboardRequestFromJSON(json: any): CreateDashboardRequest;
-export declare function CreateDashboardRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDashboardRequest;
-export declare function CreateDashboardRequestToJSON(value?: CreateDashboardRequest | null): any;

package/dist/models/CreateDashboardRequest.js

@@ -1,50 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateDashboardRequestToJSON = exports.CreateDashboardRequestFromJSONTyped = exports.CreateDashboardRequestFromJSON = exports.instanceOfCreateDashboardRequest = void 0;
-var runtime_1 = require("../runtime");
-/**
- * Check if a given object implements the CreateDashboardRequest interface.
- */
-function instanceOfCreateDashboardRequest(value) {
-    var isInstance = true;
-    return isInstance;
-}
-exports.instanceOfCreateDashboardRequest = instanceOfCreateDashboardRequest;
-function CreateDashboardRequestFromJSON(json) {
-    return CreateDashboardRequestFromJSONTyped(json, false);
-}
-exports.CreateDashboardRequestFromJSON = CreateDashboardRequestFromJSON;
-function CreateDashboardRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        'dashboardRequest': !(0, runtime_1.exists)(json, 'dashboardRequest') ? undefined : json['dashboardRequest'],
-    };
-}
-exports.CreateDashboardRequestFromJSONTyped = CreateDashboardRequestFromJSONTyped;
-function CreateDashboardRequestToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        'dashboardRequest': value.dashboardRequest,
-    };
-}
-exports.CreateDashboardRequestToJSON = CreateDashboardRequestToJSON;

package/dist/models/CustomPipelineSettingsDto1.d.ts

@@ -1,61 +0,0 @@
-/**
- * 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.
- */
-/**
- *
- * @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 declare function instanceOfCustomPipelineSettingsDto1(value: object): boolean;
-export declare function CustomPipelineSettingsDto1FromJSON(json: any): CustomPipelineSettingsDto1;
-export declare function CustomPipelineSettingsDto1FromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomPipelineSettingsDto1;
-export declare function CustomPipelineSettingsDto1ToJSON(value?: CustomPipelineSettingsDto1 | null): any;

package/dist/models/CustomPipelineSettingsDto1.js

@@ -1,65 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomPipelineSettingsDto1ToJSON = exports.CustomPipelineSettingsDto1FromJSONTyped = exports.CustomPipelineSettingsDto1FromJSON = exports.instanceOfCustomPipelineSettingsDto1 = void 0;
-/**
- * Check if a given object implements the CustomPipelineSettingsDto1 interface.
- */
-function instanceOfCustomPipelineSettingsDto1(value) {
-    var 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;
-}
-exports.instanceOfCustomPipelineSettingsDto1 = instanceOfCustomPipelineSettingsDto1;
-function CustomPipelineSettingsDto1FromJSON(json) {
-    return CustomPipelineSettingsDto1FromJSONTyped(json, false);
-}
-exports.CustomPipelineSettingsDto1FromJSON = CustomPipelineSettingsDto1FromJSON;
-function CustomPipelineSettingsDto1FromJSONTyped(json, ignoreDiscriminator) {
-    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'],
-    };
-}
-exports.CustomPipelineSettingsDto1FromJSONTyped = CustomPipelineSettingsDto1FromJSONTyped;
-function CustomPipelineSettingsDto1ToJSON(value) {
-    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,
-    };
-}
-exports.CustomPipelineSettingsDto1ToJSON = CustomPipelineSettingsDto1ToJSON;

package/dist/models/CustomProcessRequest.d.ts

@@ -1,99 +0,0 @@
-/**
- * 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 type { CustomProcessRequestPipelineCode } from './CustomProcessRequestPipelineCode';
-import type { Executor } 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 declare function instanceOfCustomProcessRequest(value: object): boolean;
-export declare function CustomProcessRequestFromJSON(json: any): CustomProcessRequest;
-export declare function CustomProcessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessRequest;
-export declare function CustomProcessRequestToJSON(value?: CustomProcessRequest | null): any;

package/dist/models/CustomProcessRequest.js

@@ -1,83 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomProcessRequestToJSON = exports.CustomProcessRequestFromJSONTyped = exports.CustomProcessRequestFromJSON = exports.instanceOfCustomProcessRequest = void 0;
-var runtime_1 = require("../runtime");
-var CustomProcessRequestPipelineCode_1 = require("./CustomProcessRequestPipelineCode");
-var Executor_1 = require("./Executor");
-/**
- * Check if a given object implements the CustomProcessRequest interface.
- */
-function instanceOfCustomProcessRequest(value) {
-    var 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;
-}
-exports.instanceOfCustomProcessRequest = instanceOfCustomProcessRequest;
-function CustomProcessRequestFromJSON(json) {
-    return CustomProcessRequestFromJSONTyped(json, false);
-}
-exports.CustomProcessRequestFromJSON = CustomProcessRequestFromJSON;
-function CustomProcessRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        'processId': !(0, runtime_1.exists)(json, 'processId') ? undefined : json['processId'],
-        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
-        'description': json['description'],
-        'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
-        'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
-        'pipelineCode': (0, CustomProcessRequestPipelineCode_1.CustomProcessRequestPipelineCodeFromJSON)(json['pipelineCode']),
-        'childProcessIds': json['childProcessIds'],
-        'parentProcessIds': json['parentProcessIds'],
-        'projectIds': json['projectIds'],
-        'definitionRepository': json['definitionRepository'],
-        'definitionBranch': json['definitionBranch'],
-        'definitionFolder': json['definitionFolder'],
-    };
-}
-exports.CustomProcessRequestFromJSONTyped = CustomProcessRequestFromJSONTyped;
-function CustomProcessRequestToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        'processId': value.processId,
-        'name': value.name,
-        'description': value.description,
-        'documentationUrl': value.documentationUrl,
-        'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
-        'pipelineCode': (0, CustomProcessRequestPipelineCode_1.CustomProcessRequestPipelineCodeToJSON)(value.pipelineCode),
-        'childProcessIds': value.childProcessIds,
-        'parentProcessIds': value.parentProcessIds,
-        'projectIds': value.projectIds,
-        'definitionRepository': value.definitionRepository,
-        'definitionBranch': value.definitionBranch,
-        'definitionFolder': value.definitionFolder,
-    };
-}
-exports.CustomProcessRequestToJSON = CustomProcessRequestToJSON;

package/dist/models/CustomProcessRequestPipelineCode.d.ts

@@ -1,50 +0,0 @@
-/**
- * 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 type { RepositoryType } 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 declare function instanceOfCustomProcessRequestPipelineCode(value: object): boolean;
-export declare function CustomProcessRequestPipelineCodeFromJSON(json: any): CustomProcessRequestPipelineCode;
-export declare function CustomProcessRequestPipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessRequestPipelineCode;
-export declare function CustomProcessRequestPipelineCodeToJSON(value?: CustomProcessRequestPipelineCode | null): any;