@cirrobio/api-client 0.4.3 → 0.9.1

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

@@ -11,99 +11,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-import { exists, mapValues } from '../runtime';
-import type { DatasetCondition } from './DatasetCondition';
-import {
-    DatasetConditionFromJSON,
-    DatasetConditionFromJSONTyped,
-    DatasetConditionToJSON,
-} from './DatasetCondition';
-import type { ShareType } from './ShareType';
-import {
-    ShareTypeFromJSON,
-    ShareTypeFromJSONTyped,
-    ShareTypeToJSON,
-} from './ShareType';
-
-/**
- * 
- * @export
- * @interface Share
- */
-export interface Share {
-    /**
-     * 
-     * @type {string}
-     * @memberof Share
-     */
-    id: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof Share
-     */
-    name: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof Share
-     */
-    description: string;
-    /**
-     * The ID of the project that owns the share
-     * @type {string}
-     * @memberof Share
-     */
-    originatingProjectId: string;
-    /**
-     * 
-     * @type {ShareType}
-     * @memberof Share
-     */
-    shareType: ShareType;
-    /**
-     * 
-     * @type {Array<DatasetCondition>}
-     * @memberof Share
-     */
-    conditions: Array<DatasetCondition>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof Share
-     */
-    classificationIds: Array<string>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof Share
-     */
-    keywords: Array<string>;
-    /**
-     * 
-     * @type {string}
-     * @memberof Share
-     */
-    createdBy: string;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Share
-     */
-    createdAt: Date;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Share
-     */
-    updatedAt: Date;
-}
-
+import { DatasetConditionFromJSON, DatasetConditionToJSON, } from './DatasetCondition';
+import { ShareTypeFromJSON, ShareTypeToJSON, } from './ShareType';
 /**
  * Check if a given object implements the Share interface.
  */
-export function instanceOfShare(value: object): boolean {
+export function instanceOfShare(value) {
     let isInstance = true;
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
@@ -116,26 +29,22 @@ export function instanceOfShare(value: object): boolean {
     isInstance = isInstance && "createdBy" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
-
     return isInstance;
 }
-
-export function ShareFromJSON(json: any): Share {
+export function ShareFromJSON(json) {
     return ShareFromJSONTyped(json, false);
 }
-
-export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share {
+export 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': ShareTypeFromJSON(json['shareType']),
-        'conditions': ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
+        'conditions': (json['conditions'].map(DatasetConditionFromJSON)),
         'classificationIds': json['classificationIds'],
         'keywords': json['keywords'],
         'createdBy': json['createdBy'],
@@ -143,8 +52,7 @@ export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sha
         'updatedAt': (new Date(json['updatedAt'])),
     };
 }
-
-export function ShareToJSON(value?: Share | null): any {
+export function ShareToJSON(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -152,13 +60,12 @@ export function ShareToJSON(value?: Share | null): any {
         return null;
     }
     return {
-        
         'id': value.id,
         'name': value.name,
         'description': value.description,
         'originatingProjectId': value.originatingProjectId,
         'shareType': ShareTypeToJSON(value.shareType),
-        'conditions': ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
+        'conditions': (value.conditions.map(DatasetConditionToJSON)),
         'classificationIds': value.classificationIds,
         'keywords': value.keywords,
         'createdBy': value.createdBy,
@@ -166,4 +73,3 @@ export function ShareToJSON(value?: Share | null): any {
         'updatedAt': (value.updatedAt.toISOString()),
     };
 }
-

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

@@ -0,0 +1,85 @@
+/* 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 { DatasetConditionFromJSON, DatasetConditionToJSON, } from './DatasetCondition';
+import { NamedItemFromJSON, NamedItemToJSON, } from './NamedItem';
+import { ShareTypeFromJSON, ShareTypeToJSON, } from './ShareType';
+/**
+ * Check if a given object implements the ShareDetail interface.
+ */
+export 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;
+}
+export function ShareDetailFromJSON(json) {
+    return ShareDetailFromJSONTyped(json, false);
+}
+export function ShareDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'originatingProject': NamedItemFromJSON(json['originatingProject']),
+        'shareType': ShareTypeFromJSON(json['shareType']),
+        'sharedProjects': (json['sharedProjects'].map(NamedItemFromJSON)),
+        'conditions': (json['conditions'].map(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'])),
+    };
+}
+export function ShareDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'originatingProject': NamedItemToJSON(value.originatingProject),
+        'shareType': ShareTypeToJSON(value.shareType),
+        'sharedProjects': (value.sharedProjects.map(NamedItemToJSON)),
+        'conditions': (value.conditions.map(DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'classificationIds': value.classificationIds,
+        'isSubscribed': value.isSubscribed,
+        'isViewRestricted': value.isViewRestricted,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}

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

@@ -0,0 +1,60 @@
+/* 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 { DatasetConditionFromJSON, DatasetConditionToJSON, } from './DatasetCondition';
+/**
+ * Check if a given object implements the ShareInput interface.
+ */
+export 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;
+}
+export function ShareInputFromJSON(json) {
+    return ShareInputFromJSONTyped(json, false);
+}
+export 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(DatasetConditionFromJSON)),
+        'keywords': !exists(json, 'keywords') ? undefined : json['keywords'],
+        'sharedProjectIds': !exists(json, 'sharedProjectIds') ? undefined : json['sharedProjectIds'],
+        'isViewRestricted': !exists(json, 'isViewRestricted') ? undefined : json['isViewRestricted'],
+    };
+}
+export 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(DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'sharedProjectIds': value.sharedProjectIds,
+        'isViewRestricted': value.isViewRestricted,
+    };
+}

package/dist/esm/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/{src/models/ShareType.ts → dist/esm/models/ShareType.js}

@@ -11,28 +11,23 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
 /**
- * 
+ *
  * @export
  * @enum {string}
  */
-export enum ShareType {
-    Publisher = 'PUBLISHER',
-    Subscriber = 'SUBSCRIBER',
-    Available = 'AVAILABLE'
-}
-
-
-export function ShareTypeFromJSON(json: any): ShareType {
+export var ShareType;
+(function (ShareType) {
+    ShareType["Publisher"] = "PUBLISHER";
+    ShareType["Subscriber"] = "SUBSCRIBER";
+    ShareType["Available"] = "AVAILABLE";
+})(ShareType || (ShareType = {}));
+export function ShareTypeFromJSON(json) {
     return ShareTypeFromJSONTyped(json, false);
 }
-
-export function ShareTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareType {
-    return json as ShareType;
+export function ShareTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
 }
-
-export function ShareTypeToJSON(value?: ShareType | null): any {
-    return value as any;
+export function ShareTypeToJSON(value) {
+    return value;
 }
-

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

@@ -0,0 +1,40 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export 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 || (Status = {}));
+export function StatusFromJSON(json) {
+    return StatusFromJSONTyped(json, false);
+}
+export function StatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function StatusToJSON(value) {
+    return value;
+}

package/dist/esm/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;