MINOR: remove some document fields in model.document serialization

* improve storey performances

* add comments

Author: Bimdata-io

.openapi-generator/FILES

@@ -87,6 +87,8 @@ docs/MaterialOption.md
 docs/MaterialRequest.md
 docs/Model.md
 docs/ModelApi.md
+docs/ModelDocument.md
+docs/ModelDocumentRequest.md
 docs/ModelErrors.md
 docs/ModelErrorsRequest.md
 docs/ModelFiles.md
@@ -341,6 +343,8 @@ src/model/MaterialListComponentRequest.js
 src/model/MaterialOption.js
 src/model/MaterialRequest.js
 src/model/Model.js
+src/model/ModelDocument.js
+src/model/ModelDocumentRequest.js
 src/model/ModelErrors.js
 src/model/ModelErrorsRequest.js
 src/model/ModelFiles.js
@@ -589,6 +593,8 @@ test/model/MaterialListComponentRequest.spec.js
 test/model/MaterialOption.spec.js
 test/model/MaterialRequest.spec.js
 test/model/Model.spec.js
+test/model/ModelDocument.spec.js
+test/model/ModelDocumentRequest.spec.js
 test/model/ModelErrors.spec.js
 test/model/ModelErrorsRequest.spec.js
 test/model/ModelFiles.spec.js

README.md

@@ -564,6 +564,8 @@ Class | Method | HTTP request | Description
  - [bimdata.MaterialOption](docs/MaterialOption.md)
  - [bimdata.MaterialRequest](docs/MaterialRequest.md)
  - [bimdata.Model](docs/Model.md)
+ - [bimdata.ModelDocument](docs/ModelDocument.md)
+ - [bimdata.ModelDocumentRequest](docs/ModelDocumentRequest.md)
  - [bimdata.ModelErrors](docs/ModelErrors.md)
  - [bimdata.ModelErrorsRequest](docs/ModelErrorsRequest.md)
  - [bimdata.ModelFiles](docs/ModelFiles.md)

docs/CollaborationApi.md

@@ -960,7 +960,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/Model.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **createdAt** | **Date** |  | [readonly] 
 **updatedAt** | **Date** |  | [readonly] 
 **documentId** | **Number** |  | [readonly] 
-**document** | [**Document**](Document.md) |  | [readonly] 
+**document** | [**ModelDocument**](ModelDocument.md) |  | [readonly] 
 **structureFile** | **String** |  | [readonly] 
 **systemsFile** | **String** |  | [readonly] 
 **mapFile** | **String** |  | [readonly] 

docs/ModelDocument.md

@@ -0,0 +1,34 @@
+# bimdata.ModelDocument
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** |  | [readonly] 
+**name** | **String** | Shown name of the file | 
+**fileName** | **String** | Full name of the file | [optional] 
+**description** | **String** | Description of the file | [optional] 
+**file** | **String** |  | 
+**size** | **Number** | Size of the file. | [readonly] 
+**createdAt** | **Date** | Creation date | [readonly] 
+**updatedAt** | **Date** | Date of the last update | [readonly] 
+**headId** | **Number** | Document id of head version | [readonly] 
+**isHeadVersion** | **Boolean** | Document is a head of version or is owned by another document | [readonly] 
+**historyCount** | **Number** | Number of previous versions | [readonly] 
+**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
+**officePreview** | **String** | Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt | [readonly] 
+
+
+
+## Enum: UserPermissionEnum
+
+
+* `1` (value: `1`)
+
+* `50` (value: `50`)
+
+* `100` (value: `100`)
+
+
+
+

docs/ModelDocumentRequest.md

@@ -0,0 +1,22 @@
+# bimdata.ModelDocumentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Shown name of the file | 
+**fileName** | **String** | Full name of the file | [optional] 
+**description** | **String** | Description of the file | [optional] 
+**file** | **File** |  | 
+**processHint** | **String** | Provide a info about the document in order to customize the way it is processed.  * `PHOTOSPHERE` - PHOTOSPHERE | [optional] 
+
+
+
+## Enum: ProcessHintEnum
+
+
+* `PHOTOSPHERE` (value: `"PHOTOSPHERE"`)
+
+
+
+

docs/ModelSerializerWithoutChildren.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **createdAt** | **Date** |  | [readonly] 
 **updatedAt** | **Date** |  | [readonly] 
 **documentId** | **Number** |  | [readonly] 
-**document** | [**Document**](Document.md) |  | [readonly] 
+**document** | [**ModelDocument**](ModelDocument.md) |  | [readonly] 
 **structureFile** | **String** |  | [readonly] 
 **systemsFile** | **String** |  | [readonly] 
 **mapFile** | **String** |  | [readonly] 

docs/WriteFolderRequest.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the folder | 
 **defaultPermission** | **Number** | Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write | [optional] 
 **parentId** | **Number** |  | [optional] 
+**name** | **String** | Name of the folder | 
 **children** | [**[WriteFolderRequest]**](WriteFolderRequest.md) |  | [optional] 
 
 

src/api/CollaborationApi.js

@@ -866,7 +866,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, 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
@@ -934,7 +934,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, 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

src/index.js

@@ -95,6 +95,8 @@ import MaterialListComponentRequest from './model/MaterialListComponentRequest';
 import MaterialOption from './model/MaterialOption';
 import MaterialRequest from './model/MaterialRequest';
 import Model from './model/Model';
+import ModelDocument from './model/ModelDocument';
+import ModelDocumentRequest from './model/ModelDocumentRequest';
 import ModelErrors from './model/ModelErrors';
 import ModelErrorsRequest from './model/ModelErrorsRequest';
 import ModelFiles from './model/ModelFiles';
@@ -793,6 +795,18 @@ export {
      */
     Model,
 
+    /**
+     * The ModelDocument model constructor.
+     * @property {module:model/ModelDocument}
+     */
+    ModelDocument,
+
+    /**
+     * The ModelDocumentRequest model constructor.
+     * @property {module:model/ModelDocumentRequest}
+     */
+    ModelDocumentRequest,
+
     /**
      * The ModelErrors model constructor.
      * @property {module:model/ModelErrors}