MINOR: add document full text search (#893)

* add document full text search

* use cloud language if no language provided

* enable text only on ai clouds

* fix tests

* add comment to doc

* fix test with new field

Author: Bimdata-io

.openapi-generator/FILES

@@ -39,6 +39,7 @@ docs/Direction.md
 docs/DirectionRequest.md
 docs/Document.md
 docs/DocumentPreviewFile.md
+docs/DocumentText.md
 docs/DocumentWithElementList.md
 docs/Drawing.md
 docs/DrawingRequest.md
@@ -111,6 +112,7 @@ docs/PatchedClassificationRequest.md
 docs/PatchedCloudRequest.md
 docs/PatchedCommentRequest.md
 docs/PatchedDocumentRequest.md
+docs/PatchedDocumentTextRequest.md
 docs/PatchedDrawingRequest.md
 docs/PatchedElementRequest.md
 docs/PatchedFolderWithoutChildrenRequest.md
@@ -317,6 +319,7 @@ src/model/Direction.js
 src/model/DirectionRequest.js
 src/model/Document.js
 src/model/DocumentPreviewFile.js
+src/model/DocumentText.js
 src/model/DocumentWithElementList.js
 src/model/Drawing.js
 src/model/DrawingRequest.js
@@ -388,6 +391,7 @@ src/model/PatchedClassificationRequest.js
 src/model/PatchedCloudRequest.js
 src/model/PatchedCommentRequest.js
 src/model/PatchedDocumentRequest.js
+src/model/PatchedDocumentTextRequest.js
 src/model/PatchedDrawingRequest.js
 src/model/PatchedElementRequest.js
 src/model/PatchedFolderWithoutChildrenRequest.js
@@ -588,6 +592,7 @@ test/model/Direction.spec.js
 test/model/DirectionRequest.spec.js
 test/model/Document.spec.js
 test/model/DocumentPreviewFile.spec.js
+test/model/DocumentText.spec.js
 test/model/DocumentWithElementList.spec.js
 test/model/Drawing.spec.js
 test/model/DrawingRequest.spec.js
@@ -659,6 +664,7 @@ test/model/PatchedClassificationRequest.spec.js
 test/model/PatchedCloudRequest.spec.js
 test/model/PatchedCommentRequest.spec.js
 test/model/PatchedDocumentRequest.spec.js
+test/model/PatchedDocumentTextRequest.spec.js
 test/model/PatchedDrawingRequest.spec.js
 test/model/PatchedElementRequest.spec.js
 test/model/PatchedFolderWithoutChildrenRequest.spec.js

README.md

@@ -302,6 +302,7 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**updateCloud**](docs/CollaborationApi.md#updateCloud) | **PATCH** /cloud/{id} | Update some fields of a cloud
 *bimdata.CollaborationApi* | [**updateCloudUser**](docs/CollaborationApi.md#updateCloudUser) | **PATCH** /cloud/{cloud_pk}/user/{id} | Change the user role in the cloud
 *bimdata.CollaborationApi* | [**updateDocument**](docs/CollaborationApi.md#updateDocument) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
+*bimdata.CollaborationApi* | [**updateDocumentText**](docs/CollaborationApi.md#updateDocumentText) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/text | Update the text representation of a document
 *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
@@ -535,6 +536,7 @@ Class | Method | HTTP request | Description
  - [bimdata.DirectionRequest](docs/DirectionRequest.md)
  - [bimdata.Document](docs/Document.md)
  - [bimdata.DocumentPreviewFile](docs/DocumentPreviewFile.md)
+ - [bimdata.DocumentText](docs/DocumentText.md)
  - [bimdata.DocumentWithElementList](docs/DocumentWithElementList.md)
  - [bimdata.Drawing](docs/Drawing.md)
  - [bimdata.DrawingRequest](docs/DrawingRequest.md)
@@ -606,6 +608,7 @@ Class | Method | HTTP request | Description
  - [bimdata.PatchedCloudRequest](docs/PatchedCloudRequest.md)
  - [bimdata.PatchedCommentRequest](docs/PatchedCommentRequest.md)
  - [bimdata.PatchedDocumentRequest](docs/PatchedDocumentRequest.md)
+ - [bimdata.PatchedDocumentTextRequest](docs/PatchedDocumentTextRequest.md)
  - [bimdata.PatchedDrawingRequest](docs/PatchedDrawingRequest.md)
  - [bimdata.PatchedElementRequest](docs/PatchedElementRequest.md)
  - [bimdata.PatchedFolderWithoutChildrenRequest](docs/PatchedFolderWithoutChildrenRequest.md)

docs/CollaborationApi.md

@@ -102,6 +102,7 @@ Method | HTTP request | Description
 [**updateCloud**](CollaborationApi.md#updateCloud) | **PATCH** /cloud/{id} | Update some fields of a cloud
 [**updateCloudUser**](CollaborationApi.md#updateCloudUser) | **PATCH** /cloud/{cloud_pk}/user/{id} | Change the user role in the cloud
 [**updateDocument**](CollaborationApi.md#updateDocument) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
+[**updateDocumentText**](CollaborationApi.md#updateDocumentText) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/text | Update the text representation of a document
 [**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
@@ -960,7 +961,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'GLTF', 'IFC', 'OBJ', 'POINT_CLOUD', 'DXF', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'IFC', 'POINT_CLOUD', 'DWG', 'DXF', 'GLTF', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -3387,7 +3388,7 @@ Name | Type | Description  | Notes
 
 Retrieve all documents
 
-Retrieve all documents in the project. Filters are case insentive  Required scopes: document:read
+Retrieve all documents in the project. Filters are case insentive. Search filter only works if AI features are enabled.  Required scopes: document:read
 
 ### Example
 
@@ -3431,9 +3432,11 @@ let opts = {
   'nameContains': "nameContains_example", // String | 
   'nameEndswith': "nameEndswith_example", // String | 
   'nameStartswith': "nameStartswith_example", // String | 
+  'search': "search_example", // String | 
   'sizeMax': 789, // Number | Size of the file.
   'sizeMin': 789, // Number | Size of the file.
   'tags': ["null"], // [String] | Multiple values may be separated by commas.
+  'text': true, // Boolean | If this field is present (with any value), the full text representation of the documents will be added to the response under the field `text`
   'visaCreatorEmail': "visaCreatorEmail_example", // String | 
   'visaDeadlineAfter': new Date("2013-10-20"), // Date | 
   'visaDeadlineBefore': new Date("2013-10-20"), // Date | 
@@ -3475,9 +3478,11 @@ Name | Type | Description  | Notes
  **nameContains** | **String**|  | [optional] 
  **nameEndswith** | **String**|  | [optional] 
  **nameStartswith** | **String**|  | [optional] 
+ **search** | **String**|  | [optional] 
  **sizeMax** | **Number**| Size of the file. | [optional] 
  **sizeMin** | **Number**| Size of the file. | [optional] 
  **tags** | [**[String]**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **text** | **Boolean**| If this field is present (with any value), the full text representation of the documents will be added to the response under the field `text` | [optional] 
  **visaCreatorEmail** | **String**|  | [optional] 
  **visaDeadlineAfter** | **Date**|  | [optional] 
  **visaDeadlineBefore** | **Date**|  | [optional] 
@@ -3618,6 +3623,7 @@ let opts = {
   'nameContains': "nameContains_example", // String | 
   'nameEndswith': "nameEndswith_example", // String | 
   'nameStartswith': "nameStartswith_example", // String | 
+  'search': "search_example", // String | 
   'sizeMax': 789, // Number | Size of the file.
   'sizeMin': 789, // Number | Size of the file.
   'tags': ["null"], // [String] | Multiple values may be separated by commas.
@@ -3663,6 +3669,7 @@ Name | Type | Description  | Notes
  **nameContains** | **String**|  | [optional] 
  **nameEndswith** | **String**|  | [optional] 
  **nameStartswith** | **String**|  | [optional] 
+ **search** | **String**|  | [optional] 
  **sizeMax** | **Number**| Size of the file. | [optional] 
  **sizeMin** | **Number**| Size of the file. | [optional] 
  **tags** | [**[String]**](String.md)| Multiple values may be separated by commas. | [optional] 
@@ -6619,6 +6626,75 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## updateDocumentText
+
+> DocumentText updateDocumentText(cloudPk, id, projectPk, opts)
+
+Update the text representation of a document
+
+Update the text representation of a document. The document itself will not be changed. It is useful for full text search  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 = {
+  'patchedDocumentTextRequest': new bimdata.PatchedDocumentTextRequest() // PatchedDocumentTextRequest | 
+};
+apiInstance.updateDocumentText(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. | 
+ **patchedDocumentTextRequest** | [**PatchedDocumentTextRequest**](PatchedDocumentTextRequest.md)|  | [optional] 
+
+### Return type
+
+[**DocumentText**](DocumentText.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**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## updateFolder
 
 > FolderWithoutChildren updateFolder(cloudPk, id, projectPk, opts)

docs/DocumentText.md

@@ -0,0 +1,30 @@
+# bimdata.DocumentText
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** |  | [readonly] 
+**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
+**language** | **String** | * `french` - french * `spanish` - spanish * `german` - german * `english` - english * `italian` - italian | [optional] 
+
+
+
+## Enum: LanguageEnum
+
+
+* `french` (value: `"french"`)
+
+* `spanish` (value: `"spanish"`)
+
+* `german` (value: `"german"`)
+
+* `english` (value: `"english"`)
+
+* `italian` (value: `"italian"`)
+
+* `null` (value: `"null"`)
+
+
+
+

docs/PatchedDocumentTextRequest.md

@@ -0,0 +1,29 @@
+# bimdata.PatchedDocumentTextRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
+**language** | **String** | * `french` - french * `spanish` - spanish * `german` - german * `english` - english * `italian` - italian | [optional] 
+
+
+
+## Enum: LanguageEnum
+
+
+* `french` (value: `"french"`)
+
+* `spanish` (value: `"spanish"`)
+
+* `german` (value: `"german"`)
+
+* `english` (value: `"english"`)
+
+* `italian` (value: `"italian"`)
+
+* `null` (value: `"null"`)
+
+
+
+

docs/WriteFolder.md

@@ -4,22 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly] 
 **parentId** | **Number** |  | [optional] 
+**createdAt** | **Date** | Creation date | [readonly] 
+**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
+**id** | **Number** |  | [readonly] 
+**name** | **String** | Name of the folder | 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
+**defaultPermission** | **Number** | Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write | [optional] 
 **groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**name** | **String** | Name of the folder | 
-**id** | **Number** |  | [readonly] 
-**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
 **userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**createdAt** | **Date** | Creation date | [readonly] 
-**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**defaultPermission** | **Number** | Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
 
-## Enum: UserPermissionEnum
+## Enum: DefaultPermissionEnum
 
 
 * `1` (value: `1`)
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
 
 
 
-## Enum: DefaultPermissionEnum
+## Enum: UserPermissionEnum
 
 
 * `1` (value: `1`)