@cirrobio/api-client 0.10.5 → 0.11.0

package/dist/esm/models/MountedDataset.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.
+ */
+/**
+ * Represents a mounted dataset in a workspace
+ * @export
+ * @interface MountedDataset
+ */
+export interface MountedDataset {
+    /**
+     * Folder name that appears in the workspace
+     * @type {string}
+     * @memberof MountedDataset
+     */
+    name: string;
+    /**
+     * Full S3 prefix to the data
+     * @type {string}
+     * @memberof MountedDataset
+     */
+    uri: string;
+}
+/**
+ * Check if a given object implements the MountedDataset interface.
+ */
+export declare function instanceOfMountedDataset(value: object): boolean;
+export declare function MountedDatasetFromJSON(json: any): MountedDataset;
+export declare function MountedDatasetFromJSONTyped(json: any, ignoreDiscriminator: boolean): MountedDataset;
+export declare function MountedDatasetToJSON(value?: MountedDataset | null): any;

package/dist/esm/models/MountedDataset.js

@@ -0,0 +1,46 @@
+/* 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 MountedDataset interface.
+ */
+export function instanceOfMountedDataset(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "uri" in value;
+    return isInstance;
+}
+export function MountedDatasetFromJSON(json) {
+    return MountedDatasetFromJSONTyped(json, false);
+}
+export function MountedDatasetFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'uri': json['uri'],
+    };
+}
+export function MountedDatasetToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'uri': value.uri,
+    };
+}

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

