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

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/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/WorkspaceEnvironment.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { WorkspaceComputeConfig } from './WorkspaceComputeConfig';
+/**
+ *
+ * @export
+ * @interface WorkspaceEnvironment
+ */
+export interface WorkspaceEnvironment {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    category: string;
+    /**
+     *
+     * @type {WorkspaceComputeConfig}
+     * @memberof WorkspaceEnvironment
+     */
+    defaultComputeConfig: WorkspaceComputeConfig;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    owner: string;
+}
+/**
+ * Check if a given object implements the WorkspaceEnvironment interface.
+ */
+export declare function instanceOfWorkspaceEnvironment(value: object): boolean;
+export declare function WorkspaceEnvironmentFromJSON(json: any): WorkspaceEnvironment;
+export declare function WorkspaceEnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceEnvironment;
+export declare function WorkspaceEnvironmentToJSON(value?: WorkspaceEnvironment | null): any;

package/dist/esm/models/WorkspaceEnvironment.js

@@ -0,0 +1,59 @@
+/* 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 { WorkspaceComputeConfigFromJSON, WorkspaceComputeConfigToJSON, } from './WorkspaceComputeConfig';
+/**
+ * Check if a given object implements the WorkspaceEnvironment interface.
+ */
+export function instanceOfWorkspaceEnvironment(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "category" in value;
+    isInstance = isInstance && "defaultComputeConfig" in value;
+    isInstance = isInstance && "owner" in value;
+    return isInstance;
+}
+export function WorkspaceEnvironmentFromJSON(json) {
+    return WorkspaceEnvironmentFromJSONTyped(json, false);
+}
+export function WorkspaceEnvironmentFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'category': json['category'],
+        'defaultComputeConfig': WorkspaceComputeConfigFromJSON(json['defaultComputeConfig']),
+        'owner': json['owner'],
+    };
+}
+export function WorkspaceEnvironmentToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'category': value.category,
+        'defaultComputeConfig': WorkspaceComputeConfigToJSON(value.defaultComputeConfig),
+        'owner': value.owner,
+    };
+}

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

@@ -152,5 +152,6 @@ export * from './ValidateFileRequirementsRequest';
 export * from './Workspace';
 export * from './WorkspaceComputeConfig';
 export * from './WorkspaceConnectionResponse';
+export * from './WorkspaceEnvironment';
 export * from './WorkspaceInput';
 export * from './WorkspaceSession';

package/dist/esm/models/index.js

@@ -154,5 +154,6 @@ export * from './ValidateFileRequirementsRequest';
 export * from './Workspace';
 export * from './WorkspaceComputeConfig';
 export * from './WorkspaceConnectionResponse';
+export * from './WorkspaceEnvironment';
 export * from './WorkspaceInput';
 export * from './WorkspaceSession';

package/dist/models/WorkspaceEnvironment.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { WorkspaceComputeConfig } from './WorkspaceComputeConfig';
+/**
+ *
+ * @export
+ * @interface WorkspaceEnvironment
+ */
+export interface WorkspaceEnvironment {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    category: string;
+    /**
+     *
+     * @type {WorkspaceComputeConfig}
+     * @memberof WorkspaceEnvironment
+     */
+    defaultComputeConfig: WorkspaceComputeConfig;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceEnvironment
+     */
+    owner: string;
+}
+/**
+ * Check if a given object implements the WorkspaceEnvironment interface.
+ */
+export declare function instanceOfWorkspaceEnvironment(value: object): boolean;
+export declare function WorkspaceEnvironmentFromJSON(json: any): WorkspaceEnvironment;
+export declare function WorkspaceEnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceEnvironment;
+export declare function WorkspaceEnvironmentToJSON(value?: WorkspaceEnvironment | null): any;

package/dist/models/WorkspaceEnvironment.js

@@ -0,0 +1,66 @@
+"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.WorkspaceEnvironmentToJSON = exports.WorkspaceEnvironmentFromJSONTyped = exports.WorkspaceEnvironmentFromJSON = exports.instanceOfWorkspaceEnvironment = void 0;
+const WorkspaceComputeConfig_1 = require("./WorkspaceComputeConfig");
+/**
+ * Check if a given object implements the WorkspaceEnvironment interface.
+ */
+function instanceOfWorkspaceEnvironment(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "category" in value;
+    isInstance = isInstance && "defaultComputeConfig" in value;
+    isInstance = isInstance && "owner" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspaceEnvironment = instanceOfWorkspaceEnvironment;
+function WorkspaceEnvironmentFromJSON(json) {
+    return WorkspaceEnvironmentFromJSONTyped(json, false);
+}
+exports.WorkspaceEnvironmentFromJSON = WorkspaceEnvironmentFromJSON;
+function WorkspaceEnvironmentFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'category': json['category'],
+        'defaultComputeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigFromJSON)(json['defaultComputeConfig']),
+        'owner': json['owner'],
+    };
+}
+exports.WorkspaceEnvironmentFromJSONTyped = WorkspaceEnvironmentFromJSONTyped;
+function WorkspaceEnvironmentToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'category': value.category,
+        'defaultComputeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigToJSON)(value.defaultComputeConfig),
+        'owner': value.owner,
+    };
+}
+exports.WorkspaceEnvironmentToJSON = WorkspaceEnvironmentToJSON;

package/dist/models/index.d.ts

@@ -152,5 +152,6 @@ export * from './ValidateFileRequirementsRequest';
 export * from './Workspace';
 export * from './WorkspaceComputeConfig';
 export * from './WorkspaceConnectionResponse';
+export * from './WorkspaceEnvironment';
 export * from './WorkspaceInput';
 export * from './WorkspaceSession';

package/dist/models/index.js

@@ -170,5 +170,6 @@ __exportStar(require("./ValidateFileRequirementsRequest"), exports);
 __exportStar(require("./Workspace"), exports);
 __exportStar(require("./WorkspaceComputeConfig"), exports);
 __exportStar(require("./WorkspaceConnectionResponse"), exports);
+__exportStar(require("./WorkspaceEnvironment"), exports);
 __exportStar(require("./WorkspaceInput"), exports);
 __exportStar(require("./WorkspaceSession"), exports);

package/package.json

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