@cirrobio/api-client 0.2.8 → 0.2.10

package/src/apis/FileApi.ts

@@ -16,29 +16,32 @@
 import * as runtime from '../runtime';
 import type {
   AWSCredentials,
-  FileAccessRequest,
   GenerateSftpCredentialsRequest,
+  GovernanceFileAccessRequest,
+  ProjectFileAccessRequest,
   SftpCredentials,
 } from '../models/index';
 import {
     AWSCredentialsFromJSON,
     AWSCredentialsToJSON,
-    FileAccessRequestFromJSON,
-    FileAccessRequestToJSON,
     GenerateSftpCredentialsRequestFromJSON,
     GenerateSftpCredentialsRequestToJSON,
+    GovernanceFileAccessRequestFromJSON,
+    GovernanceFileAccessRequestToJSON,
+    ProjectFileAccessRequestFromJSON,
+    ProjectFileAccessRequestToJSON,
     SftpCredentialsFromJSON,
     SftpCredentialsToJSON,
 } from '../models/index';
 
 export interface GenerateGovernanceFileAccessTokenRequest {
     requirementId: string;
-    fileAccessRequest: FileAccessRequest;
+    governanceFileAccessRequest: GovernanceFileAccessRequest;
 }
 
 export interface GenerateProjectFileAccessTokenRequest {
     projectId: string;
-    fileAccessRequest: FileAccessRequest;
+    projectFileAccessRequest: ProjectFileAccessRequest;
 }
 
 export interface GenerateProjectSftpTokenRequest {
@@ -60,8 +63,8 @@ export class FileApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('requirementId','Required parameter requestParameters.requirementId was null or undefined when calling generateGovernanceFileAccessToken.');
         }
 
-        if (requestParameters.fileAccessRequest === null || requestParameters.fileAccessRequest === undefined) {
-            throw new runtime.RequiredError('fileAccessRequest','Required parameter requestParameters.fileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
+        if (requestParameters.governanceFileAccessRequest === null || requestParameters.governanceFileAccessRequest === undefined) {
+            throw new runtime.RequiredError('governanceFileAccessRequest','Required parameter requestParameters.governanceFileAccessRequest was null or undefined when calling generateGovernanceFileAccessToken.');
         }
 
         const queryParameters: any = {};
@@ -83,7 +86,7 @@ export class FileApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: FileAccessRequestToJSON(requestParameters.fileAccessRequest),
+            body: GovernanceFileAccessRequestToJSON(requestParameters.governanceFileAccessRequest),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));
@@ -107,8 +110,8 @@ export class FileApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling generateProjectFileAccessToken.');
         }
 
-        if (requestParameters.fileAccessRequest === null || requestParameters.fileAccessRequest === undefined) {
-            throw new runtime.RequiredError('fileAccessRequest','Required parameter requestParameters.fileAccessRequest was null or undefined when calling generateProjectFileAccessToken.');
+        if (requestParameters.projectFileAccessRequest === null || requestParameters.projectFileAccessRequest === undefined) {
+            throw new runtime.RequiredError('projectFileAccessRequest','Required parameter requestParameters.projectFileAccessRequest was null or undefined when calling generateProjectFileAccessToken.');
         }
 
         const queryParameters: any = {};
@@ -130,7 +133,7 @@ export class FileApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: FileAccessRequestToJSON(requestParameters.fileAccessRequest),
+            body: ProjectFileAccessRequestToJSON(requestParameters.projectFileAccessRequest),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => AWSCredentialsFromJSON(jsonValue));

package/src/apis/GovernanceApi.ts

