@cirrobio/api-client 0.2.22 → 0.4.0

package/dist/models/ProcessDetail.d.ts

@@ -14,7 +14,7 @@ import type { Executor } from './Executor';
 import type { FileMappingRule } from './FileMappingRule';
 import type { PipelineCode } from './PipelineCode';
 /**
- *
+ * Identifies a data type or pipeline in Cirro
  * @export
  * @interface ProcessDetail
  */
@@ -32,7 +32,7 @@ export interface ProcessDetail {
      */
     name: string;
     /**
-     *
+     * Description of the process
      * @type {string}
      * @memberof ProcessDetail
      */
@@ -42,7 +42,7 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    dataType?: string | null;
+    dataType: string;
     /**
      *
      * @type {Executor}
@@ -68,23 +68,23 @@ export interface ProcessDetail {
      */
     childProcessIds: Array<string>;
     /**
-     * IDs of pipelines that can run this pipeline
+     * IDs of processes that can run this pipeline
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     parentProcessIds: Array<string>;
     /**
-     * Link to pipeline documentation
+     * Link to process documentation
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl?: string | null;
+    documentationUrl?: string;
     /**
      * Description of the files to be uploaded (optional)
      * @type {string}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage?: string | null;
+    fileRequirementsMessage?: string;
     /**
      *
      * @type {PipelineCode}
@@ -98,29 +98,35 @@ export interface ProcessDetail {
      */
     owner?: string | null;
     /**
-     * Projects that can run this pipeline
+     * Projects that can run this process
      * @type {Array<string>}
      * @memberof ProcessDetail
      */
     linkedProjectIds: Array<string>;
     /**
-     * Whether the pipeline is available to all projects in the organization
+     * Whether the process is shared with the tenant
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    isTenantWide?: boolean;
+    isTenantWide: boolean;
     /**
      * Whether the pipeline is allowed to have multiple dataset sources
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    allowMultipleSources?: boolean;
+    allowMultipleSources: boolean;
     /**
      * Whether the pipeline uses the Cirro-provided sample sheet
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    usesSampleSheet?: boolean;
+    usesSampleSheet: boolean;
+    /**
+     * Whether the process is marked as archived
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    isArchived: boolean;
     /**
      *
      * @type {CustomPipelineSettings}
@@ -128,17 +134,23 @@ export interface ProcessDetail {
      */
     customSettings?: CustomPipelineSettings | null;
     /**
-     * Whether the process is marked for removal
-     * @type {boolean}
+     *
+     * @type {Array<FileMappingRule>}
      * @memberof ProcessDetail
      */
-    isArchived?: boolean;
+    fileMappingRules?: Array<FileMappingRule> | null;
     /**
-     * Describes the files that this dataset type expects.
-     * @type {Array<FileMappingRule>}
+     * When the process was created (does not reflect the pipeline code)
+     * @type {Date}
      * @memberof ProcessDetail
      */
-    fileMappingRules?: Array<FileMappingRule> | null;
+    createdAt?: Date;
+    /**
+     * When the process was updated (does not reflect the pipeline code)
+     * @type {Date}
+     * @memberof ProcessDetail
+     */
+    updatedAt?: Date;
 }
 /**
  * Check if a given object implements the ProcessDetail interface.

package/dist/models/ProcessDetail.js

@@ -27,10 +27,15 @@ function instanceOfProcessDetail(value) {
     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 && "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.instanceOfProcessDetail = instanceOfProcessDetail;
@@ -46,7 +51,7 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
-        'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
+        'dataType': json['dataType'],
         'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
         'category': !(0, runtime_1.exists)(json, 'category') ? undefined : json['category'],
         'pipelineType': !(0, runtime_1.exists)(json, 'pipelineType') ? undefined : json['pipelineType'],
@@ -57,12 +62,14 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
         'pipelineCode': !(0, runtime_1.exists)(json, 'pipelineCode') ? undefined : (0, PipelineCode_1.PipelineCodeFromJSON)(json['pipelineCode']),
         'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
         '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'],
+        'isTenantWide': json['isTenantWide'],
+        'allowMultipleSources': json['allowMultipleSources'],
+        'usesSampleSheet': json['usesSampleSheet'],
+        'isArchived': json['isArchived'],
         'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
-        'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
         'fileMappingRules': !(0, runtime_1.exists)(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRule_1.FileMappingRuleFromJSON)),
+        '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.ProcessDetailFromJSONTyped = ProcessDetailFromJSONTyped;
@@ -91,9 +98,11 @@ function ProcessDetailToJSON(value) {
         'isTenantWide': value.isTenantWide,
         'allowMultipleSources': value.allowMultipleSources,
         'usesSampleSheet': value.usesSampleSheet,
-        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
         'isArchived': value.isArchived,
+        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
         'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRule_1.FileMappingRuleToJSON)),
+        'createdAt': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
     };
 }
 exports.ProcessDetailToJSON = ProcessDetailToJSON;

package/dist/models/index.d.ts

@@ -27,6 +27,7 @@ export * from './CreateProjectAccessRequest';
 export * from './CreateReferenceRequest';
 export * from './CreateResponse';
 export * from './CustomPipelineSettings';
+export * from './CustomProcessInput';
 export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';

package/dist/models/index.js

@@ -45,6 +45,7 @@ __exportStar(require("./CreateProjectAccessRequest"), exports);
 __exportStar(require("./CreateReferenceRequest"), exports);
 __exportStar(require("./CreateResponse"), exports);
 __exportStar(require("./CustomPipelineSettings"), exports);
+__exportStar(require("./CustomProcessInput"), exports);
 __exportStar(require("./CustomerType"), exports);
 __exportStar(require("./Dashboard"), exports);
 __exportStar(require("./DashboardRequest"), exports);

package/package.json

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

package/src/apis/BillingApi.ts

@@ -132,41 +132,6 @@ export class BillingApi extends runtime.BaseAPI {
         await this.deleteBillingAccountRaw(requestParameters, initOverrides);
     }
 
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    async generateBillingReportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        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: `/billing-report`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.VoidApiResponse(response);
-    }
-
-    /**
-     * Generates a billing report xlsx with cost information
-     * Generate billing report
-     */
-    async generateBillingReport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.generateBillingReportRaw(initOverrides);
-    }
-
     /**
      * Gets a list of billing accounts the current user has access to
      * List billing accounts

package/src/apis/ProcessesApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   CreateResponse,
   CustomPipelineSettings,
+  CustomProcessInput,
   ErrorMessage,
   FileRequirements,
   FormSchema,
@@ -31,6 +32,8 @@ import {
     CreateResponseToJSON,
     CustomPipelineSettingsFromJSON,
     CustomPipelineSettingsToJSON,
+    CustomProcessInputFromJSON,
+    CustomProcessInputToJSON,
     ErrorMessageFromJSON,
     ErrorMessageToJSON,
     FileRequirementsFromJSON,
@@ -59,7 +62,7 @@ export interface CalculatePipelineCostRequest {
 }
 
 export interface CreateCustomProcessRequest {
-    processDetail: ProcessDetail;
+    customProcessInput: CustomProcessInput;
 }
 
 export interface GetProcessRequest {
@@ -80,7 +83,7 @@ export interface SyncCustomProcessRequest {
 
 export interface UpdateCustomProcessRequest {
     processId: string;
-    processDetail: ProcessDetail;
+    customProcessInput: CustomProcessInput;
 }
 
 export interface ValidateFileRequirementsOperationRequest {
@@ -184,8 +187,8 @@ export class ProcessesApi extends runtime.BaseAPI {
      * Create custom process
      */
     async createCustomProcessRaw(requestParameters: CreateCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
-        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.');
         }
 
         const queryParameters: any = {};
