@cirrobio/api-client 0.10.6 → 0.11.0

package/dist/models/Workspace.js

@@ -0,0 +1,91 @@
+"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.WorkspaceToJSON = exports.WorkspaceFromJSONTyped = exports.WorkspaceFromJSON = exports.instanceOfWorkspace = void 0;
+const runtime_1 = require("../runtime");
+const MountedDataset_1 = require("./MountedDataset");
+const SharingType_1 = require("./SharingType");
+const Status_1 = require("./Status");
+const WorkspaceComputeConfig_1 = require("./WorkspaceComputeConfig");
+const WorkspaceSession_1 = require("./WorkspaceSession");
+/**
+ * Check if a given object implements the Workspace interface.
+ */
+function instanceOfWorkspace(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "statusMessage" in value;
+    isInstance = isInstance && "mountedDatasets" in value;
+    isInstance = isInstance && "computeConfig" in value;
+    isInstance = isInstance && "sharingType" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "startedAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspace = instanceOfWorkspace;
+function WorkspaceFromJSON(json) {
+    return WorkspaceFromJSONTyped(json, false);
+}
+exports.WorkspaceFromJSON = WorkspaceFromJSON;
+function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'status': (0, Status_1.StatusFromJSON)(json['status']),
+        'statusMessage': json['statusMessage'],
+        'mountedDatasets': (json['mountedDatasets'].map(MountedDataset_1.MountedDatasetFromJSON)),
+        'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigFromJSON)(json['computeConfig']),
+        'sharingType': (0, SharingType_1.SharingTypeFromJSON)(json['sharingType']),
+        'sessions': !(0, runtime_1.exists)(json, 'sessions') ? undefined : (json['sessions'] === null ? null : json['sessions'].map(WorkspaceSession_1.WorkspaceSessionFromJSON)),
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'startedAt': (new Date(json['startedAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+exports.WorkspaceFromJSONTyped = WorkspaceFromJSONTyped;
+function WorkspaceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'status': (0, Status_1.StatusToJSON)(value.status),
+        'statusMessage': value.statusMessage,
+        'mountedDatasets': (value.mountedDatasets.map(MountedDataset_1.MountedDatasetToJSON)),
+        'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigToJSON)(value.computeConfig),
+        'sharingType': (0, SharingType_1.SharingTypeToJSON)(value.sharingType),
+        'sessions': value.sessions === undefined ? undefined : (value.sessions === null ? null : value.sessions.map(WorkspaceSession_1.WorkspaceSessionToJSON)),
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'startedAt': (value.startedAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+exports.WorkspaceToJSON = WorkspaceToJSON;

package/dist/models/WorkspaceComputeConfig.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ */
+/**
+ * Configuration parameters for a containerized workspace compute environment.
+ * @export
+ * @interface WorkspaceComputeConfig
+ */
+export interface WorkspaceComputeConfig {
+    /**
+     * Fully qualified container image URI (including registry, repository, and tag).
+     * @type {string}
+     * @memberof WorkspaceComputeConfig
+     */
+    containerImageUri: string;
+    /**
+     * Number of vCPU cores allocated to the workspace.
+     * @type {number}
+     * @memberof WorkspaceComputeConfig
+     */
+    cpu?: number;
+    /**
+     * Memory allocated to the workspace container in GiB.
+     * @type {number}
+     * @memberof WorkspaceComputeConfig
+     */
+    memoryGib?: number;
+    /**
+     * Persistent storage volume size allocated to the workspace in GiB.
+     * @type {number}
+     * @memberof WorkspaceComputeConfig
+     */
+    volumeSizeGib?: number;
+    /**
+     * Map of environment variables injected into the container at runtime. Keys must be non-blank.
+     * @type {{ [key: string]: string; }}
+     * @memberof WorkspaceComputeConfig
+     */
+    environmentVariables?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * User-facing web server port (http).
+     * @type {number}
+     * @memberof WorkspaceComputeConfig
+     */
+    localPort?: number;
+}
+/**
+ * Check if a given object implements the WorkspaceComputeConfig interface.
+ */
+export declare function instanceOfWorkspaceComputeConfig(value: object): boolean;
+export declare function WorkspaceComputeConfigFromJSON(json: any): WorkspaceComputeConfig;
+export declare function WorkspaceComputeConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceComputeConfig;
+export declare function WorkspaceComputeConfigToJSON(value?: WorkspaceComputeConfig | null): any;

package/dist/models/WorkspaceComputeConfig.js

@@ -0,0 +1,61 @@
+"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.WorkspaceComputeConfigToJSON = exports.WorkspaceComputeConfigFromJSONTyped = exports.WorkspaceComputeConfigFromJSON = exports.instanceOfWorkspaceComputeConfig = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the WorkspaceComputeConfig interface.
+ */
+function instanceOfWorkspaceComputeConfig(value) {
+    let isInstance = true;
+    isInstance = isInstance && "containerImageUri" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspaceComputeConfig = instanceOfWorkspaceComputeConfig;
+function WorkspaceComputeConfigFromJSON(json) {
+    return WorkspaceComputeConfigFromJSONTyped(json, false);
+}
+exports.WorkspaceComputeConfigFromJSON = WorkspaceComputeConfigFromJSON;
+function WorkspaceComputeConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'containerImageUri': json['containerImageUri'],
+        'cpu': !(0, runtime_1.exists)(json, 'cpu') ? undefined : json['cpu'],
+        'memoryGib': !(0, runtime_1.exists)(json, 'memoryGib') ? undefined : json['memoryGib'],
+        'volumeSizeGib': !(0, runtime_1.exists)(json, 'volumeSizeGib') ? undefined : json['volumeSizeGib'],
+        'environmentVariables': !(0, runtime_1.exists)(json, 'environmentVariables') ? undefined : json['environmentVariables'],
+        'localPort': !(0, runtime_1.exists)(json, 'localPort') ? undefined : json['localPort'],
+    };
+}
+exports.WorkspaceComputeConfigFromJSONTyped = WorkspaceComputeConfigFromJSONTyped;
+function WorkspaceComputeConfigToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'containerImageUri': value.containerImageUri,
+        'cpu': value.cpu,
+        'memoryGib': value.memoryGib,
+        'volumeSizeGib': value.volumeSizeGib,
+        'environmentVariables': value.environmentVariables,
+        'localPort': value.localPort,
+    };
+}
+exports.WorkspaceComputeConfigToJSON = WorkspaceComputeConfigToJSON;

package/dist/models/WorkspaceConnectionResponse.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 WorkspaceConnectionResponse
+ */
+export interface WorkspaceConnectionResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceConnectionResponse
+     */
+    connectionUrl: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkspaceConnectionResponse
+     */
+    expiresAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceConnectionResponse
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the WorkspaceConnectionResponse interface.
+ */
+export declare function instanceOfWorkspaceConnectionResponse(value: object): boolean;
+export declare function WorkspaceConnectionResponseFromJSON(json: any): WorkspaceConnectionResponse;
+export declare function WorkspaceConnectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceConnectionResponse;
+export declare function WorkspaceConnectionResponseToJSON(value?: WorkspaceConnectionResponse | null): any;

package/dist/models/WorkspaceConnectionResponse.js

@@ -0,0 +1,56 @@
+"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.WorkspaceConnectionResponseToJSON = exports.WorkspaceConnectionResponseFromJSONTyped = exports.WorkspaceConnectionResponseFromJSON = exports.instanceOfWorkspaceConnectionResponse = void 0;
+/**
+ * Check if a given object implements the WorkspaceConnectionResponse interface.
+ */
+function instanceOfWorkspaceConnectionResponse(value) {
+    let isInstance = true;
+    isInstance = isInstance && "connectionUrl" in value;
+    isInstance = isInstance && "expiresAt" in value;
+    isInstance = isInstance && "message" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspaceConnectionResponse = instanceOfWorkspaceConnectionResponse;
+function WorkspaceConnectionResponseFromJSON(json) {
+    return WorkspaceConnectionResponseFromJSONTyped(json, false);
+}
+exports.WorkspaceConnectionResponseFromJSON = WorkspaceConnectionResponseFromJSON;
+function WorkspaceConnectionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'connectionUrl': json['connectionUrl'],
+        'expiresAt': (new Date(json['expiresAt'])),
+        'message': json['message'],
+    };
+}
+exports.WorkspaceConnectionResponseFromJSONTyped = WorkspaceConnectionResponseFromJSONTyped;
+function WorkspaceConnectionResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'connectionUrl': value.connectionUrl,
+        'expiresAt': (value.expiresAt.toISOString()),
+        'message': value.message,
+    };
+}
+exports.WorkspaceConnectionResponseToJSON = WorkspaceConnectionResponseToJSON;

