@cirrobio/api-client 0.9.0 → 0.9.2

package/dist/models/RequestStatus.js

@@ -0,0 +1,39 @@
+"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.RequestStatusToJSON = exports.RequestStatusFromJSONTyped = exports.RequestStatusFromJSON = exports.RequestStatus = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var RequestStatus;
+(function (RequestStatus) {
+    RequestStatus["Pending"] = "PENDING";
+    RequestStatus["Accepted"] = "ACCEPTED";
+    RequestStatus["Denied"] = "DENIED";
+})(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
+function RequestStatusFromJSON(json) {
+    return RequestStatusFromJSONTyped(json, false);
+}
+exports.RequestStatusFromJSON = RequestStatusFromJSON;
+function RequestStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.RequestStatusFromJSONTyped = RequestStatusFromJSONTyped;
+function RequestStatusToJSON(value) {
+    return value;
+}
+exports.RequestStatusToJSON = RequestStatusToJSON;

package/dist/models/RequirementFulfillmentInput.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.
+ */
+/**
+ *
+ * @export
+ * @interface RequirementFulfillmentInput
+ */
+export interface RequirementFulfillmentInput {
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementFulfillmentInput
+     */
+    file?: string | null;
+    /**
+     * If not provided, defaults to the current instant
+     * @type {Date}
+     * @memberof RequirementFulfillmentInput
+     */
+    completedOn?: Date | null;
+}
+/**
+ * Check if a given object implements the RequirementFulfillmentInput interface.
+ */
+export declare function instanceOfRequirementFulfillmentInput(value: object): boolean;
+export declare function RequirementFulfillmentInputFromJSON(json: any): RequirementFulfillmentInput;
+export declare function RequirementFulfillmentInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementFulfillmentInput;
+export declare function RequirementFulfillmentInputToJSON(value?: RequirementFulfillmentInput | null): any;

package/dist/models/RequirementFulfillmentInput.js

@@ -0,0 +1,52 @@
+"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.RequirementFulfillmentInputToJSON = exports.RequirementFulfillmentInputFromJSONTyped = exports.RequirementFulfillmentInputFromJSON = exports.instanceOfRequirementFulfillmentInput = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the RequirementFulfillmentInput interface.
+ */
+function instanceOfRequirementFulfillmentInput(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfRequirementFulfillmentInput = instanceOfRequirementFulfillmentInput;
+function RequirementFulfillmentInputFromJSON(json) {
+    return RequirementFulfillmentInputFromJSONTyped(json, false);
+}
+exports.RequirementFulfillmentInputFromJSON = RequirementFulfillmentInputFromJSON;
+function RequirementFulfillmentInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'file': !(0, runtime_1.exists)(json, 'file') ? undefined : json['file'],
+        'completedOn': !(0, runtime_1.exists)(json, 'completedOn') ? undefined : (json['completedOn'] === null ? null : new Date(json['completedOn'])),
+    };
+}
+exports.RequirementFulfillmentInputFromJSONTyped = RequirementFulfillmentInputFromJSONTyped;
+function RequirementFulfillmentInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'file': value.file,
+        'completedOn': value.completedOn === undefined ? undefined : (value.completedOn === null ? null : value.completedOn.toISOString()),
+    };
+}
+exports.RequirementFulfillmentInputToJSON = RequirementFulfillmentInputToJSON;