@@ -17,9 +17,12 @@ import * as runtime from '../runtime';
 import type {
   ClassificationInput,
   ContactInput,
+  FulfillmentResponse,
   GovernanceClassification,
   GovernanceContact,
   GovernanceRequirement,
+  ProjectRequirement,
+  RequirementFulfillmentInput,
   RequirementInput,
 } from '../models/index';
 import {
@@ -27,12 +30,18 @@ import {
     ClassificationInputToJSON,
     ContactInputFromJSON,
     ContactInputToJSON,
+    FulfillmentResponseFromJSON,
+    FulfillmentResponseToJSON,
     GovernanceClassificationFromJSON,
     GovernanceClassificationToJSON,
     GovernanceContactFromJSON,
     GovernanceContactToJSON,
     GovernanceRequirementFromJSON,
     GovernanceRequirementToJSON,
+    ProjectRequirementFromJSON,
+    ProjectRequirementToJSON,
+    RequirementFulfillmentInputFromJSON,
+    RequirementFulfillmentInputToJSON,
     RequirementInputFromJSON,
     RequirementInputToJSON,
 } from '../models/index';
@@ -61,6 +70,12 @@ export interface DeleteRequirementRequest {
     requirementId: string;
 }
 
+export interface FulfillRequirementRequest {
+    projectId: string;
+    requirementId: string;
+    requirementFulfillmentInput: RequirementFulfillmentInput;
+}
+
 export interface GetClassificationRequest {
     classificationId: string;
 }
@@ -73,6 +88,10 @@ export interface GetRequirementRequest {
     requirementId: string;
 }
 
+export interface GetRequirementsByProjectRequest {
+    projectId: string;
+}
+
 export interface UpdateClassificationRequest {
     classificationId: string;
     classificationInput: ClassificationInput;
@@ -339,6 +358,57 @@ export class GovernanceApi extends runtime.BaseAPI {
         await this.deleteRequirementRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Saves a record of the fulfillment of a governance requirement
+     * Fulfill a project\'s requirement
+     */
+    async fulfillRequirementRaw(requestParameters: FulfillRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FulfillmentResponse>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling fulfillRequirement.');
+        }
+
+        if (requestParameters.requirementId === null || requestParameters.requirementId === undefined) {
+            throw new runtime.RequiredError('requirementId','Required parameter requestParameters.requirementId was null or undefined when calling fulfillRequirement.');
+        }
+
+        if (requestParameters.requirementFulfillmentInput === null || requestParameters.requirementFulfillmentInput === undefined) {
+            throw new runtime.RequiredError('requirementFulfillmentInput','Required parameter requestParameters.requirementFulfillmentInput was null or undefined when calling fulfillRequirement.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/governance/projects/{projectId}/requirements/{requirementId}:fulfill`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"requirementId"}}`, encodeURIComponent(String(requestParameters.requirementId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RequirementFulfillmentInputToJSON(requestParameters.requirementFulfillmentInput),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FulfillmentResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Saves a record of the fulfillment of a governance requirement
+     * Fulfill a project\'s requirement
+     */
+    async fulfillRequirement(requestParameters: FulfillRequirementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FulfillmentResponse> {
+        const response = await this.fulfillRequirementRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a data classification
      * Get a classification
@@ -567,6 +637,46 @@ export class GovernanceApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Retrieve governance requirements for a project with fulfillment information for the current user
+     * Get project requirements
+     */
+    async getRequirementsByProjectRaw(requestParameters: GetRequirementsByProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectRequirement>>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getRequirementsByProject.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/governance/projects/{projectId}/requirements`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectRequirementFromJSON));
+    }
+
+    /**
+     * Retrieve governance requirements for a project with fulfillment information for the current user
+     * Get project requirements
+     */
+    async getRequirementsByProject(requestParameters: GetRequirementsByProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectRequirement>> {
+        const response = await this.getRequirementsByProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Updates a classification
      * Update classification

package/src/models/FulfillmentResponse.ts

@@ -0,0 +1,75 @@
+/* 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 FulfillmentResponse
+ */
+export interface FulfillmentResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof FulfillmentResponse
+     */
+    fulfillmentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FulfillmentResponse
+     */
+    path: string;
+}
+
+/**
+ * Check if a given object implements the FulfillmentResponse interface.
+ */
+export function instanceOfFulfillmentResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "fulfillmentId" in value;
+    isInstance = isInstance && "path" in value;
+
+    return isInstance;
+}
+
+export function FulfillmentResponseFromJSON(json: any): FulfillmentResponse {
+    return FulfillmentResponseFromJSONTyped(json, false);
+}
+
+export function FulfillmentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FulfillmentResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'fulfillmentId': json['fulfillmentId'],
+        'path': json['path'],
+    };
+}
+
+export function FulfillmentResponseToJSON(value?: FulfillmentResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'fulfillmentId': value.fulfillmentId,
+        'path': value.path,
+    };
+}
+

package/src/models/GovernanceAccessType.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.
+ */
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+export enum GovernanceAccessType {
+    GovernanceUpload = 'GOVERNANCE_UPLOAD',
+    GovernanceDownload = 'GOVERNANCE_DOWNLOAD',
+    FulfillmentUpload = 'FULFILLMENT_UPLOAD',
+    FulfillmentDownload = 'FULFILLMENT_DOWNLOAD'
+}
+
+
+export function GovernanceAccessTypeFromJSON(json: any): GovernanceAccessType {
+    return GovernanceAccessTypeFromJSONTyped(json, false);
+}
+
+export function GovernanceAccessTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceAccessType {
+    return json as GovernanceAccessType;
+}
+
+export function GovernanceAccessTypeToJSON(value?: GovernanceAccessType | null): any {
+    return value as any;
+}
+

package/src/models/GovernanceFileAccessRequest.ts

@@ -0,0 +1,89 @@
+/* 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 { GovernanceAccessType } from './GovernanceAccessType';
+import {
+    GovernanceAccessTypeFromJSON,
+    GovernanceAccessTypeFromJSONTyped,
+    GovernanceAccessTypeToJSON,
+} from './GovernanceAccessType';
+
+/**
+ * 
+ * @export
+ * @interface GovernanceFileAccessRequest
+ */
+export interface GovernanceFileAccessRequest {
+    /**
+     * 
+     * @type {GovernanceAccessType}
+     * @memberof GovernanceFileAccessRequest
+     */
+    accessType: GovernanceAccessType;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceFileAccessRequest
+     */
+    fulfillmentId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GovernanceFileAccessRequest
+     */
+    tokenLifetimeHours?: number | null;
+}
+
+/**
+ * Check if a given object implements the GovernanceFileAccessRequest interface.
+ */
+export function instanceOfGovernanceFileAccessRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "accessType" in value;
+
+    return isInstance;
+}
+
+export function GovernanceFileAccessRequestFromJSON(json: any): GovernanceFileAccessRequest {
+    return GovernanceFileAccessRequestFromJSONTyped(json, false);
+}
+
+export function GovernanceFileAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceFileAccessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'accessType': GovernanceAccessTypeFromJSON(json['accessType']),
+        'fulfillmentId': !exists(json, 'fulfillmentId') ? undefined : json['fulfillmentId'],
+        'tokenLifetimeHours': !exists(json, 'tokenLifetimeHours') ? undefined : json['tokenLifetimeHours'],
+    };
+}
+
+export function GovernanceFileAccessRequestToJSON(value?: GovernanceFileAccessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'accessType': GovernanceAccessTypeToJSON(value.accessType),
+        'fulfillmentId': value.fulfillmentId,
+        'tokenLifetimeHours': value.tokenLifetimeHours,
+    };
+}
+

package/src/models/GovernanceRequirement.ts

@@ -133,7 +133,7 @@ export interface GovernanceRequirement {
      * @type {GovernanceTrainingVerification}
      * @memberof GovernanceRequirement
      */
-    verification?: GovernanceTrainingVerification | null;
+    verificationMethod?: GovernanceTrainingVerification | null;
     /**
      * 
      * @type {string}
@@ -197,7 +197,7 @@ export function GovernanceRequirementFromJSONTyped(json: any, ignoreDiscriminato
         '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']),
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
@@ -226,7 +226,7 @@ export function GovernanceRequirementToJSON(value?: GovernanceRequirement | null
         '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),
         'createdBy': value.createdBy,
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),

package/src/models/{AccessType.ts → ProjectAccessType.ts}

@@ -17,26 +17,24 @@
  * @export
  * @enum {string}
  */
-export enum AccessType {
+export enum ProjectAccessType {
     DatasetUpload = 'DATASET_UPLOAD',
     SharedDatasetDownload = 'SHARED_DATASET_DOWNLOAD',
     SamplesheetUpload = 'SAMPLESHEET_UPLOAD',
     ReferenceUpload = 'REFERENCE_UPLOAD',
-    ProjectDownload = 'PROJECT_DOWNLOAD',
-    GovernanceUpload = 'GOVERNANCE_UPLOAD',
-    GovernanceDownload = 'GOVERNANCE_DOWNLOAD'
+    ProjectDownload = 'PROJECT_DOWNLOAD'
 }
 
 
-export function AccessTypeFromJSON(json: any): AccessType {
-    return AccessTypeFromJSONTyped(json, false);
+export function ProjectAccessTypeFromJSON(json: any): ProjectAccessType {
+    return ProjectAccessTypeFromJSONTyped(json, false);
 }
 
-export function AccessTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessType {
-    return json as AccessType;
+export function ProjectAccessTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectAccessType {
+    return json as ProjectAccessType;
 }
 
-export function AccessTypeToJSON(value?: AccessType | null): any {
+export function ProjectAccessTypeToJSON(value?: ProjectAccessType | null): any {
     return value as any;
 }
 

package/src/models/{FileAccessRequest.ts → ProjectFileAccessRequest.ts}

@@ -13,66 +13,66 @@
  */
 
 import { exists, mapValues } from '../runtime';
-import type { AccessType } from './AccessType';
+import type { ProjectAccessType } from './ProjectAccessType';
 import {
-    AccessTypeFromJSON,
-    AccessTypeFromJSONTyped,
-    AccessTypeToJSON,
-} from './AccessType';
+    ProjectAccessTypeFromJSON,
+    ProjectAccessTypeFromJSONTyped,
+    ProjectAccessTypeToJSON,
+} from './ProjectAccessType';
 
 /**
  * 
  * @export
- * @interface FileAccessRequest
+ * @interface ProjectFileAccessRequest
  */
-export interface FileAccessRequest {
+export interface ProjectFileAccessRequest {
     /**
      * 
-     * @type {AccessType}
-     * @memberof FileAccessRequest
+     * @type {ProjectAccessType}
+     * @memberof ProjectFileAccessRequest
      */
-    accessType: AccessType;
+    accessType: ProjectAccessType;
     /**
      * 
      * @type {string}
-     * @memberof FileAccessRequest
+     * @memberof ProjectFileAccessRequest
      */
     datasetId?: string | null;
     /**
      * 
      * @type {number}
-     * @memberof FileAccessRequest
+     * @memberof ProjectFileAccessRequest
      */
     tokenLifetimeHours?: number | null;
 }
 
 /**
- * Check if a given object implements the FileAccessRequest interface.
+ * Check if a given object implements the ProjectFileAccessRequest interface.
  */
-export function instanceOfFileAccessRequest(value: object): boolean {
+export function instanceOfProjectFileAccessRequest(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "accessType" in value;
 
     return isInstance;
 }
 
-export function FileAccessRequestFromJSON(json: any): FileAccessRequest {
-    return FileAccessRequestFromJSONTyped(json, false);
+export function ProjectFileAccessRequestFromJSON(json: any): ProjectFileAccessRequest {
+    return ProjectFileAccessRequestFromJSONTyped(json, false);
 }
 
-export function FileAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileAccessRequest {
+export function ProjectFileAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectFileAccessRequest {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
         
-        'accessType': AccessTypeFromJSON(json['accessType']),
+        'accessType': ProjectAccessTypeFromJSON(json['accessType']),
         'datasetId': !exists(json, 'datasetId') ? undefined : json['datasetId'],
         'tokenLifetimeHours': !exists(json, 'tokenLifetimeHours') ? undefined : json['tokenLifetimeHours'],
     };
 }
 
-export function FileAccessRequestToJSON(value?: FileAccessRequest | null): any {
+export function ProjectFileAccessRequestToJSON(value?: ProjectFileAccessRequest | null): any {
     if (value === undefined) {
         return undefined;
     }
@@ -81,7 +81,7 @@ export function FileAccessRequestToJSON(value?: FileAccessRequest | null): any {
     }
     return {
         
-        'accessType': AccessTypeToJSON(value.accessType),
+        'accessType': ProjectAccessTypeToJSON(value.accessType),
         'datasetId': value.datasetId,
         'tokenLifetimeHours': value.tokenLifetimeHours,
     };