diff --git a/README.md b/README.md index 92312d3..ecc4f1c 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,6 @@ Class | Method | HTTP request | Description *bimdata.CollaborationApi* | [**getProjectCreatorVisas**](docs/CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user *bimdata.CollaborationApi* | [**getProjectDMSTree**](docs/CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree *bimdata.CollaborationApi* | [**getProjectFolderTree**](docs/CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project -*bimdata.CollaborationApi* | [**getProjectFolderTreeSerializers**](docs/CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects *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 diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md index 98466b5..02a9de2 100644 --- a/docs/CollaborationApi.md +++ b/docs/CollaborationApi.md @@ -69,7 +69,6 @@ Method | HTTP request | Description [**getProjectCreatorVisas**](CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user [**getProjectDMSTree**](CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree [**getProjectFolderTree**](CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project -[**getProjectFolderTreeSerializers**](CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects [**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 @@ -961,7 +960,7 @@ Name | Type | Description | Notes Create a document -Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'OBJ', 'GLTF', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write +Create a document. If the document is one of {'OBJ', 'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'DXF'}, a model will be created and attached to this document Required scopes: document:write ### Example @@ -4376,7 +4375,7 @@ Name | Type | Description | Notes ## getProjectFolderTree -> ProjectFolderTree getProjectFolderTree(cloudPk, id) +> [ProjectFolderTree] getProjectFolderTree(cloudPk, id) Retrieve folder tree of the project @@ -4425,67 +4424,6 @@ Name | Type | Description | Notes ### Return type -[**ProjectFolderTree**](ProjectFolderTree.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 - - -## getProjectFolderTreeSerializers - -> [ProjectFolderTree] getProjectFolderTreeSerializers(cloudPk) - -Retrieve folder tree for all projects - -Retrieve folder tree for all projects - -### 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.getProjectFolderTreeSerializers(cloudPk).then((data) => { - console.log('API called successfully. Returned data: ' + data); -}, (error) => { - console.error(error); -}); - -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **cloudPk** | **Number**| | - -### Return type - [**[ProjectFolderTree]**](ProjectFolderTree.md) ### Authorization diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js index d3a6cc3..a491999 100644 --- a/src/api/CollaborationApi.js +++ b/src/api/CollaborationApi.js @@ -865,7 +865,7 @@ export default class CollaborationApi { /** * Create a document - * Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'OBJ', 'GLTF', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write + * Create a document. If the document is one of {'OBJ', 'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'DXF'}, 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 @@ -931,7 +931,7 @@ export default class CollaborationApi { /** * Create a document - * Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'OBJ', 'GLTF', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write + * Create a document. If the document is one of {'OBJ', 'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'DXF'}, 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 @@ -4121,7 +4121,7 @@ export default class CollaborationApi { * Retrieve folder tree of the project * @param {Number} cloudPk * @param {Number} id A unique integer value identifying this project. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProjectFolderTree} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ getProjectFolderTreeWithHttpInfo(cloudPk, id) { let postBody = null; @@ -4148,7 +4148,7 @@ export default class CollaborationApi { let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer']; let contentTypes = []; let accepts = ['application/json']; - let returnType = ProjectFolderTree; + let returnType = [ProjectFolderTree]; return this.apiClient.callApi( '/cloud/{cloud_pk}/project/{id}/folder-tree', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -4161,7 +4161,7 @@ export default class CollaborationApi { * Retrieve folder tree of the project * @param {Number} cloudPk * @param {Number} id A unique integer value identifying this project. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectFolderTree} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ getProjectFolderTree(cloudPk, id) { return this.getProjectFolderTreeWithHttpInfo(cloudPk, id) @@ -4171,54 +4171,6 @@ export default class CollaborationApi { } - /** - * Retrieve folder tree for all projects - * Retrieve folder tree for all projects - * @param {Number} cloudPk - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response - */ - getProjectFolderTreeSerializersWithHttpInfo(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 getProjectFolderTreeSerializers"); - } - - 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 = [ProjectFolderTree]; - return this.apiClient.callApi( - '/cloud/{cloud_pk}/project/folder-trees', 'GET', - pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType, null - ); - } - - /** - * Retrieve folder tree for all projects - * Retrieve folder tree for all projects - * @param {Number} cloudPk - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} - */ - getProjectFolderTreeSerializers(cloudPk) { - return this.getProjectFolderTreeSerializersWithHttpInfo(cloudPk) - .then(function(response_and_data) { - return response_and_data.data; - }); - } - - /** * Retrieve all pending invitations in the project * Returns app's invitations only Required scopes: org:manage diff --git a/test/api/CollaborationApi.spec.js b/test/api/CollaborationApi.spec.js index c9c0483..d5506cb 100644 --- a/test/api/CollaborationApi.spec.js +++ b/test/api/CollaborationApi.spec.js @@ -698,16 +698,6 @@ done(); }); }); - describe('getProjectFolderTreeSerializers', function() { - it('should call getProjectFolderTreeSerializers successfully', function(done) { - //uncomment below and update the code to test getProjectFolderTreeSerializers - //instance.getProjectFolderTreeSerializers(function(error) { - // if (error) throw error; - //expect().to.be(); - //}); - done(); - }); - }); describe('getProjectInvitations', function() { it('should call getProjectInvitations successfully', function(done) { //uncomment below and update the code to test getProjectInvitations