@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/models/Executor.js

@@ -0,0 +1,40 @@
+"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.ExecutorToJSON = exports.ExecutorFromJSONTyped = exports.ExecutorFromJSON = exports.Executor = void 0;
+/**
+ * How the workflow is executed
+ * @export
+ * @enum {string}
+ */
+var Executor;
+(function (Executor) {
+    Executor["Ingest"] = "INGEST";
+    Executor["Nextflow"] = "NEXTFLOW";
+    Executor["Cromwell"] = "CROMWELL";
+    Executor["OmicsReady2Run"] = "OMICS_READY2RUN";
+})(Executor = exports.Executor || (exports.Executor = {}));
+function ExecutorFromJSON(json) {
+    return ExecutorFromJSONTyped(json, false);
+}
+exports.ExecutorFromJSON = ExecutorFromJSON;
+function ExecutorFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.ExecutorFromJSONTyped = ExecutorFromJSONTyped;
+function ExecutorToJSON(value) {
+    return value;
+}
+exports.ExecutorToJSON = ExecutorToJSON;

package/dist/models/FeatureFlags.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 FeatureFlags
+ */
+export interface FeatureFlags {
+    /**
+     *
+     * @type {boolean}
+     * @memberof FeatureFlags
+     */
+    sftpEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FeatureFlags
+     */
+    governanceEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FeatureFlags
+     */
+    projectRequestsEnabled: boolean;
+}
+/**
+ * Check if a given object implements the FeatureFlags interface.
+ */
+export declare function instanceOfFeatureFlags(value: object): boolean;
+export declare function FeatureFlagsFromJSON(json: any): FeatureFlags;
+export declare function FeatureFlagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureFlags;
+export declare function FeatureFlagsToJSON(value?: FeatureFlags | null): any;

package/dist/models/FeatureFlags.js

@@ -0,0 +1,56 @@
+"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.FeatureFlagsToJSON = exports.FeatureFlagsFromJSONTyped = exports.FeatureFlagsFromJSON = exports.instanceOfFeatureFlags = void 0;
+/**
+ * Check if a given object implements the FeatureFlags interface.
+ */
+function instanceOfFeatureFlags(value) {
+    let isInstance = true;
+    isInstance = isInstance && "sftpEnabled" in value;
+    isInstance = isInstance && "governanceEnabled" in value;
+    isInstance = isInstance && "projectRequestsEnabled" in value;
+    return isInstance;
+}
+exports.instanceOfFeatureFlags = instanceOfFeatureFlags;
+function FeatureFlagsFromJSON(json) {
+    return FeatureFlagsFromJSONTyped(json, false);
+}
+exports.FeatureFlagsFromJSON = FeatureFlagsFromJSON;
+function FeatureFlagsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'sftpEnabled': json['sftpEnabled'],
+        'governanceEnabled': json['governanceEnabled'],
+        'projectRequestsEnabled': json['projectRequestsEnabled'],
+    };
+}
+exports.FeatureFlagsFromJSONTyped = FeatureFlagsFromJSONTyped;
+function FeatureFlagsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'sftpEnabled': value.sftpEnabled,
+        'governanceEnabled': value.governanceEnabled,
+        'projectRequestsEnabled': value.projectRequestsEnabled,
+    };
+}
+exports.FeatureFlagsToJSON = FeatureFlagsToJSON;