package/dist/models/WorkspaceInput.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { MountedDataset } from './MountedDataset';
+import type { SharingType } from './SharingType';
+import type { WorkspaceComputeConfig } from './WorkspaceComputeConfig';
+/**
+ *
+ * @export
+ * @interface WorkspaceInput
+ */
+export interface WorkspaceInput {
+    /**
+     * Name of the workspace.
+     * @type {string}
+     * @memberof WorkspaceInput
+     */
+    name: string;
+    /**
+     * Description of the workspace.
+     * @type {string}
+     * @memberof WorkspaceInput
+     */
+    description?: string;
+    /**
+     * List of datasets to mount into the workspace.
+     * @type {Array<MountedDataset>}
+     * @memberof WorkspaceInput
+     */
+    mountedDatasets: Array<MountedDataset>;
+    /**
+     *
+     * @type {WorkspaceComputeConfig}
+     * @memberof WorkspaceInput
+     */
+    computeConfig: WorkspaceComputeConfig;
+    /**
+     *
+     * @type {SharingType}
+     * @memberof WorkspaceInput
+     */
+    sharingType: SharingType;
+}
+/**
+ * Check if a given object implements the WorkspaceInput interface.
+ */
+export declare function instanceOfWorkspaceInput(value: object): boolean;
+export declare function WorkspaceInputFromJSON(json: any): WorkspaceInput;
+export declare function WorkspaceInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceInput;
+export declare function WorkspaceInputToJSON(value?: WorkspaceInput | null): any;

