@cirrobio/api-client 0.10.6 → 0.11.1

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;

package/dist/esm/models/WorkspaceInput.js

@@ -0,0 +1,58 @@
+/* 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 { WorkspaceComputeConfigFromJSON, WorkspaceComputeConfigToJSON, } from './WorkspaceComputeConfig';
+/**
+ * Check if a given object implements the WorkspaceInput interface.
+ */
+export 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;
+}
+export function WorkspaceInputFromJSON(json) {
+    return WorkspaceInputFromJSONTyped(json, false);
+}
+export function WorkspaceInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'mountedDatasets': (json['mountedDatasets'].map(MountedDatasetFromJSON)),
+        'computeConfig': WorkspaceComputeConfigFromJSON(json['computeConfig']),
+        'sharingType': SharingTypeFromJSON(json['sharingType']),
+    };
+}
+export function WorkspaceInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'mountedDatasets': (value.mountedDatasets.map(MountedDatasetToJSON)),
+        'computeConfig': WorkspaceComputeConfigToJSON(value.computeConfig),
+        'sharingType': SharingTypeToJSON(value.sharingType),
+    };
+}

package/dist/esm/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/esm/models/WorkspaceSession.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 WorkspaceSession interface.
+ */
+export function instanceOfWorkspaceSession(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "user" in value;
+    isInstance = isInstance && "createdAt" in value;
+    return isInstance;
+}
+export function WorkspaceSessionFromJSON(json) {
+    return WorkspaceSessionFromJSONTyped(json, false);
+}
+export function WorkspaceSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'user': json['user'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function WorkspaceSessionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'user': value.user,
+        'createdAt': (value.createdAt.toISOString()),
+    };
+}

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

@@ -22,6 +22,7 @@ export * from './ComputeEnvironmentConfiguration';
 export * from './ComputeEnvironmentConfigurationInput';
 export * from './Contact';
 export * from './ContactInput';
+export * from './CostResponse';
 export * from './CreateNotebookInstanceRequest';
 export * from './CreateProjectAccessRequest';
 export * from './CreateReferenceRequest';
@@ -69,6 +70,7 @@ export * from './GovernanceRequirement';
 export * from './GovernanceScope';
 export * from './GovernanceTrainingVerification';
 export * from './GovernanceType';
+export * from './GroupCost';
 export * from './ImportDataRequest';
 export * from './InviteUserRequest';
 export * from './InviteUserResponse';
@@ -78,6 +80,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 +128,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';
@@ -133,6 +137,7 @@ export * from './SystemInfoResponse';
 export * from './Table';
 export * from './Tag';
 export * from './Task';
+export * from './TaskCost';
 export * from './TenantInfo';
 export * from './UpdateDatasetRequest';
 export * from './UpdateUserRequest';
@@ -144,3 +149,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/esm/models/index.js

@@ -24,6 +24,7 @@ export * from './ComputeEnvironmentConfiguration';
 export * from './ComputeEnvironmentConfigurationInput';
 export * from './Contact';
 export * from './ContactInput';
+export * from './CostResponse';
 export * from './CreateNotebookInstanceRequest';
 export * from './CreateProjectAccessRequest';
 export * from './CreateReferenceRequest';
@@ -71,6 +72,7 @@ export * from './GovernanceRequirement';
 export * from './GovernanceScope';
 export * from './GovernanceTrainingVerification';
 export * from './GovernanceType';
+export * from './GroupCost';
 export * from './ImportDataRequest';
 export * from './InviteUserRequest';
 export * from './InviteUserResponse';
@@ -80,6 +82,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';
@@ -127,6 +130,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';
@@ -135,6 +139,7 @@ export * from './SystemInfoResponse';
 export * from './Table';
 export * from './Tag';
 export * from './Task';
+export * from './TaskCost';
 export * from './TenantInfo';
 export * from './UpdateDatasetRequest';
 export * from './UpdateUserRequest';
@@ -146,3 +151,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/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;