MINOR: Add a 2D mask to model to be able to cleanup plan (#832)

* Add ability to save a viewport for a plan.

* Fix doc.

* Rename 2D mask.

* Use kwargs instead of args in test mask 2d.

* Rework with a simplier view on the model

* Rename migration to match the mask2d rename

Author: Bimdata-io

.openapi-generator/FILES

@@ -81,6 +81,8 @@ docs/LogEntry.md
 docs/MarketplaceAppImage.md
 docs/MarketplaceAppLight.md
 docs/MarketplaceAppLightRequest.md
+docs/Mask2D.md
+docs/Mask2DRequest.md
 docs/Material.md
 docs/MaterialListComponent.md
 docs/MaterialListComponentRequest.md
@@ -342,6 +344,8 @@ src/model/LogEntry.js
 src/model/MarketplaceAppImage.js
 src/model/MarketplaceAppLight.js
 src/model/MarketplaceAppLightRequest.js
+src/model/Mask2D.js
+src/model/Mask2DRequest.js
 src/model/Material.js
 src/model/MaterialListComponent.js
 src/model/MaterialListComponentRequest.js
@@ -596,6 +600,8 @@ test/model/LogEntry.spec.js
 test/model/MarketplaceAppImage.spec.js
 test/model/MarketplaceAppLight.spec.js
 test/model/MarketplaceAppLightRequest.spec.js
+test/model/Mask2D.spec.js
+test/model/Mask2DRequest.spec.js
 test/model/Material.spec.js
 test/model/MaterialListComponent.spec.js
 test/model/MaterialListComponentRequest.spec.js

README.md

@@ -337,6 +337,7 @@ Class | Method | HTTP request | Description
 *bimdata.ModelApi* | [**createElementPropertySetPropertyDefinition**](docs/ModelApi.md#createElementPropertySetPropertyDefinition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Create a Definition to a Property
 *bimdata.ModelApi* | [**createElementPropertySetPropertyDefinitionUnit**](docs/ModelApi.md#createElementPropertySetPropertyDefinitionUnit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Create a Unit to a Definition
 *bimdata.ModelApi* | [**createLayer**](docs/ModelApi.md#createLayer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
+*bimdata.ModelApi* | [**createMask2D**](docs/ModelApi.md#createMask2D) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Create or update a 2D mask for the model
 *bimdata.ModelApi* | [**createMetaBuilding**](docs/ModelApi.md#createMetaBuilding) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
 *bimdata.ModelApi* | [**createModel**](docs/ModelApi.md#createModel) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-model | Make a PDF or Image file a Model
 *bimdata.ModelApi* | [**createModelPropertyDefinition**](docs/ModelApi.md#createModelPropertyDefinition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Create a PropertyDefinition on the model
@@ -361,6 +362,7 @@ Class | Method | HTTP request | Description
 *bimdata.ModelApi* | [**deleteDrawing**](docs/ModelApi.md#deleteDrawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
 *bimdata.ModelApi* | [**deleteElement**](docs/ModelApi.md#deleteElement) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
 *bimdata.ModelApi* | [**deleteLayer**](docs/ModelApi.md#deleteLayer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
+*bimdata.ModelApi* | [**deleteMask2D**](docs/ModelApi.md#deleteMask2D) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Delete the 2D mask for the model
 *bimdata.ModelApi* | [**deleteModel**](docs/ModelApi.md#deleteModel) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
 *bimdata.ModelApi* | [**deleteModelProperty**](docs/ModelApi.md#deleteModelProperty) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Delete a Property of a model
 *bimdata.ModelApi* | [**deleteModelPropertyDefinition**](docs/ModelApi.md#deleteModelPropertyDefinition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Delete a PropertyDefinitions of a model
@@ -559,6 +561,8 @@ Class | Method | HTTP request | Description
  - [bimdata.MarketplaceAppImage](docs/MarketplaceAppImage.md)
  - [bimdata.MarketplaceAppLight](docs/MarketplaceAppLight.md)
  - [bimdata.MarketplaceAppLightRequest](docs/MarketplaceAppLightRequest.md)
+ - [bimdata.Mask2D](docs/Mask2D.md)
+ - [bimdata.Mask2DRequest](docs/Mask2DRequest.md)
  - [bimdata.Material](docs/Material.md)
  - [bimdata.MaterialListComponent](docs/MaterialListComponent.md)
  - [bimdata.MaterialListComponentRequest](docs/MaterialListComponentRequest.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', 'GLTF', 'POINT_CLOUD', 'DWG', 'IFC', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'POINT_CLOUD', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/Mask2D.md

@@ -0,0 +1,12 @@
+# bimdata.Mask2D
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** |  | [readonly] 
+**viewport** | **[[Number]]** | Viewport of the manually created mask to show only a part of the model. | 
+**createdAt** | **Date** | Creation date | [readonly] 
+**updatedAt** | **Date** | Date of the last update | [readonly] 
+
+

docs/Mask2DRequest.md

@@ -0,0 +1,9 @@
+# bimdata.Mask2DRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**viewport** | **[[Number]]** | Viewport of the manually created mask to show only a part of the model. | 
+
+

docs/Model.md

@@ -35,6 +35,7 @@ Name | Type | Description | Notes
 **parentId** | **Number** | The first page of the pdf | [readonly] 
 **pageNumber** | **Number** | The page number of the related pdf | [readonly] 
 **layoutName** | **String** | The name of the DWG layout (only set when type==DWG) | [optional] 
+**mask2d** | [**Mask2D**](Mask2D.md) |  | 
 **children** | [**[ModelSerializerWithoutChildren]**](ModelSerializerWithoutChildren.md) | Contains additional pages of a pdf | [readonly] 
 
 

docs/ModelApi.md

@@ -30,6 +30,7 @@ Method | HTTP request | Description
 [**createElementPropertySetPropertyDefinition**](ModelApi.md#createElementPropertySetPropertyDefinition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Create a Definition to a Property
 [**createElementPropertySetPropertyDefinitionUnit**](ModelApi.md#createElementPropertySetPropertyDefinitionUnit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Create a Unit to a Definition
 [**createLayer**](ModelApi.md#createLayer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
+[**createMask2D**](ModelApi.md#createMask2D) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Create or update a 2D mask for the model
 [**createMetaBuilding**](ModelApi.md#createMetaBuilding) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
 [**createModel**](ModelApi.md#createModel) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-model | Make a PDF or Image file a Model
 [**createModelPropertyDefinition**](ModelApi.md#createModelPropertyDefinition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Create a PropertyDefinition on the model
@@ -54,6 +55,7 @@ Method | HTTP request | Description
 [**deleteDrawing**](ModelApi.md#deleteDrawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
 [**deleteElement**](ModelApi.md#deleteElement) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
 [**deleteLayer**](ModelApi.md#deleteLayer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
+[**deleteMask2D**](ModelApi.md#deleteMask2D) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Delete the 2D mask for the model
 [**deleteModel**](ModelApi.md#deleteModel) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
 [**deleteModelProperty**](ModelApi.md#deleteModelProperty) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Delete a Property of a model
 [**deleteModelPropertyDefinition**](ModelApi.md#deleteModelPropertyDefinition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Delete a PropertyDefinitions of a model
@@ -1970,6 +1972,73 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## createMask2D
+
+> Mask2D createMask2D(cloudPk, id, projectPk, mask2DRequest)
+
+Create or update a 2D mask for the model
+
+Create or update a 2D mask for the model. Only available for PDF, JPEG and PNG models
+
+### 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.ModelApi();
+let cloudPk = 56; // Number | 
+let id = 56; // Number | A unique integer value identifying this model.
+let projectPk = 56; // Number | 
+let mask2DRequest = new bimdata.Mask2DRequest(); // Mask2DRequest | 
+apiInstance.createMask2D(cloudPk, id, projectPk, mask2DRequest).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloudPk** | **Number**|  | 
+ **id** | **Number**| A unique integer value identifying this model. | 
+ **projectPk** | **Number**|  | 
+ **mask2DRequest** | [**Mask2DRequest**](Mask2DRequest.md)|  | 
+
+### Return type
+
+[**Mask2D**](Mask2D.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
+
+
 ## createMetaBuilding
 
 > Model createMetaBuilding(cloudPk, projectPk, createBuildingByNameRequest)
@@ -3580,6 +3649,71 @@ null (empty response body)
 - **Accept**: Not defined
 
 
+## deleteMask2D
+
+> deleteMask2D(cloudPk, id, projectPk)
+
+Delete the 2D mask for the model
+
+Delete the 2D mask for the model.
+
+### 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.ModelApi();
+let cloudPk = 56; // Number | 
+let id = 56; // Number | A unique integer value identifying this model.
+let projectPk = 56; // Number | 
+apiInstance.deleteMask2D(cloudPk, id, projectPk).then(() => {
+  console.log('API called successfully.');
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloudPk** | **Number**|  | 
+ **id** | **Number**| A unique integer value identifying this model. | 
+ **projectPk** | **Number**|  | 
+
+### Return type
+
+null (empty response body)
+
+### 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**: Not defined
+- **Accept**: Not defined
+
+
 ## deleteModel
 
 > deleteModel(cloudPk, id, projectPk)

docs/ModelSerializerWithoutChildren.md

@@ -35,6 +35,7 @@ Name | Type | Description | Notes
 **parentId** | **Number** | The first page of the pdf | [readonly] 
 **pageNumber** | **Number** | The page number of the related pdf | [readonly] 
 **layoutName** | **String** | The name of the DWG layout (only set when type==DWG) | [optional] 
+**mask2d** | [**Mask2D**](Mask2D.md) |  | 
 
 
 

docs/PatchedModelRequest.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **northVector** | **[[Number]]** | This field is only for information. Updating it won't impact the export. | [optional] 
 **recommanded2dAngle** | **Number** | This is the angle in clockwise degree to apply on the 2D to optimise the horizontality of objects. This field is only for information. Updating it won't impact the export. | [optional] 
 **layoutName** | **String** | The name of the DWG layout (only set when type==DWG) | [optional] 
+**mask2d** | [**Mask2DRequest**](Mask2DRequest.md) |  | [optional] 
 
 
 

docs/WriteFolder.md

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