package/dist/models/WorkspaceInput.js

@@ -0,0 +1,65 @@
+"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.WorkspaceInputToJSON = exports.WorkspaceInputFromJSONTyped = exports.WorkspaceInputFromJSON = exports.instanceOfWorkspaceInput = void 0;
+const runtime_1 = require("../runtime");
+const MountedDataset_1 = require("./MountedDataset");
+const SharingType_1 = require("./SharingType");
+const WorkspaceComputeConfig_1 = require("./WorkspaceComputeConfig");
+/**
+ * Check if a given object implements the WorkspaceInput interface.
+ */
+function instanceOfWorkspaceInput(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "mountedDatasets" in value;
+    isInstance = isInstance && "computeConfig" in value;
+    isInstance = isInstance && "sharingType" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspaceInput = instanceOfWorkspaceInput;
+function WorkspaceInputFromJSON(json) {
+    return WorkspaceInputFromJSONTyped(json, false);
+}
+exports.WorkspaceInputFromJSON = WorkspaceInputFromJSON;
+function WorkspaceInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+        'mountedDatasets': (json['mountedDatasets'].map(MountedDataset_1.MountedDatasetFromJSON)),
+        'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigFromJSON)(json['computeConfig']),
+        'sharingType': (0, SharingType_1.SharingTypeFromJSON)(json['sharingType']),
+    };
+}
+exports.WorkspaceInputFromJSONTyped = WorkspaceInputFromJSONTyped;
+function WorkspaceInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'mountedDatasets': (value.mountedDatasets.map(MountedDataset_1.MountedDatasetToJSON)),
+        'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigToJSON)(value.computeConfig),
+        'sharingType': (0, SharingType_1.SharingTypeToJSON)(value.sharingType),
+    };
+}
+exports.WorkspaceInputToJSON = WorkspaceInputToJSON;

