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

Commit aa33f22

Browse files
Bimdata-ioBimdata-io
committed
PATCH: fix model_type documentation
1 parent 9ea2a48 commit aa33f22

File tree

11 files changed

+127
-127
lines changed

11 files changed

+127
-127
lines changed

‎docs/CollaborationApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -961,7 +961,7 @@ Name | Type | Description | Notes
961961
962962
Create a document
963963

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

966966
### Example
967967

‎docs/DocumentText.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Number** | | [readonly]
88
**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
9-
**language** | **String** | * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french | [optional]
9+
**language** | **String** | * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german | [optional]
1010

1111

1212

1313
## Enum: LanguageEnum
1414

1515

16-
* `german` (value: `"german"`)
16+
* `french` (value: `"french"`)
17+
18+
* `italian` (value: `"italian"`)
1719

1820
* `english` (value: `"english"`)
1921

2022
* `spanish` (value: `"spanish"`)
2123

22-
* `italian` (value: `"italian"`)
23-
24-
* `french` (value: `"french"`)
24+
* `german` (value: `"german"`)
2525

2626
* `null` (value: `"null"`)
2727

‎docs/ModelApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7498,7 +7498,7 @@ let projectPk = 56; // Number |
74987498
let opts = {
74997499
'source': "source_example", // String | * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED
75007500
'status': ["null"], // [String] | * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix
7501-
'type': ["null"] // [String] | * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
7501+
'type': ["null"] // [String] | * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
75027502
};
75037503
apiInstance.getModels(cloudPk, projectPk, opts).then((data) => {
75047504
console.log('API called successfully. Returned data: ' + data);
@@ -7517,7 +7517,7 @@ Name | Type | Description | Notes
75177517
**projectPk** | **Number**| |
75187518
**source** | **String**| * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED | [optional]
75197519
**status** | [**[String]**](String.md)| * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix | [optional]
7520-
**type** | [**[String]**](String.md)| * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING | [optional]
7520+
**type** | [**[String]**](String.md)| * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING | [optional]
75217521

75227522
### Return type
75237523

‎docs/PatchedDocumentTextRequest.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
8-
**language** | **String** | * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french | [optional]
8+
**language** | **String** | * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german | [optional]
99

1010

1111

1212
## Enum: LanguageEnum
1313

1414

15-
* `german` (value: `"german"`)
15+
* `french` (value: `"french"`)
16+
17+
* `italian` (value: `"italian"`)
1618

1719
* `english` (value: `"english"`)
1820

1921
* `spanish` (value: `"spanish"`)
2022

21-
* `italian` (value: `"italian"`)
22-
23-
* `french` (value: `"french"`)
23+
* `german` (value: `"german"`)
2424

2525
* `null` (value: `"null"`)
2626

‎docs/WriteFolder.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7+
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
8+
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
79
**name** | **String** | Name of the folder |
8-
**createdAt** | **Date** | Creation date | [readonly]
10+
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
911
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
10-
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
1112
**id** | **Number** | | [readonly]
12-
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
1313
**parentId** | **Number** | | [optional]
14-
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
15-
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
16-
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
1714
**updatedAt** | **Date** | Date of the last update | [readonly]
15+
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
16+
**createdAt** | **Date** | Creation date | [readonly]
17+
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
1818
**children** | [**[WriteFolder]**](WriteFolder.md) | | [optional]
1919

2020

2121

22-
## Enum: DefaultPermissionEnum
22+
## Enum: UserPermissionEnum
2323

2424

2525
* `1` (value: `1`)
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
3232

3333

3434

35-
## Enum: UserPermissionEnum
35+
## Enum: DefaultPermissionEnum
3636

3737

3838
* `1` (value: `1`)

‎src/api/CollaborationApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ export default class CollaborationApi {
868868

869869
/**
870870
* Create a document
871-
* Create a document. If the document is one of {'DWG', 'PHOTOSPHERE', 'GLTF', 'IFC', 'DXF', 'POINT_CLOUD', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write
871+
* Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write
872872
* @param {Number} cloudPk A unique integer value identifying this cloud.
873873
* @param {Number} projectPk A unique integer value identifying this project.
874874
* @param {String} name Shown name of the file
@@ -936,7 +936,7 @@ export default class CollaborationApi {
936936

937937
/**
938938
* Create a document
939-
* Create a document. If the document is one of {'DWG', 'PHOTOSPHERE', 'GLTF', 'IFC', 'DXF', 'POINT_CLOUD', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write
939+
* Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write
940940
* @param {Number} cloudPk A unique integer value identifying this cloud.
941941
* @param {Number} projectPk A unique integer value identifying this project.
942942
* @param {String} name Shown name of the file

‎src/api/ModelApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7688,7 +7688,7 @@ export default class ModelApi {
76887688
* @param {Object} opts Optional parameters
76897689
* @param {module:model/String} opts.source * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED
76907690
* @param {Array.<module:model/String>} opts.status * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix
7691-
* @param {Array.<module:model/String>} opts.type * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
7691+
* @param {Array.<module:model/String>} opts.type * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
76927692
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Model>} and HTTP response
76937693
*/
76947694
getModelsWithHttpInfo(cloudPk, projectPk, opts) {
@@ -7736,7 +7736,7 @@ export default class ModelApi {
77367736
* @param {Object} opts Optional parameters
77377737
* @param {module:model/String} opts.source * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED
77387738
* @param {Array.<module:model/String>} opts.status * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix
7739-
* @param {Array.<module:model/String>} opts.type * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
7739+
* @param {Array.<module:model/String>} opts.type * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING
77407740
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Model>}
77417741
*/
77427742
getModels(cloudPk, projectPk, opts) {

‎src/model/DocumentText.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ DocumentText.prototype['id'] = undefined;
7777
DocumentText.prototype['text'] = undefined;
7878

7979
/**
80-
* * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french
80+
* * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german
8181
* @member {module:model/DocumentText.LanguageEnum} language
8282
*/
8383
DocumentText.prototype['language'] = undefined;
@@ -94,34 +94,34 @@ DocumentText.prototype['language'] = undefined;
9494
DocumentText['LanguageEnum'] = {
9595

9696
/**
97-
* value: "german"
97+
* value: "french"
9898
* @const
9999
*/
100-
"german": "german",
100+
"french": "french",
101101

102102
/**
103-
* value: "english"
103+
* value: "italian"
104104
* @const
105105
*/
106-
"english": "english",
106+
"italian": "italian",
107107

108108
/**
109-
* value: "spanish"
109+
* value: "english"
110110
* @const
111111
*/
112-
"spanish": "spanish",
112+
"english": "english",
113113

114114
/**
115-
* value: "italian"
115+
* value: "spanish"
116116
* @const
117117
*/
118-
"italian": "italian",
118+
"spanish": "spanish",
119119

120120
/**
121-
* value: "french"
121+
* value: "german"
122122
* @const
123123
*/
124-
"french": "french",
124+
"german": "german",
125125

126126
/**
127127
* value: "null"

‎src/model/PatchedDocumentTextRequest.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class PatchedDocumentTextRequest {
6767
PatchedDocumentTextRequest.prototype['text'] = undefined;
6868

6969
/**
70-
* * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french
70+
* * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german
7171
* @member {module:model/PatchedDocumentTextRequest.LanguageEnum} language
7272
*/
7373
PatchedDocumentTextRequest.prototype['language'] = undefined;
@@ -84,34 +84,34 @@ PatchedDocumentTextRequest.prototype['language'] = undefined;
8484
PatchedDocumentTextRequest['LanguageEnum'] = {
8585

8686
/**
87-
* value: "german"
87+
* value: "french"
8888
* @const
8989
*/
90-
"german": "german",
90+
"french": "french",
9191

9292
/**
93-
* value: "english"
93+
* value: "italian"
9494
* @const
9595
*/
96-
"english": "english",
96+
"italian": "italian",
9797

9898
/**
99-
* value: "spanish"
99+
* value: "english"
100100
* @const
101101
*/
102-
"spanish": "spanish",
102+
"english": "english",
103103

104104
/**
105-
* value: "italian"
105+
* value: "spanish"
106106
* @const
107107
*/
108-
"italian": "italian",
108+
"spanish": "spanish",
109109

110110
/**
111-
* value: "french"
111+
* value: "german"
112112
* @const
113113
*/
114-
"french": "french",
114+
"german": "german",
115115

116116
/**
117117
* value: "null"

0 commit comments

Comments
 (0)