MINOR: add document-preview (#642)

* add document-preview

* add admin reprocess

* rename field

Author: Bimdata-io

.openapi-generator/FILES

@@ -39,6 +39,7 @@ docs/DetailedExtensions.md
 docs/Direction.md
 docs/DirectionRequest.md
 docs/Document.md
+docs/DocumentPreviewFile.md
 docs/DocumentWithElementList.md
 docs/Element.md
 docs/ElementClassificationRelation.md
@@ -302,6 +303,7 @@ src/model/DetailedExtensions.js
 src/model/Direction.js
 src/model/DirectionRequest.js
 src/model/Document.js
+src/model/DocumentPreviewFile.js
 src/model/DocumentWithElementList.js
 src/model/Element.js
 src/model/ElementClassificationRelation.js
@@ -557,6 +559,7 @@ test/model/DetailedExtensions.spec.js
 test/model/Direction.spec.js
 test/model/DirectionRequest.spec.js
 test/model/Document.spec.js
+test/model/DocumentPreviewFile.spec.js
 test/model/DocumentWithElementList.spec.js
 test/model/Element.spec.js
 test/model/ElementClassificationRelation.spec.js

README.md

@@ -327,6 +327,7 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**updateFolder**](docs/CollaborationApi.md#updateFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
 *bimdata.CollaborationApi* | [**updateGroupFolder**](docs/CollaborationApi.md#updateGroupFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} | Update the permission of a group on a folder. When propagate is set to True, the permission of all children in the folder will be updated.
 *bimdata.CollaborationApi* | [**updateManageGroup**](docs/CollaborationApi.md#updateManageGroup) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Update some fields of a group
+*bimdata.CollaborationApi* | [**updatePreviewFile**](docs/CollaborationApi.md#updatePreviewFile) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file | Update preview of the document
 *bimdata.CollaborationApi* | [**updateProject**](docs/CollaborationApi.md#updateProject) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
 *bimdata.CollaborationApi* | [**updateProjectAccessToken**](docs/CollaborationApi.md#updateProjectAccessToken) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Update some fields of a token
 *bimdata.CollaborationApi* | [**updateProjectUser**](docs/CollaborationApi.md#updateProjectUser) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Change the user role in the cloud
@@ -686,6 +687,7 @@ Class | Method | HTTP request | Description
  - [bimdata.Direction](docs/Direction.md)
  - [bimdata.DirectionRequest](docs/DirectionRequest.md)
  - [bimdata.Document](docs/Document.md)
+ - [bimdata.DocumentPreviewFile](docs/DocumentPreviewFile.md)
  - [bimdata.DocumentWithElementList](docs/DocumentWithElementList.md)
  - [bimdata.Element](docs/Element.md)
  - [bimdata.ElementClassificationRelation](docs/ElementClassificationRelation.md)

docs/CollaborationApi.md

@@ -103,6 +103,7 @@ Method | HTTP request | Description
 [**updateFolder**](CollaborationApi.md#updateFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
 [**updateGroupFolder**](CollaborationApi.md#updateGroupFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} | Update the permission of a group on a folder. When propagate is set to True, the permission of all children in the folder will be updated.
 [**updateManageGroup**](CollaborationApi.md#updateManageGroup) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Update some fields of a group
+[**updatePreviewFile**](CollaborationApi.md#updatePreviewFile) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file | Update preview of the document
 [**updateProject**](CollaborationApi.md#updateProject) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
 [**updateProjectAccessToken**](CollaborationApi.md#updateProjectAccessToken) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Update some fields of a token
 [**updateProjectUser**](CollaborationApi.md#updateProjectUser) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Change the user role in the cloud
@@ -954,7 +955,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'GLTF', 'IFC', 'OBJ', 'DWG', 'BFX', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'OBJ', 'IFC', 'DWG', 'POINT_CLOUD', 'GLTF', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -987,7 +988,6 @@ let opts = {
   'parentId': 56, // Number | 
   'fileName': "fileName_example", // String | Full name of the file
   'description': "description_example", // String | Description of the file
-  'size': 789, // Number | Size of the file.
   'modelSource': "modelSource_example", // String | Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
   'ifcSource': "ifcSource_example", // String | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
   'successorOf': 56 // Number | Old document version to replace. Only for create
@@ -1012,7 +1012,6 @@ Name | Type | Description  | Notes
  **parentId** | **Number**|  | [optional] 
  **fileName** | **String**| Full name of the file | [optional] 
  **description** | **String**| Description of the file | [optional] 
- **size** | **Number**| Size of the file. | [optional] 
  **modelSource** | **String**| Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional] 
  **ifcSource** | **String**| DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional] 
  **successorOf** | **Number**| Old document version to replace. Only for create | [optional] 
@@ -6544,6 +6543,75 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## updatePreviewFile
+
+> DocumentPreviewFile updatePreviewFile(cloudPk, id, projectPk, opts)
+
+Update preview of the document
+
+Update preview of the document  Required scopes: document:write
+
+### Example
+
+```javascript
+import bimdata from '@bimdata/bimdata-api-client';
+let defaultClient = bimdata.ApiClient.instance;
+// Configure API key authorization: ApiKey
+let ApiKey = defaultClient.authentications['ApiKey'];
+ApiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//ApiKey.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure API key authorization: Bearer
+let Bearer = defaultClient.authentications['Bearer'];
+Bearer.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//Bearer.apiKeyPrefix = 'Token';
+
+let apiInstance = new bimdata.CollaborationApi();
+let cloudPk = 56; // Number | A unique integer value identifying this cloud.
+let id = 56; // Number | A unique integer value identifying this document.
+let projectPk = 56; // Number | A unique integer value identifying this project.
+let opts = {
+  'officePreview': "/path/to/file" // File | Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
+};
+apiInstance.updatePreviewFile(cloudPk, id, projectPk, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloudPk** | **Number**| A unique integer value identifying this cloud. | 
+ **id** | **Number**| A unique integer value identifying this document. | 
+ **projectPk** | **Number**| A unique integer value identifying this project. | 
+ **officePreview** | **File**| Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt | [optional] 
+
+### Return type
+
+[**DocumentPreviewFile**](DocumentPreviewFile.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
 ## updateProject
 
 > Project updateProject(cloudPk, id, opts)

docs/Document.md

@@ -12,16 +12,17 @@ Name | Type | Description | Notes
 **fileName** | **String** | Full name of the file | [optional] 
 **description** | **String** | Description of the file | [optional] 
 **file** | **String** |  | 
-**size** | **Number** | Size of the file. | [optional] 
+**size** | **Number** | Size of the file. | [readonly] 
 **tags** | [**[Tag]**](Tag.md) |  | [readonly] 
 **visas** | [**[Visa]**](Visa.md) |  | [readonly] 
 **createdAt** | **Date** | Creation date | [readonly] 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
 **modelId** | **Number** |  | [readonly] 
-**modelType** | **String** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, DAE, BFX, POINT_CLOUD | [readonly] 
+**modelType** | **String** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD | [readonly] 
 **ifcId** | **Number** | DEPRECATED: Use 'model_id' instead. | [readonly] 
 **userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **isHeadVersion** | **Boolean** | Document is a head of version or is owned by another document | [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] 
 
 
 
@@ -44,10 +45,6 @@ Name | Type | Description | Notes
 
 * `OBJ` (value: `"OBJ"`)
 
-* `DAE` (value: `"DAE"`)
-
-* `BFX` (value: `"BFX"`)
-
 * `POINT_CLOUD` (value: `"POINT_CLOUD"`)
 
 * `null` (value: `"null"`)

docs/DocumentPreviewFile.md

@@ -0,0 +1,9 @@
+# bimdata.DocumentPreviewFile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+
+

docs/Model.md

@@ -55,10 +55,6 @@ Name | Type | Description | Notes
 
 * `OBJ` (value: `"OBJ"`)
 
-* `DAE` (value: `"DAE"`)
-
-* `BFX` (value: `"BFX"`)
-
 * `POINT_CLOUD` (value: `"POINT_CLOUD"`)
 
 * `METABUILDING` (value: `"METABUILDING"`)

docs/ModelSerializerWithoutChildren.md

@@ -54,10 +54,6 @@ Name | Type | Description | Notes
 
 * `OBJ` (value: `"OBJ"`)
 
-* `DAE` (value: `"DAE"`)
-
-* `BFX` (value: `"BFX"`)
-
 * `POINT_CLOUD` (value: `"POINT_CLOUD"`)
 
 * `METABUILDING` (value: `"METABUILDING"`)

docs/PatchedDocumentRequest.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **fileName** | **String** | Full name of the file | [optional] 
 **description** | **String** | Description of the file | [optional] 
 **file** | **File** |  | [optional] 
-**size** | **Number** | Size of the file. | [optional] 
 **modelSource** | **String** | Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional] 
 **ifcSource** | **String** | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional] 
 **successorOf** | **Number** | Old document version to replace. Only for create | [optional] 

docs/RecursiveFolderChildren.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **createdBy** | [**ShortUser**](ShortUser.md) |  | [optional] 
 **type** | **String** | DEPRECATED: Use 'nature' instead. Values can be 'Folder', 'Document' or 'Ifc'. It is usefull to parse the tree and discriminate folders and files | [readonly] 
 **nature** | **String** | Values can be 'Folder', 'Document' or 'Model'. It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**modelType** | **String** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, DAE, BFX, POINT_CLOUD | [readonly] 
+**modelType** | **String** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD | [readonly] 
 **name** | **String** |  | 
 **createdAt** | **Date** |  | 
 **updatedAt** | **Date** |  | 
@@ -73,10 +73,6 @@ Name | Type | Description | Notes
 
 * `OBJ` (value: `"OBJ"`)
 
-* `DAE` (value: `"DAE"`)
-
-* `BFX` (value: `"BFX"`)
-
 * `POINT_CLOUD` (value: `"POINT_CLOUD"`)
 
 * `null` (value: `"null"`)

src/api/CollaborationApi.js

@@ -21,6 +21,7 @@ import CloudInvitation from '../model/CloudInvitation';
 import CloudInvitationRequest from '../model/CloudInvitationRequest';
 import CloudRequest from '../model/CloudRequest';
 import Document from '../model/Document';
+import DocumentPreviewFile from '../model/DocumentPreviewFile';
 import Folder from '../model/Folder';
 import FolderUserProject from '../model/FolderUserProject';
 import FolderWithoutChildren from '../model/FolderWithoutChildren';
@@ -857,7 +858,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'GLTF', 'IFC', 'OBJ', 'DWG', 'BFX', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'OBJ', 'IFC', 'DWG', 'POINT_CLOUD', 'GLTF', 'DXF'}, 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
@@ -866,7 +867,6 @@ export default class CollaborationApi {
      * @param {Number} opts.parentId 
      * @param {String} opts.fileName Full name of the file
      * @param {String} opts.description Description of the file
-     * @param {Number} opts.size Size of the file.
      * @param {module:model/String} opts.modelSource Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
      * @param {module:model/String} opts.ifcSource DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
      * @param {Number} opts.successorOf Old document version to replace. Only for create
@@ -906,7 +906,6 @@ export default class CollaborationApi {
         'file_name': opts['fileName'],
         'description': opts['description'],
         'file': file,
-        'size': opts['size'],
         'model_source': opts['modelSource'],
         'ifc_source': opts['ifcSource'],
         'successor_of': opts['successorOf']
@@ -925,7 +924,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'GLTF', 'IFC', 'OBJ', 'DWG', 'BFX', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'OBJ', 'IFC', 'DWG', 'POINT_CLOUD', 'GLTF', 'DXF'}, 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 +933,6 @@ export default class CollaborationApi {
      * @param {Number} opts.parentId 
      * @param {String} opts.fileName Full name of the file
      * @param {String} opts.description Description of the file
-     * @param {Number} opts.size Size of the file.
      * @param {module:model/String} opts.modelSource Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
      * @param {module:model/String} opts.ifcSource DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
      * @param {Number} opts.successorOf Old document version to replace. Only for create
@@ -6074,6 +6072,74 @@ export default class CollaborationApi {
     }
 
 
+    /**
+     * Update preview of the document
+     * Update preview of the document  Required scopes: document:write
+     * @param {Number} cloudPk A unique integer value identifying this cloud.
+     * @param {Number} id A unique integer value identifying this document.
+     * @param {Number} projectPk A unique integer value identifying this project.
+     * @param {Object} opts Optional parameters
+     * @param {File} opts.officePreview Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DocumentPreviewFile} and HTTP response
+     */
+    updatePreviewFileWithHttpInfo(cloudPk, id, projectPk, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'cloudPk' is set
+      if (cloudPk === undefined || cloudPk === null) {
+        throw new Error("Missing the required parameter 'cloudPk' when calling updatePreviewFile");
+      }
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling updatePreviewFile");
+      }
+      // verify the required parameter 'projectPk' is set
+      if (projectPk === undefined || projectPk === null) {
+        throw new Error("Missing the required parameter 'projectPk' when calling updatePreviewFile");
+      }
+
+      let pathParams = {
+        'cloud_pk': cloudPk,
+        'id': id,
+        'project_pk': projectPk
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+        'office_preview': opts['officePreview']
+      };
+
+      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
+      let contentTypes = ['multipart/form-data', 'application/x-www-form-urlencoded'];
+      let accepts = ['application/json'];
+      let returnType = DocumentPreviewFile;
+      return this.apiClient.callApi(
+        '/cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file', 'PATCH',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Update preview of the document
+     * Update preview of the document  Required scopes: document:write
+     * @param {Number} cloudPk A unique integer value identifying this cloud.
+     * @param {Number} id A unique integer value identifying this document.
+     * @param {Number} projectPk A unique integer value identifying this project.
+     * @param {Object} opts Optional parameters
+     * @param {File} opts.officePreview Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DocumentPreviewFile}
+     */
+    updatePreviewFile(cloudPk, id, projectPk, opts) {
+      return this.updatePreviewFileWithHttpInfo(cloudPk, id, projectPk, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Update some fields of a project
      * Update some fields of a project  Required scopes: org:manage