@cirrobio/api-client 0.2.8 → 0.2.9

package/src/models/ProjectRequirement.ts

@@ -0,0 +1,254 @@
+/* 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 { GovernanceContact } from './GovernanceContact';
+import {
+    GovernanceContactFromJSON,
+    GovernanceContactFromJSONTyped,
+    GovernanceContactToJSON,
+} from './GovernanceContact';
+import type { GovernanceExpiryType } from './GovernanceExpiryType';
+import {
+    GovernanceExpiryTypeFromJSON,
+    GovernanceExpiryTypeFromJSONTyped,
+    GovernanceExpiryTypeToJSON,
+} from './GovernanceExpiryType';
+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 ProjectRequirement
+ */
+export interface ProjectRequirement {
+    /**
+     * The unique identifier for the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    id: string;
+    /**
+     * The name of the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    name: string;
+    /**
+     * A brief description of the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    description: string;
+    /**
+     * 
+     * @type {GovernanceType}
+     * @memberof ProjectRequirement
+     */
+    type: GovernanceType;
+    /**
+     * S3 prefix where files for the requirement are saved
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    path: string;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof ProjectRequirement
+     */
+    scope: GovernanceScope;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof ProjectRequirement
+     */
+    acceptance?: GovernanceScope | null;
+    /**
+     * The governance contacts assigned to the requirement.
+     * @type {Array<GovernanceContact>}
+     * @memberof ProjectRequirement
+     */
+    contacts: Array<GovernanceContact>;
+    /**
+     * The date of enactment for the requirement
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    enactmentDate?: Date | null;
+    /**
+     * 
+     * @type {GovernanceExpiryType}
+     * @memberof ProjectRequirement
+     */
+    expirationType?: GovernanceExpiryType;
+    /**
+     * The number of days for a relative to completion expiration
+     * @type {number}
+     * @memberof ProjectRequirement
+     */
+    expirationDaysAfterCompletion?: number | null;
+    /**
+     * The date of expiration for the requirement
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    expirationDate?: Date | null;
+    /**
+     * Optional files with extra information, e.g. templates for documents, links, etc
+     * @type {Array<GovernanceFile>}
+     * @memberof ProjectRequirement
+     */
+    supplementalDocs?: Array<GovernanceFile> | null;
+    /**
+     * 
+     * @type {GovernanceFile}
+     * @memberof ProjectRequirement
+     */
+    file?: GovernanceFile | null;
+    /**
+     * 
+     * @type {GovernanceScope}
+     * @memberof ProjectRequirement
+     */
+    authorship?: GovernanceScope | null;
+    /**
+     * 
+     * @type {GovernanceTrainingVerification}
+     * @memberof ProjectRequirement
+     */
+    verificationMethod?: GovernanceTrainingVerification | null;
+    /**
+     * Whether the current user has fulfilled the requirement for this project
+     * @type {boolean}
+     * @memberof ProjectRequirement
+     */
+    isFulfilled: boolean;
+    /**
+     * The date the requirement was fulfilled by the user
+     * @type {Date}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentDate?: Date | null;
+    /**
+     * The optional file uploaded to fulfill the requirement
+     * @type {string}
+     * @memberof ProjectRequirement
+     */
+    fulfillmentFile?: string | null;
+}
+
+/**
+ * Check if a given object implements the ProjectRequirement interface.
+ */
+export function instanceOfProjectRequirement(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 && "contacts" in value;
+    isInstance = isInstance && "isFulfilled" in value;
+
+    return isInstance;
+}
+
+export function ProjectRequirementFromJSON(json: any): ProjectRequirement {
+    return ProjectRequirementFromJSONTyped(json, false);
+}
+
+export function ProjectRequirementFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectRequirement {
+    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']),
+        'contacts': ((json['contacts'] as Array<any>).map(GovernanceContactFromJSON)),
+        'enactmentDate': !exists(json, 'enactmentDate') ? undefined : (json['enactmentDate'] === null ? null : new Date(json['enactmentDate'])),
+        'expirationType': !exists(json, 'expirationType') ? undefined : GovernanceExpiryTypeFromJSON(json['expirationType']),
+        'expirationDaysAfterCompletion': !exists(json, 'expirationDaysAfterCompletion') ? undefined : json['expirationDaysAfterCompletion'],
+        'expirationDate': !exists(json, 'expirationDate') ? undefined : (json['expirationDate'] === null ? null : new Date(json['expirationDate'])),
+        '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']),
+        'verificationMethod': !exists(json, 'verificationMethod') ? undefined : GovernanceTrainingVerificationFromJSON(json['verificationMethod']),
+        'isFulfilled': json['isFulfilled'],
+        'fulfillmentDate': !exists(json, 'fulfillmentDate') ? undefined : (json['fulfillmentDate'] === null ? null : new Date(json['fulfillmentDate'])),
+        'fulfillmentFile': !exists(json, 'fulfillmentFile') ? undefined : json['fulfillmentFile'],
+    };
+}
+
+export function ProjectRequirementToJSON(value?: ProjectRequirement | 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),
+        'contacts': ((value.contacts as Array<any>).map(GovernanceContactToJSON)),
+        'enactmentDate': value.enactmentDate === undefined ? undefined : (value.enactmentDate === null ? null : value.enactmentDate.toISOString()),
+        'expirationType': GovernanceExpiryTypeToJSON(value.expirationType),
+        'expirationDaysAfterCompletion': value.expirationDaysAfterCompletion,
+        'expirationDate': value.expirationDate === undefined ? undefined : (value.expirationDate === null ? null : value.expirationDate.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),
+        'verificationMethod': GovernanceTrainingVerificationToJSON(value.verificationMethod),
+        'isFulfilled': value.isFulfilled,
+        'fulfillmentDate': value.fulfillmentDate === undefined ? undefined : (value.fulfillmentDate === null ? null : value.fulfillmentDate.toISOString()),
+        'fulfillmentFile': value.fulfillmentFile,
+    };
+}
+

