@cirrobio/api-client 0.10.6 → 0.11.0

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

@@ -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/esm/models/index.js

@@ -80,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';
@@ -127,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';
@@ -146,3 +148,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/Dashboard.d.ts

@@ -44,7 +44,7 @@ export interface Dashboard {
      * @type {{ [key: string]: any; }}
      * @memberof Dashboard
      */
-    dashboardData: {
+    dashboardData?: {
         [key: string]: any;
     };
     /**
@@ -52,7 +52,7 @@ export interface Dashboard {
      * @type {{ [key: string]: any; }}
      * @memberof Dashboard
      */
-    info: {
+    info?: {
         [key: string]: any;
     };
     /**

package/dist/models/Dashboard.js

@@ -14,6 +14,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DashboardToJSON = exports.DashboardFromJSONTyped = exports.DashboardFromJSON = exports.instanceOfDashboard = void 0;
+const runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the Dashboard interface.
  */
@@ -23,8 +24,6 @@ function instanceOfDashboard(value) {
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processIds" in value;
-    isInstance = isInstance && "dashboardData" in value;
-    isInstance = isInstance && "info" in value;
     isInstance = isInstance && "createdBy" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
@@ -44,8 +43,8 @@ function DashboardFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'description': json['description'],
         'processIds': json['processIds'],
-        'dashboardData': json['dashboardData'],
-        'info': json['info'],
+        'dashboardData': !(0, runtime_1.exists)(json, 'dashboardData') ? undefined : json['dashboardData'],
+        'info': !(0, runtime_1.exists)(json, 'info') ? undefined : json['info'],
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),

package/dist/models/DashboardRequest.d.ts

@@ -38,7 +38,7 @@ export interface DashboardRequest {
      * @type {{ [key: string]: any; }}
      * @memberof DashboardRequest
      */
-    dashboardData: {
+    dashboardData?: {
         [key: string]: any;
     };
     /**
@@ -46,7 +46,7 @@ export interface DashboardRequest {
      * @type {{ [key: string]: any; }}
      * @memberof DashboardRequest
      */
-    info: {
+    info?: {
         [key: string]: any;
     };
 }

package/dist/models/DashboardRequest.js

@@ -14,6 +14,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DashboardRequestToJSON = exports.DashboardRequestFromJSONTyped = exports.DashboardRequestFromJSON = exports.instanceOfDashboardRequest = void 0;
+const runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the DashboardRequest interface.
  */
@@ -22,8 +23,6 @@ function instanceOfDashboardRequest(value) {
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "processIds" in value;
-    isInstance = isInstance && "dashboardData" in value;
-    isInstance = isInstance && "info" in value;
     return isInstance;
 }
 exports.instanceOfDashboardRequest = instanceOfDashboardRequest;
@@ -39,8 +38,8 @@ function DashboardRequestFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'description': json['description'],
         'processIds': json['processIds'],
-        'dashboardData': json['dashboardData'],
-        'info': json['info'],
+        'dashboardData': !(0, runtime_1.exists)(json, 'dashboardData') ? undefined : json['dashboardData'],
+        'info': !(0, runtime_1.exists)(json, 'info') ? undefined : json['info'],
     };
 }
 exports.DashboardRequestFromJSONTyped = DashboardRequestFromJSONTyped;

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

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

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

@@ -31,7 +31,6 @@ 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;
@@ -57,7 +56,6 @@ function ShareDetailFromJSONTyped(json, ignoreDiscriminator) {
         'conditions': (json['conditions'].map(DatasetCondition_1.DatasetConditionFromJSON)),
         'keywords': json['keywords'],
         'classificationIds': json['classificationIds'],
-        'isSubscribed': json['isSubscribed'],
         'isViewRestricted': json['isViewRestricted'],
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
@@ -82,7 +80,6 @@ function ShareDetailToJSON(value) {
         'conditions': (value.conditions.map(DatasetCondition_1.DatasetConditionToJSON)),
         'keywords': value.keywords,
         'classificationIds': value.classificationIds,
-        'isSubscribed': value.isSubscribed,
         'isViewRestricted': value.isViewRestricted,
         'createdBy': value.createdBy,
         'createdAt': (value.createdAt.toISOString()),

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

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

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