@cirrobio/api-client 0.9.0 → 0.9.1

package/dist/models/Share.js

@@ -0,0 +1,82 @@
+"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.ShareToJSON = exports.ShareFromJSONTyped = exports.ShareFromJSON = exports.instanceOfShare = void 0;
+const DatasetCondition_1 = require("./DatasetCondition");
+const ShareType_1 = require("./ShareType");
+/**
+ * Check if a given object implements the Share interface.
+ */
+function instanceOfShare(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "originatingProjectId" in value;
+    isInstance = isInstance && "shareType" in value;
+    isInstance = isInstance && "conditions" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "keywords" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    return isInstance;
+}
+exports.instanceOfShare = instanceOfShare;
+function ShareFromJSON(json) {
+    return ShareFromJSONTyped(json, false);
+}
+exports.ShareFromJSON = ShareFromJSON;
+function ShareFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'originatingProjectId': json['originatingProjectId'],
+        'shareType': (0, ShareType_1.ShareTypeFromJSON)(json['shareType']),
+        'conditions': (json['conditions'].map(DatasetCondition_1.DatasetConditionFromJSON)),
+        'classificationIds': json['classificationIds'],
+        'keywords': json['keywords'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+exports.ShareFromJSONTyped = ShareFromJSONTyped;
+function ShareToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'originatingProjectId': value.originatingProjectId,
+        'shareType': (0, ShareType_1.ShareTypeToJSON)(value.shareType),
+        'conditions': (value.conditions.map(DatasetCondition_1.DatasetConditionToJSON)),
+        'classificationIds': value.classificationIds,
+        'keywords': value.keywords,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+exports.ShareToJSON = ShareToJSON;

package/dist/models/ShareDetail.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { DatasetCondition } from './DatasetCondition';
+import type { NamedItem } from './NamedItem';
+import type { ShareType } from './ShareType';
+/**
+ *
+ * @export
+ * @interface ShareDetail
+ */
+export interface ShareDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof ShareDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareDetail
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareDetail
+     */
+    description: string;
+    /**
+     *
+     * @type {NamedItem}
+     * @memberof ShareDetail
+     */
+    originatingProject: NamedItem;
+    /**
+     *
+     * @type {ShareType}
+     * @memberof ShareDetail
+     */
+    shareType: ShareType;
+    /**
+     *
+     * @type {Array<NamedItem>}
+     * @memberof ShareDetail
+     */
+    sharedProjects: Array<NamedItem>;
+    /**
+     * The conditions under which the dataset is shared
+     * @type {Array<DatasetCondition>}
+     * @memberof ShareDetail
+     */
+    conditions: Array<DatasetCondition>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ShareDetail
+     */
+    keywords: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ShareDetail
+     */
+    classificationIds: Array<string>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ShareDetail
+     */
+    isSubscribed: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ShareDetail
+     */
+    isViewRestricted: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareDetail
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ShareDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof ShareDetail
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the ShareDetail interface.
+ */
+export declare function instanceOfShareDetail(value: object): boolean;
+export declare function ShareDetailFromJSON(json: any): ShareDetail;
+export declare function ShareDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareDetail;
+export declare function ShareDetailToJSON(value?: ShareDetail | null): any;

package/dist/models/ShareDetail.js

@@ -0,0 +1,92 @@
+"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.ShareDetailToJSON = exports.ShareDetailFromJSONTyped = exports.ShareDetailFromJSON = exports.instanceOfShareDetail = void 0;
+const DatasetCondition_1 = require("./DatasetCondition");
+const NamedItem_1 = require("./NamedItem");
+const ShareType_1 = require("./ShareType");
+/**
+ * Check if a given object implements the ShareDetail interface.
+ */
+function instanceOfShareDetail(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "originatingProject" in value;
+    isInstance = isInstance && "shareType" in value;
+    isInstance = isInstance && "sharedProjects" in value;
+    isInstance = isInstance && "conditions" in value;
+    isInstance = isInstance && "keywords" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "isSubscribed" in value;
+    isInstance = isInstance && "isViewRestricted" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    return isInstance;
+}
+exports.instanceOfShareDetail = instanceOfShareDetail;
+function ShareDetailFromJSON(json) {
+    return ShareDetailFromJSONTyped(json, false);
+}
+exports.ShareDetailFromJSON = ShareDetailFromJSON;
+function ShareDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'originatingProject': (0, NamedItem_1.NamedItemFromJSON)(json['originatingProject']),
+        'shareType': (0, ShareType_1.ShareTypeFromJSON)(json['shareType']),
+        'sharedProjects': (json['sharedProjects'].map(NamedItem_1.NamedItemFromJSON)),
+        'conditions': (json['conditions'].map(DatasetCondition_1.DatasetConditionFromJSON)),
+        'keywords': json['keywords'],
+        'classificationIds': json['classificationIds'],
+        'isSubscribed': json['isSubscribed'],
+        'isViewRestricted': json['isViewRestricted'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+exports.ShareDetailFromJSONTyped = ShareDetailFromJSONTyped;
+function ShareDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'originatingProject': (0, NamedItem_1.NamedItemToJSON)(value.originatingProject),
+        'shareType': (0, ShareType_1.ShareTypeToJSON)(value.shareType),
+        'sharedProjects': (value.sharedProjects.map(NamedItem_1.NamedItemToJSON)),
+        'conditions': (value.conditions.map(DatasetCondition_1.DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'classificationIds': value.classificationIds,
+        'isSubscribed': value.isSubscribed,
+        'isViewRestricted': value.isViewRestricted,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+exports.ShareDetailToJSON = ShareDetailToJSON;

package/dist/models/ShareInput.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { DatasetCondition } from './DatasetCondition';
+/**
+ *
+ * @export
+ * @interface ShareInput
+ */
+export interface ShareInput {
+    /**
+     *
+     * @type {string}
+     * @memberof ShareInput
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareInput
+     */
+    description: string;
+    /**
+     * Data classification IDs for the share
+     * @type {Array<string>}
+     * @memberof ShareInput
+     */
+    classificationIds: Array<string>;
+    /**
+     * The conditions under which the dataset is shared
+     * @type {Array<DatasetCondition>}
+     * @memberof ShareInput
+     */
+    conditions: Array<DatasetCondition>;
+    /**
+     * Search keywords for the share
+     * @type {Array<string>}
+     * @memberof ShareInput
+     */
+    keywords?: Array<string>;
+    /**
+     * The project IDs that can access this share
+     * @type {Array<string>}
+     * @memberof ShareInput
+     */
+    sharedProjectIds?: Array<string>;
+    /**
+     * Whether files within the share are restricted from viewing or downloading
+     * @type {boolean}
+     * @memberof ShareInput
+     */
+    isViewRestricted?: boolean;
+}
+/**
+ * Check if a given object implements the ShareInput interface.
+ */
+export declare function instanceOfShareInput(value: object): boolean;
+export declare function ShareInputFromJSON(json: any): ShareInput;
+export declare function ShareInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareInput;
+export declare function ShareInputToJSON(value?: ShareInput | null): any;

package/dist/models/ShareInput.js

@@ -0,0 +1,67 @@
+"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.ShareInputToJSON = exports.ShareInputFromJSONTyped = exports.ShareInputFromJSON = exports.instanceOfShareInput = void 0;
+const runtime_1 = require("../runtime");
+const DatasetCondition_1 = require("./DatasetCondition");
+/**
+ * Check if a given object implements the ShareInput interface.
+ */
+function instanceOfShareInput(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "conditions" in value;
+    return isInstance;
+}
+exports.instanceOfShareInput = instanceOfShareInput;
+function ShareInputFromJSON(json) {
+    return ShareInputFromJSONTyped(json, false);
+}
+exports.ShareInputFromJSON = ShareInputFromJSON;
+function ShareInputFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'],
+        'classificationIds': json['classificationIds'],
+        'conditions': (json['conditions'].map(DatasetCondition_1.DatasetConditionFromJSON)),
+        'keywords': !(0, runtime_1.exists)(json, 'keywords') ? undefined : json['keywords'],
+        'sharedProjectIds': !(0, runtime_1.exists)(json, 'sharedProjectIds') ? undefined : json['sharedProjectIds'],
+        'isViewRestricted': !(0, runtime_1.exists)(json, 'isViewRestricted') ? undefined : json['isViewRestricted'],
+    };
+}
+exports.ShareInputFromJSONTyped = ShareInputFromJSONTyped;
+function ShareInputToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'classificationIds': value.classificationIds,
+        'conditions': (value.conditions.map(DatasetCondition_1.DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'sharedProjectIds': value.sharedProjectIds,
+        'isViewRestricted': value.isViewRestricted,
+    };
+}
+exports.ShareInputToJSON = ShareInputToJSON;

package/dist/models/ShareType.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ShareType {
+    Publisher = "PUBLISHER",
+    Subscriber = "SUBSCRIBER",
+    Available = "AVAILABLE"
+}
+export declare function ShareTypeFromJSON(json: any): ShareType;
+export declare function ShareTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareType;
+export declare function ShareTypeToJSON(value?: ShareType | null): any;

package/dist/models/ShareType.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.ShareTypeToJSON = exports.ShareTypeFromJSONTyped = exports.ShareTypeFromJSON = exports.ShareType = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var ShareType;
+(function (ShareType) {
+    ShareType["Publisher"] = "PUBLISHER";
+    ShareType["Subscriber"] = "SUBSCRIBER";
+    ShareType["Available"] = "AVAILABLE";
+})(ShareType = exports.ShareType || (exports.ShareType = {}));
+function ShareTypeFromJSON(json) {
+    return ShareTypeFromJSONTyped(json, false);
+}
+exports.ShareTypeFromJSON = ShareTypeFromJSON;
+function ShareTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.ShareTypeFromJSONTyped = ShareTypeFromJSONTyped;
+function ShareTypeToJSON(value) {
+    return value;
+}
+exports.ShareTypeToJSON = ShareTypeToJSON;

package/dist/models/Status.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum Status {
+    Completed = "COMPLETED",
+    Pending = "PENDING",
+    Running = "RUNNING",
+    Archived = "ARCHIVED",
+    Deleted = "DELETED",
+    Deleting = "DELETING",
+    Suspended = "SUSPENDED",
+    Delete = "DELETE",
+    Failed = "FAILED",
+    Unknown = "UNKNOWN"
+}
+export declare function StatusFromJSON(json: any): Status;
+export declare function StatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): Status;
+export declare function StatusToJSON(value?: Status | null): any;

package/dist/models/Status.js

@@ -0,0 +1,46 @@
+"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.StatusToJSON = exports.StatusFromJSONTyped = exports.StatusFromJSON = exports.Status = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var Status;
+(function (Status) {
+    Status["Completed"] = "COMPLETED";
+    Status["Pending"] = "PENDING";
+    Status["Running"] = "RUNNING";
+    Status["Archived"] = "ARCHIVED";
+    Status["Deleted"] = "DELETED";
+    Status["Deleting"] = "DELETING";
+    Status["Suspended"] = "SUSPENDED";
+    Status["Delete"] = "DELETE";
+    Status["Failed"] = "FAILED";
+    Status["Unknown"] = "UNKNOWN";
+})(Status = exports.Status || (exports.Status = {}));
+function StatusFromJSON(json) {
+    return StatusFromJSONTyped(json, false);
+}
+exports.StatusFromJSON = StatusFromJSON;
+function StatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.StatusFromJSONTyped = StatusFromJSONTyped;
+function StatusToJSON(value) {
+    return value;
+}
+exports.StatusToJSON = StatusToJSON;

package/dist/models/StopExecutionResponse.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 StopExecutionResponse
+ */
+export interface StopExecutionResponse {
+    /**
+     * List of job IDs that were successful in termination
+     * @type {Array<string>}
+     * @memberof StopExecutionResponse
+     */
+    success?: Array<string>;
+    /**
+     * List of job IDs that were not successful in termination
+     * @type {Array<string>}
+     * @memberof StopExecutionResponse
+     */
+    failed?: Array<string>;
+}
+/**
+ * Check if a given object implements the StopExecutionResponse interface.
+ */
+export declare function instanceOfStopExecutionResponse(value: object): boolean;
+export declare function StopExecutionResponseFromJSON(json: any): StopExecutionResponse;
+export declare function StopExecutionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StopExecutionResponse;
+export declare function StopExecutionResponseToJSON(value?: StopExecutionResponse | null): any;

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

package/dist/models/SyncStatus.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Status of the last sync operation
+ * @export
+ * @enum {string}
+ */
+export declare enum SyncStatus {
+    Successful = "SUCCESSFUL",
+    Failed = "FAILED"
+}
+export declare function SyncStatusFromJSON(json: any): SyncStatus;
+export declare function SyncStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncStatus;
+export declare function SyncStatusToJSON(value?: SyncStatus | null): any;