@cirrobio/api-client 0.9.0 → 0.9.1

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

@@ -0,0 +1,78 @@
+/* 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 { GovernanceExpiryFromJSON, GovernanceExpiryToJSON, } from './GovernanceExpiry';
+import { GovernanceFileFromJSON, GovernanceFileToJSON, } from './GovernanceFile';
+import { GovernanceScopeFromJSON, GovernanceScopeToJSON, } from './GovernanceScope';
+import { GovernanceTrainingVerificationFromJSON, GovernanceTrainingVerificationToJSON, } from './GovernanceTrainingVerification';
+import { GovernanceTypeFromJSON, GovernanceTypeToJSON, } from './GovernanceType';
+/**
+ * Check if a given object implements the RequirementInput interface.
+ */
+export 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;
+}
+export function RequirementInputFromJSON(json) {
+    return RequirementInputFromJSONTyped(json, false);
+}
+export function RequirementInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'],
+        'type': GovernanceTypeFromJSON(json['type']),
+        'scope': GovernanceScopeFromJSON(json['scope']),
+        'projectId': !exists(json, 'projectId') ? undefined : json['projectId'],
+        'acceptance': !exists(json, 'acceptance') ? undefined : GovernanceScopeFromJSON(json['acceptance']),
+        'contactIds': json['contactIds'],
+        'expiration': GovernanceExpiryFromJSON(json['expiration']),
+        'enactmentDate': !exists(json, 'enactmentDate') ? undefined : (json['enactmentDate'] === null ? null : new Date(json['enactmentDate'])),
+        'supplementalDocs': !exists(json, 'supplementalDocs') ? undefined : (json['supplementalDocs'] === null ? null : json['supplementalDocs'].map(GovernanceFileFromJSON)),
+        'file': !exists(json, 'file') ? undefined : GovernanceFileFromJSON(json['file']),
+        'authorship': !exists(json, 'authorship') ? undefined : GovernanceScopeFromJSON(json['authorship']),
+        'verificationMethod': !exists(json, 'verificationMethod') ? undefined : GovernanceTrainingVerificationFromJSON(json['verificationMethod']),
+    };
+}
+export function RequirementInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'type': GovernanceTypeToJSON(value.type),
+        'scope': GovernanceScopeToJSON(value.scope),
+        'projectId': value.projectId,
+        'acceptance': GovernanceScopeToJSON(value.acceptance),
+        'contactIds': value.contactIds,
+        'expiration': 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(GovernanceFileToJSON)),
+        'file': GovernanceFileToJSON(value.file),
+        'authorship': GovernanceScopeToJSON(value.authorship),
+        'verificationMethod': GovernanceTrainingVerificationToJSON(value.verificationMethod),
+    };
+}

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

@@ -0,0 +1,52 @@
+/* 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 ResourcesInfo interface.
+ */
+export 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) {
+    return ResourcesInfoFromJSONTyped(json, false);
+}
+export 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) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'commit': value.commit,
+        'date': (value.date.toISOString()),
+        'repository': value.repository,
+        'sourceVersion': value.sourceVersion,
+    };
+}

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

@@ -0,0 +1,66 @@
+/* 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 RunAnalysisRequest interface.
+ */
+export 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;
+}
+export function RunAnalysisRequestFromJSON(json) {
+    return RunAnalysisRequestFromJSONTyped(json, false);
+}
+export function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'processId': json['processId'],
+        'sourceDatasetIds': json['sourceDatasetIds'],
+        'sourceSampleIds': !exists(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
+        'sourceSampleFilesMap': !exists(json, 'sourceSampleFilesMap') ? undefined : json['sourceSampleFilesMap'],
+        'resumeDatasetId': !exists(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
+        'params': json['params'],
+        'notificationEmails': json['notificationEmails'],
+        'computeEnvironmentId': !exists(json, 'computeEnvironmentId') ? undefined : json['computeEnvironmentId'],
+    };
+}
+export 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,
+    };
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 { DataFile } from './DataFile';
+/**
+ *
+ * @export
+ * @interface Sample
+ */
+export interface Sample {
+    /**
+     *
+     * @type {string}
+     * @memberof Sample
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Sample
+     */
+    name: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof Sample
+     */
+    metadata?: {
+        [key: string]: any;
+    } | null;
+    /**
+     * Files associated with this sample
+     * @type {Array<DataFile>}
+     * @memberof Sample
+     */
+    files?: Array<DataFile> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Sample
+     */
+    datasetIds?: Array<string> | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Sample
+     */
+    createdAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Sample
+     */
+    updatedAt?: Date | null;
+}
+/**
+ * Check if a given object implements the Sample interface.
+ */
+export declare function instanceOfSample(value: object): boolean;
+export declare function SampleFromJSON(json: any): Sample;
+export declare function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sample;
+export declare function SampleToJSON(value?: Sample | null): any;