package/dist/models/FileEntry.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 FileEntry
+ */
+export interface FileEntry {
+    /**
+     * Relative path to file
+     * @type {string}
+     * @memberof FileEntry
+     */
+    path?: string;
+    /**
+     * File size (in bytes)
+     * @type {number}
+     * @memberof FileEntry
+     */
+    size?: number;
+    /**
+     * Metadata associated with the file
+     * @type {{ [key: string]: string; }}
+     * @memberof FileEntry
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+export declare function instanceOfFileEntry(value: object): boolean;
+export declare function FileEntryFromJSON(json: any): FileEntry;
+export declare function FileEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileEntry;
+export declare function FileEntryToJSON(value?: FileEntry | null): any;

package/dist/models/FileEntry.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.FileEntryToJSON = exports.FileEntryFromJSONTyped = exports.FileEntryFromJSON = exports.instanceOfFileEntry = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+function instanceOfFileEntry(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfFileEntry = instanceOfFileEntry;
+function FileEntryFromJSON(json) {
+    return FileEntryFromJSONTyped(json, false);
+}
+exports.FileEntryFromJSON = FileEntryFromJSON;
+function FileEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'size': !(0, runtime_1.exists)(json, 'size') ? undefined : json['size'],
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+    };
+}
+exports.FileEntryFromJSONTyped = FileEntryFromJSONTyped;
+function FileEntryToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'path': value.path,
+        'size': value.size,
+        'metadata': value.metadata,
+    };
+}
+exports.FileEntryToJSON = FileEntryToJSON;

package/dist/models/FileMappingRule.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { FileNamePattern } from './FileNamePattern';
+/**
+ *
+ * @export
+ * @interface FileMappingRule
+ */
+export interface FileMappingRule {
+    /**
+     * Describes the group of possible files that meet a single file type criteria.
+     * @type {string}
+     * @memberof FileMappingRule
+     */
+    description: string;
+    /**
+     * Minimum number of files to expect for the file type group.
+     * @type {number}
+     * @memberof FileMappingRule
+     */
+    min?: number;
+    /**
+     * Maximum number of files to expect for the file type group.
+     * @type {number}
+     * @memberof FileMappingRule
+     */
+    max?: number;
+    /**
+     * Specifies if the file type will be associated with a sample.
+     * @type {boolean}
+     * @memberof FileMappingRule
+     */
+    isSample?: boolean;
+    /**
+     * Describes the possible file patterns to expect for the file type group.
+     * @type {Array<FileNamePattern>}
+     * @memberof FileMappingRule
+     */
+    fileNamePatterns: Array<FileNamePattern>;
+}
+/**
+ * Check if a given object implements the FileMappingRule interface.
+ */
+export declare function instanceOfFileMappingRule(value: object): boolean;
+export declare function FileMappingRuleFromJSON(json: any): FileMappingRule;
+export declare function FileMappingRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileMappingRule;
+export declare function FileMappingRuleToJSON(value?: FileMappingRule | null): any;

package/dist/models/FileMappingRule.js

@@ -0,0 +1,61 @@
+"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.FileMappingRuleToJSON = exports.FileMappingRuleFromJSONTyped = exports.FileMappingRuleFromJSON = exports.instanceOfFileMappingRule = void 0;
+const runtime_1 = require("../runtime");
+const FileNamePattern_1 = require("./FileNamePattern");
+/**
+ * Check if a given object implements the FileMappingRule interface.
+ */
+function instanceOfFileMappingRule(value) {
+    let isInstance = true;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "fileNamePatterns" in value;
+    return isInstance;
+}
+exports.instanceOfFileMappingRule = instanceOfFileMappingRule;
+function FileMappingRuleFromJSON(json) {
+    return FileMappingRuleFromJSONTyped(json, false);
+}
+exports.FileMappingRuleFromJSON = FileMappingRuleFromJSON;
+function FileMappingRuleFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'description': json['description'],
+        'min': !(0, runtime_1.exists)(json, 'min') ? undefined : json['min'],
+        'max': !(0, runtime_1.exists)(json, 'max') ? undefined : json['max'],
+        'isSample': !(0, runtime_1.exists)(json, 'isSample') ? undefined : json['isSample'],
+        'fileNamePatterns': (json['fileNamePatterns'].map(FileNamePattern_1.FileNamePatternFromJSON)),
+    };
+}
+exports.FileMappingRuleFromJSONTyped = FileMappingRuleFromJSONTyped;
+function FileMappingRuleToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'description': value.description,
+        'min': value.min,
+        'max': value.max,
+        'isSample': value.isSample,
+        'fileNamePatterns': (value.fileNamePatterns.map(FileNamePattern_1.FileNamePatternToJSON)),
+    };
+}
+exports.FileMappingRuleToJSON = FileMappingRuleToJSON;

package/dist/models/FileNamePattern.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 FileNamePattern
+ */
+export interface FileNamePattern {
+    /**
+     * User-readable name for the file type used for display.
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    exampleName: string;
+    /**
+     * File description.
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    description: string;
+    /**
+     * File name pattern, formatted as a valid regex, to extract sample name and other metadata.
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    sampleMatchingPattern: string;
+}
+/**
+ * Check if a given object implements the FileNamePattern interface.
+ */
+export declare function instanceOfFileNamePattern(value: object): boolean;
+export declare function FileNamePatternFromJSON(json: any): FileNamePattern;
+export declare function FileNamePatternFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileNamePattern;
+export declare function FileNamePatternToJSON(value?: FileNamePattern | null): any;

package/dist/models/FileNamePattern.js

@@ -0,0 +1,56 @@
+"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.FileNamePatternToJSON = exports.FileNamePatternFromJSONTyped = exports.FileNamePatternFromJSON = exports.instanceOfFileNamePattern = void 0;
+/**
+ * Check if a given object implements the FileNamePattern interface.
+ */
+function instanceOfFileNamePattern(value) {
+    let isInstance = true;
+    isInstance = isInstance && "exampleName" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "sampleMatchingPattern" in value;
+    return isInstance;
+}
+exports.instanceOfFileNamePattern = instanceOfFileNamePattern;
+function FileNamePatternFromJSON(json) {
+    return FileNamePatternFromJSONTyped(json, false);
+}
+exports.FileNamePatternFromJSON = FileNamePatternFromJSON;
+function FileNamePatternFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'exampleName': json['exampleName'],
+        'description': json['description'],
+        'sampleMatchingPattern': json['sampleMatchingPattern'],
+    };
+}
+exports.FileNamePatternFromJSONTyped = FileNamePatternFromJSONTyped;
+function FileNamePatternToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'exampleName': value.exampleName,
+        'description': value.description,
+        'sampleMatchingPattern': value.sampleMatchingPattern,
+    };
+}
+exports.FileNamePatternToJSON = FileNamePatternToJSON;