package/dist/models/RequirementInput.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 { GovernanceExpiry } from './GovernanceExpiry';
+import type { GovernanceFile } from './GovernanceFile';
+import type { GovernanceScope } from './GovernanceScope';
+import type { GovernanceTrainingVerification } from './GovernanceTrainingVerification';
+import type { GovernanceType } from './GovernanceType';
+/**
+ *
+ * @export
+ * @interface RequirementInput
+ */
+export interface RequirementInput {
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementInput
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementInput
+     */
+    description: string;
+    /**
+     *
+     * @type {GovernanceType}
+     * @memberof RequirementInput
+     */
+    type: GovernanceType;
+    /**
+     *
+     * @type {GovernanceScope}
+     * @memberof RequirementInput
+     */
+    scope: GovernanceScope;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementInput
+     */
+    projectId?: string | null;
+    /**
+     *
+     * @type {GovernanceScope}
+     * @memberof RequirementInput
+     */
+    acceptance?: GovernanceScope | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof RequirementInput
+     */
+    contactIds: Array<string>;
+    /**
+     *
+     * @type {GovernanceExpiry}
+     * @memberof RequirementInput
+     */
+    expiration: GovernanceExpiry;
+    /**
+     *
+     * @type {Date}
+     * @memberof RequirementInput
+     */
+    enactmentDate?: Date | null;
+    /**
+     *
+     * @type {Array<GovernanceFile>}
+     * @memberof RequirementInput
+     */
+    supplementalDocs?: Array<GovernanceFile> | null;
+    /**
+     *
+     * @type {GovernanceFile}
+     * @memberof RequirementInput
+     */
+    file?: GovernanceFile | null;
+    /**
+     *
+     * @type {GovernanceScope}
+     * @memberof RequirementInput
+     */
+    authorship?: GovernanceScope | null;
+    /**
+     *
+     * @type {GovernanceTrainingVerification}
+     * @memberof RequirementInput
+     */
+    verificationMethod?: GovernanceTrainingVerification | null;
+}
+/**
+ * Check if a given object implements the RequirementInput interface.
+ */
+export declare function instanceOfRequirementInput(value: object): boolean;
+export declare function RequirementInputFromJSON(json: any): RequirementInput;
+export declare function RequirementInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementInput;
+export declare function RequirementInputToJSON(value?: RequirementInput | null): any;

package/dist/models/RequirementInput.js

@@ -0,0 +1,85 @@
+"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.RequirementInputToJSON = exports.RequirementInputFromJSONTyped = exports.RequirementInputFromJSON = exports.instanceOfRequirementInput = void 0;
+const runtime_1 = require("../runtime");
+const GovernanceExpiry_1 = require("./GovernanceExpiry");
+const GovernanceFile_1 = require("./GovernanceFile");
+const GovernanceScope_1 = require("./GovernanceScope");
+const GovernanceTrainingVerification_1 = require("./GovernanceTrainingVerification");
+const GovernanceType_1 = require("./GovernanceType");
+/**
+ * Check if a given object implements the RequirementInput interface.
+ */
+function instanceOfRequirementInput(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "scope" in value;
+    isInstance = isInstance && "contactIds" in value;
+    isInstance = isInstance && "expiration" in value;
+    return isInstance;
+}
+exports.instanceOfRequirementInput = instanceOfRequirementInput;
+function RequirementInputFromJSON(json) {
+    return RequirementInputFromJSONTyped(json, false);
+}
+exports.RequirementInputFromJSON = RequirementInputFromJSON;
+function RequirementInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'],
+        'type': (0, GovernanceType_1.GovernanceTypeFromJSON)(json['type']),
+        'scope': (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['scope']),
+        'projectId': !(0, runtime_1.exists)(json, 'projectId') ? undefined : json['projectId'],
+        'acceptance': !(0, runtime_1.exists)(json, 'acceptance') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['acceptance']),
+        'contactIds': json['contactIds'],
+        'expiration': (0, GovernanceExpiry_1.GovernanceExpiryFromJSON)(json['expiration']),
+        'enactmentDate': !(0, runtime_1.exists)(json, 'enactmentDate') ? undefined : (json['enactmentDate'] === null ? null : new Date(json['enactmentDate'])),
+        'supplementalDocs': !(0, runtime_1.exists)(json, 'supplementalDocs') ? undefined : (json['supplementalDocs'] === null ? null : json['supplementalDocs'].map(GovernanceFile_1.GovernanceFileFromJSON)),
+        'file': !(0, runtime_1.exists)(json, 'file') ? undefined : (0, GovernanceFile_1.GovernanceFileFromJSON)(json['file']),
+        'authorship': !(0, runtime_1.exists)(json, 'authorship') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['authorship']),
+        'verificationMethod': !(0, runtime_1.exists)(json, 'verificationMethod') ? undefined : (0, GovernanceTrainingVerification_1.GovernanceTrainingVerificationFromJSON)(json['verificationMethod']),
+    };
+}
+exports.RequirementInputFromJSONTyped = RequirementInputFromJSONTyped;
+function RequirementInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'type': (0, GovernanceType_1.GovernanceTypeToJSON)(value.type),
+        'scope': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.scope),
+        'projectId': value.projectId,
+        'acceptance': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.acceptance),
+        'contactIds': value.contactIds,
+        'expiration': (0, GovernanceExpiry_1.GovernanceExpiryToJSON)(value.expiration),
+        'enactmentDate': value.enactmentDate === undefined ? undefined : (value.enactmentDate === null ? null : value.enactmentDate.toISOString()),
+        'supplementalDocs': value.supplementalDocs === undefined ? undefined : (value.supplementalDocs === null ? null : value.supplementalDocs.map(GovernanceFile_1.GovernanceFileToJSON)),
+        'file': (0, GovernanceFile_1.GovernanceFileToJSON)(value.file),
+        'authorship': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.authorship),
+        'verificationMethod': (0, GovernanceTrainingVerification_1.GovernanceTrainingVerificationToJSON)(value.verificationMethod),
+    };
+}
+exports.RequirementInputToJSON = RequirementInputToJSON;