package/src/models/RequirementFulfillmentInput.ts

@@ -0,0 +1,65 @@
+/* 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 RequirementFulfillmentInput
+ */
+export interface RequirementFulfillmentInput {
+    /**
+     * 
+     * @type {string}
+     * @memberof RequirementFulfillmentInput
+     */
+    file?: string | null;
+}
+
+/**
+ * Check if a given object implements the RequirementFulfillmentInput interface.
+ */
+export function instanceOfRequirementFulfillmentInput(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function RequirementFulfillmentInputFromJSON(json: any): RequirementFulfillmentInput {
+    return RequirementFulfillmentInputFromJSONTyped(json, false);
+}
+
+export function RequirementFulfillmentInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementFulfillmentInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'file': !exists(json, 'file') ? undefined : json['file'],
+    };
+}
+
+export function RequirementFulfillmentInputToJSON(value?: RequirementFulfillmentInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'file': value.file,
+    };
+}
+

package/src/models/RequirementInput.ts

@@ -121,7 +121,7 @@ export interface RequirementInput {
      * @type {GovernanceTrainingVerification}
      * @memberof RequirementInput
      */
-    verification?: GovernanceTrainingVerification | null;
+    verificationMethod?: GovernanceTrainingVerification | null;
 }
 
 /**
@@ -160,7 +160,7 @@ export function RequirementInputFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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']),
+        'verificationMethod': !exists(json, 'verificationMethod') ? undefined : GovernanceTrainingVerificationFromJSON(json['verificationMethod']),
     };
 }
 
@@ -184,7 +184,7 @@ export function RequirementInputToJSON(value?: RequirementInput | null): any {
         '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),
+        'verificationMethod': GovernanceTrainingVerificationToJSON(value.verificationMethod),
     };
 }
 

package/src/models/index.ts

@@ -1,7 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AWSCredentials';
-export * from './AccessType';
 export * from './Agent';
 export * from './AgentDetail';
 export * from './AgentInput';
@@ -41,19 +40,21 @@ export * from './EnvironmentType';
 export * from './ErrorMessage';
 export * from './Executor';
 export * from './FeatureFlags';
-export * from './FileAccessRequest';
 export * from './FileEntry';
 export * from './FileMappingRule';
 export * from './FileNamePattern';
 export * from './FileRequirements';
 export * from './FormSchema';
+export * from './FulfillmentResponse';
 export * from './GenerateSftpCredentialsRequest';
 export * from './GetExecutionLogsResponse';
+export * from './GovernanceAccessType';
 export * from './GovernanceClassification';
 export * from './GovernanceContact';
 export * from './GovernanceExpiry';
 export * from './GovernanceExpiryType';
 export * from './GovernanceFile';
+export * from './GovernanceFileAccessRequest';
 export * from './GovernanceFileType';
 export * from './GovernanceRequirement';
 export * from './GovernanceScope';
@@ -81,11 +82,14 @@ export * from './Process';
 export * from './ProcessDetail';
 export * from './Project';
 export * from './ProjectAccessRequest';
+export * from './ProjectAccessType';
 export * from './ProjectCreateOptions';
 export * from './ProjectDetail';
+export * from './ProjectFileAccessRequest';
 export * from './ProjectInput';
 export * from './ProjectMetrics';
 export * from './ProjectRequest';
+export * from './ProjectRequirement';
 export * from './ProjectRole';
 export * from './ProjectSettings';
 export * from './ProjectUser';
@@ -93,6 +97,7 @@ export * from './Reference';
 export * from './ReferenceType';
 export * from './RepositoryType';
 export * from './RequestStatus';
+export * from './RequirementFulfillmentInput';
 export * from './RequirementInput';
 export * from './ResourcesInfo';
 export * from './RunAnalysisRequest';

package/dist/models/AccessType.js

@@ -1,43 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccessTypeToJSON = exports.AccessTypeFromJSONTyped = exports.AccessTypeFromJSON = exports.AccessType = void 0;
-/**
- *
- * @export
- * @enum {string}
- */
-var AccessType;
-(function (AccessType) {
-    AccessType["DatasetUpload"] = "DATASET_UPLOAD";
-    AccessType["SharedDatasetDownload"] = "SHARED_DATASET_DOWNLOAD";
-    AccessType["SamplesheetUpload"] = "SAMPLESHEET_UPLOAD";
-    AccessType["ReferenceUpload"] = "REFERENCE_UPLOAD";
-    AccessType["ProjectDownload"] = "PROJECT_DOWNLOAD";
-    AccessType["GovernanceUpload"] = "GOVERNANCE_UPLOAD";
-    AccessType["GovernanceDownload"] = "GOVERNANCE_DOWNLOAD";
-})(AccessType = exports.AccessType || (exports.AccessType = {}));
-function AccessTypeFromJSON(json) {
-    return AccessTypeFromJSONTyped(json, false);
-}
-exports.AccessTypeFromJSON = AccessTypeFromJSON;
-function AccessTypeFromJSONTyped(json, ignoreDiscriminator) {
-    return json;
-}
-exports.AccessTypeFromJSONTyped = AccessTypeFromJSONTyped;
-function AccessTypeToJSON(value) {
-    return value;
-}
-exports.AccessTypeToJSON = AccessTypeToJSON;

package/dist/models/FileAccessRequest.d.ts

@@ -1,44 +0,0 @@
-/**
- * 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 { AccessType } from './AccessType';
-/**
- *
- * @export
- * @interface FileAccessRequest
- */
-export interface FileAccessRequest {
-    /**
-     *
-     * @type {AccessType}
-     * @memberof FileAccessRequest
-     */
-    accessType: AccessType;
-    /**
-     *
-     * @type {string}
-     * @memberof FileAccessRequest
-     */
-    datasetId?: string | null;
-    /**
-     *
-     * @type {number}
-     * @memberof FileAccessRequest
-     */
-    tokenLifetimeHours?: number | null;
-}
-/**
- * Check if a given object implements the FileAccessRequest interface.
- */
-export declare function instanceOfFileAccessRequest(value: object): boolean;
-export declare function FileAccessRequestFromJSON(json: any): FileAccessRequest;
-export declare function FileAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileAccessRequest;
-export declare function FileAccessRequestToJSON(value?: FileAccessRequest | null): any;