@cirrobio/api-client 0.2.0 → 0.2.1

package/src/models/ContactInput.ts

@@ -0,0 +1,102 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface ContactInput
+ */
+export interface ContactInput {
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInput
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInput
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInput
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInput
+     */
+    phone: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContactInput
+     */
+    email: string;
+}
+
+/**
+ * Check if a given object implements the ContactInput interface.
+ */
+export function instanceOfContactInput(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "title" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "phone" in value;
+    isInstance = isInstance && "email" in value;
+
+    return isInstance;
+}
+
+export function ContactInputFromJSON(json: any): ContactInput {
+    return ContactInputFromJSONTyped(json, false);
+}
+
+export function ContactInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'title': json['title'],
+        'description': json['description'],
+        'name': json['name'],
+        'phone': json['phone'],
+        'email': json['email'],
+    };
+}
+
+export function ContactInputToJSON(value?: ContactInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'title': value.title,
+        'description': value.description,
+        'name': value.name,
+        'phone': value.phone,
+        'email': value.email,
+    };
+}
+

package/src/models/GovernanceClassification.ts

@@ -37,6 +37,12 @@ export interface GovernanceClassification {
      * @memberof GovernanceClassification
      */
     description: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof GovernanceClassification
+     */
+    requirementIds: Array<string>;
     /**
      * 
      * @type {string}
@@ -65,6 +71,7 @@ export function instanceOfGovernanceClassification(value: object): boolean {
     isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "requirementIds" in value;
     isInstance = isInstance && "createdBy" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
@@ -85,6 +92,7 @@ export function GovernanceClassificationFromJSONTyped(json: any, ignoreDiscrimin
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
+        'requirementIds': json['requirementIds'],
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
@@ -103,6 +111,7 @@ export function GovernanceClassificationToJSON(value?: GovernanceClassification
         'id': value.id,
         'name': value.name,
         'description': value.description,
+        'requirementIds': value.requirementIds,
         'createdBy': value.createdBy,
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),

package/src/models/GovernanceContact.ts

@@ -0,0 +1,111 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface GovernanceContact
+ */
+export interface GovernanceContact {
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    phone: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceContact
+     */
+    email: string;
+}
+
+/**
+ * Check if a given object implements the GovernanceContact interface.
+ */
+export function instanceOfGovernanceContact(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "title" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "phone" in value;
+    isInstance = isInstance && "email" in value;
+
+    return isInstance;
+}
+
+export function GovernanceContactFromJSON(json: any): GovernanceContact {
+    return GovernanceContactFromJSONTyped(json, false);
+}
+
+export function GovernanceContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceContact {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'title': json['title'],
+        'description': json['description'],
+        'name': json['name'],
+        'phone': json['phone'],
+        'email': json['email'],
+    };
+}
+
+export function GovernanceContactToJSON(value?: GovernanceContact | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'title': value.title,
+        'description': value.description,
+        'name': value.name,
+        'phone': value.phone,
+        'email': value.email,
+    };
+}
+

package/src/models/GovernanceExpiry.ts

@@ -0,0 +1,88 @@
+/* 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 { GovernanceExpiryType } from './GovernanceExpiryType';
+import {
+    GovernanceExpiryTypeFromJSON,
+    GovernanceExpiryTypeFromJSONTyped,
+    GovernanceExpiryTypeToJSON,
+} from './GovernanceExpiryType';
+
+/**
+ * 
+ * @export
+ * @interface GovernanceExpiry
+ */
+export interface GovernanceExpiry {
+    /**
+     * 
+     * @type {GovernanceExpiryType}
+     * @memberof GovernanceExpiry
+     */
+    type?: GovernanceExpiryType;
+    /**
+     * The number of days for a relative expiration
+     * @type {number}
+     * @memberof GovernanceExpiry
+     */
+    days?: number | null;
+    /**
+     * The date for an absolute expiration
+     * @type {Date}
+     * @memberof GovernanceExpiry
+     */
+    date?: Date | null;
+}
+
+/**
+ * Check if a given object implements the GovernanceExpiry interface.
+ */
+export function instanceOfGovernanceExpiry(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function GovernanceExpiryFromJSON(json: any): GovernanceExpiry {
+    return GovernanceExpiryFromJSONTyped(json, false);
+}
+
+export function GovernanceExpiryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceExpiry {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'type': !exists(json, 'type') ? undefined : GovernanceExpiryTypeFromJSON(json['type']),
+        'days': !exists(json, 'days') ? undefined : json['days'],
+        'date': !exists(json, 'date') ? undefined : (json['date'] === null ? null : new Date(json['date'])),
+    };
+}
+
+export function GovernanceExpiryToJSON(value?: GovernanceExpiry | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'type': GovernanceExpiryTypeToJSON(value.type),
+        'days': value.days,
+        'date': value.date === undefined ? undefined : (value.date === null ? null : value.date.toISOString()),
+    };
+}
+