package/dist/models/ResourcesInfo.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 ResourcesInfo
+ */
+export interface ResourcesInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourcesInfo
+     */
+    commit: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourcesInfo
+     */
+    date: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourcesInfo
+     */
+    repository: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourcesInfo
+     */
+    sourceVersion: string;
+}
+/**
+ * Check if a given object implements the ResourcesInfo interface.
+ */
+export declare function instanceOfResourcesInfo(value: object): boolean;
+export declare function ResourcesInfoFromJSON(json: any): ResourcesInfo;
+export declare function ResourcesInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourcesInfo;
+export declare function ResourcesInfoToJSON(value?: ResourcesInfo | null): any;

package/{src/models/ResourcesInfo.ts → dist/models/ResourcesInfo.js}

@@ -1,3 +1,4 @@
+"use strict";
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -11,71 +12,37 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-import { exists, mapValues } from '../runtime';
-/**
- * 
- * @export
- * @interface ResourcesInfo
- */
-export interface ResourcesInfo {
-    /**
-     * 
-     * @type {string}
-     * @memberof ResourcesInfo
-     */
-    commit: string;
-    /**
-     * 
-     * @type {Date}
-     * @memberof ResourcesInfo
-     */
-    date: Date;
-    /**
-     * 
-     * @type {string}
-     * @memberof ResourcesInfo
-     */
-    repository: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ResourcesInfo
-     */
-    sourceVersion: string;
-}
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourcesInfoToJSON = exports.ResourcesInfoFromJSONTyped = exports.ResourcesInfoFromJSON = exports.instanceOfResourcesInfo = void 0;
 /**
  * Check if a given object implements the ResourcesInfo interface.
  */