package/{src/models/Sample.ts → dist/esm/models/Sample.js}

@@ -11,97 +11,35 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-import { exists, mapValues } from '../runtime';
-import type { DataFile } from './DataFile';
-import {
-    DataFileFromJSON,
-    DataFileFromJSONTyped,
-    DataFileToJSON,
-} from './DataFile';
-
-/**
- * 
- * @export
- * @interface Sample
- */
-export interface Sample {
-    /**
-     * 
-     * @type {string}
-     * @memberof Sample
-     */
-    id: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof Sample
-     */
-    name: string;
-    /**
-     * 
-     * @type {{ [key: string]: any; }}
-     * @memberof Sample
-     */
-    metadata?: { [key: string]: any; } | null;
-    /**
-     * Files associated with this sample
-     * @type {Array<DataFile>}
-     * @memberof Sample
-     */
-    files?: Array<DataFile> | null;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof Sample
-     */
-    datasetIds?: Array<string> | null;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Sample
-     */
-    createdAt?: Date | null;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Sample
-     */
-    updatedAt?: Date | null;
-}
-
+import { exists } from '../runtime';
+import { DataFileFromJSON, DataFileToJSON, } from './DataFile';
 /**
  * Check if a given object implements the Sample interface.
  */
-export function instanceOfSample(value: object): boolean {
+export function instanceOfSample(value) {
     let isInstance = true;
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
-
     return isInstance;
 }
-
-export function SampleFromJSON(json: any): Sample {
+export function SampleFromJSON(json) {
     return SampleFromJSONTyped(json, false);
 }
-
-export function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sample {
+export function SampleFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
-        
         'id': json['id'],
         'name': json['name'],
         'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
-        'files': !exists(json, 'files') ? undefined : (json['files'] === null ? null : (json['files'] as Array<any>).map(DataFileFromJSON)),
+        'files': !exists(json, 'files') ? undefined : (json['files'] === null ? null : json['files'].map(DataFileFromJSON)),
         'datasetIds': !exists(json, 'datasetIds') ? undefined : json['datasetIds'],
         'createdAt': !exists(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
         'updatedAt': !exists(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
     };
 }
-
-export function SampleToJSON(value?: Sample | null): any {
+export function SampleToJSON(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -109,14 +47,12 @@ export function SampleToJSON(value?: Sample | null): any {
         return null;
     }
     return {
-        
         'id': value.id,
         'name': value.name,
         'metadata': value.metadata,
-        'files': value.files === undefined ? undefined : (value.files === null ? null : (value.files as Array<any>).map(DataFileToJSON)),
+        'files': value.files === undefined ? undefined : (value.files === null ? null : value.files.map(DataFileToJSON)),
         'datasetIds': value.datasetIds,
         'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
         'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),
     };
 }
-

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

@@ -0,0 +1,39 @@
+/**
+ * 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 SampleRequest
+ */
+export interface SampleRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SampleRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof SampleRequest
+     */
+    metadata: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the SampleRequest interface.
+ */
+export declare function instanceOfSampleRequest(value: object): boolean;
+export declare function SampleRequestFromJSON(json: any): SampleRequest;
+export declare function SampleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SampleRequest;
+export declare function SampleRequestToJSON(value?: SampleRequest | null): any;