@cirrobio/api-client 0.3.0 → 0.4.0

package/.openapi-generator/FILES

@@ -52,6 +52,7 @@ src/models/CreateProjectAccessRequest.ts
 src/models/CreateReferenceRequest.ts
 src/models/CreateResponse.ts
 src/models/CustomPipelineSettings.ts
+src/models/CustomProcessInput.ts
 src/models/CustomerType.ts
 src/models/Dashboard.ts
 src/models/DashboardRequest.ts

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.2.22 --save
+npm install @cirrobio/api-client@0.4.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/BillingApi.d.ts

@@ -48,16 +48,6 @@ export declare class BillingApi extends runtime.BaseAPI {
      * Delete billing account
      */
     deleteBillingAccount(requestParameters: DeleteBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    generateBillingReportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    generateBillingReport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Gets a list of billing accounts the current user has access to
      * List billing accounts

package/dist/apis/BillingApi.js

@@ -185,56 +185,6 @@ var BillingApi = /** @class */ (function (_super) {
             });
         });
     };
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    BillingApi.prototype.generateBillingReportRaw = function (initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        queryParameters = {};
-                        headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
-                        token = this.configuration.accessToken;
-                        return [4 /*yield*/, token("accessToken", [])];
-                    case 1:
-                        tokenString = _a.sent();
-                        if (tokenString) {
-                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
-                        }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
-                            path: "/billing-report",
-                            method: 'GET',
-                            headers: headerParameters,
-                            query: queryParameters,
-                        }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
-                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
-                }
-            });
-        });
-    };
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    BillingApi.prototype.generateBillingReport = function (initOverrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.generateBillingReportRaw(initOverrides)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
     /**
      * Gets a list of billing accounts the current user has access to
      * List billing accounts

package/dist/apis/ProcessesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, CustomPipelineSettings, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
+import type { CreateResponse, CustomPipelineSettings, CustomProcessInput, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
 export interface ArchiveCustomProcessRequest {
     processId: string;
 }
@@ -19,7 +19,7 @@ export interface CalculatePipelineCostRequest {
     body: object;
 }
 export interface CreateCustomProcessRequest {
-    processDetail: ProcessDetail;
+    customProcessInput: CustomProcessInput;
 }
 export interface GetProcessRequest {
     processId: string;
@@ -35,7 +35,7 @@ export interface SyncCustomProcessRequest {
 }
 export interface UpdateCustomProcessRequest {
     processId: string;
-    processDetail: ProcessDetail;
+    customProcessInput: CustomProcessInput;
 }
 export interface ValidateFileRequirementsOperationRequest {
     processId: string;

package/dist/apis/ProcessesApi.js

@@ -198,8 +198,8 @@ var ProcessesApi = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.processDetail === null || requestParameters.processDetail === undefined) {
-                            throw new runtime.RequiredError('processDetail', 'Required parameter requestParameters.processDetail was null or undefined when calling createCustomProcess.');
+                        if (requestParameters.customProcessInput === null || requestParameters.customProcessInput === undefined) {
+                            throw new runtime.RequiredError('customProcessInput', 'Required parameter requestParameters.customProcessInput was null or undefined when calling createCustomProcess.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -218,7 +218,7 @@ var ProcessesApi = /** @class */ (function (_super) {
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
-                            body: (0, index_1.ProcessDetailToJSON)(requestParameters.processDetail),
+                            body: (0, index_1.CustomProcessInputToJSON)(requestParameters.customProcessInput),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
@@ -479,8 +479,8 @@ var ProcessesApi = /** @class */ (function (_super) {
                         if (requestParameters.processId === null || requestParameters.processId === undefined) {
                             throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling updateCustomProcess.');
                         }
-                        if (requestParameters.processDetail === null || requestParameters.processDetail === undefined) {
-                            throw new runtime.RequiredError('processDetail', 'Required parameter requestParameters.processDetail was null or undefined when calling updateCustomProcess.');
+                        if (requestParameters.customProcessInput === null || requestParameters.customProcessInput === undefined) {
+                            throw new runtime.RequiredError('customProcessInput', 'Required parameter requestParameters.customProcessInput was null or undefined when calling updateCustomProcess.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -499,7 +499,7 @@ var ProcessesApi = /** @class */ (function (_super) {
                             method: 'PUT',
                             headers: headerParameters,
                             query: queryParameters,
-                            body: (0, index_1.ProcessDetailToJSON)(requestParameters.processDetail),
+                            body: (0, index_1.CustomProcessInputToJSON)(requestParameters.customProcessInput),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();

package/dist/models/CustomProcessInput.d.ts

@@ -0,0 +1,131 @@
+/**
+ * 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 { CustomPipelineSettings } from './CustomPipelineSettings';
+import type { Executor } from './Executor';
+import type { FileMappingRule } from './FileMappingRule';
+import type { PipelineCode } from './PipelineCode';
+/**
+ *
+ * @export
+ * @interface CustomProcessInput
+ */
+export interface CustomProcessInput {
+    /**
+     * Unique ID of the Process
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    id: string;
+    /**
+     * Friendly name for the process
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    name: string;
+    /**
+     * Description of the process
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    description: string;
+    /**
+     * Name of the data type this pipeline produces (if it is not defined, use the name)
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    dataType?: string | null;
+    /**
+     *
+     * @type {Executor}
+     * @memberof CustomProcessInput
+     */
+    executor: Executor;
+    /**
+     * Category of the process
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    category?: string;
+    /**
+     * IDs of pipelines that can be run downstream
+     * @type {Array<string>}
+     * @memberof CustomProcessInput
+     */
+    childProcessIds: Array<string>;
+    /**
+     * IDs of processes that can run this pipeline
+     * @type {Array<string>}
+     * @memberof CustomProcessInput
+     */
+    parentProcessIds: Array<string>;
+    /**
+     * Link to process documentation
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    documentationUrl?: string | null;
+    /**
+     * Description of the files to be uploaded (optional)
+     * @type {string}
+     * @memberof CustomProcessInput
+     */
+    fileRequirementsMessage?: string | null;
+    /**
+     *
+     * @type {PipelineCode}
+     * @memberof CustomProcessInput
+     */
+    pipelineCode?: PipelineCode | null;
+    /**
+     * Projects that can run this process
+     * @type {Array<string>}
+     * @memberof CustomProcessInput
+     */
+    linkedProjectIds: Array<string>;
+    /**
+     * Whether the process is shared with the tenant
+     * @type {boolean}
+     * @memberof CustomProcessInput
+     */
+    isTenantWide?: boolean;
+    /**
+     * Whether the pipeline is allowed to have multiple dataset sources
+     * @type {boolean}
+     * @memberof CustomProcessInput
+     */
+    allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof CustomProcessInput
+     */
+    usesSampleSheet?: boolean;
+    /**
+     *
+     * @type {CustomPipelineSettings}
+     * @memberof CustomProcessInput
+     */
+    customSettings?: CustomPipelineSettings | null;
+    /**
+     *
+     * @type {Array<FileMappingRule>}
+     * @memberof CustomProcessInput
+     */
+    fileMappingRules?: Array<FileMappingRule> | null;
+}
+/**
+ * Check if a given object implements the CustomProcessInput interface.
+ */
+export declare function instanceOfCustomProcessInput(value: object): boolean;
+export declare function CustomProcessInputFromJSON(json: any): CustomProcessInput;
+export declare function CustomProcessInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessInput;
+export declare function CustomProcessInputToJSON(value?: CustomProcessInput | null): any;

package/dist/models/CustomProcessInput.js

@@ -0,0 +1,93 @@
+"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.CustomProcessInputToJSON = exports.CustomProcessInputFromJSONTyped = exports.CustomProcessInputFromJSON = exports.instanceOfCustomProcessInput = void 0;
+var runtime_1 = require("../runtime");
+var CustomPipelineSettings_1 = require("./CustomPipelineSettings");
+var Executor_1 = require("./Executor");
+var FileMappingRule_1 = require("./FileMappingRule");
+var PipelineCode_1 = require("./PipelineCode");
+/**
+ * Check if a given object implements the CustomProcessInput interface.
+ */
+function instanceOfCustomProcessInput(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "executor" in value;
+    isInstance = isInstance && "childProcessIds" in value;
+    isInstance = isInstance && "parentProcessIds" in value;
+    isInstance = isInstance && "linkedProjectIds" in value;
+    return isInstance;
+}
+exports.instanceOfCustomProcessInput = instanceOfCustomProcessInput;
+function CustomProcessInputFromJSON(json) {
+    return CustomProcessInputFromJSONTyped(json, false);
+}
+exports.CustomProcessInputFromJSON = CustomProcessInputFromJSON;
+function CustomProcessInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        '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']),
+        'category': !(0, runtime_1.exists)(json, 'category') ? undefined : json['category'],
+        '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']),
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': !(0, runtime_1.exists)(json, 'isTenantWide') ? undefined : json['isTenantWide'],
+        'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
+        'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
+        'fileMappingRules': !(0, runtime_1.exists)(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRule_1.FileMappingRuleFromJSON)),
+    };
+}
+exports.CustomProcessInputFromJSONTyped = CustomProcessInputFromJSONTyped;
+function CustomProcessInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'dataType': value.dataType,
+        'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
+        'category': value.category,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'pipelineCode': (0, PipelineCode_1.PipelineCodeToJSON)(value.pipelineCode),
+        'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
+        'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
+        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
+        'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRule_1.FileMappingRuleToJSON)),
+    };
+}
+exports.CustomProcessInputToJSON = CustomProcessInputToJSON;