package/dist/models/WorkspaceSession.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 WorkspaceSession
+ */
+export interface WorkspaceSession {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceSession
+     */
+    user: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkspaceSession
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the WorkspaceSession interface.
+ */
+export declare function instanceOfWorkspaceSession(value: object): boolean;
+export declare function WorkspaceSessionFromJSON(json: any): WorkspaceSession;
+export declare function WorkspaceSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceSession;
+export declare function WorkspaceSessionToJSON(value?: WorkspaceSession | null): any;

package/dist/models/WorkspaceSession.js

@@ -0,0 +1,56 @@
+"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.WorkspaceSessionToJSON = exports.WorkspaceSessionFromJSONTyped = exports.WorkspaceSessionFromJSON = exports.instanceOfWorkspaceSession = void 0;
+/**
+ * Check if a given object implements the WorkspaceSession interface.
+ */
+function instanceOfWorkspaceSession(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "user" in value;
+    isInstance = isInstance && "createdAt" in value;
+    return isInstance;
+}
+exports.instanceOfWorkspaceSession = instanceOfWorkspaceSession;
+function WorkspaceSessionFromJSON(json) {
+    return WorkspaceSessionFromJSONTyped(json, false);
+}
+exports.WorkspaceSessionFromJSON = WorkspaceSessionFromJSON;
+function WorkspaceSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'user': json['user'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+exports.WorkspaceSessionFromJSONTyped = WorkspaceSessionFromJSONTyped;
+function WorkspaceSessionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'user': value.user,
+        'createdAt': (value.createdAt.toISOString()),
+    };
+}
+exports.WorkspaceSessionToJSON = WorkspaceSessionToJSON;

package/dist/models/index.d.ts

@@ -78,6 +78,7 @@ export * from './Message';
 export * from './MessageInput';
 export * from './MessageType';
 export * from './MetricRecord';
+export * from './MountedDataset';
 export * from './MoveDatasetInput';
 export * from './MoveDatasetResponse';
 export * from './NamedItem';
@@ -125,6 +126,7 @@ export * from './Share';
 export * from './ShareDetail';
 export * from './ShareInput';
 export * from './ShareType';
+export * from './SharingType';
 export * from './SortOrder';
 export * from './Status';
 export * from './StopExecutionResponse';
@@ -144,3 +146,8 @@ export * from './UserProjectAssignment';
 export * from './UserSettings';
 export * from './ValidateFileNamePatternsRequest';
 export * from './ValidateFileRequirementsRequest';
+export * from './Workspace';
+export * from './WorkspaceComputeConfig';
+export * from './WorkspaceConnectionResponse';
+export * from './WorkspaceInput';
+export * from './WorkspaceSession';

package/dist/models/index.js

@@ -96,6 +96,7 @@ __exportStar(require("./Message"), exports);
 __exportStar(require("./MessageInput"), exports);
 __exportStar(require("./MessageType"), exports);
 __exportStar(require("./MetricRecord"), exports);
+__exportStar(require("./MountedDataset"), exports);
 __exportStar(require("./MoveDatasetInput"), exports);
 __exportStar(require("./MoveDatasetResponse"), exports);
 __exportStar(require("./NamedItem"), exports);
@@ -143,6 +144,7 @@ __exportStar(require("./Share"), exports);
 __exportStar(require("./ShareDetail"), exports);
 __exportStar(require("./ShareInput"), exports);
 __exportStar(require("./ShareType"), exports);
+__exportStar(require("./SharingType"), exports);
 __exportStar(require("./SortOrder"), exports);
 __exportStar(require("./Status"), exports);
 __exportStar(require("./StopExecutionResponse"), exports);
@@ -162,3 +164,8 @@ __exportStar(require("./UserProjectAssignment"), exports);
 __exportStar(require("./UserSettings"), exports);
 __exportStar(require("./ValidateFileNamePatternsRequest"), exports);
 __exportStar(require("./ValidateFileRequirementsRequest"), exports);
+__exportStar(require("./Workspace"), exports);
+__exportStar(require("./WorkspaceComputeConfig"), exports);
+__exportStar(require("./WorkspaceConnectionResponse"), exports);
+__exportStar(require("./WorkspaceInput"), exports);
+__exportStar(require("./WorkspaceSession"), exports);

package/package.json

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