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

Commit 964ffc6

Browse files
Bimdata-ioBimdata-io
committed
MINOR: add project description (#659)
1 parent e4d9fb3 commit 964ffc6

File tree

88 files changed

+218
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+218
-128
lines changed

‎docs/CheckProjectAccess.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**hasAdminPermission** | **Boolean** | |
1010
**tokenScopes** | **[String]** | |
1111
**usableScopes** | **[String]** | Some tokens may have write scopes (eg: model:write) but the user of the token is a guest in the project so they can't use the scopes. |
12-
**userRole** | **Number** | | [optional]
12+
**userRole** | **Number** | * `100` - admin * `50` - user * `25` - guest | [optional]
1313

1414

1515

‎docs/CheckerResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Number** | | [readonly]
8-
**status** | **String** | | [optional]
8+
**status** | **String** | * `C` - completed * `P` - pending * `E` - errored | [optional]
99
**result** | **String** | | [optional]
1010
**collisions** | **String** | | [optional]
1111
**createdAt** | **Date** | | [readonly]

‎docs/CheckerResultRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**status** | **String** | | [optional]
7+
**status** | **String** | * `C` - completed * `P` - pending * `E` - errored | [optional]
88
**result** | **String** | | [optional]
99
**collisions** | **String** | | [optional]
1010
**errorDetail** | **String** | | [optional]

‎docs/CloudInvitation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**id** | **Number** | | [readonly]
88
**email** | **String** | email of the user to invite |
99
**redirectUri** | **String** | User will be redirected to this uri when they accept the invitation |
10-
**role** | **Number** | | [readonly]
10+
**role** | **Number** | * `100` - admin * `50` - user | [readonly]
1111

1212

1313

‎docs/CloudRole.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**cloud** | **Number** | |
8-
**role** | **Number** | Role of the user in the cloud | [optional]
8+
**role** | **Number** | Role of the user in the cloud * `100` - admin * `50` - user | [optional]
99

1010

1111

‎docs/CollaborationApi.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,7 @@ Name | Type | Description | Notes
955955
956956
Create a document
957957

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

960960
### Example
961961

@@ -988,8 +988,8 @@ let opts = {
988988
'parentId': 56, // Number |
989989
'fileName': "fileName_example", // String | Full name of the file
990990
'description': "description_example", // String | Description of the file
991-
'modelSource': "modelSource_example", // String | Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
992-
'ifcSource': "ifcSource_example", // String | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
991+
'modelSource': "modelSource_example", // String | Define the model.source field if the upload is a Model (IFC, PDF, DWG...) * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED
992+
'ifcSource': "ifcSource_example", // String | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED
993993
'successorOf': 56 // Number | Old document version to replace. Only for create
994994
};
995995
apiInstance.createDocument(cloudPk, projectPk, name, file, opts).then((data) => {
@@ -1012,8 +1012,8 @@ Name | Type | Description | Notes
10121012
**parentId** | **Number**| | [optional]
10131013
**fileName** | **String**| Full name of the file | [optional]
10141014
**description** | **String**| Description of the file | [optional]
1015-
**modelSource** | **String**| Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
1016-
**ifcSource** | **String**| DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
1015+
**modelSource** | **String**| Define the model.source field if the upload is a Model (IFC, PDF, DWG...) * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED | [optional]
1016+
**ifcSource** | **String**| DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED | [optional]
10171017
**successorOf** | **Number**| Old document version to replace. Only for create | [optional]
10181018

10191019
### Return type

‎docs/Folder.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**updatedAt** | **Date** | Date of the last update | [readonly]
1414
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
1515
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
16-
**defaultPermission** | **Number** | Permission for a Folder | [optional]
16+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1717
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
1818
**children** | [**[RecursiveFolderChildren]**](RecursiveFolderChildren.md) | | [readonly]
1919

‎docs/FolderUserProject.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
1212
**lastname** | **String** | | [readonly]
1313
**profilePicture** | **String** | | [readonly]
1414
**sub** | **String** | | [readonly]
15-
**role** | **Number** | | [readonly]
16-
**permission** | **Number** | | [readonly]
15+
**role** | **Number** | * `100` - admin * `50` - user * `25` - guest | [readonly]
16+
**permission** | **Number** | * `1` - denied * `50` - read_only * `100` - read_write | [readonly]
1717

1818

1919

‎docs/FolderWithoutChildren.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**updatedAt** | **Date** | Date of the last update | [readonly]
1414
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
1515
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
16-
**defaultPermission** | **Number** | Permission for a Folder | [optional]
16+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1717
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
1818

1919

‎docs/FolderWithoutChildrenRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**parentId** | **Number** | | [optional]
88
**name** | **String** | Name of the folder |
9-
**defaultPermission** | **Number** | Permission for a Folder | [optional]
9+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1010

1111

1212

0 commit comments

Comments
 (0)