package/src/models/GovernanceExpiryType.ts

@@ -0,0 +1,39 @@
+/* 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 expiry conditions that can be applied to governance requirements.
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceExpiryType {
+    None = 'NONE',
+    Absolute = 'ABSOLUTE',
+    RelativeEnactment = 'RELATIVE_ENACTMENT',
+    RelativeCompletion = 'RELATIVE_COMPLETION'
+}
+
+
+export function GovernanceExpiryTypeFromJSON(json: any): GovernanceExpiryType {
+    return GovernanceExpiryTypeFromJSONTyped(json, false);
+}
+
+export function GovernanceExpiryTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceExpiryType {
+    return json as GovernanceExpiryType;
+}
+
+export function GovernanceExpiryTypeToJSON(value?: GovernanceExpiryType | null): any {
+    return value as any;
+}
+

package/src/models/GovernanceFile.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';
+
+/**
+ * 
+ * @export
+ * @interface GovernanceFile
+ */
+export interface GovernanceFile {
+    /**
+     * The title of the resource visible to users
+     * @type {string}
+     * @memberof GovernanceFile
+     */
+    name?: string;
+    /**
+     * A description of the resource visible to users
+     * @type {string}
+     * @memberof GovernanceFile
+     */
+    description?: string;
+    /**
+     * The file name without path or the full link path
+     * @type {string}
+     * @memberof GovernanceFile
+     */
+    src?: string;
+    /**
+     * 
+     * @type {GovernanceFileType}
+     * @memberof GovernanceFile
+     */
+    type?: GovernanceFileType;
+}
+
+/**
+ * Check if a given object implements the GovernanceFile interface.
+ */
+export function instanceOfGovernanceFile(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function GovernanceFileFromJSON(json: any): GovernanceFile {
+    return GovernanceFileFromJSONTyped(json, false);
+}
+
+export function GovernanceFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFile {
+    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 GovernanceFileToJSON(value?: GovernanceFile | 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/GovernanceFileType.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 options for supplementals for governance requirements
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceFileType {
+    File = 'FILE',
+    Link = 'LINK'
+}
+
+
+export function GovernanceFileTypeFromJSON(json: any): GovernanceFileType {
+    return GovernanceFileTypeFromJSONTyped(json, false);
+}
+
+export function GovernanceFileTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFileType {
+    return json as GovernanceFileType;
+}
+
+export function GovernanceFileTypeToJSON(value?: GovernanceFileType | null): any {
+    return value as any;
+}
+

package/src/models/GovernanceRequirement.ts

@@ -0,0 +1,194 @@
+/* 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;
+    /**
+     * The full S3 path 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;
+    /**
+     * The IDs of governance contacts assigned  to the requirement.
+     * @type {Array<string>}
+     * @memberof GovernanceRequirement
+     */
+    contactIds?: Array<string> | null;
+    /**
+     * 
+     * @type {GovernanceExpiry}
+     * @memberof GovernanceRequirement
+     */
+    expiration: GovernanceExpiry;
+    /**
+     * 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;
+}
+
+/**
+ * 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 && "expiration" 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': !exists(json, 'name') ? undefined : json['name'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'type': !exists(json, 'type') ? undefined : GovernanceTypeFromJSON(json['type']),
+        'path': !exists(json, 'path') ? undefined : json['path'],
+        'scope': !exists(json, 'scope') ? undefined : GovernanceScopeFromJSON(json['scope']),
+        'acceptance': !exists(json, 'acceptance') ? undefined : 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 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),
+        '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),
+    };
+}
+