package/dist/models/Process.d.ts

@@ -11,7 +11,7 @@
  */
 import type { Executor } from './Executor';
 /**
- *
+ * Identifies a data type or pipeline in Cirro
  * @export
  * @interface Process
  */
@@ -29,17 +29,17 @@ export interface Process {
      */
     name: string;
     /**
-     *
+     * Description of the process
      * @type {string}
      * @memberof Process
      */
-    description?: string;
+    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;
+    dataType: string;
     /**
      *
      * @type {Executor}
@@ -51,15 +51,15 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    category: string;
+    category?: string;
     /**
      * Type of pipeline
      * @type {string}
      * @memberof Process
      */
-    pipelineType: string;
+    pipelineType?: string;
     /**
-     * Link to pipeline documentation
+     * Link to process documentation
      * @type {string}
      * @memberof Process
      */
@@ -75,43 +75,61 @@ export interface Process {
      * @type {Array<string>}
      * @memberof Process
      */
-    childProcessIds?: Array<string>;
+    childProcessIds: Array<string>;
     /**
-     * IDs of pipelines that can run this pipeline
+     * IDs of processes that can run this pipeline
      * @type {Array<string>}
      * @memberof Process
      */
-    parentProcessIds?: Array<string>;
+    parentProcessIds: Array<string>;
     /**
      * Username of the pipeline creator (blank if Cirro curated)
      * @type {string}
      * @memberof Process
      */
-    owner?: string;
+    owner?: string | null;
     /**
-     * Projects that can run this pipeline
+     * Projects that can run this process
      * @type {Array<string>}
      * @memberof Process
      */
-    linkedProjectIds?: Array<string>;
+    linkedProjectIds: Array<string>;
+    /**
+     * Whether the process is shared with the tenant
+     * @type {boolean}
+     * @memberof Process
+     */
+    isTenantWide: boolean;
     /**
      * Whether the pipeline is allowed to have multiple dataset sources
      * @type {boolean}
      * @memberof Process
      */
-    allowMultipleSources?: boolean;
+    allowMultipleSources: boolean;
     /**
      * Whether the pipeline uses the Cirro-provided sample sheet
      * @type {boolean}
      * @memberof Process
      */
-    usesSampleSheet?: boolean;
+    usesSampleSheet: boolean;
     /**
-     * Whether the pipeline is marked as archived
+     * Whether the process is marked as archived
      * @type {boolean}
      * @memberof Process
      */
-    isArchived?: boolean;
+    isArchived: boolean;
+    /**
+     * When the process was created (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof Process
+     */
+    createdAt?: Date;
+    /**
+     * When the process was updated (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof Process
+     */
+    updatedAt?: Date;
 }
 /**
  * Check if a given object implements the Process interface.

package/dist/models/Process.js

@@ -23,9 +23,16 @@ function instanceOfProcess(value) {
     var isInstance = true;
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "dataType" in value;
     isInstance = isInstance && "executor" in value;
-    isInstance = isInstance && "category" in value;
-    isInstance = isInstance && "pipelineType" in value;
+    isInstance = isInstance && "childProcessIds" in value;
+    isInstance = isInstance && "parentProcessIds" in value;
+    isInstance = isInstance && "linkedProjectIds" in value;
+    isInstance = isInstance && "isTenantWide" in value;
+    isInstance = isInstance && "allowMultipleSources" in value;
+    isInstance = isInstance && "usesSampleSheet" in value;
+    isInstance = isInstance && "isArchived" in value;
     return isInstance;
 }
 exports.instanceOfProcess = instanceOfProcess;
@@ -40,20 +47,23 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
-        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
-        'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
+        'description': json['description'],
+        'dataType': json['dataType'],
         'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
-        'category': json['category'],
-        'pipelineType': json['pipelineType'],
+        'category': !(0, runtime_1.exists)(json, 'category') ? undefined : json['category'],
+        'pipelineType': !(0, runtime_1.exists)(json, 'pipelineType') ? undefined : json['pipelineType'],
         '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'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
         'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
-        'linkedProjectIds': !(0, runtime_1.exists)(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
-        'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
-        'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
-        'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
+        'createdAt': !(0, runtime_1.exists)(json, 'createdAt') ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': !(0, runtime_1.exists)(json, 'updatedAt') ? undefined : (new Date(json['updatedAt'])),
     };
 }
 exports.ProcessFromJSONTyped = ProcessFromJSONTyped;
@@ -78,9 +88,12 @@ function ProcessToJSON(value) {
         'parentProcessIds': value.parentProcessIds,
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
         'allowMultipleSources': value.allowMultipleSources,
         'usesSampleSheet': value.usesSampleSheet,
         'isArchived': value.isArchived,
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
     };
 }
 exports.ProcessToJSON = ProcessToJSON;