@cirrobio/api-client 0.12.9 → 0.12.11

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

package/dist/apis/ProcessesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, CustomPipelineSettings, CustomProcessInput, FileNameMatch, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileNamePatternsRequest, ValidateFileRequirementsRequest } from '../models/index';
+import type { CreateResponse, CustomPipelineSettings, CustomProcessInput, FileNameMatch, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ProcessDocumentation, ValidateFileNamePatternsRequest, ValidateFileRequirementsRequest } from '../models/index';
 export interface ArchiveCustomProcessRequest {
     processId: string;
 }
@@ -24,6 +24,9 @@ export interface CreateCustomProcessRequest {
 export interface GetProcessRequest {
     processId: string;
 }
+export interface GetProcessDocumentationRequest {
+    processId: string;
+}
 export interface GetProcessParametersRequest {
     processId: string;
 }
@@ -89,6 +92,16 @@ export declare class ProcessesApi extends runtime.BaseAPI {
      * Get process
      */
     getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentationRaw(requestParameters: GetProcessDocumentationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDocumentation>>;
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentation(requestParameters: GetProcessDocumentationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDocumentation>;
     /**
      * Retrieves the input parameters for a process
      * Get process parameters

package/dist/apis/ProcessesApi.js

@@ -183,6 +183,43 @@ class ProcessesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling getProcessDocumentation.');
+            }
+            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: `/processes/{processId}/documentation`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessDocumentationFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProcessDocumentationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves the input parameters for a process
      * Get process parameters

package/dist/esm/apis/ProcessesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateResponse, CustomPipelineSettings, CustomProcessInput, FileNameMatch, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ValidateFileNamePatternsRequest, ValidateFileRequirementsRequest } from '../models/index';
+import type { CreateResponse, CustomPipelineSettings, CustomProcessInput, FileNameMatch, FileRequirements, FormSchema, PipelineCost, Process, ProcessDetail, ProcessDocumentation, ValidateFileNamePatternsRequest, ValidateFileRequirementsRequest } from '../models/index';
 export interface ArchiveCustomProcessRequest {
     processId: string;
 }
@@ -24,6 +24,9 @@ export interface CreateCustomProcessRequest {
 export interface GetProcessRequest {
     processId: string;
 }
+export interface GetProcessDocumentationRequest {
+    processId: string;
+}
 export interface GetProcessParametersRequest {
     processId: string;
 }
@@ -89,6 +92,16 @@ export declare class ProcessesApi extends runtime.BaseAPI {
      * Get process
      */
     getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail>;
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentationRaw(requestParameters: GetProcessDocumentationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDocumentation>>;
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentation(requestParameters: GetProcessDocumentationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDocumentation>;
     /**
      * Retrieves the input parameters for a process
      * Get process parameters

package/dist/esm/apis/ProcessesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateResponseFromJSON, CustomPipelineSettingsFromJSON, CustomProcessInputToJSON, FileNameMatchFromJSON, FileRequirementsFromJSON, FormSchemaFromJSON, PipelineCostFromJSON, ProcessFromJSON, ProcessDetailFromJSON, ValidateFileNamePatternsRequestToJSON, ValidateFileRequirementsRequestToJSON, } from '../models/index';
+import { CreateResponseFromJSON, CustomPipelineSettingsFromJSON, CustomProcessInputToJSON, FileNameMatchFromJSON, FileRequirementsFromJSON, FormSchemaFromJSON, PipelineCostFromJSON, ProcessFromJSON, ProcessDetailFromJSON, ProcessDocumentationFromJSON, ValidateFileNamePatternsRequestToJSON, ValidateFileRequirementsRequestToJSON, } from '../models/index';
 /**
  *
  */
@@ -180,6 +180,43 @@ export class ProcessesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling getProcessDocumentation.');
+            }
+            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: `/processes/{processId}/documentation`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ProcessDocumentationFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves documentation for a given pipeline or data type (if available).
+     * Get process documentation
+     */
+    getProcessDocumentation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getProcessDocumentationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves the input parameters for a process
      * Get process parameters

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

@@ -41,10 +41,10 @@ export interface DatasetViz {
     type?: string;
     /**
      * Config or path to config used to render viz
-     * @type {any}
+     * @type {object}
      * @memberof DatasetViz
      */
-    config?: any | null;
+    config?: object;
 }
 /**
  * Check if a given object implements the DatasetViz interface.

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

@@ -64,7 +64,7 @@ export interface Discussion {
      * @type {Date}
      * @memberof Discussion
      */
-    lastMessageTime: Date;
+    lastMessageTime?: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/Discussion.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { exists } from '../runtime';
 import { DiscussionTypeFromJSON, DiscussionTypeToJSON, } from './DiscussionType';
 import { EntityFromJSON, EntityToJSON, } from './Entity';
 /**
@@ -25,7 +26,6 @@ export function instanceOfDiscussion(value) {
     isInstance = isInstance && "type" in value;
     isInstance = isInstance && "projectId" in value;
     isInstance = isInstance && "createdBy" in value;
-    isInstance = isInstance && "lastMessageTime" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
     return isInstance;
@@ -45,7 +45,7 @@ export function DiscussionFromJSONTyped(json, ignoreDiscriminator) {
         'type': DiscussionTypeFromJSON(json['type']),
         'projectId': json['projectId'],
         'createdBy': json['createdBy'],
-        'lastMessageTime': (new Date(json['lastMessageTime'])),
+        'lastMessageTime': !exists(json, 'lastMessageTime') ? undefined : (json['lastMessageTime'] === null ? null : new Date(json['lastMessageTime'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -65,7 +65,7 @@ export function DiscussionToJSON(value) {
         'type': DiscussionTypeToJSON(value.type),
         'projectId': value.projectId,
         'createdBy': value.createdBy,
-        'lastMessageTime': (value.lastMessageTime.toISOString()),
+        'lastMessageTime': value.lastMessageTime === undefined ? undefined : (value.lastMessageTime === null ? null : value.lastMessageTime.toISOString()),
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),
     };

package/dist/esm/models/ProcessDocumentation.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 ProcessDocumentation
+ */
+export interface ProcessDocumentation {
+    /**
+     * Full URI to documentation
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    docsUri?: string;
+    /**
+     * URI of process documentation (partial)
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    partialUri?: string;
+    /**
+     * Documentation content
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    content?: string;
+}
+/**
+ * Check if a given object implements the ProcessDocumentation interface.
+ */
+export declare function instanceOfProcessDocumentation(value: object): boolean;
+export declare function ProcessDocumentationFromJSON(json: any): ProcessDocumentation;
+export declare function ProcessDocumentationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDocumentation;
+export declare function ProcessDocumentationToJSON(value?: ProcessDocumentation | null): any;

package/dist/esm/models/ProcessDocumentation.js

@@ -0,0 +1,47 @@
+/* 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 ProcessDocumentation interface.
+ */
+export function instanceOfProcessDocumentation(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function ProcessDocumentationFromJSON(json) {
+    return ProcessDocumentationFromJSONTyped(json, false);
+}
+export function ProcessDocumentationFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'docsUri': !exists(json, 'docsUri') ? undefined : json['docsUri'],
+        'partialUri': !exists(json, 'partialUri') ? undefined : json['partialUri'],
+        'content': !exists(json, 'content') ? undefined : json['content'],
+    };
+}
+export function ProcessDocumentationToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'docsUri': value.docsUri,
+        'partialUri': value.partialUri,
+        'content': value.content,
+    };
+}

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

@@ -16,7 +16,8 @@
  */
 export declare enum SharingType {
     Private = "PRIVATE",
-    ReadWrite = "READ_WRITE"
+    ReadWrite = "READ_WRITE",
+    ReadWriteControl = "READ_WRITE_CONTROL"
 }
 export declare function SharingTypeFromJSON(json: any): SharingType;
 export declare function SharingTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SharingType;

package/dist/esm/models/SharingType.js

@@ -20,6 +20,7 @@ export var SharingType;
 (function (SharingType) {
     SharingType["Private"] = "PRIVATE";
     SharingType["ReadWrite"] = "READ_WRITE";
+    SharingType["ReadWriteControl"] = "READ_WRITE_CONTROL";
 })(SharingType || (SharingType = {}));
 export function SharingTypeFromJSON(json) {
     return SharingTypeFromJSONTyped(json, false);

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

@@ -22,6 +22,8 @@ export declare enum Status {
     Deleted = "DELETED",
     Deleting = "DELETING",
     Suspended = "SUSPENDED",
+    Stopping = "STOPPING",
+    Starting = "STARTING",
     Delete = "DELETE",
     Failed = "FAILED",
     Unknown = "UNKNOWN"

package/dist/esm/models/Status.js

@@ -25,6 +25,8 @@ export var Status;
     Status["Deleted"] = "DELETED";
     Status["Deleting"] = "DELETING";
     Status["Suspended"] = "SUSPENDED";
+    Status["Stopping"] = "STOPPING";
+    Status["Starting"] = "STARTING";
     Status["Delete"] = "DELETE";
     Status["Failed"] = "FAILED";
     Status["Unknown"] = "UNKNOWN";

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

@@ -22,11 +22,11 @@ export interface Task {
      */
     name: string;
     /**
-     *
+     * Job ID on the underlying execution environment (i.e. AWS Batch ID)
      * @type {string}
      * @memberof Task
      */
-    nativeJobId: string;
+    nativeJobId?: string | null;
     /**
      *
      * @type {string}
@@ -38,37 +38,37 @@ export interface Task {
      * @type {Date}
      * @memberof Task
      */
-    requestedAt: Date;
+    requestedAt?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof Task
      */
-    startedAt?: Date;
+    startedAt?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof Task
      */
-    stoppedAt?: Date;
+    stoppedAt?: Date | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    containerImage?: string;
+    containerImage?: string | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    commandLine?: string;
+    commandLine?: string | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    logLocation?: string;
+    logLocation?: string | null;
 }
 /**
  * Check if a given object implements the Task interface.

package/dist/esm/models/Task.js

@@ -18,9 +18,7 @@ import { exists } from '../runtime';
 export function instanceOfTask(value) {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "nativeJobId" in value;
     isInstance = isInstance && "status" in value;
-    isInstance = isInstance && "requestedAt" in value;
     return isInstance;
 }
 export function TaskFromJSON(json) {
@@ -32,11 +30,11 @@ export function TaskFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'nativeJobId': json['nativeJobId'],
+        'nativeJobId': !exists(json, 'nativeJobId') ? undefined : json['nativeJobId'],
         'status': json['status'],
-        'requestedAt': (new Date(json['requestedAt'])),
-        'startedAt': !exists(json, 'startedAt') ? undefined : (new Date(json['startedAt'])),
-        'stoppedAt': !exists(json, 'stoppedAt') ? undefined : (new Date(json['stoppedAt'])),
+        'requestedAt': !exists(json, 'requestedAt') ? undefined : (json['requestedAt'] === null ? null : new Date(json['requestedAt'])),
+        'startedAt': !exists(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
+        'stoppedAt': !exists(json, 'stoppedAt') ? undefined : (json['stoppedAt'] === null ? null : new Date(json['stoppedAt'])),
         'containerImage': !exists(json, 'containerImage') ? undefined : json['containerImage'],
         'commandLine': !exists(json, 'commandLine') ? undefined : json['commandLine'],
         'logLocation': !exists(json, 'logLocation') ? undefined : json['logLocation'],
@@ -53,9 +51,9 @@ export function TaskToJSON(value) {
         'name': value.name,
         'nativeJobId': value.nativeJobId,
         'status': value.status,
-        'requestedAt': (value.requestedAt.toISOString()),
-        'startedAt': value.startedAt === undefined ? undefined : (value.startedAt.toISOString()),
-        'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt.toISOString()),
+        'requestedAt': value.requestedAt === undefined ? undefined : (value.requestedAt === null ? null : value.requestedAt.toISOString()),
+        'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
+        'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt === null ? null : value.stoppedAt.toISOString()),
         'containerImage': value.containerImage,
         'commandLine': value.commandLine,
         'logLocation': value.logLocation,

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

@@ -98,6 +98,7 @@ export * from './PortalErrorResponse';
 export * from './PostponeWorkspaceAutostopInput';
 export * from './Process';
 export * from './ProcessDetail';
+export * from './ProcessDocumentation';
 export * from './Project';
 export * from './ProjectAccessRequest';
 export * from './ProjectAccessType';

package/dist/esm/models/index.js

@@ -100,6 +100,7 @@ export * from './PortalErrorResponse';
 export * from './PostponeWorkspaceAutostopInput';
 export * from './Process';
 export * from './ProcessDetail';
+export * from './ProcessDocumentation';
 export * from './Project';
 export * from './ProjectAccessRequest';
 export * from './ProjectAccessType';

package/dist/models/DatasetViz.d.ts

@@ -41,10 +41,10 @@ export interface DatasetViz {
     type?: string;
     /**
      * Config or path to config used to render viz
-     * @type {any}
+     * @type {object}
      * @memberof DatasetViz
      */
-    config?: any | null;
+    config?: object;
 }
 /**
  * Check if a given object implements the DatasetViz interface.

package/dist/models/Discussion.d.ts

@@ -64,7 +64,7 @@ export interface Discussion {
      * @type {Date}
      * @memberof Discussion
      */
-    lastMessageTime: Date;
+    lastMessageTime?: Date | null;
     /**
      *
      * @type {Date}

package/dist/models/Discussion.js

@@ -14,6 +14,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DiscussionToJSON = exports.DiscussionFromJSONTyped = exports.DiscussionFromJSON = exports.instanceOfDiscussion = void 0;
+const runtime_1 = require("../runtime");
 const DiscussionType_1 = require("./DiscussionType");
 const Entity_1 = require("./Entity");
 /**
@@ -28,7 +29,6 @@ function instanceOfDiscussion(value) {
     isInstance = isInstance && "type" in value;
     isInstance = isInstance && "projectId" in value;
     isInstance = isInstance && "createdBy" in value;
-    isInstance = isInstance && "lastMessageTime" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
     return isInstance;
@@ -50,7 +50,7 @@ function DiscussionFromJSONTyped(json, ignoreDiscriminator) {
         'type': (0, DiscussionType_1.DiscussionTypeFromJSON)(json['type']),
         'projectId': json['projectId'],
         'createdBy': json['createdBy'],
-        'lastMessageTime': (new Date(json['lastMessageTime'])),
+        'lastMessageTime': !(0, runtime_1.exists)(json, 'lastMessageTime') ? undefined : (json['lastMessageTime'] === null ? null : new Date(json['lastMessageTime'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -71,7 +71,7 @@ function DiscussionToJSON(value) {
         'type': (0, DiscussionType_1.DiscussionTypeToJSON)(value.type),
         'projectId': value.projectId,
         'createdBy': value.createdBy,
-        'lastMessageTime': (value.lastMessageTime.toISOString()),
+        'lastMessageTime': value.lastMessageTime === undefined ? undefined : (value.lastMessageTime === null ? null : value.lastMessageTime.toISOString()),
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),
     };

package/dist/models/ProcessDocumentation.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 ProcessDocumentation
+ */
+export interface ProcessDocumentation {
+    /**
+     * Full URI to documentation
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    docsUri?: string;
+    /**
+     * URI of process documentation (partial)
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    partialUri?: string;
+    /**
+     * Documentation content
+     * @type {string}
+     * @memberof ProcessDocumentation
+     */
+    content?: string;
+}
+/**
+ * Check if a given object implements the ProcessDocumentation interface.
+ */
+export declare function instanceOfProcessDocumentation(value: object): boolean;
+export declare function ProcessDocumentationFromJSON(json: any): ProcessDocumentation;
+export declare function ProcessDocumentationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDocumentation;
+export declare function ProcessDocumentationToJSON(value?: ProcessDocumentation | null): any;

package/dist/models/ProcessDocumentation.js

@@ -0,0 +1,54 @@
+"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.ProcessDocumentationToJSON = exports.ProcessDocumentationFromJSONTyped = exports.ProcessDocumentationFromJSON = exports.instanceOfProcessDocumentation = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ProcessDocumentation interface.
+ */
+function instanceOfProcessDocumentation(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfProcessDocumentation = instanceOfProcessDocumentation;
+function ProcessDocumentationFromJSON(json) {
+    return ProcessDocumentationFromJSONTyped(json, false);
+}
+exports.ProcessDocumentationFromJSON = ProcessDocumentationFromJSON;
+function ProcessDocumentationFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'docsUri': !(0, runtime_1.exists)(json, 'docsUri') ? undefined : json['docsUri'],
+        'partialUri': !(0, runtime_1.exists)(json, 'partialUri') ? undefined : json['partialUri'],
+        'content': !(0, runtime_1.exists)(json, 'content') ? undefined : json['content'],
+    };
+}
+exports.ProcessDocumentationFromJSONTyped = ProcessDocumentationFromJSONTyped;
+function ProcessDocumentationToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'docsUri': value.docsUri,
+        'partialUri': value.partialUri,
+        'content': value.content,
+    };
+}
+exports.ProcessDocumentationToJSON = ProcessDocumentationToJSON;

package/dist/models/SharingType.d.ts

@@ -16,7 +16,8 @@
  */
 export declare enum SharingType {
     Private = "PRIVATE",
-    ReadWrite = "READ_WRITE"
+    ReadWrite = "READ_WRITE",
+    ReadWriteControl = "READ_WRITE_CONTROL"
 }
 export declare function SharingTypeFromJSON(json: any): SharingType;
 export declare function SharingTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SharingType;

package/dist/models/SharingType.js

@@ -23,6 +23,7 @@ var SharingType;
 (function (SharingType) {
     SharingType["Private"] = "PRIVATE";
     SharingType["ReadWrite"] = "READ_WRITE";
+    SharingType["ReadWriteControl"] = "READ_WRITE_CONTROL";
 })(SharingType = exports.SharingType || (exports.SharingType = {}));
 function SharingTypeFromJSON(json) {
     return SharingTypeFromJSONTyped(json, false);

package/dist/models/Status.d.ts

@@ -22,6 +22,8 @@ export declare enum Status {
     Deleted = "DELETED",
     Deleting = "DELETING",
     Suspended = "SUSPENDED",
+    Stopping = "STOPPING",
+    Starting = "STARTING",
     Delete = "DELETE",
     Failed = "FAILED",
     Unknown = "UNKNOWN"

package/dist/models/Status.js

@@ -28,6 +28,8 @@ var Status;
     Status["Deleted"] = "DELETED";
     Status["Deleting"] = "DELETING";
     Status["Suspended"] = "SUSPENDED";
+    Status["Stopping"] = "STOPPING";
+    Status["Starting"] = "STARTING";
     Status["Delete"] = "DELETE";
     Status["Failed"] = "FAILED";
     Status["Unknown"] = "UNKNOWN";

package/dist/models/Task.d.ts

@@ -22,11 +22,11 @@ export interface Task {
      */
     name: string;
     /**
-     *
+     * Job ID on the underlying execution environment (i.e. AWS Batch ID)
      * @type {string}
      * @memberof Task
      */
-    nativeJobId: string;
+    nativeJobId?: string | null;
     /**
      *
      * @type {string}
@@ -38,37 +38,37 @@ export interface Task {
      * @type {Date}
      * @memberof Task
      */
-    requestedAt: Date;
+    requestedAt?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof Task
      */
-    startedAt?: Date;
+    startedAt?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof Task
      */
-    stoppedAt?: Date;
+    stoppedAt?: Date | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    containerImage?: string;
+    containerImage?: string | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    commandLine?: string;
+    commandLine?: string | null;
     /**
      *
      * @type {string}
      * @memberof Task
      */
-    logLocation?: string;
+    logLocation?: string | null;
 }
 /**
  * Check if a given object implements the Task interface.

package/dist/models/Task.js

@@ -21,9 +21,7 @@ const runtime_1 = require("../runtime");
 function instanceOfTask(value) {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
-    isInstance = isInstance && "nativeJobId" in value;
     isInstance = isInstance && "status" in value;
-    isInstance = isInstance && "requestedAt" in value;
     return isInstance;
 }
 exports.instanceOfTask = instanceOfTask;
@@ -37,11 +35,11 @@ function TaskFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'nativeJobId': json['nativeJobId'],
+        'nativeJobId': !(0, runtime_1.exists)(json, 'nativeJobId') ? undefined : json['nativeJobId'],
         'status': json['status'],
-        'requestedAt': (new Date(json['requestedAt'])),
-        'startedAt': !(0, runtime_1.exists)(json, 'startedAt') ? undefined : (new Date(json['startedAt'])),
-        'stoppedAt': !(0, runtime_1.exists)(json, 'stoppedAt') ? undefined : (new Date(json['stoppedAt'])),
+        'requestedAt': !(0, runtime_1.exists)(json, 'requestedAt') ? undefined : (json['requestedAt'] === null ? null : new Date(json['requestedAt'])),
+        'startedAt': !(0, runtime_1.exists)(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
+        'stoppedAt': !(0, runtime_1.exists)(json, 'stoppedAt') ? undefined : (json['stoppedAt'] === null ? null : new Date(json['stoppedAt'])),
         'containerImage': !(0, runtime_1.exists)(json, 'containerImage') ? undefined : json['containerImage'],
         'commandLine': !(0, runtime_1.exists)(json, 'commandLine') ? undefined : json['commandLine'],
         'logLocation': !(0, runtime_1.exists)(json, 'logLocation') ? undefined : json['logLocation'],
@@ -59,9 +57,9 @@ function TaskToJSON(value) {
         'name': value.name,
         'nativeJobId': value.nativeJobId,
         'status': value.status,
-        'requestedAt': (value.requestedAt.toISOString()),
-        'startedAt': value.startedAt === undefined ? undefined : (value.startedAt.toISOString()),
-        'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt.toISOString()),
+        'requestedAt': value.requestedAt === undefined ? undefined : (value.requestedAt === null ? null : value.requestedAt.toISOString()),
+        'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
+        'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt === null ? null : value.stoppedAt.toISOString()),
         'containerImage': value.containerImage,
         'commandLine': value.commandLine,
         'logLocation': value.logLocation,

package/dist/models/index.d.ts

@@ -98,6 +98,7 @@ export * from './PortalErrorResponse';
 export * from './PostponeWorkspaceAutostopInput';
 export * from './Process';
 export * from './ProcessDetail';
+export * from './ProcessDocumentation';
 export * from './Project';
 export * from './ProjectAccessRequest';
 export * from './ProjectAccessType';

package/dist/models/index.js

@@ -116,6 +116,7 @@ __exportStar(require("./PortalErrorResponse"), exports);
 __exportStar(require("./PostponeWorkspaceAutostopInput"), exports);
 __exportStar(require("./Process"), exports);
 __exportStar(require("./ProcessDetail"), exports);
+__exportStar(require("./ProcessDocumentation"), exports);
 __exportStar(require("./Project"), exports);
 __exportStar(require("./ProjectAccessRequest"), exports);
 __exportStar(require("./ProjectAccessType"), exports);

package/package.json

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