@cirrobio/api-client 0.1.23 → 0.1.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.1.23",
+  "version": "0.1.24",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/apis/GovernanceApi.ts

@@ -0,0 +1,255 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ClassificationInput,
+  GovernanceClassification,
+} from '../models/index';
+import {
+    ClassificationInputFromJSON,
+    ClassificationInputToJSON,
+    GovernanceClassificationFromJSON,
+    GovernanceClassificationToJSON,
+} from '../models/index';
+
+export interface CreateClassificationRequest {
+    classificationInput: ClassificationInput;
+}
+
+export interface DeleteClassificationRequest {
+    classificationId: string;
+}
+
+export interface GetClassificationRequest {
+    classificationId: string;
+}
+
+export interface UpdateClassificationRequest {
+    classificationId: string;
+    classificationInput: ClassificationInput;
+}
+
+/**
+ * 
+ */
+export class GovernanceApi extends runtime.BaseAPI {
+
+    /**
+     * Creates a classification
+     * Create classification
+     */
+    async createClassificationRaw(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>> {
+        if (requestParameters.classificationInput === null || requestParameters.classificationInput === undefined) {
+            throw new runtime.RequiredError('classificationInput','Required parameter requestParameters.classificationInput was null or undefined when calling createClassification.');
+        }
+
+        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/classifications`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ClassificationInputToJSON(requestParameters.classificationInput),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GovernanceClassificationFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a classification
+     * Create classification
+     */
+    async createClassification(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification> {
+        const response = await this.createClassificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Deletes the classification, and removes it from all projects.
+     * Delete a classification
+     */
+    async deleteClassificationRaw(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.classificationId === null || requestParameters.classificationId === undefined) {
+            throw new runtime.RequiredError('classificationId','Required parameter requestParameters.classificationId was null or undefined when calling deleteClassification.');
+        }
+
+        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/classifications/{classificationId}`.replace(`{${"classificationId"}}`, encodeURIComponent(String(requestParameters.classificationId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Deletes the classification, and removes it from all projects.
+     * Delete a classification
+     */
+    async deleteClassification(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteClassificationRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieve a data classification
+     * Get a classification
+     */
+    async getClassificationRaw(requestParameters: GetClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>> {
+        if (requestParameters.classificationId === null || requestParameters.classificationId === undefined) {
+            throw new runtime.RequiredError('classificationId','Required parameter requestParameters.classificationId was null or undefined when calling getClassification.');
+        }
+
+        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/classifications/{classificationId}`.replace(`{${"classificationId"}}`, encodeURIComponent(String(requestParameters.classificationId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GovernanceClassificationFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a data classification
+     * Get a classification
+     */
+    async getClassification(requestParameters: GetClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification> {
+        const response = await this.getClassificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a list of data classifications
+     * Get classifications
+     */
+    async getClassificationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceClassification>>> {
+        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/classifications`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GovernanceClassificationFromJSON));
+    }
+
+    /**
+     * Retrieve a list of data classifications
+     * Get classifications
+     */
+    async getClassifications(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceClassification>> {
+        const response = await this.getClassificationsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Updates a classification
+     * Update classification
+     */
+    async updateClassificationRaw(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GovernanceClassification>> {
+        if (requestParameters.classificationId === null || requestParameters.classificationId === undefined) {
+            throw new runtime.RequiredError('classificationId','Required parameter requestParameters.classificationId was null or undefined when calling updateClassification.');
+        }
+
+        if (requestParameters.classificationInput === null || requestParameters.classificationInput === undefined) {
+            throw new runtime.RequiredError('classificationInput','Required parameter requestParameters.classificationInput was null or undefined when calling updateClassification.');
+        }
+
+        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/classifications/{classificationId}`.replace(`{${"classificationId"}}`, encodeURIComponent(String(requestParameters.classificationId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ClassificationInputToJSON(requestParameters.classificationInput),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GovernanceClassificationFromJSON(jsonValue));
+    }
+
+    /**
+     * Updates a classification
+     * Update classification
+     */
+    async updateClassification(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceClassification> {
+        const response = await this.updateClassificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/ProjectRequestsApi.ts

@@ -0,0 +1,80 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  CreateResponse,
+  ProjectRequest,
+} from '../models/index';
+import {
+    CreateResponseFromJSON,
+    CreateResponseToJSON,
+    ProjectRequestFromJSON,
+    ProjectRequestToJSON,
+} from '../models/index';
+
+export interface CreateProjectRequestRequest {
+    projectRequest: ProjectRequest;
+}
+
+/**
+ * 
+ */
+export class ProjectRequestsApi extends runtime.BaseAPI {
+
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    async createProjectRequestRaw(requestParameters: CreateProjectRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
+        if (requestParameters.projectRequest === null || requestParameters.projectRequest === undefined) {
+            throw new runtime.RequiredError('projectRequest','Required parameter requestParameters.projectRequest was null or undefined when calling createProjectRequest.');
+        }
+
+        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: `/project-requests`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ProjectRequestToJSON(requestParameters.projectRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Request a new project to be created
+     * Create project request
+     */
+    async createProjectRequest(requestParameters: CreateProjectRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
+        const response = await this.createProjectRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/ProjectsApi.ts

@@ -22,7 +22,7 @@ import type {
   ProjectAccessRequest,
   ProjectCreateOptions,
   ProjectDetail,
-  ProjectRequest,
+  ProjectInput,
   ProjectUser,
   SetUserProjectRoleRequest,
   Tag,
@@ -42,8 +42,8 @@ import {
     ProjectCreateOptionsToJSON,
     ProjectDetailFromJSON,
     ProjectDetailToJSON,
-    ProjectRequestFromJSON,
-    ProjectRequestToJSON,
+    ProjectInputFromJSON,
+    ProjectInputToJSON,
     ProjectUserFromJSON,
     ProjectUserToJSON,
     SetUserProjectRoleRequestFromJSON,
@@ -68,7 +68,7 @@ export interface CreateAccessRequestRequest {
 }
 
 export interface CreateProjectRequest {
-    projectRequest: ProjectRequest;
+    projectInput: ProjectInput;
 }
 
 export interface DenyAccessRequestRequest {
@@ -104,7 +104,7 @@ export interface UnarchiveProjectRequest {
 
 export interface UpdateProjectRequest {
     projectId: string;
-    projectRequest: ProjectRequest;
+    projectInput: ProjectInput;
 }
 
 export interface UpdateProjectTagsRequest {
@@ -258,8 +258,8 @@ export class ProjectsApi extends runtime.BaseAPI {
      * Create project
      */
     async createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
-        if (requestParameters.projectRequest === null || requestParameters.projectRequest === undefined) {
-            throw new runtime.RequiredError('projectRequest','Required parameter requestParameters.projectRequest was null or undefined when calling createProject.');
+        if (requestParameters.projectInput === null || requestParameters.projectInput === undefined) {
+            throw new runtime.RequiredError('projectInput','Required parameter requestParameters.projectInput was null or undefined when calling createProject.');
         }
 
         const queryParameters: any = {};
@@ -281,7 +281,7 @@ export class ProjectsApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: ProjectRequestToJSON(requestParameters.projectRequest),
+            body: ProjectInputToJSON(requestParameters.projectInput),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
@@ -704,8 +704,8 @@ export class ProjectsApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling updateProject.');
         }
 
-        if (requestParameters.projectRequest === null || requestParameters.projectRequest === undefined) {
-            throw new runtime.RequiredError('projectRequest','Required parameter requestParameters.projectRequest was null or undefined when calling updateProject.');
+        if (requestParameters.projectInput === null || requestParameters.projectInput === undefined) {
+            throw new runtime.RequiredError('projectInput','Required parameter requestParameters.projectInput was null or undefined when calling updateProject.');
         }
 
         const queryParameters: any = {};
@@ -727,7 +727,7 @@ export class ProjectsApi extends runtime.BaseAPI {
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-            body: ProjectRequestToJSON(requestParameters.projectRequest),
+            body: ProjectInputToJSON(requestParameters.projectInput),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ProjectDetailFromJSON(jsonValue));

package/src/apis/index.ts

@@ -7,10 +7,12 @@ export * from './DashboardsApi';
 export * from './DatasetsApi';
 export * from './ExecutionApi';
 export * from './FileApi';
+export * from './GovernanceApi';
 export * from './MetadataApi';
 export * from './MetricsApi';
 export * from './NotebooksApi';
 export * from './ProcessesApi';
+export * from './ProjectRequestsApi';
 export * from './ProjectsApi';
 export * from './ReferencesApi';
 export * from './SystemApi';

package/src/models/ClassificationInput.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 ClassificationInput
+ */
+export interface ClassificationInput {
+    /**
+     * 
+     * @type {string}
+     * @memberof ClassificationInput
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClassificationInput
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the ClassificationInput interface.
+ */
+export function instanceOfClassificationInput(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+
+    return isInstance;
+}
+
+export function ClassificationInputFromJSON(json: any): ClassificationInput {
+    return ClassificationInputFromJSONTyped(json, false);
+}
+
+export function ClassificationInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClassificationInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+
+export function ClassificationInputToJSON(value?: ClassificationInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'description': value.description,
+    };
+}
+

package/src/models/GovernanceClassification.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 GovernanceClassification
+ */
+export interface GovernanceClassification {
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceClassification
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceClassification
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceClassification
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GovernanceClassification
+     */
+    createdBy: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GovernanceClassification
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GovernanceClassification
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the GovernanceClassification interface.
+ */
+export function instanceOfGovernanceClassification(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function GovernanceClassificationFromJSON(json: any): GovernanceClassification {
+    return GovernanceClassificationFromJSONTyped(json, false);
+}
+
+export function GovernanceClassificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceClassification {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function GovernanceClassificationToJSON(value?: GovernanceClassification | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/ProjectDetail.ts

@@ -110,6 +110,12 @@ export interface ProjectDetail {
      * @memberof ProjectDetail
      */
     tags: Array<Tag>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ProjectDetail
+     */
+    classificationIds: Array<string>;
     /**
      * 
      * @type {string}
@@ -144,6 +150,7 @@ export function instanceOfProjectDetail(value: object): boolean {
     isInstance = isInstance && "settings" in value;
     isInstance = isInstance && "statusMessage" in value;
     isInstance = isInstance && "tags" in value;
+    isInstance = isInstance && "classificationIds" in value;
     isInstance = isInstance && "createdBy" in value;
     isInstance = isInstance && "createdAt" in value;
     isInstance = isInstance && "updatedAt" in value;
@@ -171,6 +178,7 @@ export function ProjectDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'account': !exists(json, 'account') ? undefined : CloudAccountFromJSON(json['account']),
         'statusMessage': json['statusMessage'],
         'tags': ((json['tags'] as Array<any>).map(TagFromJSON)),
+        'classificationIds': json['classificationIds'],
         'createdBy': json['createdBy'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
@@ -196,6 +204,7 @@ export function ProjectDetailToJSON(value?: ProjectDetail | null): any {
         'account': CloudAccountToJSON(value.account),
         'statusMessage': value.statusMessage,
         'tags': ((value.tags as Array<any>).map(TagToJSON)),
+        'classificationIds': value.classificationIds,
         'createdBy': value.createdBy,
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),