@cirrobio/api-client 0.1.22 → 0.1.24

package/dist/models/ProjectRequest.js

@@ -14,11 +14,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectRequestToJSON = exports.ProjectRequestFromJSONTyped = exports.ProjectRequestFromJSON = exports.instanceOfProjectRequest = void 0;
-var runtime_1 = require("../runtime");
-var CloudAccount_1 = require("./CloudAccount");
-var Contact_1 = require("./Contact");
-var ProjectSettings_1 = require("./ProjectSettings");
-var Tag_1 = require("./Tag");
 /**
  * Check if a given object implements the ProjectRequest interface.
  */
@@ -26,9 +21,10 @@ function instanceOfProjectRequest(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "description" in value;
-    isInstance = isInstance && "billingAccountId" in value;
-    isInstance = isInstance && "settings" in value;
-    isInstance = isInstance && "contacts" in value;
+    isInstance = isInstance && "classificationIds" in value;
+    isInstance = isInstance && "billingInfo" in value;
+    isInstance = isInstance && "adminUsername" in value;
+    isInstance = isInstance && "message" in value;
     return isInstance;
 }
 exports.instanceOfProjectRequest = instanceOfProjectRequest;
@@ -43,11 +39,10 @@ function ProjectRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'],
         'description': json['description'],
-        'billingAccountId': json['billingAccountId'],
-        'settings': (0, ProjectSettings_1.ProjectSettingsFromJSON)(json['settings']),
-        'contacts': (json['contacts'].map(Contact_1.ContactFromJSON)),
-        'account': !(0, runtime_1.exists)(json, 'account') ? undefined : (0, CloudAccount_1.CloudAccountFromJSON)(json['account']),
-        'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : (json['tags'] === null ? null : json['tags'].map(Tag_1.TagFromJSON)),
+        'classificationIds': json['classificationIds'],
+        'billingInfo': json['billingInfo'],
+        'adminUsername': json['adminUsername'],
+        'message': json['message'],
     };
 }
 exports.ProjectRequestFromJSONTyped = ProjectRequestFromJSONTyped;
@@ -61,11 +56,10 @@ function ProjectRequestToJSON(value) {
     return {
         'name': value.name,
         'description': value.description,
-        'billingAccountId': value.billingAccountId,
-        'settings': (0, ProjectSettings_1.ProjectSettingsToJSON)(value.settings),
-        'contacts': (value.contacts.map(Contact_1.ContactToJSON)),
-        'account': (0, CloudAccount_1.CloudAccountToJSON)(value.account),
-        'tags': value.tags === undefined ? undefined : (value.tags === null ? null : value.tags.map(Tag_1.TagToJSON)),
+        'classificationIds': value.classificationIds,
+        'billingInfo': value.billingInfo,
+        'adminUsername': value.adminUsername,
+        'message': value.message,
     };
 }
 exports.ProjectRequestToJSON = ProjectRequestToJSON;

package/dist/models/Status.d.ts

@@ -23,7 +23,8 @@ export declare enum Status {
     Deleting = "DELETING",
     Suspended = "SUSPENDED",
     Delete = "DELETE",
-    Failed = "FAILED"
+    Failed = "FAILED",
+    Unknown = "UNKNOWN"
 }
 export declare function StatusFromJSON(json: any): Status;
 export declare function StatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): Status;

package/dist/models/Status.js

@@ -30,6 +30,7 @@ var Status;
     Status["Suspended"] = "SUSPENDED";
     Status["Delete"] = "DELETE";
     Status["Failed"] = "FAILED";