package/dist/models/FileRequirements.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { AllowedDataType } from './AllowedDataType';
+/**
+ *
+ * @export
+ * @interface FileRequirements
+ */
+export interface FileRequirements {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileRequirements
+     */
+    files: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof FileRequirements
+     */
+    errorMsg: string;
+    /**
+     *
+     * @type {Array<AllowedDataType>}
+     * @memberof FileRequirements
+     */
+    allowedDataTypes: Array<AllowedDataType>;
+}
+/**
+ * Check if a given object implements the FileRequirements interface.
+ */
+export declare function instanceOfFileRequirements(value: object): boolean;
+export declare function FileRequirementsFromJSON(json: any): FileRequirements;
+export declare function FileRequirementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileRequirements;
+export declare function FileRequirementsToJSON(value?: FileRequirements | null): any;

package/dist/models/FileRequirements.js

@@ -0,0 +1,57 @@
+"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.FileRequirementsToJSON = exports.FileRequirementsFromJSONTyped = exports.FileRequirementsFromJSON = exports.instanceOfFileRequirements = void 0;
+const AllowedDataType_1 = require("./AllowedDataType");
+/**
+ * Check if a given object implements the FileRequirements interface.
+ */
+function instanceOfFileRequirements(value) {
+    let isInstance = true;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedDataTypes" in value;
+    return isInstance;
+}
+exports.instanceOfFileRequirements = instanceOfFileRequirements;
+function FileRequirementsFromJSON(json) {
+    return FileRequirementsFromJSONTyped(json, false);
+}
+exports.FileRequirementsFromJSON = FileRequirementsFromJSON;
+function FileRequirementsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'files': json['files'],
+        'errorMsg': json['errorMsg'],
+        'allowedDataTypes': (json['allowedDataTypes'].map(AllowedDataType_1.AllowedDataTypeFromJSON)),
+    };
+}
+exports.FileRequirementsFromJSONTyped = FileRequirementsFromJSONTyped;
+function FileRequirementsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'files': value.files,
+        'errorMsg': value.errorMsg,
+        'allowedDataTypes': (value.allowedDataTypes.map(AllowedDataType_1.AllowedDataTypeToJSON)),
+    };
+}
+exports.FileRequirementsToJSON = FileRequirementsToJSON;

package/dist/models/FormSchema.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 FormSchema
+ */
+export interface FormSchema {
+    /**
+     * JSONSchema representation of the parameters
+     * @type {{ [key: string]: any; }}
+     * @memberof FormSchema
+     */
+    form?: {
+        [key: string]: any;
+    };
+    /**
+     * Describes how the form should be rendered, see rjsf
+     * @type {{ [key: string]: any; }}
+     * @memberof FormSchema
+     */
+    ui?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the FormSchema interface.
+ */
+export declare function instanceOfFormSchema(value: object): boolean;
+export declare function FormSchemaFromJSON(json: any): FormSchema;
+export declare function FormSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): FormSchema;
+export declare function FormSchemaToJSON(value?: FormSchema | null): any;

package/dist/models/FormSchema.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.FormSchemaToJSON = exports.FormSchemaFromJSONTyped = exports.FormSchemaFromJSON = exports.instanceOfFormSchema = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the FormSchema interface.
+ */
+function instanceOfFormSchema(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfFormSchema = instanceOfFormSchema;
+function FormSchemaFromJSON(json) {
+    return FormSchemaFromJSONTyped(json, false);
+}
+exports.FormSchemaFromJSON = FormSchemaFromJSON;
+function FormSchemaFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'form': !(0, runtime_1.exists)(json, 'form') ? undefined : json['form'],
+        'ui': !(0, runtime_1.exists)(json, 'ui') ? undefined : json['ui'],
+    };
+}
+exports.FormSchemaFromJSONTyped = FormSchemaFromJSONTyped;
+function FormSchemaToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'form': value.form,
+        'ui': value.ui,
+    };
+}
+exports.FormSchemaToJSON = FormSchemaToJSON;