@cirrobio/api-client 0.9.0 → 0.9.1

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

@@ -11,78 +11,33 @@
  * 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 GovernanceFileInput
- */
-export interface GovernanceFileInput {
-    /**
-     * 
-     * @type {string}
-     * @memberof GovernanceFileInput
-     */
-    name: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof GovernanceFileInput
-     */
-    description: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof GovernanceFileInput
-     */
-    src: string;
-    /**
-     * 
-     * @type {GovernanceFileType}
-     * @memberof GovernanceFileInput
-     */
-    type: GovernanceFileType;
-}
-
+import { GovernanceFileTypeFromJSON, GovernanceFileTypeToJSON, } from './GovernanceFileType';
 /**
  * Check if a given object implements the GovernanceFileInput interface.
  */
-export function instanceOfGovernanceFileInput(value: object): boolean {
+export function instanceOfGovernanceFileInput(value) {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "src" in value;
     isInstance = isInstance && "type" in value;
-
     return isInstance;
 }
-
-export function GovernanceFileInputFromJSON(json: any): GovernanceFileInput {
+export function GovernanceFileInputFromJSON(json) {
     return GovernanceFileInputFromJSONTyped(json, false);
 }
-
-export function GovernanceFileInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFileInput {
+export function GovernanceFileInputFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
-        
         'name': json['name'],
         'description': json['description'],
         'src': json['src'],
         'type': GovernanceFileTypeFromJSON(json['type']),
     };
 }
-
-export function GovernanceFileInputToJSON(value?: GovernanceFileInput | null): any {
+export function GovernanceFileInputToJSON(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -90,11 +45,9 @@ export function GovernanceFileInputToJSON(value?: GovernanceFileInput | null): a
         return null;
     }
     return {
-        
         'name': value.name,
         'description': value.description,
         'src': value.src,
         'type': GovernanceFileTypeToJSON(value.type),
     };
 }
-

package/dist/esm/models/GovernanceFileType.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.
+ */
+/**
+ * The options for supplementals for governance requirements
+ * @export
+ * @enum {string}
+ */
+export declare enum GovernanceFileType {
+    File = "FILE",
+    Link = "LINK"
+}
+export declare function GovernanceFileTypeFromJSON(json: any): GovernanceFileType;
+export declare function GovernanceFileTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFileType;
+export declare function GovernanceFileTypeToJSON(value?: GovernanceFileType | null): any;

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

@@ -11,27 +11,22 @@
  * 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 {
+export var GovernanceFileType;
+(function (GovernanceFileType) {
+    GovernanceFileType["File"] = "FILE";
+    GovernanceFileType["Link"] = "LINK";
+})(GovernanceFileType || (GovernanceFileType = {}));
+export function GovernanceFileTypeFromJSON(json) {
     return GovernanceFileTypeFromJSONTyped(json, false);
 }
-
-export function GovernanceFileTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFileType {
-    return json as GovernanceFileType;
+export function GovernanceFileTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
 }
-
-export function GovernanceFileTypeToJSON(value?: GovernanceFileType | null): any {
-    return value as any;
+export function GovernanceFileTypeToJSON(value) {
+    return value;
 }
-

package/dist/esm/models/GovernanceRequirement.d.ts

@@ -0,0 +1,146 @@
+/**
+ * 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 { GovernanceExpiry } from './GovernanceExpiry';
+import type { GovernanceFile } from './GovernanceFile';
+import type { GovernanceScope } from './GovernanceScope';
+import type { GovernanceTrainingVerification } from './GovernanceTrainingVerification';
+import type { GovernanceType } 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;
+    /**
+     * The project ID if the requirement is project scope
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    projectId?: string;
+    /**
+     *
+     * @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;
+    /**
+     * Files supplied by each project when authorship is project
+     * @type {{ [key: string]: GovernanceFile; }}
+     * @memberof GovernanceRequirement
+     */
+    projectFileMap?: {
+        [key: string]: GovernanceFile;
+    } | null;
+    /**
+     *
+     * @type {GovernanceTrainingVerification}
+     * @memberof GovernanceRequirement
+     */
+    verificationMethod?: 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 declare function instanceOfGovernanceRequirement(value: object): boolean;
+export declare function GovernanceRequirementFromJSON(json: any): GovernanceRequirement;
+export declare function GovernanceRequirementFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceRequirement;
+export declare function GovernanceRequirementToJSON(value?: GovernanceRequirement | null): any;

package/dist/esm/models/GovernanceRequirement.js

@@ -0,0 +1,95 @@
+/* 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 { GovernanceExpiryFromJSON, GovernanceExpiryToJSON, } from './GovernanceExpiry';
+import { GovernanceFileFromJSON, GovernanceFileToJSON, } from './GovernanceFile';
+import { GovernanceScopeFromJSON, GovernanceScopeToJSON, } from './GovernanceScope';
+import { GovernanceTrainingVerificationFromJSON, GovernanceTrainingVerificationToJSON, } from './GovernanceTrainingVerification';
+import { GovernanceTypeFromJSON, GovernanceTypeToJSON, } from './GovernanceType';
+/**
+ * Check if a given object implements the GovernanceRequirement interface.
+ */
+export function instanceOfGovernanceRequirement(value) {
+    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) {
+    return GovernanceRequirementFromJSONTyped(json, false);
+}
+export function GovernanceRequirementFromJSONTyped(json, ignoreDiscriminator) {
+    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']),
+        'projectId': !exists(json, 'projectId') ? undefined : json['projectId'],
+        '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'].map(GovernanceFileFromJSON)),
+        'file': !exists(json, 'file') ? undefined : GovernanceFileFromJSON(json['file']),
+        'authorship': !exists(json, 'authorship') ? undefined : GovernanceScopeFromJSON(json['authorship']),
+        'projectFileMap': !exists(json, 'projectFileMap') ? undefined : (json['projectFileMap'] === null ? null : mapValues(json['projectFileMap'], GovernanceFileFromJSON)),
+        'verificationMethod': !exists(json, 'verificationMethod') ? undefined : GovernanceTrainingVerificationFromJSON(json['verificationMethod']),
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function GovernanceRequirementToJSON(value) {
+    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),
+        'projectId': value.projectId,
+        '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.map(GovernanceFileToJSON)),
+        'file': GovernanceFileToJSON(value.file),
+        'authorship': GovernanceScopeToJSON(value.authorship),
+        'projectFileMap': value.projectFileMap === undefined ? undefined : (value.projectFileMap === null ? null : mapValues(value.projectFileMap, GovernanceFileToJSON)),
+        'verificationMethod': GovernanceTrainingVerificationToJSON(value.verificationMethod),
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}

package/dist/esm/models/GovernanceRequirementFile.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { GovernanceFileType } 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 declare function instanceOfGovernanceRequirementFile(value: object): boolean;
+export declare function GovernanceRequirementFileFromJSON(json: any): GovernanceRequirementFile;
+export declare function GovernanceRequirementFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceRequirementFile;
+export declare function GovernanceRequirementFileToJSON(value?: GovernanceRequirementFile | null): any;

package/dist/esm/models/GovernanceRequirementFile.js

@@ -0,0 +1,50 @@
+/* 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 { GovernanceFileTypeFromJSON, GovernanceFileTypeToJSON, } from './GovernanceFileType';
+/**
+ * Check if a given object implements the GovernanceRequirementFile interface.
+ */
+export function instanceOfGovernanceRequirementFile(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function GovernanceRequirementFileFromJSON(json) {
+    return GovernanceRequirementFileFromJSONTyped(json, false);
+}
+export function GovernanceRequirementFileFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    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/dist/esm/models/GovernanceScope.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.
+ */
+/**
+ * The levels at which governance requirements can be enforced
+ * @export
+ * @enum {string}
+ */
+export declare enum GovernanceScope {
+    Tenant = "TENANT",
+    Project = "PROJECT"
+}
+export declare function GovernanceScopeFromJSON(json: any): GovernanceScope;
+export declare function GovernanceScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceScope;
+export declare function GovernanceScopeToJSON(value?: GovernanceScope | null): any;

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

@@ -11,27 +11,22 @@
  * 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 {
+export var GovernanceScope;
+(function (GovernanceScope) {
+    GovernanceScope["Tenant"] = "TENANT";
+    GovernanceScope["Project"] = "PROJECT";
+})(GovernanceScope || (GovernanceScope = {}));
+export function GovernanceScopeFromJSON(json) {
     return GovernanceScopeFromJSONTyped(json, false);
 }
-
-export function GovernanceScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceScope {
-    return json as GovernanceScope;
+export function GovernanceScopeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
 }
-
-export function GovernanceScopeToJSON(value?: GovernanceScope | null): any {
-    return value as any;
+export function GovernanceScopeToJSON(value) {
+    return value;
 }
-

package/dist/esm/models/GovernanceTrainingVerification.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.
+ */
+/**
+ * The ways in which the completion of training can be verified.
+ * @export
+ * @enum {string}
+ */
+export declare enum GovernanceTrainingVerification {
+    Self = "SELF",
+    Certificate = "CERTIFICATE"
+}
+export declare function GovernanceTrainingVerificationFromJSON(json: any): GovernanceTrainingVerification;
+export declare function GovernanceTrainingVerificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceTrainingVerification;
+export declare function GovernanceTrainingVerificationToJSON(value?: GovernanceTrainingVerification | null): any;

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

@@ -11,27 +11,22 @@
  * 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 {
+export var GovernanceTrainingVerification;
+(function (GovernanceTrainingVerification) {
+    GovernanceTrainingVerification["Self"] = "SELF";
+    GovernanceTrainingVerification["Certificate"] = "CERTIFICATE";
+})(GovernanceTrainingVerification || (GovernanceTrainingVerification = {}));
+export function GovernanceTrainingVerificationFromJSON(json) {
     return GovernanceTrainingVerificationFromJSONTyped(json, false);
 }
-
-export function GovernanceTrainingVerificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceTrainingVerification {
-    return json as GovernanceTrainingVerification;
+export function GovernanceTrainingVerificationFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
 }
-
-export function GovernanceTrainingVerificationToJSON(value?: GovernanceTrainingVerification | null): any {
-    return value as any;
+export function GovernanceTrainingVerificationToJSON(value) {
+    return value;
 }
-

package/dist/esm/models/GovernanceType.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.
+ */
+/**
+ * The types of governance requirements that can be enforced
+ * @export
+ * @enum {string}
+ */
+export declare enum GovernanceType {
+    Document = "DOCUMENT",
+    Agreement = "AGREEMENT",
+    Training = "TRAINING"
+}
+export declare function GovernanceTypeFromJSON(json: any): GovernanceType;
+export declare function GovernanceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceType;
+export declare function GovernanceTypeToJSON(value?: GovernanceType | null): any;