@cirrobio/api-client 0.2.0 → 0.2.2

package/src/models/GovernanceRequirement.ts

@@ -0,0 +1,235 @@
+/* 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 GovernanceRequirement
+ */
+export interface GovernanceRequirement {
+    /**
+     * The unique identifier for the requirement
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    id: string;
+    /**
+     *  The name of the requirement
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    name: string;
+    /**
+     * A brief description of the requirement
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    description: string;
+    /**
+     * 
+     * @type {GovernanceType}
+     * @memberof GovernanceRequirement
+     */
+    type: GovernanceType;
+    /**
+     * S3 prefix where files for the requirement are saved
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    path: string;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof GovernanceRequirement
+     */
+    scope: GovernanceScope;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof GovernanceRequirement
+     */
+    acceptance?: GovernanceScope | null;
+    /**
+     * The IDs of governance contacts assigned to the requirement.
+     * @type {Array<string>}
+     * @memberof GovernanceRequirement
+     */
+    contactIds: Array<string>;
+    /**
+     * 
+     * @type {GovernanceExpiry}
+     * @memberof GovernanceRequirement
+     */
+    expiration: GovernanceExpiry;
+    /**
+     * The date of enactment for a requirement
+     * @type {Date}
+     * @memberof GovernanceRequirement
+     */
+    enactmentDate?: Date | null;
+    /**
+     * Optional files with extra information, e.g. templates for documents, links, etc
+     * @type {Array<GovernanceFile>}
+     * @memberof GovernanceRequirement
+     */
+    supplementalDocs?: Array<GovernanceFile> | null;
+    /**
+     * 
+     * @type {GovernanceFile}
+     * @memberof GovernanceRequirement
+     */
+    file?: GovernanceFile | null;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof GovernanceRequirement
+     */
+    authorship?: GovernanceScope | null;
+    /**
+     * 
+     * @type {GovernanceTrainingVerification}
+     * @memberof GovernanceRequirement
+     */
+    verification?: GovernanceTrainingVerification | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    createdBy: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GovernanceRequirement
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GovernanceRequirement
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the GovernanceRequirement interface.
+ */
+export function instanceOfGovernanceRequirement(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "path" in value;
+    isInstance = isInstance && "scope" in value;
+    isInstance = isInstance && "contactIds" in value;
+    isInstance = isInstance && "expiration" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function GovernanceRequirementFromJSON(json: any): GovernanceRequirement {
+    return GovernanceRequirementFromJSONTyped(json, false);
+}
+
+export function GovernanceRequirementFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceRequirement {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'type': GovernanceTypeFromJSON(json['type']),
+        'path': json['path'],
+        'scope': GovernanceScopeFromJSON(json['scope']),
+        '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'] 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']),
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function GovernanceRequirementToJSON(value?: GovernanceRequirement | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'type': GovernanceTypeToJSON(value.type),
+        'path': value.path,
+        'scope': GovernanceScopeToJSON(value.scope),
+        '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 as Array<any>).map(GovernanceFileToJSON)),
+        'file': GovernanceFileToJSON(value.file),
+        'authorship': GovernanceScopeToJSON(value.authorship),
+        'verification': GovernanceTrainingVerificationToJSON(value.verification),
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/GovernanceRequirementFile.ts

@@ -0,0 +1,96 @@
+/* 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 { GovernanceFileType } from './GovernanceFileType';
+import {
+    GovernanceFileTypeFromJSON,
+    GovernanceFileTypeFromJSONTyped,
+    GovernanceFileTypeToJSON,
+} from './GovernanceFileType';
+
+/**
+ * The document uploaded for the requirement: only if agreement or document object has a matching scope and authorship
+ * @export
+ * @interface GovernanceRequirementFile
+ */
+export interface GovernanceRequirementFile {
+    /**
+     * The title of the resource visible to users
+     * @type {string}
+     * @memberof GovernanceRequirementFile
+     */
+    name?: string;
+    /**
+     * A description of the resource visible to users
+     * @type {string}
+     * @memberof GovernanceRequirementFile
+     */
+    description?: string;
+    /**
+     * The file name without path or the full link path
+     * @type {string}
+     * @memberof GovernanceRequirementFile
+     */
+    src?: string;
+    /**
+     * 
+     * @type {GovernanceFileType}
+     * @memberof GovernanceRequirementFile
+     */
+    type?: GovernanceFileType;
+}
+
+/**
+ * Check if a given object implements the GovernanceRequirementFile interface.
+ */
+export function instanceOfGovernanceRequirementFile(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function GovernanceRequirementFileFromJSON(json: any): GovernanceRequirementFile {
+    return GovernanceRequirementFileFromJSONTyped(json, false);
+}
+
+export function GovernanceRequirementFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceRequirementFile {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'src': !exists(json, 'src') ? undefined : json['src'],
+        'type': !exists(json, 'type') ? undefined : GovernanceFileTypeFromJSON(json['type']),
+    };
+}
+
+export function GovernanceRequirementFileToJSON(value?: GovernanceRequirementFile | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'description': value.description,
+        'src': value.src,
+        'type': GovernanceFileTypeToJSON(value.type),
+    };
+}
+

package/src/models/GovernanceScope.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+/**
+ * The levels at which governance requirements can be enforced
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceScope {
+    Tenant = 'TENANT',
+    Project = 'PROJECT'
+}
+
+
+export function GovernanceScopeFromJSON(json: any): GovernanceScope {
+    return GovernanceScopeFromJSONTyped(json, false);
+}
+
+export function GovernanceScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceScope {
+    return json as GovernanceScope;
+}
+
+export function GovernanceScopeToJSON(value?: GovernanceScope | null): any {
+    return value as any;
+}
+

package/src/models/GovernanceTrainingVerification.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+/**
+ * The ways in which the completion of training can be verified.
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceTrainingVerification {
+    Self = 'SELF',
+    Certificate = 'CERTIFICATE'
+}
+
+
+export function GovernanceTrainingVerificationFromJSON(json: any): GovernanceTrainingVerification {
+    return GovernanceTrainingVerificationFromJSONTyped(json, false);
+}
+
+export function GovernanceTrainingVerificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceTrainingVerification {
+    return json as GovernanceTrainingVerification;
+}
+
+export function GovernanceTrainingVerificationToJSON(value?: GovernanceTrainingVerification | null): any {
+    return value as any;
+}
+

package/src/models/GovernanceType.ts

@@ -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.
+ */
+
+/**
+ * The types of governance requirements that can be enforced
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceType {
+    Document = 'DOCUMENT',
+    Agreement = 'AGREEMENT',
+    Training = 'TRAINING',
+    Contact = 'CONTACT',
+    Classification = 'CLASSIFICATION'
+}
+
+
+export function GovernanceTypeFromJSON(json: any): GovernanceType {
+    return GovernanceTypeFromJSONTyped(json, false);
+}
+
+export function GovernanceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceType {
+    return json as GovernanceType;
+}
+
+export function GovernanceTypeToJSON(value?: GovernanceType | null): any {
+    return value as any;
+}
+

package/src/models/RequirementInput.ts

@@ -0,0 +1,190 @@
+/* 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 | 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
+     */
+    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 && "contactIds" 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': !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'] 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),
+        'enactmentDate': value.enactmentDate === undefined ? undefined : (value.enactmentDate === null ? null : value.enactmentDate.toISOString()),
+        '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

