@cirrobio/api-client 0.1.30 → 0.2.1

package/src/models/RequirementInput.ts

@@ -0,0 +1,182 @@
+/* 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, mapValues } from '../runtime';
+import type { GovernanceExpiry } from './GovernanceExpiry';
+import {
+    GovernanceExpiryFromJSON,
+    GovernanceExpiryFromJSONTyped,
+    GovernanceExpiryToJSON,
+} from './GovernanceExpiry';
+import type { GovernanceFile } from './GovernanceFile';
+import {
+    GovernanceFileFromJSON,
+    GovernanceFileFromJSONTyped,
+    GovernanceFileToJSON,
+} from './GovernanceFile';
+import type { GovernanceScope } from './GovernanceScope';
+import {
+    GovernanceScopeFromJSON,
+    GovernanceScopeFromJSONTyped,
+    GovernanceScopeToJSON,
+} from './GovernanceScope';
+import type { GovernanceTrainingVerification } from './GovernanceTrainingVerification';
+import {
+    GovernanceTrainingVerificationFromJSON,
+    GovernanceTrainingVerificationFromJSONTyped,
+    GovernanceTrainingVerificationToJSON,
+} from './GovernanceTrainingVerification';
+import type { GovernanceType } from './GovernanceType';
+import {
+    GovernanceTypeFromJSON,
+    GovernanceTypeFromJSONTyped,
+    GovernanceTypeToJSON,
+} 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 {GovernanceScope}
+     * @memberof RequirementInput
+     */
+    acceptance: GovernanceScope;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RequirementInput
+     */
+    contactIds?: Array<string> | null;
+    /**
+     * 
+     * @type {GovernanceExpiry}
+     * @memberof RequirementInput
+     */
+    expiration: GovernanceExpiry;
+    /**
+     * 
+     * @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
+     */
+    verification?: GovernanceTrainingVerification | null;
+}
+
+/**
+ * Check if a given object implements the RequirementInput interface.
+ */
+export function instanceOfRequirementInput(value: object): boolean {
+    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 && "acceptance" in value;
+    isInstance = isInstance && "expiration" in value;
+
+    return isInstance;
+}
+
+export function RequirementInputFromJSON(json: any): RequirementInput {
+    return RequirementInputFromJSONTyped(json, false);
+}
+
+export function RequirementInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+        'type': GovernanceTypeFromJSON(json['type']),
+        'scope': GovernanceScopeFromJSON(json['scope']),
+        'acceptance': GovernanceScopeFromJSON(json['acceptance']),
+        'contactIds': !exists(json, 'contactIds') ? undefined : json['contactIds'],
+        'expiration': GovernanceExpiryFromJSON(json['expiration']),
+        'supplementalDocs': !exists(json, 'supplementalDocs') ? undefined : (json['supplementalDocs'] === null ? null : (json['supplementalDocs'] as Array<any>).map(GovernanceFileFromJSON)),
+        'file': !exists(json, 'file') ? undefined : GovernanceFileFromJSON(json['file']),
+        'authorship': !exists(json, 'authorship') ? undefined : GovernanceScopeFromJSON(json['authorship']),
+        'verification': !exists(json, 'verification') ? undefined : GovernanceTrainingVerificationFromJSON(json['verification']),
+    };
+}
+
+export function RequirementInputToJSON(value?: RequirementInput | null): any {
+    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),
+        'acceptance': GovernanceScopeToJSON(value.acceptance),
+        'contactIds': value.contactIds,
+        'expiration': GovernanceExpiryToJSON(value.expiration),
+        'supplementalDocs': value.supplementalDocs === undefined ? undefined : (value.supplementalDocs === null ? null : (value.supplementalDocs as Array<any>).map(GovernanceFileToJSON)),
+        'file': GovernanceFileToJSON(value.file),
+        'authorship': GovernanceScopeToJSON(value.authorship),
+        'verification': GovernanceTrainingVerificationToJSON(value.verification),
+    };
+}
+

package/src/models/Share.ts

