@cirrobio/api-client 0.11.0 → 0.11.2

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

package/dist/apis/ExecutionApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, GetExecutionLogsResponse, RunAnalysisRequest, StopExecutionResponse, Task } from '../models/index';
+import type { CostResponse, CreateResponse, GetExecutionLogsResponse, RunAnalysisRequest, StopExecutionResponse, Task } from '../models/index';
+export interface CalculateCostRequest {
+    projectId: string;
+    datasetId: string;
+}
 export interface GetExecutionLogsRequest {
     datasetId: string;
     projectId: string;
@@ -43,6 +47,16 @@ export interface StopAnalysisRequest {
  *
  */
 export declare class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCostRaw(requestParameters: CalculateCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CostResponse>>;
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCost(requestParameters: CalculateCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CostResponse>;
     /**
      * Gets live logs from main execution task
      * Get execution logs

package/dist/apis/ExecutionApi.js

@@ -29,6 +29,46 @@ const index_1 = require("../models/index");
  *
  */
 class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCostRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling calculateCost.');
+            }
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling calculateCost.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/cost`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CostResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCost(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.calculateCostRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Gets live logs from main execution task
      * Get execution logs

package/dist/apis/WorkspacesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceInput } from '../models/index';
+import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
 export interface ConnectWorkspaceRequest {
     projectId: string;
     workspaceId: string;
@@ -102,6 +102,16 @@ export declare class WorkspacesApi extends runtime.BaseAPI {
      * Get workspace
      */
     getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironmentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkspaceEnvironment>>>;
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkspaceEnvironment>>;
     /**
      * Retrieves a list of workspaces that the user has access to
      * Get workspaces

package/dist/apis/WorkspacesApi.js

@@ -235,6 +235,40 @@ class WorkspacesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironmentsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/workspace-environments`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.WorkspaceEnvironmentFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironments(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWorkspaceEnvironmentsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves a list of workspaces that the user has access to
      * Get workspaces

package/dist/esm/apis/ExecutionApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, GetExecutionLogsResponse, RunAnalysisRequest, StopExecutionResponse, Task } from '../models/index';
+import type { CostResponse, CreateResponse, GetExecutionLogsResponse, RunAnalysisRequest, StopExecutionResponse, Task } from '../models/index';
+export interface CalculateCostRequest {
+    projectId: string;
+    datasetId: string;
+}
 export interface GetExecutionLogsRequest {
     datasetId: string;
     projectId: string;
@@ -43,6 +47,16 @@ export interface StopAnalysisRequest {
  *
  */
 export declare class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCostRaw(requestParameters: CalculateCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CostResponse>>;
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCost(requestParameters: CalculateCostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CostResponse>;
     /**
      * Gets live logs from main execution task
      * Get execution logs

package/dist/esm/apis/ExecutionApi.js

@@ -21,11 +21,51 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateResponseFromJSON, GetExecutionLogsResponseFromJSON, RunAnalysisRequestToJSON, StopExecutionResponseFromJSON, TaskFromJSON, } from '../models/index';
+import { CostResponseFromJSON, CreateResponseFromJSON, GetExecutionLogsResponseFromJSON, RunAnalysisRequestToJSON, StopExecutionResponseFromJSON, TaskFromJSON, } from '../models/index';
 /**
  *
  */
 export class ExecutionApi extends runtime.BaseAPI {
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCostRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling calculateCost.');
+            }
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling calculateCost.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/cost`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CostResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Calculate cost of an execution run
+     * Calculate cost
+     */
+    calculateCost(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.calculateCostRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Gets live logs from main execution task
      * Get execution logs

package/dist/esm/apis/WorkspacesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceInput } from '../models/index';
+import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
 export interface ConnectWorkspaceRequest {
     projectId: string;
     workspaceId: string;
@@ -102,6 +102,16 @@ export declare class WorkspacesApi extends runtime.BaseAPI {
      * Get workspace
      */
     getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironmentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkspaceEnvironment>>>;
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkspaceEnvironment>>;
     /**
      * Retrieves a list of workspaces that the user has access to
      * Get workspaces

package/dist/esm/apis/WorkspacesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateResponseFromJSON, WorkspaceFromJSON, WorkspaceConnectionResponseFromJSON, WorkspaceInputToJSON, } from '../models/index';
+import { CreateResponseFromJSON, WorkspaceFromJSON, WorkspaceConnectionResponseFromJSON, WorkspaceEnvironmentFromJSON, WorkspaceInputToJSON, } from '../models/index';
 /**
  *
  */
@@ -232,6 +232,40 @@ export class WorkspacesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironmentsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/workspace-environments`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(WorkspaceEnvironmentFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of pre-defined workspace environments available to use
+     * Get workspace environments
+     */
+    getWorkspaceEnvironments(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWorkspaceEnvironmentsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves a list of workspaces that the user has access to
      * Get workspaces

package/dist/esm/models/CostResponse.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { GroupCost } from './GroupCost';
+import type { TaskCost } from './TaskCost';
+/**
+ *
+ * @export
+ * @interface CostResponse
+ */
+export interface CostResponse {
+    /**
+     * Total cost
+     * @type {number}
+     * @memberof CostResponse
+     */
+    totalCost?: number;
+    /**
+     * Costs grouped by the task status
+     * @type {Array<GroupCost>}
+     * @memberof CostResponse
+     */
+    groups?: Array<GroupCost>;
+    /**
+     * Costs for each workflow task
+     * @type {Array<TaskCost>}
+     * @memberof CostResponse
+     */
+    tasks?: Array<TaskCost>;
+    /**
+     * Whether this is an estimated cost
+     * @type {boolean}
+     * @memberof CostResponse
+     */
+    isEstimate?: boolean;
+}
+/**
+ * Check if a given object implements the CostResponse interface.
+ */
+export declare function instanceOfCostResponse(value: object): boolean;
+export declare function CostResponseFromJSON(json: any): CostResponse;
+export declare function CostResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CostResponse;
+export declare function CostResponseToJSON(value?: CostResponse | null): any;

package/dist/esm/models/CostResponse.js

@@ -0,0 +1,51 @@
+/* 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 } from '../runtime';
+import { GroupCostFromJSON, GroupCostToJSON, } from './GroupCost';
+import { TaskCostFromJSON, TaskCostToJSON, } from './TaskCost';
+/**
+ * Check if a given object implements the CostResponse interface.
+ */
+export function instanceOfCostResponse(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function CostResponseFromJSON(json) {
+    return CostResponseFromJSONTyped(json, false);
+}
+export function CostResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'totalCost': !exists(json, 'totalCost') ? undefined : json['totalCost'],
+        'groups': !exists(json, 'groups') ? undefined : (json['groups'].map(GroupCostFromJSON)),
+        'tasks': !exists(json, 'tasks') ? undefined : (json['tasks'].map(TaskCostFromJSON)),
+        'isEstimate': !exists(json, 'isEstimate') ? undefined : json['isEstimate'],
+    };
+}
+export function CostResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'totalCost': value.totalCost,
+        'groups': value.groups === undefined ? undefined : (value.groups.map(GroupCostToJSON)),
+        'tasks': value.tasks === undefined ? undefined : (value.tasks.map(TaskCostToJSON)),
+        'isEstimate': value.isEstimate,
+    };
+}

package/dist/esm/models/FeatureFlags.d.ts

@@ -33,6 +33,12 @@ export interface FeatureFlags {
      * @memberof FeatureFlags
      */
     projectRequestsEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FeatureFlags
+     */
+    workspacesEnabled: boolean;
 }
 /**
  * Check if a given object implements the FeatureFlags interface.

package/dist/esm/models/FeatureFlags.js

@@ -19,6 +19,7 @@ export function instanceOfFeatureFlags(value) {
     isInstance = isInstance && "sftpEnabled" in value;
     isInstance = isInstance && "governanceEnabled" in value;
     isInstance = isInstance && "projectRequestsEnabled" in value;
+    isInstance = isInstance && "workspacesEnabled" in value;
     return isInstance;
 }
 export function FeatureFlagsFromJSON(json) {
@@ -32,6 +33,7 @@ export function FeatureFlagsFromJSONTyped(json, ignoreDiscriminator) {
         'sftpEnabled': json['sftpEnabled'],
         'governanceEnabled': json['governanceEnabled'],
         'projectRequestsEnabled': json['projectRequestsEnabled'],
+        'workspacesEnabled': json['workspacesEnabled'],
     };
 }
 export function FeatureFlagsToJSON(value) {
@@ -45,5 +47,6 @@ export function FeatureFlagsToJSON(value) {
         'sftpEnabled': value.sftpEnabled,
         'governanceEnabled': value.governanceEnabled,
         'projectRequestsEnabled': value.projectRequestsEnabled,
+        'workspacesEnabled': value.workspacesEnabled,
     };
 }

package/dist/esm/models/GroupCost.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 GroupCost
+ */
+export interface GroupCost {
+    /**
+     * Task status group
+     * @type {string}
+     * @memberof GroupCost
+     */
+    name?: string;
+    /**
+     * Cost
+     * @type {number}
+     * @memberof GroupCost
+     */
+    cost?: number;
+}
+/**
+ * Check if a given object implements the GroupCost interface.
+ */
+export declare function instanceOfGroupCost(value: object): boolean;
+export declare function GroupCostFromJSON(json: any): GroupCost;
+export declare function GroupCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupCost;
+export declare function GroupCostToJSON(value?: GroupCost | null): any;

package/dist/esm/models/GroupCost.js

@@ -0,0 +1,45 @@
+/* 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 } from '../runtime';
+/**
+ * Check if a given object implements the GroupCost interface.
+ */
+export function instanceOfGroupCost(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function GroupCostFromJSON(json) {
+    return GroupCostFromJSONTyped(json, false);
+}
+export function GroupCostFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'cost': !exists(json, 'cost') ? undefined : json['cost'],
+    };
+}
+export function GroupCostToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'cost': value.cost,
+    };
+}

package/dist/esm/models/TaskCost.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 TaskCost
+ */
+export interface TaskCost {
+    /**
+     *
+     * @type {string}
+     * @memberof TaskCost
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaskCost
+     */
+    taskId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaskCost
+     */
+    status: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TaskCost
+     */
+    cost: number;
+}
+/**
+ * Check if a given object implements the TaskCost interface.
+ */
+export declare function instanceOfTaskCost(value: object): boolean;
+export declare function TaskCostFromJSON(json: any): TaskCost;
+export declare function TaskCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaskCost;
+export declare function TaskCostToJSON(value?: TaskCost | null): any;

package/dist/esm/models/TaskCost.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the TaskCost interface.
+ */
+export function instanceOfTaskCost(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "taskId" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "cost" in value;
+    return isInstance;
+}
+export function TaskCostFromJSON(json) {
+    return TaskCostFromJSONTyped(json, false);
+}
+export function TaskCostFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'taskId': json['taskId'],
+        'status': json['status'],
+        'cost': json['cost'],
+    };
+}
+export function TaskCostToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'taskId': value.taskId,
+        'status': value.status,
+        'cost': value.cost,
+    };
+}