MINOR: remove sub projects (#782)

Bimdata-io · Bimdata-io · commit 969e640569d4 · 2024-10-24T17:33:13.000Z
diff --git a/README.md b/README.md
@@ -271,7 +271,6 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**getProjectFolderTree**](docs/CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
 *bimdata.CollaborationApi* | [**getProjectInvitations**](docs/CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
 *bimdata.CollaborationApi* | [**getProjectSize**](docs/CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
-*bimdata.CollaborationApi* | [**getProjectSubTree**](docs/CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
 *bimdata.CollaborationApi* | [**getProjectTree**](docs/CollaborationApi.md#getProjectTree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
 *bimdata.CollaborationApi* | [**getProjectUsers**](docs/CollaborationApi.md#getProjectUsers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user | Retrieve all users in a project, or a list with a filter by email
 *bimdata.CollaborationApi* | [**getProjectValidatorVisas**](docs/CollaborationApi.md#getProjectValidatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/validator | List visas where user is a validator
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -72,7 +72,6 @@ Method | HTTP request | Description
 [**getProjectFolderTree**](CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
 [**getProjectInvitations**](CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
 [**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
-[**getProjectSubTree**](CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
 [**getProjectTree**](CollaborationApi.md#getProjectTree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
 [**getProjectUsers**](CollaborationApi.md#getProjectUsers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user | Retrieve all users in a project, or a list with a filter by email
 [**getProjectValidatorVisas**](CollaborationApi.md#getProjectValidatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/validator | List visas where user is a validator
@@ -961,7 +960,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;IFC&#39;, &#39;GLTF&#39;, &#39;OBJ&#39;, &#39;DXF&#39;, &#39;POINT_CLOUD&#39;, &#39;DWG&#39;}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {&#39;DXF&#39;, &#39;IFC&#39;, &#39;POINT_CLOUD&#39;, &#39;GLTF&#39;, &#39;DWG&#39;, &#39;OBJ&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -4654,67 +4653,6 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## getProjectSubTree
-
-> [ProjectWithChildren] getProjectSubTree(cloudPk)
-
-Retrieve the complete projects tree of the cloud
-
-Retrieve the complete projects tree of the cloud
-
-### Example
-
-```javascript
-import bimdata from '@bimdata/bimdata-api-client';
-let defaultClient = bimdata.ApiClient.instance;
-// Configure API key authorization: ApiKey
-let ApiKey = defaultClient.authentications['ApiKey'];
-ApiKey.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//ApiKey.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: BIMData_Connect
-let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
-BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
-// Configure OAuth2 access token for authorization: BIMData_Connect
-let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
-BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
-// Configure API key authorization: Bearer
-let Bearer = defaultClient.authentications['Bearer'];
-Bearer.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//Bearer.apiKeyPrefix = 'Token';
-
-let apiInstance = new bimdata.CollaborationApi();
-let cloudPk = 56; // Number | 
-apiInstance.getProjectSubTree(cloudPk).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cloudPk** | **Number**|  | 
-
-### Return type
-
-[**[ProjectWithChildren]**](ProjectWithChildren.md)
-
-### Authorization
-
-[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## getProjectTree
 
 > Folder getProjectTree(cloudPk, id)
diff --git a/docs/GroupFolderRead.md b/docs/GroupFolderRead.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**group** | [**Group**](Group.md) |  | 
+**group** | [**Group**](Group.md) |  | [readonly] 
 **permission** | **Number** | * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | 
 
 
diff --git a/docs/PatchedProjectRequest.md b/docs/PatchedProjectRequest.md
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the project | [optional] 
 **description** | **String** |  | [optional] 
 **status** | **String** | * &#x60;A&#x60; - active * &#x60;D&#x60; - deleted | [optional] 
-**parentId** | **Number** |  | [optional] 
 **mainModelId** | **Number** |  | [optional] 
 
 
diff --git a/docs/Project.md b/docs/Project.md
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **status** | **String** | * &#x60;A&#x60; - active * &#x60;D&#x60; - deleted | [optional] 
 **createdAt** | **Date** | Creation date | [readonly] 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
-**parentId** | **Number** |  | [optional] 
 **rootFolderId** | **Number** |  | [readonly] 
 **mainModelId** | **Number** |  | [optional] 
 
diff --git a/docs/ProjectRequest.md b/docs/ProjectRequest.md
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the project | 
 **description** | **String** |  | [optional] 
 **status** | **String** | * &#x60;A&#x60; - active * &#x60;D&#x60; - deleted | [optional] 
-**parentId** | **Number** |  | [optional] 
 **mainModelId** | **Number** |  | [optional] 
 
 
diff --git a/docs/ProjectWithChildren.md b/docs/ProjectWithChildren.md
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
 **status** | **String** | * &#x60;A&#x60; - active * &#x60;D&#x60; - deleted | [optional] 
 **createdAt** | **Date** | Creation date | [readonly] 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
-**parentId** | **Number** |  | [optional] 
 **children** | [**[ProjectWithChildren]**](ProjectWithChildren.md) |  | [readonly] 
 **rootFolderId** | **Number** |  | [readonly] 
 **mainModelId** | **Number** | Main model of the project | [readonly] 
diff --git a/docs/WriteFolderRequest.md b/docs/WriteFolderRequest.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the folder | 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
+**name** | **String** | Name of the folder | 
 **parentId** | **Number** |  | [optional] 
 **children** | [**[WriteFolderRequest]**](WriteFolderRequest.md) |  | [optional] 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -867,7 +867,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'IFC', 'POINT_CLOUD', 'GLTF', 'DWG', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
@@ -933,7 +933,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'IFC', 'POINT_CLOUD', 'GLTF', 'DWG', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
@@ -4380,54 +4380,6 @@ export default class CollaborationApi {
     }
 
 
-    /**
-     * Retrieve the complete projects tree of the cloud
-     * Retrieve the complete projects tree of the cloud
-     * @param {Number} cloudPk 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ProjectWithChildren>} and HTTP response
-     */
-    getProjectSubTreeWithHttpInfo(cloudPk) {
-      let postBody = null;
-      // verify the required parameter 'cloudPk' is set
-      if (cloudPk === undefined || cloudPk === null) {
-        throw new Error("Missing the required parameter 'cloudPk' when calling getProjectSubTree");
-      }
-
-      let pathParams = {
-        'cloud_pk': cloudPk
-      };
-      let queryParams = {
-      };
-      let headerParams = {
-      };
-      let formParams = {
-      };
-
-      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
-      let contentTypes = [];
-      let accepts = ['application/json'];
-      let returnType = [ProjectWithChildren];
-      return this.apiClient.callApi(
-        '/cloud/{cloud_pk}/project/subtree', 'GET',
-        pathParams, queryParams, headerParams, formParams, postBody,
-        authNames, contentTypes, accepts, returnType, null
-      );
-    }
-
-    /**
-     * Retrieve the complete projects tree of the cloud
-     * Retrieve the complete projects tree of the cloud
-     * @param {Number} cloudPk 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ProjectWithChildren>}
-     */
-    getProjectSubTree(cloudPk) {
-      return this.getProjectSubTreeWithHttpInfo(cloudPk)
-        .then(function(response_and_data) {
-          return response_and_data.data;
-        });
-    }
-
-
     /**
      * Retrieve the complete DMS tree
      * Retrieve the complete DMS tree (all folders and all documents in the project). DEPRECATED: renamed to getProjectDMSTree
diff --git a/src/model/GroupFolderRead.js b/src/model/GroupFolderRead.js
@@ -53,7 +53,7 @@ class GroupFolderRead {
             obj = obj || new GroupFolderRead();
 
             if (data.hasOwnProperty('group')) {
-                obj['group'] = Group.constructFromObject(data['group']);
+                obj['group'] = ApiClient.convertToType(data['group'], Group);
             }
             if (data.hasOwnProperty('permission')) {
                 obj['permission'] = ApiClient.convertToType(data['permission'], 'Number');
diff --git a/src/model/PatchedProjectRequest.js b/src/model/PatchedProjectRequest.js
@@ -59,9 +59,6 @@ class PatchedProjectRequest {
             if (data.hasOwnProperty('status')) {
                 obj['status'] = ApiClient.convertToType(data['status'], 'String');
             }
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
-            }
             if (data.hasOwnProperty('main_model_id')) {
                 obj['main_model_id'] = ApiClient.convertToType(data['main_model_id'], 'Number');
             }
@@ -94,11 +91,6 @@ PatchedProjectRequest.prototype['description'] = undefined;
  */
 PatchedProjectRequest.prototype['status'] = undefined;
 
-/**
- * @member {Number} parent_id
- */
-PatchedProjectRequest.prototype['parent_id'] = undefined;
-
 /**
  * @member {Number} main_model_id
  */
diff --git a/src/model/Project.js b/src/model/Project.js
@@ -84,9 +84,6 @@ class Project {
             if (data.hasOwnProperty('updated_at')) {
                 obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'Date');
             }
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
-            }
             if (data.hasOwnProperty('root_folder_id')) {
                 obj['root_folder_id'] = ApiClient.convertToType(data['root_folder_id'], 'Number');
             }
@@ -144,11 +141,6 @@ Project.prototype['created_at'] = undefined;
  */
 Project.prototype['updated_at'] = undefined;
 
-/**
- * @member {Number} parent_id
- */
-Project.prototype['parent_id'] = undefined;
-
 /**
  * @member {Number} root_folder_id
  */
diff --git a/src/model/ProjectRequest.js b/src/model/ProjectRequest.js
@@ -61,9 +61,6 @@ class ProjectRequest {
             if (data.hasOwnProperty('status')) {
                 obj['status'] = ApiClient.convertToType(data['status'], 'String');
             }
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
-            }
             if (data.hasOwnProperty('main_model_id')) {
                 obj['main_model_id'] = ApiClient.convertToType(data['main_model_id'], 'Number');
             }
@@ -96,11 +93,6 @@ ProjectRequest.prototype['description'] = undefined;
  */
 ProjectRequest.prototype['status'] = undefined;
 
-/**
- * @member {Number} parent_id
- */
-ProjectRequest.prototype['parent_id'] = undefined;
-
 /**
  * @member {Number} main_model_id
  */
diff --git a/src/model/ProjectWithChildren.js b/src/model/ProjectWithChildren.js
@@ -82,9 +82,6 @@ class ProjectWithChildren {
             if (data.hasOwnProperty('updated_at')) {
                 obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'Date');
             }
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
-            }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [ProjectWithChildren]);
             }
@@ -140,11 +137,6 @@ ProjectWithChildren.prototype['created_at'] = undefined;
  */
 ProjectWithChildren.prototype['updated_at'] = undefined;
 
-/**
- * @member {Number} parent_id
- */
-ProjectWithChildren.prototype['parent_id'] = undefined;
-
 /**
  * @member {Array.<module:model/ProjectWithChildren>} children
  */
diff --git a/src/model/WriteFolderRequest.js b/src/model/WriteFolderRequest.js
@@ -49,12 +49,12 @@ class WriteFolderRequest {
         if (data) {
             obj = obj || new WriteFolderRequest();
 
-            if (data.hasOwnProperty('name')) {
-                obj['name'] = ApiClient.convertToType(data['name'], 'String');
-            }
             if (data.hasOwnProperty('default_permission')) {
                 obj['default_permission'] = ApiClient.convertToType(data['default_permission'], 'Number');
             }
+            if (data.hasOwnProperty('name')) {
+                obj['name'] = ApiClient.convertToType(data['name'], 'String');
+            }
             if (data.hasOwnProperty('parent_id')) {
                 obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
             }
@@ -68,18 +68,18 @@ class WriteFolderRequest {
 
 }
 
-/**
- * Name of the folder
- * @member {String} name
- */
-WriteFolderRequest.prototype['name'] = undefined;
-
 /**
  * Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write
  * @member {module:model/WriteFolderRequest.DefaultPermissionEnum} default_permission
  */
 WriteFolderRequest.prototype['default_permission'] = undefined;
 
+/**
+ * Name of the folder
+ * @member {String} name
+ */
+WriteFolderRequest.prototype['name'] = undefined;
+
 /**
  * @member {Number} parent_id
  */
diff --git a/test/api/CollaborationApi.spec.js b/test/api/CollaborationApi.spec.js
@@ -728,16 +728,6 @@
         done();
       });
     });
-    describe('getProjectSubTree', function() {
-      it('should call getProjectSubTree successfully', function(done) {
-        //uncomment below and update the code to test getProjectSubTree
-        //instance.getProjectSubTree(function(error) {
-        //  if (error) throw error;
-        //expect().to.be();
-        //});
-        done();
-      });
-    });
     describe('getProjectTree', function() {
       it('should call getProjectTree successfully', function(done) {
         //uncomment below and update the code to test getProjectTree
diff --git a/test/model/PatchedProjectRequest.spec.js b/test/model/PatchedProjectRequest.spec.js
@@ -78,12 +78,6 @@
       //expect(instance).to.be();
     });
 
-    it('should have the property parentId (base name: "parent_id")', function() {
-      // uncomment below and update the code to test the property parentId
-      //var instance = new bimdata.PatchedProjectRequest();
-      //expect(instance).to.be();
-    });
-
     it('should have the property mainModelId (base name: "main_model_id")', function() {
       // uncomment below and update the code to test the property mainModelId
       //var instance = new bimdata.PatchedProjectRequest();
diff --git a/test/model/Project.spec.js b/test/model/Project.spec.js
@@ -102,12 +102,6 @@
       //expect(instance).to.be();
     });
 
-    it('should have the property parentId (base name: "parent_id")', function() {
-      // uncomment below and update the code to test the property parentId
-      //var instance = new bimdata.Project();
-      //expect(instance).to.be();
-    });
-
     it('should have the property rootFolderId (base name: "root_folder_id")', function() {
       // uncomment below and update the code to test the property rootFolderId
       //var instance = new bimdata.Project();
diff --git a/test/model/ProjectRequest.spec.js b/test/model/ProjectRequest.spec.js
diff --git a/test/model/ProjectWithChildren.spec.js b/test/model/ProjectWithChildren.spec.js
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class GroupFolderRead {`
`53`	`53`	`obj = obj \|\| new GroupFolderRead();`
`54`	`54`
`55`	`55`	`if (data.hasOwnProperty('group')) {`
`56`		`- obj['group'] = Group.constructFromObject(data['group']);`
	`56`	`+ obj['group'] = ApiClient.convertToType(data['group'], Group);`
`57`	`57`	`}`
`58`	`58`	`if (data.hasOwnProperty('permission')) {`
`59`	`59`	`obj['permission'] = ApiClient.convertToType(data['permission'], 'Number');`