@@ -207,7 +210,7 @@ export class ProcessesApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: ProcessDetailToJSON(requestParameters.processDetail),
+            body: CustomProcessInputToJSON(requestParameters.customProcessInput),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
@@ -391,8 +394,8 @@ export class ProcessesApi extends runtime.BaseAPI {
             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.');
         }
 
         const queryParameters: any = {};
@@ -414,7 +417,7 @@ export class ProcessesApi extends runtime.BaseAPI {
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-            body: ProcessDetailToJSON(requestParameters.processDetail),
+            body: CustomProcessInputToJSON(requestParameters.customProcessInput),
         }, initOverrides);
 
         return new runtime.VoidApiResponse(response);

package/src/models/CustomProcessInput.ts

@@ -0,0 +1,225 @@
+/* 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 { CustomPipelineSettings } from './CustomPipelineSettings';
+import {
+    CustomPipelineSettingsFromJSON,
+    CustomPipelineSettingsFromJSONTyped,
+    CustomPipelineSettingsToJSON,
+} from './CustomPipelineSettings';
+import type { Executor } from './Executor';
+import {
+    ExecutorFromJSON,
+    ExecutorFromJSONTyped,
+    ExecutorToJSON,
+} from './Executor';
+import type { FileMappingRule } from './FileMappingRule';
+import {
+    FileMappingRuleFromJSON,
+    FileMappingRuleFromJSONTyped,
+    FileMappingRuleToJSON,
+} from './FileMappingRule';
+import type { PipelineCode } from './PipelineCode';
+import {
+    PipelineCodeFromJSON,
+    PipelineCodeFromJSONTyped,
+    PipelineCodeToJSON,
+} 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 function instanceOfCustomProcessInput(value: object): boolean {
+    let 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;
+}
+
+export function CustomProcessInputFromJSON(json: any): CustomProcessInput {
+    return CustomProcessInputFromJSONTyped(json, false);
+}
+
+export function CustomProcessInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
+        'executor': ExecutorFromJSON(json['executor']),
+        'category': !exists(json, 'category') ? undefined : json['category'],
+        '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']),
+        'linkedProjectIds': json['linkedProjectIds'],
+        'isTenantWide': !exists(json, 'isTenantWide') ? undefined : json['isTenantWide'],
+        'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
+        'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
+        'fileMappingRules': !exists(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : (json['fileMappingRules'] as Array<any>).map(FileMappingRuleFromJSON)),
+    };
+}
+
+export function CustomProcessInputToJSON(value?: CustomProcessInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'dataType': value.dataType,
+        'executor': ExecutorToJSON(value.executor),
+        'category': value.category,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'pipelineCode': PipelineCodeToJSON(value.pipelineCode),
+        'linkedProjectIds': value.linkedProjectIds,
+        'isTenantWide': value.isTenantWide,
+        'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
+        'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
+        'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : (value.fileMappingRules as Array<any>).map(FileMappingRuleToJSON)),
+    };
+}
+