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

Commit 2887e51

Browse files
Bimdata-ioBimdata-io
committed
PATCH: fix list/create methods openAPI
1 parent 8c360c1 commit 2887e51

17 files changed

Lines changed: 894 additions & 47 deletions

‎README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ Class | Method | HTTP request | Description
244244
*bimdata.CollaborationApi* | [**getClassifications**](docs/CollaborationApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
245245
*bimdata.CollaborationApi* | [**getCloud**](docs/CollaborationApi.md#getCloud) | **GET** /cloud/{id} | Retrieve one cloud
246246
*bimdata.CollaborationApi* | [**getCloudInvitations**](docs/CollaborationApi.md#getCloudInvitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
247-
*bimdata.CollaborationApi* | [**getCloudSize**](docs/CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all ifc files in the cloud
247+
*bimdata.CollaborationApi* | [**getCloudSize**](docs/CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Returns the sizes of the cloud in Bytes.
248248
*bimdata.CollaborationApi* | [**getCloudUser**](docs/CollaborationApi.md#getCloudUser) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
249249
*bimdata.CollaborationApi* | [**getCloudUsers**](docs/CollaborationApi.md#getCloudUsers) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
250250
*bimdata.CollaborationApi* | [**getClouds**](docs/CollaborationApi.md#getClouds) | **GET** /cloud | Retrieve all clouds
@@ -261,6 +261,7 @@ Class | Method | HTTP request | Description
261261
*bimdata.CollaborationApi* | [**getProjectAccessTokens**](docs/CollaborationApi.md#getProjectAccessTokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
262262
*bimdata.CollaborationApi* | [**getProjectDMSTree**](docs/CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
263263
*bimdata.CollaborationApi* | [**getProjectInvitations**](docs/CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
264+
*bimdata.CollaborationApi* | [**getProjectSize**](docs/CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all ifc files in the project
264265
*bimdata.CollaborationApi* | [**getProjectSubTree**](docs/CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
265266
*bimdata.CollaborationApi* | [**getProjectTree**](docs/CollaborationApi.md#getProjectTree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
266267
*bimdata.CollaborationApi* | [**getProjectUser**](docs/CollaborationApi.md#getProjectUser) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Retrieve a user in a project
@@ -444,6 +445,8 @@ Class | Method | HTTP request | Description
444445
- [bimdata.Direction](docs/Direction.md)
445446
- [bimdata.Document](docs/Document.md)
446447
- [bimdata.Element](docs/Element.md)
448+
- [bimdata.ElementClassificationRelation](docs/ElementClassificationRelation.md)
449+
- [bimdata.ElementPropertySetRelation](docs/ElementPropertySetRelation.md)
447450
- [bimdata.Extensions](docs/Extensions.md)
448451
- [bimdata.Feature](docs/Feature.md)
449452
- [bimdata.Folder](docs/Folder.md)
@@ -489,6 +492,7 @@ Class | Method | HTTP request | Description
489492
- [bimdata.ProjectAccessToken](docs/ProjectAccessToken.md)
490493
- [bimdata.ProjectInvitation](docs/ProjectInvitation.md)
491494
- [bimdata.ProjectRole](docs/ProjectRole.md)
495+
- [bimdata.ProjectSize](docs/ProjectSize.md)
492496
- [bimdata.ProjectWithChildren](docs/ProjectWithChildren.md)
493497
- [bimdata.Property](docs/Property.md)
494498
- [bimdata.PropertyDefinition](docs/PropertyDefinition.md)
@@ -514,6 +518,7 @@ Class | Method | HTTP request | Description
514518
- [bimdata.SelfBcfUser](docs/SelfBcfUser.md)
515519
- [bimdata.SelfUser](docs/SelfUser.md)
516520
- [bimdata.SimpleElement](docs/SimpleElement.md)
521+
- [bimdata.Size](docs/Size.md)
517522
- [bimdata.Snapshot](docs/Snapshot.md)
518523
- [bimdata.Space](docs/Space.md)
519524
- [bimdata.Stage](docs/Stage.md)

‎docs/CollaborationApi.md‎

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Method | HTTP request | Description
4141
[**getClassifications**](CollaborationApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
4242
[**getCloud**](CollaborationApi.md#getCloud) | **GET** /cloud/{id} | Retrieve one cloud
4343
[**getCloudInvitations**](CollaborationApi.md#getCloudInvitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
44-
[**getCloudSize**](CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all ifc files in the cloud
44+
[**getCloudSize**](CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Returns the sizes of the cloud in Bytes.
4545
[**getCloudUser**](CollaborationApi.md#getCloudUser) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
4646
[**getCloudUsers**](CollaborationApi.md#getCloudUsers) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
4747
[**getClouds**](CollaborationApi.md#getClouds) | **GET** /cloud | Retrieve all clouds
@@ -58,6 +58,7 @@ Method | HTTP request | Description
5858
[**getProjectAccessTokens**](CollaborationApi.md#getProjectAccessTokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
5959
[**getProjectDMSTree**](CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
6060
[**getProjectInvitations**](CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
61+
[**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all ifc files in the project
6162
[**getProjectSubTree**](CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
6263
[**getProjectTree**](CollaborationApi.md#getProjectTree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
6364
[**getProjectUser**](CollaborationApi.md#getProjectUser) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Retrieve a user in a project
@@ -2321,11 +2322,11 @@ Name | Type | Description | Notes
23212322

23222323
## getCloudSize
23232324

2324-
> Number getCloudSize(id)
2325+
> Size getCloudSize(id)
23252326
2326-
Get size of all ifc files in the cloud
2327+
Returns the sizes of the cloud in Bytes.
23272328

2328-
Returns the size of the cloud in Bytes
2329+
Returns the sizes of the cloud in Bytes. The response fields depends on the role of the user. If the user is an admin, all field will be returned. If the user is a standard user, only `remaining_total_size` and `remaining_smart_data_size` will be set. If the call is made from an API access, role admin (100) will be returned and all fields will be set. The fields `managed by` indicate if the subscription for this cloud is an API subscription or a BIMData Platform subscription. If the cloud is managed by an API plan, the remaining sizes will take others organizations's clouds size into account
23292330

23302331
### Example
23312332

@@ -2363,7 +2364,7 @@ Name | Type | Description | Notes
23632364

23642365
### Return type
23652366

2366-
**Number**
2367+
[**Size**](Size.md)
23672368

23682369
### Authorization
23692370

@@ -3315,6 +3316,64 @@ Name | Type | Description | Notes
33153316
- **Accept**: application/json
33163317

33173318

3319+
## getProjectSize
3320+
3321+
> ProjectSize getProjectSize(cloudPk, id)
3322+
3323+
Get size of all ifc files in the project
3324+
3325+
Returns the size of the project in Bytes
3326+
3327+
### Example
3328+
3329+
```javascript
3330+
import bimdata from '@bimdata/bimdata-api-client';
3331+
let defaultClient = bimdata.ApiClient.instance;
3332+
// Configure API key authorization: Bearer
3333+
let Bearer = defaultClient.authentications['Bearer'];
3334+
Bearer.apiKey = 'YOUR API KEY';
3335+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3336+
//Bearer.apiKeyPrefix = 'Token';
3337+
// Configure OAuth2 access token for authorization: bimdata_connect
3338+
let bimdata_connect = defaultClient.authentications['bimdata_connect'];
3339+
bimdata_connect.accessToken = 'YOUR ACCESS TOKEN';
3340+
// Configure OAuth2 access token for authorization: client_credentials
3341+
let client_credentials = defaultClient.authentications['client_credentials'];
3342+
client_credentials.accessToken = 'YOUR ACCESS TOKEN';
3343+
3344+
let apiInstance = new bimdata.CollaborationApi();
3345+
let cloudPk = "cloudPk_example"; // String |
3346+
let id = 56; // Number | A unique integer value identifying this project.
3347+
apiInstance.getProjectSize(cloudPk, id).then((data) => {
3348+
console.log('API called successfully. Returned data: ' + data);
3349+
}, (error) => {
3350+
console.error(error);
3351+
});
3352+
3353+
```
3354+
3355+
### Parameters
3356+
3357+
3358+
Name | Type | Description | Notes
3359+
------------- | ------------- | ------------- | -------------
3360+
**cloudPk** | **String**| |
3361+
**id** | **Number**| A unique integer value identifying this project. |
3362+
3363+
### Return type
3364+
3365+
[**ProjectSize**](ProjectSize.md)
3366+
3367+
### Authorization
3368+
3369+
[Bearer](../README.md#Bearer), [bimdata_connect](../README.md#bimdata_connect), [client_credentials](../README.md#client_credentials)
3370+
3371+
### HTTP request headers
3372+
3373+
- **Content-Type**: Not defined
3374+
- **Accept**: application/json
3375+
3376+
33183377
## getProjectSubTree
33193378

33203379
> [ProjectWithChildren] getProjectSubTree(cloudPk)

‎docs/ElementClassificationRelation.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# bimdata.ElementClassificationRelation
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**elementUuid** | **String** | |
8+
**classificationId** | **Number** | |
9+
10+

‎docs/ElementPropertySetRelation.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# bimdata.ElementPropertySetRelation
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**elementUuid** | **String** | |
8+
**propertySetId** | **Number** | |
9+
10+

‎docs/IfcApi.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -937,11 +937,11 @@ Name | Type | Description | Notes
937937

938938
## createClassificationElementRelations
939939

940-
> createClassificationElementRelations(cloudPk, ifcPk, projectPk)
940+
> createClassificationElementRelations(cloudPk, ifcPk, projectPk, data)
941941
942942
Create association between existing classification and existing element
943943

944-
Required scopes: ifc:write
944+
Create association between existing classification and existing element Required scopes: ifc:write
945945

946946
### Example
947947

@@ -964,7 +964,8 @@ let apiInstance = new bimdata.IfcApi();
964964
let cloudPk = "cloudPk_example"; // String |
965965
let ifcPk = "ifcPk_example"; // String |
966966
let projectPk = "projectPk_example"; // String |
967-
apiInstance.createClassificationElementRelations(cloudPk, ifcPk, projectPk).then(() => {
967+
let data = [new bimdata.ElementClassificationRelation()]; // [ElementClassificationRelation] |
968+
apiInstance.createClassificationElementRelations(cloudPk, ifcPk, projectPk, data).then(() => {
968969
console.log('API called successfully.');
969970
}, (error) => {
970971
console.error(error);
@@ -980,6 +981,7 @@ Name | Type | Description | Notes
980981
**cloudPk** | **String**| |
981982
**ifcPk** | **String**| |
982983
**projectPk** | **String**| |
984+
**data** | [**[ElementClassificationRelation]**](ElementClassificationRelation.md)| |
983985

984986
### Return type
985987

@@ -991,7 +993,7 @@ null (empty response body)
991993

992994
### HTTP request headers
993995

994-
- **Content-Type**: Not defined
996+
- **Content-Type**: application/json
995997
- **Accept**: Not defined
996998

997999

@@ -1639,11 +1641,11 @@ Name | Type | Description | Notes
16391641

16401642
## createPropertySetElementRelations
16411643

1642-
> createPropertySetElementRelations(cloudPk, ifcPk, projectPk)
1644+
> createPropertySetElementRelations(cloudPk, ifcPk, projectPk, data)
16431645
16441646
Create association between PropertySet and element
16451647

1646-
Required scopes: ifc:write
1648+
Create association between existing PropertySet and existing element Required scopes: ifc:write
16471649

16481650
### Example
16491651

@@ -1666,7 +1668,8 @@ let apiInstance = new bimdata.IfcApi();
16661668
let cloudPk = "cloudPk_example"; // String |
16671669
let ifcPk = "ifcPk_example"; // String |
16681670
let projectPk = "projectPk_example"; // String |
1669-
apiInstance.createPropertySetElementRelations(cloudPk, ifcPk, projectPk).then(() => {
1671+
let data = [new bimdata.ElementPropertySetRelation()]; // [ElementPropertySetRelation] |
1672+
apiInstance.createPropertySetElementRelations(cloudPk, ifcPk, projectPk, data).then(() => {
16701673
console.log('API called successfully.');
16711674
}, (error) => {
16721675
console.error(error);
@@ -1682,6 +1685,7 @@ Name | Type | Description | Notes
16821685
**cloudPk** | **String**| |
16831686
**ifcPk** | **String**| |
16841687
**projectPk** | **String**| |
1688+
**data** | [**[ElementPropertySetRelation]**](ElementPropertySetRelation.md)| |
16851689

16861690
### Return type
16871691

@@ -1693,7 +1697,7 @@ null (empty response body)
16931697

16941698
### HTTP request headers
16951699

1696-
- **Content-Type**: Not defined
1700+
- **Content-Type**: application/json
16971701
- **Accept**: Not defined
16981702

16991703

@@ -6779,11 +6783,11 @@ Name | Type | Description | Notes
67796783

67806784
## listClassificationElementRelations
67816785

6782-
> listClassificationElementRelations(cloudPk, ifcPk, projectPk)
6786+
> [ElementClassificationRelation] listClassificationElementRelations(cloudPk, ifcPk, projectPk)
67836787
67846788
List all associations between classifications and elements
67856789

6786-
Required scopes: ifc:read
6790+
List all associations between classifications and elements Required scopes: ifc:read
67876791

67886792
### Example
67896793

@@ -6806,8 +6810,8 @@ let apiInstance = new bimdata.IfcApi();
68066810
let cloudPk = "cloudPk_example"; // String |
68076811
let ifcPk = "ifcPk_example"; // String |
68086812
let projectPk = "projectPk_example"; // String |
6809-
apiInstance.listClassificationElementRelations(cloudPk, ifcPk, projectPk).then(() => {
6810-
console.log('API called successfully.');
6813+
apiInstance.listClassificationElementRelations(cloudPk, ifcPk, projectPk).then((data) => {
6814+
console.log('API called successfully. Returned data: ' + data);
68116815
}, (error) => {
68126816
console.error(error);
68136817
});
@@ -6825,7 +6829,7 @@ Name | Type | Description | Notes
68256829

68266830
### Return type
68276831

6828-
null (empty response body)
6832+
[**[ElementClassificationRelation]**](ElementClassificationRelation.md)
68296833

68306834
### Authorization
68316835

@@ -6834,7 +6838,7 @@ null (empty response body)
68346838
### HTTP request headers
68356839

68366840
- **Content-Type**: Not defined
6837-
- **Accept**: Not defined
6841+
- **Accept**: application/json
68386842

68396843

68406844
## mergeIfcs

‎docs/ProjectSize.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# bimdata.ProjectSize
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**totalSize** | **Number** | | [optional] [readonly]
8+
**smartDataSize** | **Number** | | [optional] [readonly]
9+
10+

‎docs/Size.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# bimdata.Size
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**managedBy** | **String** | |
8+
**role** | **String** | |
9+
**totalSize** | **Number** | | [optional] [readonly]
10+
**smartDataSize** | **Number** | | [optional] [readonly]
11+
**totalSizeAvailable** | **Number** | | [optional] [readonly]
12+
**smartDataSizeAvailable** | **Number** | | [optional] [readonly]
13+
**remainingTotalSize** | **Number** | | [optional] [readonly]
14+
**remainingSmartDataSize** | **Number** | | [optional] [readonly]
15+
**remainingTotalSizePercent** | **Number** | | [optional] [readonly]
16+
**remainingSmartDataSizePercent** | **Number** | | [optional] [readonly]
17+
18+
19+
20+
## Enum: ManagedByEnum
21+
22+
23+
* `BIMDATA_PLATFORM` (value: `"BIMDATA_PLATFORM"`)
24+
25+
* `ORGANIZATION` (value: `"ORGANIZATION"`)
26+
27+
28+
29+
30+
31+
## Enum: RoleEnum
32+
33+
34+
* `A` (value: `"A"`)
35+
36+
* `D` (value: `"D"`)
37+
38+
39+
40+

0 commit comments

Comments
 (0)