@@ -72,12 +72,6 @@ export interface ShareDetail {
      * @memberof ShareDetail
      */
     classificationIds: Array<string>;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ShareDetail
-     */
-    isSubscribed: boolean;
     /**
      *
      * @type {boolean}

package/dist/esm/models/ShareDetail.js

@@ -28,7 +28,6 @@ export function instanceOfShareDetail(value) {
     isInstance = isInstance && "conditions" in value;
     isInstance = isInstance && "keywords" in value;
     isInstance = isInstance && "classificationIds" in value;
-    isInstance = isInstance && "isSubscribed" in value;
     isInstance = isInstance && "isViewRestricted" in value;
     isInstance = isInstance && "createdBy" in value;
     isInstance = isInstance && "createdAt" in value;
@@ -52,7 +51,6 @@ export function ShareDetailFromJSONTyped(json, ignoreDiscriminator) {
         'conditions': (json['conditions'].map(DatasetConditionFromJSON)),
         'keywords': json['keywords'],
         'classificationIds': json['classificationIds'],
-        'isSubscribed': json['isSubscribed'],
         'isViewRestricted': json['isViewRestricted'],
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
@@ -76,7 +74,6 @@ export function ShareDetailToJSON(value) {
         'conditions': (value.conditions.map(DatasetConditionToJSON)),
         'keywords': value.keywords,
         'classificationIds': value.classificationIds,
-        'isSubscribed': value.isSubscribed,
         'isViewRestricted': value.isViewRestricted,
         'createdBy': value.createdBy,
         'createdAt': (value.createdAt.toISOString()),

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

@@ -0,0 +1,23 @@
+/**
+ * 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
+ * @enum {string}
+ */
+export declare enum SharingType {
+    Private = "PRIVATE",
+    ReadWrite = "READ_WRITE"
+}
+export declare function SharingTypeFromJSON(json: any): SharingType;
+export declare function SharingTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SharingType;
+export declare function SharingTypeToJSON(value?: SharingType | null): any;

package/dist/esm/models/SharingType.js

@@ -0,0 +1,32 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export var SharingType;
+(function (SharingType) {
+    SharingType["Private"] = "PRIVATE";
+    SharingType["ReadWrite"] = "READ_WRITE";
+})(SharingType || (SharingType = {}));
+export function SharingTypeFromJSON(json) {
+    return SharingTypeFromJSONTyped(json, false);
+}
+export function SharingTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SharingTypeToJSON(value) {
+    return value;
+}

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

@@ -0,0 +1,108 @@
+/**
+ * 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 { Status } from './Status';
+import type { WorkspaceComputeConfig } from './WorkspaceComputeConfig';
+import type { WorkspaceSession } from './WorkspaceSession';
+/**
+ *
+ * @export
+ * @interface Workspace
+ */
+export interface Workspace {
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    description: string;
+    /**
+     *
+     * @type {Status}
+     * @memberof Workspace
+     */
+    status: Status;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    statusMessage: string;
+    /**
+     *
+     * @type {Array<MountedDataset>}
+     * @memberof Workspace
+     */
+    mountedDatasets: Array<MountedDataset>;
+    /**
+     *
+     * @type {WorkspaceComputeConfig}
+     * @memberof Workspace
+     */
+    computeConfig: WorkspaceComputeConfig;
+    /**
+     *
+     * @type {SharingType}
+     * @memberof Workspace
+     */
+    sharingType: SharingType;
+    /**
+     *
+     * @type {Array<WorkspaceSession>}
+     * @memberof Workspace
+     */
+    sessions?: Array<WorkspaceSession> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the Workspace interface.
+ */
+export declare function instanceOfWorkspace(value: object): boolean;
+export declare function WorkspaceFromJSON(json: any): Workspace;
+export declare function WorkspaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Workspace;
+export declare function WorkspaceToJSON(value?: Workspace | null): any;

package/dist/esm/models/Workspace.js

@@ -0,0 +1,84 @@
+/* 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 { MountedDatasetFromJSON, MountedDatasetToJSON, } from './MountedDataset';
+import { SharingTypeFromJSON, SharingTypeToJSON, } from './SharingType';
+import { StatusFromJSON, StatusToJSON, } from './Status';
+import { WorkspaceComputeConfigFromJSON, WorkspaceComputeConfigToJSON, } from './WorkspaceComputeConfig';
+import { WorkspaceSessionFromJSON, WorkspaceSessionToJSON, } from './WorkspaceSession';
+/**
+ * Check if a given object implements the Workspace interface.
+ */
+export 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;
+}
+export function WorkspaceFromJSON(json) {
+    return WorkspaceFromJSONTyped(json, false);
+}
+export function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'status': StatusFromJSON(json['status']),
+        'statusMessage': json['statusMessage'],
+        'mountedDatasets': (json['mountedDatasets'].map(MountedDatasetFromJSON)),
+        'computeConfig': WorkspaceComputeConfigFromJSON(json['computeConfig']),
+        'sharingType': SharingTypeFromJSON(json['sharingType']),
+        'sessions': !exists(json, 'sessions') ? undefined : (json['sessions'] === null ? null : json['sessions'].map(WorkspaceSessionFromJSON)),
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'startedAt': (new Date(json['startedAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function WorkspaceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'status': StatusToJSON(value.status),
+        'statusMessage': value.statusMessage,
+        'mountedDatasets': (value.mountedDatasets.map(MountedDatasetToJSON)),
+        'computeConfig': WorkspaceComputeConfigToJSON(value.computeConfig),
+        'sharingType': SharingTypeToJSON(value.sharingType),
+        'sessions': value.sessions === undefined ? undefined : (value.sessions === null ? null : value.sessions.map(WorkspaceSessionToJSON)),
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'startedAt': (value.startedAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}

package/dist/esm/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/esm/models/WorkspaceComputeConfig.js

@@ -0,0 +1,54 @@
+/* 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 WorkspaceComputeConfig interface.
+ */
+export function instanceOfWorkspaceComputeConfig(value) {
+    let isInstance = true;
+    isInstance = isInstance && "containerImageUri" in value;
+    return isInstance;
+}
+export function WorkspaceComputeConfigFromJSON(json) {
+    return WorkspaceComputeConfigFromJSONTyped(json, false);
+}
+export function WorkspaceComputeConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'containerImageUri': json['containerImageUri'],
+        'cpu': !exists(json, 'cpu') ? undefined : json['cpu'],
+        'memoryGib': !exists(json, 'memoryGib') ? undefined : json['memoryGib'],
+        'volumeSizeGib': !exists(json, 'volumeSizeGib') ? undefined : json['volumeSizeGib'],
+        'environmentVariables': !exists(json, 'environmentVariables') ? undefined : json['environmentVariables'],
+        'localPort': !exists(json, 'localPort') ? undefined : json['localPort'],
+    };
+}
+export 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,
+    };
+}

package/dist/esm/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/esm/models/WorkspaceConnectionResponse.js

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

package/dist/esm/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;