@@ -0,0 +1,154 @@
+/* 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, mapValues } from '../runtime';
+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<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;
+}
+
+/**
+ * Check if a given object implements the Share interface.
+ */
+export function instanceOfShare(value: object): boolean {
+    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 && "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;
+}
+
+export function ShareFromJSON(json: any): Share {
+    return ShareFromJSONTyped(json, false);
+}
+
+export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'originatingProjectId': json['originatingProjectId'],
+        'shareType': ShareTypeFromJSON(json['shareType']),
+        'classificationIds': json['classificationIds'],
+        'keywords': json['keywords'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function ShareToJSON(value?: Share | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'originatingProjectId': value.originatingProjectId,
+        'shareType': ShareTypeToJSON(value.shareType),
+        'classificationIds': value.classificationIds,
+        'keywords': value.keywords,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/ShareDetail.ts

@@ -0,0 +1,193 @@
+/* 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, mapValues } from '../runtime';
+import type { DatasetCondition } from './DatasetCondition';
+import {
+    DatasetConditionFromJSON,
+    DatasetConditionFromJSONTyped,
+    DatasetConditionToJSON,
+} from './DatasetCondition';
+import type { NamedItem } from './NamedItem';
+import {
+    NamedItemFromJSON,
+    NamedItemFromJSONTyped,
+    NamedItemToJSON,
+} from './NamedItem';
+import type { ShareType } from './ShareType';
+import {
+    ShareTypeFromJSON,
+    ShareTypeFromJSONTyped,
+    ShareTypeToJSON,
+} 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 {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 function instanceOfShareDetail(value: object): boolean {
+    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 && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function ShareDetailFromJSON(json: any): ShareDetail {
+    return ShareDetailFromJSONTyped(json, false);
+}
+
+export function ShareDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareDetail {
+    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'] as Array<any>).map(NamedItemFromJSON)),
+        'conditions': ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
+        'keywords': json['keywords'],
+        'classificationIds': json['classificationIds'],
+        'isSubscribed': json['isSubscribed'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function ShareDetailToJSON(value?: ShareDetail | null): any {
+    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 as Array<any>).map(NamedItemToJSON)),
+        'conditions': ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'classificationIds': value.classificationIds,
+        'isSubscribed': value.isSubscribed,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/ShareInput.ts

@@ -0,0 +1,116 @@
+/* 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, mapValues } from '../runtime';
+import type { DatasetCondition } from './DatasetCondition';
+import {
+    DatasetConditionFromJSON,
+    DatasetConditionFromJSONTyped,
+    DatasetConditionToJSON,
+} 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>;
+}
+
+/**
+ * Check if a given object implements the ShareInput interface.
+ */
+export function instanceOfShareInput(value: object): boolean {
+    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: any): ShareInput {
+    return ShareInputFromJSONTyped(json, false);
+}
+
+export function ShareInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+        'classificationIds': json['classificationIds'],
+        'conditions': ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
+        'keywords': !exists(json, 'keywords') ? undefined : json['keywords'],
+        'sharedProjectIds': !exists(json, 'sharedProjectIds') ? undefined : json['sharedProjectIds'],
+    };
+}
+
+export function ShareInputToJSON(value?: ShareInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'description': value.description,
+        'classificationIds': value.classificationIds,
+        'conditions': ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
+        'keywords': value.keywords,
+        'sharedProjectIds': value.sharedProjectIds,
+    };
+}
+

package/src/models/ShareType.ts

@@ -0,0 +1,38 @@
+/* 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 enum ShareType {
+    Publisher = 'PUBLISHER',
+    Subscriber = 'SUBSCRIBER',
+    Available = 'AVAILABLE'
+}
+
+
+export function ShareTypeFromJSON(json: any): ShareType {
+    return ShareTypeFromJSONTyped(json, false);
+}
+
+export function ShareTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareType {
+    return json as ShareType;
+}
+
+export function ShareTypeToJSON(value?: ShareType | null): any {
+    return value as any;
+}
+