Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Commit 14dbd0c

Browse files
committed
PATCH: add response data to create DMSTree
1 parent 1099a20 commit 14dbd0c

18 files changed

+784
-23
lines changed

.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ docs/FeatureRequest.md
4747
docs/Folder.md
4848
docs/FolderGroupPermission.md
4949
docs/FolderGroupPermissionRequest.md
50+
docs/FolderTree.md
5051
docs/FolderUserProject.md
5152
docs/FolderWithoutChildren.md
5253
docs/FolderWithoutChildrenRequest.md
@@ -151,6 +152,7 @@ docs/ProcessorHandler.md
151152
docs/Project.md
152153
docs/ProjectAccessToken.md
153154
docs/ProjectAccessTokenRequest.md
155+
docs/ProjectFolderTree.md
154156
docs/ProjectInvitation.md
155157
docs/ProjectInvitationRequest.md
156158
docs/ProjectRequest.md
@@ -299,6 +301,7 @@ src/model/FeatureRequest.js
299301
src/model/Folder.js
300302
src/model/FolderGroupPermission.js
301303
src/model/FolderGroupPermissionRequest.js
304+
src/model/FolderTree.js
302305
src/model/FolderUserProject.js
303306
src/model/FolderWithoutChildren.js
304307
src/model/FolderWithoutChildrenRequest.js
@@ -401,6 +404,7 @@ src/model/ProcessorHandler.js
401404
src/model/Project.js
402405
src/model/ProjectAccessToken.js
403406
src/model/ProjectAccessTokenRequest.js
407+
src/model/ProjectFolderTree.js
404408
src/model/ProjectInvitation.js
405409
src/model/ProjectInvitationRequest.js
406410
src/model/ProjectRequest.js
@@ -543,6 +547,7 @@ test/model/FeatureRequest.spec.js
543547
test/model/Folder.spec.js
544548
test/model/FolderGroupPermission.spec.js
545549
test/model/FolderGroupPermissionRequest.spec.js
550+
test/model/FolderTree.spec.js
546551
test/model/FolderUserProject.spec.js
547552
test/model/FolderWithoutChildren.spec.js
548553
test/model/FolderWithoutChildrenRequest.spec.js
@@ -645,6 +650,7 @@ test/model/ProcessorHandler.spec.js
645650
test/model/Project.spec.js
646651
test/model/ProjectAccessToken.spec.js
647652
test/model/ProjectAccessTokenRequest.spec.js
653+
test/model/ProjectFolderTree.spec.js
648654
test/model/ProjectInvitation.spec.js
649655
test/model/ProjectInvitationRequest.spec.js
650656
test/model/ProjectRequest.spec.js

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ Class | Method | HTTP request | Description
284284
*bimdata.CollaborationApi* | [**getProjectAccessTokens**](docs/CollaborationApi.md#getProjectAccessTokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
285285
*bimdata.CollaborationApi* | [**getProjectCreatorVisas**](docs/CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
286286
*bimdata.CollaborationApi* | [**getProjectDMSTree**](docs/CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
287+
*bimdata.CollaborationApi* | [**getProjectFolderTreeSerializers**](docs/CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects
287288
*bimdata.CollaborationApi* | [**getProjectInvitations**](docs/CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
288289
*bimdata.CollaborationApi* | [**getProjectSize**](docs/CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
289290
*bimdata.CollaborationApi* | [**getProjectSubTree**](docs/CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
@@ -677,6 +678,7 @@ Class | Method | HTTP request | Description
677678
- [bimdata.Folder](docs/Folder.md)
678679
- [bimdata.FolderGroupPermission](docs/FolderGroupPermission.md)
679680
- [bimdata.FolderGroupPermissionRequest](docs/FolderGroupPermissionRequest.md)
681+
- [bimdata.FolderTree](docs/FolderTree.md)
680682
- [bimdata.FolderUserProject](docs/FolderUserProject.md)
681683
- [bimdata.FolderWithoutChildren](docs/FolderWithoutChildren.md)
682684
- [bimdata.FolderWithoutChildrenRequest](docs/FolderWithoutChildrenRequest.md)
@@ -779,6 +781,7 @@ Class | Method | HTTP request | Description
779781
- [bimdata.Project](docs/Project.md)
780782
- [bimdata.ProjectAccessToken](docs/ProjectAccessToken.md)
781783
- [bimdata.ProjectAccessTokenRequest](docs/ProjectAccessTokenRequest.md)
784+
- [bimdata.ProjectFolderTree](docs/ProjectFolderTree.md)
782785
- [bimdata.ProjectInvitation](docs/ProjectInvitation.md)
783786
- [bimdata.ProjectInvitationRequest](docs/ProjectInvitationRequest.md)
784787
- [bimdata.ProjectRequest](docs/ProjectRequest.md)

docs/CollaborationApi.md

Lines changed: 70 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Method | HTTP request | Description
6464
[**getProjectAccessTokens**](CollaborationApi.md#getProjectAccessTokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
6565
[**getProjectCreatorVisas**](CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
6666
[**getProjectDMSTree**](CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
67+
[**getProjectFolderTreeSerializers**](CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects
6768
[**getProjectInvitations**](CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
6869
[**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
6970
[**getProjectSubTree**](CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
@@ -693,7 +694,7 @@ Name | Type | Description | Notes
693694

694695
## createDMSTree
695696

696-
> createDMSTree(cloudPk, id, writeFolderRequest)
697+
> [Folder] createDMSTree(cloudPk, id, writeFolderRequest)
697698
698699
Create a complete DMS tree
699700

@@ -725,8 +726,8 @@ let apiInstance = new bimdata.CollaborationApi();
725726
let cloudPk = 56; // Number |
726727
let id = 56; // Number | A unique integer value identifying this project.
727728
let writeFolderRequest = [new bimdata.WriteFolderRequest()]; // [WriteFolderRequest] |
728-
apiInstance.createDMSTree(cloudPk, id, writeFolderRequest).then(() => {
729-
console.log('API called successfully.');
729+
apiInstance.createDMSTree(cloudPk, id, writeFolderRequest).then((data) => {
730+
console.log('API called successfully. Returned data: ' + data);
730731
}, (error) => {
731732
console.error(error);
732733
});
@@ -744,7 +745,7 @@ Name | Type | Description | Notes
744745

745746
### Return type
746747

747-
null (empty response body)
748+
[**[Folder]**](Folder.md)
748749

749750
### Authorization
750751

@@ -753,7 +754,7 @@ null (empty response body)
753754
### HTTP request headers
754755

755756
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
756-
- **Accept**: Not defined
757+
- **Accept**: application/json
757758

758759

759760
## createDemo
@@ -823,7 +824,7 @@ Name | Type | Description | Notes
823824
824825
Create a document
825826

826-
Create a document. If the document is one of {'DXF', 'IFC', 'DWG', 'OBJ', 'DAE', 'GLTF', 'BFX'}, a model will be created and attached to this document Required scopes: document:write
827+
Create a document. If the document is one of {'DXF', 'BFX', 'DAE', 'IFC', 'GLTF', 'DWG', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write
827828

828829
### Example
829830

@@ -4008,6 +4009,67 @@ Name | Type | Description | Notes
40084009
- **Accept**: application/json
40094010

40104011

4012+
## getProjectFolderTreeSerializers
4013+
4014+
> [ProjectFolderTree] getProjectFolderTreeSerializers(cloudPk)
4015+
4016+
Retrieve folder tree for all projects
4017+
4018+
Retrieve folder tree for all projects
4019+
4020+
### Example
4021+
4022+
```javascript
4023+
import bimdata from '@bimdata/bimdata-api-client';
4024+
let defaultClient = bimdata.ApiClient.instance;
4025+
// Configure API key authorization: ApiKey
4026+
let ApiKey = defaultClient.authentications['ApiKey'];
4027+
ApiKey.apiKey = 'YOUR API KEY';
4028+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
4029+
//ApiKey.apiKeyPrefix = 'Token';
4030+
// Configure OAuth2 access token for authorization: BIMData_Connect
4031+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
4032+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
4033+
// Configure OAuth2 access token for authorization: BIMData_Connect
4034+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
4035+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
4036+
// Configure API key authorization: Bearer
4037+
let Bearer = defaultClient.authentications['Bearer'];
4038+
Bearer.apiKey = 'YOUR API KEY';
4039+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
4040+
//Bearer.apiKeyPrefix = 'Token';
4041+
4042+
let apiInstance = new bimdata.CollaborationApi();
4043+
let cloudPk = 56; // Number |
4044+
apiInstance.getProjectFolderTreeSerializers(cloudPk).then((data) => {
4045+
console.log('API called successfully. Returned data: ' + data);
4046+
}, (error) => {
4047+
console.error(error);
4048+
});
4049+
4050+
```
4051+
4052+
### Parameters
4053+
4054+
4055+
Name | Type | Description | Notes
4056+
------------- | ------------- | ------------- | -------------
4057+
**cloudPk** | **Number**| |
4058+
4059+
### Return type
4060+
4061+
[**[ProjectFolderTree]**](ProjectFolderTree.md)
4062+
4063+
### Authorization
4064+
4065+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
4066+
4067+
### HTTP request headers
4068+
4069+
- **Content-Type**: Not defined
4070+
- **Accept**: application/json
4071+
4072+
40114073
## getProjectInvitations
40124074

40134075
> [ProjectInvitation] getProjectInvitations(cloudPk, projectPk)
@@ -5905,7 +5967,7 @@ Name | Type | Description | Notes
59055967
59065968
Update some fields of a folder
59075969

5908-
Update some fields of a folder. Only project admins can update the `default_permission` field Required scopes: document:write
5970+
Update some fields of a folder. Only project admins can update the `default_permission` field. `default_permission` choices are : ``` 1: ACCESS_DENIED, 50: READ_ONLY, 100: READ_WRTIE ``` When this route is used, the permission of all children in the folder will be updated unless a child has already been updated with this route. In this case, if the updated permission is the same as the previously modified child's, the child will lose its \"independence\" and follow the parent's future permission when it is modified again. Caution: The 'default_permission' field is not applied to users belonging to one or more groups. Required scopes: document:write
59095971

59105972
### Example
59115973

@@ -5974,7 +6036,7 @@ Name | Type | Description | Notes
59746036
59756037
Update the permission of a group on a folder
59766038

5977-
Update the permission of a group on a folder. 0: ACCESS_DENIED, 50: READ_ONLY, 100: READ_WRTIE Required scopes: org:manage
6039+
Update the permission of a group on a folder. Permissions choices are : ``` 1: ACCESS_DENIED, 50: READ_ONLY, 100: READ_WRTIE ``` When this route is used, the permission of all children in the folder will be updated unless a child has already been updated with this route. In this case, if the updated permission is the same as the previously modified child's, the child will lose its \"independence\" and follow the parent's future permission when it is modified again. Required scopes: org:manage
59786040

59796041
### Example
59806042

docs/FolderTree.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# bimdata.FolderTree
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**children** | [**[FolderTree]**](FolderTree.md) | |
8+
**name** | **String** | |
9+
10+

docs/PatchedProjectAccessTokenRequest.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,30 @@ Name | Type | Description | Notes
88
**expiresAt** | **Date** | | [optional]
99

1010

11+
12+
## Enum: [ScopesEnum]
13+
14+
15+
* `bcf:read` (value: `"bcf:read"`)
16+
17+
* `bcf:write` (value: `"bcf:write"`)
18+
19+
* `document:read` (value: `"document:read"`)
20+
21+
* `document:write` (value: `"document:write"`)
22+
23+
* `ifc:read` (value: `"ifc:read"`)
24+
25+
* `ifc:write` (value: `"ifc:write"`)
26+
27+
* `model:read` (value: `"model:read"`)
28+
29+
* `model:write` (value: `"model:write"`)
30+
31+
* `empty` (value: `""`)
32+
33+
* `null` (value: `"null"`)
34+
35+
36+
37+

docs/ProjectAccessToken.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,30 @@ Name | Type | Description | Notes
99
**expiresAt** | **Date** | | [optional]
1010

1111

12+
13+
## Enum: [ScopesEnum]
14+
15+
16+
* `bcf:read` (value: `"bcf:read"`)
17+
18+
* `bcf:write` (value: `"bcf:write"`)
19+
20+
* `document:read` (value: `"document:read"`)
21+
22+
* `document:write` (value: `"document:write"`)
23+
24+
* `ifc:read` (value: `"ifc:read"`)
25+
26+
* `ifc:write` (value: `"ifc:write"`)
27+
28+
* `model:read` (value: `"model:read"`)
29+
30+
* `model:write` (value: `"model:write"`)
31+
32+
* `empty` (value: `""`)
33+
34+
* `null` (value: `"null"`)
35+
36+
37+
38+

docs/ProjectAccessTokenRequest.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,30 @@ Name | Type | Description | Notes
88
**expiresAt** | **Date** | | [optional]
99

1010

11+
12+
## Enum: [ScopesEnum]
13+
14+
15+
* `bcf:read` (value: `"bcf:read"`)
16+
17+
* `bcf:write` (value: `"bcf:write"`)
18+
19+
* `document:read` (value: `"document:read"`)
20+
21+
* `document:write` (value: `"document:write"`)
22+
23+
* `ifc:read` (value: `"ifc:read"`)
24+
25+
* `ifc:write` (value: `"ifc:write"`)
26+
27+
* `model:read` (value: `"model:read"`)
28+
29+
* `model:write` (value: `"model:write"`)
30+
31+
* `empty` (value: `""`)
32+
33+
* `null` (value: `"null"`)
34+
35+
36+
37+

docs/ProjectFolderTree.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# bimdata.ProjectFolderTree
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **String** | |
8+
**folders** | [**[FolderTree]**](FolderTree.md) | |
9+
10+

0 commit comments

Comments
 (0)