+    Status["Unknown"] = "UNKNOWN";
 })(Status = exports.Status || (exports.Status = {}));
 function StatusFromJSON(json) {
     return StatusFromJSONTyped(json, false);

package/dist/models/index.d.ts

@@ -10,6 +10,7 @@ export * from './BillingAccount';
 export * from './BillingAccountRequest';
 export * from './BillingMethod';
 export * from './BudgetPeriod';
+export * from './ClassificationInput';
 export * from './CloudAccount';
 export * from './CloudAccountType';
 export * from './ColumnDefinition';
@@ -39,6 +40,7 @@ export * from './FileRequirements';
 export * from './FormSchema';
 export * from './GenerateSftpCredentialsRequest';
 export * from './GetExecutionLogsResponse';
+export * from './GovernanceClassification';
 export * from './ImportDataRequest';
 export * from './InviteUserRequest';
 export * from './InviteUserResponse';
@@ -59,6 +61,7 @@ export * from './Project';
 export * from './ProjectAccessRequest';
 export * from './ProjectCreateOptions';
 export * from './ProjectDetail';
+export * from './ProjectInput';
 export * from './ProjectMetrics';
 export * from './ProjectRequest';
 export * from './ProjectRole';

package/dist/models/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./BillingAccount"), exports);
 __exportStar(require("./BillingAccountRequest"), exports);
 __exportStar(require("./BillingMethod"), exports);
 __exportStar(require("./BudgetPeriod"), exports);
+__exportStar(require("./ClassificationInput"), exports);
 __exportStar(require("./CloudAccount"), exports);
 __exportStar(require("./CloudAccountType"), exports);
 __exportStar(require("./ColumnDefinition"), exports);
@@ -57,6 +58,7 @@ __exportStar(require("./FileRequirements"), exports);
 __exportStar(require("./FormSchema"), exports);
 __exportStar(require("./GenerateSftpCredentialsRequest"), exports);
 __exportStar(require("./GetExecutionLogsResponse"), exports);
+__exportStar(require("./GovernanceClassification"), exports);
 __exportStar(require("./ImportDataRequest"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
 __exportStar(require("./InviteUserResponse"), exports);
@@ -77,6 +79,7 @@ __exportStar(require("./Project"), exports);
 __exportStar(require("./ProjectAccessRequest"), exports);
 __exportStar(require("./ProjectCreateOptions"), exports);
 __exportStar(require("./ProjectDetail"), exports);
+__exportStar(require("./ProjectInput"), exports);
 __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectRequest"), exports);
 __exportStar(require("./ProjectRole"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.1.22",
+  "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

@@ -20,8 +20,9 @@ import type {
   CreateResponse,
   Project,
   ProjectAccessRequest,
+  ProjectCreateOptions,
   ProjectDetail,
-  ProjectRequest,
+  ProjectInput,
   ProjectUser,
   SetUserProjectRoleRequest,
   Tag,
@@ -37,10 +38,12 @@ import {
     ProjectToJSON,
     ProjectAccessRequestFromJSON,
     ProjectAccessRequestToJSON,
+    ProjectCreateOptionsFromJSON,
+    ProjectCreateOptionsToJSON,
     ProjectDetailFromJSON,
     ProjectDetailToJSON,
-    ProjectRequestFromJSON,
-    ProjectRequestToJSON,
+    ProjectInputFromJSON,
+    ProjectInputToJSON,
     ProjectUserFromJSON,
     ProjectUserToJSON,
     SetUserProjectRoleRequestFromJSON,
@@ -65,7 +68,7 @@ export interface CreateAccessRequestRequest {
 }
 
 export interface CreateProjectRequest {
-    projectRequest: ProjectRequest;
+    projectInput: ProjectInput;
 }
 
 export interface DenyAccessRequestRequest {
@@ -101,7 +104,7 @@ export interface UnarchiveProjectRequest {
 
 export interface UpdateProjectRequest {
     projectId: string;
-    projectRequest: ProjectRequest;
+    projectInput: ProjectInput;
 }
 
 export interface UpdateProjectTagsRequest {
@@ -255,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 = {};
@@ -278,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));
@@ -456,6 +459,42 @@ export class ProjectsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get allowed options for creating a project
+     * Get project create options
+     */
+    async getProjectCreateOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectCreateOptions>> {
+        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: `/projects`,
+            method: 'OPTIONS',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectCreateOptionsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get allowed options for creating a project
+     * Get project create options
+     */
+    async getProjectCreateOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectCreateOptions> {
+        const response = await this.getProjectCreateOptionsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Gets users who have access to the project
      * Get project permissions
@@ -665,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 = {};
@@ -688,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';