-export function instanceOfResourcesInfo(value: object): boolean {
+function instanceOfResourcesInfo(value) {
     let isInstance = true;
     isInstance = isInstance && "commit" in value;
     isInstance = isInstance && "date" in value;
     isInstance = isInstance && "repository" in value;
     isInstance = isInstance && "sourceVersion" in value;
-
     return isInstance;
 }
-
-export function ResourcesInfoFromJSON(json: any): ResourcesInfo {
+exports.instanceOfResourcesInfo = instanceOfResourcesInfo;
+function ResourcesInfoFromJSON(json) {
     return ResourcesInfoFromJSONTyped(json, false);
 }
-
-export function ResourcesInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourcesInfo {
+exports.ResourcesInfoFromJSON = ResourcesInfoFromJSON;
+function ResourcesInfoFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
-        
         'commit': json['commit'],
         'date': (new Date(json['date'])),
         'repository': json['repository'],
         'sourceVersion': json['sourceVersion'],
     };
 }
-
-export function ResourcesInfoToJSON(value?: ResourcesInfo | null): any {
+exports.ResourcesInfoFromJSONTyped = ResourcesInfoFromJSONTyped;
+function ResourcesInfoToJSON(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -83,11 +50,10 @@ export function ResourcesInfoToJSON(value?: ResourcesInfo | null): any {
         return null;
     }
     return {
-        
         'commit': value.commit,
         'date': (value.date.toISOString()),
         'repository': value.repository,
         'sourceVersion': value.sourceVersion,
     };
 }
-
+exports.ResourcesInfoToJSON = ResourcesInfoToJSON;

package/dist/models/RunAnalysisRequest.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 RunAnalysisRequest
+ */
+export interface RunAnalysisRequest {
+    /**
+     * Name of the dataset
+     * @type {string}
+     * @memberof RunAnalysisRequest
+     */
+    name: string;
+    /**
+     * Description of the dataset (optional)
+     * @type {string}
+     * @memberof RunAnalysisRequest
+     */
+    description?: string | null;
+    /**
+     * Process ID of the workflow
+     * @type {string}
+     * @memberof RunAnalysisRequest
+     */
+    processId: string;
+    /**
+     * These datasets contain files that are inputs to this workflow.
+     * @type {Array<string>}
+     * @memberof RunAnalysisRequest
+     */
+    sourceDatasetIds: Array<string>;
+    /**
+     * Samples within the source datasets that will be used as inputs to this workflow. If not specified, all samples will be used.
+     * @type {Array<string>}
+     * @memberof RunAnalysisRequest
+     */
+    sourceSampleIds?: Array<string> | null;
+    /**
+     * Files containing samples used to define source data input to this workflow. If not specified, all files will be used. Keys are sampleIds, and the lists are file paths to include.
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof RunAnalysisRequest
+     */
+    sourceSampleFilesMap?: {
+        [key: string]: Array<string>;
+    } | null;
+    /**
+     * Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
+     * @type {string}
+     * @memberof RunAnalysisRequest
+     */
+    resumeDatasetId?: string | null;
+    /**
+     * Parameters used in workflow (can be empty)
+     * @type {{ [key: string]: any; }}
+     * @memberof RunAnalysisRequest
+     */
+    params: {
+        [key: string]: any;
+    };
+    /**
+     * Emails to notify upon workflow success or failure
+     * @type {Array<string>}
+     * @memberof RunAnalysisRequest
+     */
+    notificationEmails: Array<string>;
+    /**
+     * The compute environment where to run the workflow, if not specified, it will run in AWS
+     * @type {string}
+     * @memberof RunAnalysisRequest
+     */
+    computeEnvironmentId?: string | null;
+}
+/**
+ * Check if a given object implements the RunAnalysisRequest interface.
+ */
+export declare function instanceOfRunAnalysisRequest(value: object): boolean;
+export declare function RunAnalysisRequestFromJSON(json: any): RunAnalysisRequest;
+export declare function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunAnalysisRequest;
+export declare function RunAnalysisRequestToJSON(value?: RunAnalysisRequest | null): any;

package/dist/models/RunAnalysisRequest.js

@@ -0,0 +1,73 @@
+"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.RunAnalysisRequestToJSON = exports.RunAnalysisRequestFromJSONTyped = exports.RunAnalysisRequestFromJSON = exports.instanceOfRunAnalysisRequest = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the RunAnalysisRequest interface.
+ */
+function instanceOfRunAnalysisRequest(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "processId" in value;
+    isInstance = isInstance && "sourceDatasetIds" in value;
+    isInstance = isInstance && "params" in value;
+    isInstance = isInstance && "notificationEmails" in value;
+    return isInstance;
+}
+exports.instanceOfRunAnalysisRequest = instanceOfRunAnalysisRequest;
+function RunAnalysisRequestFromJSON(json) {
+    return RunAnalysisRequestFromJSONTyped(json, false);
+}
+exports.RunAnalysisRequestFromJSON = RunAnalysisRequestFromJSON;
+function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+        'processId': json['processId'],
+        'sourceDatasetIds': json['sourceDatasetIds'],
+        'sourceSampleIds': !(0, runtime_1.exists)(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
+        'sourceSampleFilesMap': !(0, runtime_1.exists)(json, 'sourceSampleFilesMap') ? undefined : json['sourceSampleFilesMap'],
+        'resumeDatasetId': !(0, runtime_1.exists)(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
+        'params': json['params'],
+        'notificationEmails': json['notificationEmails'],
+        'computeEnvironmentId': !(0, runtime_1.exists)(json, 'computeEnvironmentId') ? undefined : json['computeEnvironmentId'],
+    };
+}
+exports.RunAnalysisRequestFromJSONTyped = RunAnalysisRequestFromJSONTyped;
+function RunAnalysisRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'processId': value.processId,
+        'sourceDatasetIds': value.sourceDatasetIds,
+        'sourceSampleIds': value.sourceSampleIds,
+        'sourceSampleFilesMap': value.sourceSampleFilesMap,
+        'resumeDatasetId': value.resumeDatasetId,
+        'params': value.params,
+        'notificationEmails': value.notificationEmails,
+        'computeEnvironmentId': value.computeEnvironmentId,
+    };
+}
+exports.RunAnalysisRequestToJSON = RunAnalysisRequestToJSON;