@@ -13,6 +13,12 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { DatasetCondition } from './DatasetCondition';
+import {
+    DatasetConditionFromJSON,
+    DatasetConditionFromJSONTyped,
+    DatasetConditionToJSON,
+} from './DatasetCondition';
 import type { ShareType } from './ShareType';
 import {
     ShareTypeFromJSON,
@@ -56,6 +62,12 @@ export interface Share {
      * @memberof Share
      */
     shareType: ShareType;
+    /**
+     * 
+     * @type {Array<DatasetCondition>}
+     * @memberof Share
+     */
+    conditions: Array<DatasetCondition>;
     /**
      * 
      * @type {Array<string>}
@@ -98,6 +110,7 @@ export function instanceOfShare(value: object): boolean {
     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;
@@ -122,6 +135,7 @@ export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sha
         'description': json['description'],
         'originatingProjectId': json['originatingProjectId'],
         'shareType': ShareTypeFromJSON(json['shareType']),
+        'conditions': ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
         'classificationIds': json['classificationIds'],
         'keywords': json['keywords'],
         'createdBy': json['createdBy'],
@@ -144,6 +158,7 @@ export function ShareToJSON(value?: Share | null): any {
         'description': value.description,
         'originatingProjectId': value.originatingProjectId,
         'shareType': ShareTypeToJSON(value.shareType),
+        'conditions': ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
         'classificationIds': value.classificationIds,
         'keywords': value.keywords,
         'createdBy': value.createdBy,