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

@@ -91,6 +91,8 @@ bimdata-api-client/model/log_entry.py
 bimdata-api-client/model/marketplace_app_image.py
 bimdata-api-client/model/marketplace_app_light.py
 bimdata-api-client/model/marketplace_app_light_request.py
+bimdata-api-client/model/mask2_d.py
+bimdata-api-client/model/mask2_d_request.py
 bimdata-api-client/model/material.py
 bimdata-api-client/model/material_list_component.py
 bimdata-api-client/model/material_list_component_request.py
@@ -345,6 +347,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
@@ -603,6 +607,8 @@ test/test_log_entry.py
 test/test_marketplace_app_image.py
 test/test_marketplace_app_light.py
 test/test_marketplace_app_light_request.py
+test/test_mask2_d.py
+test/test_mask2_d_request.py
 test/test_material.py
 test/test_material_list_component.py
 test/test_material_list_component_request.py

README.md

@@ -356,6 +356,7 @@ Class | Method | HTTP request | Description
 *ModelApi* | [**create_element_property_set_property_definition**](docs/ModelApi.md#create_element_property_set_property_definition) | **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
 *ModelApi* | [**create_element_property_set_property_definition_unit**](docs/ModelApi.md#create_element_property_set_property_definition_unit) | **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
 *ModelApi* | [**create_layer**](docs/ModelApi.md#create_layer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
+*ModelApi* | [**create_mask2_d**](docs/ModelApi.md#create_mask2_d) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Create or update a 2D mask for the model
 *ModelApi* | [**create_meta_building**](docs/ModelApi.md#create_meta_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
 *ModelApi* | [**create_model**](docs/ModelApi.md#create_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-model | Make a PDF or Image file a Model
 *ModelApi* | [**create_model_property_definition**](docs/ModelApi.md#create_model_property_definition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Create a PropertyDefinition on the model
@@ -380,6 +381,7 @@ Class | Method | HTTP request | Description
 *ModelApi* | [**delete_drawing**](docs/ModelApi.md#delete_drawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
 *ModelApi* | [**delete_element**](docs/ModelApi.md#delete_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
 *ModelApi* | [**delete_layer**](docs/ModelApi.md#delete_layer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
+*ModelApi* | [**delete_mask2_d**](docs/ModelApi.md#delete_mask2_d) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Delete the 2D mask for the model
 *ModelApi* | [**delete_model**](docs/ModelApi.md#delete_model) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
 *ModelApi* | [**delete_model_property**](docs/ModelApi.md#delete_model_property) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Delete a Property of a model
 *ModelApi* | [**delete_model_property_definition**](docs/ModelApi.md#delete_model_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Delete a PropertyDefinitions of a model
@@ -578,6 +580,8 @@ Class | Method | HTTP request | Description
  - [MarketplaceAppImage](docs/MarketplaceAppImage.md)
  - [MarketplaceAppLight](docs/MarketplaceAppLight.md)
  - [MarketplaceAppLightRequest](docs/MarketplaceAppLightRequest.md)
+ - [Mask2D](docs/Mask2D.md)
+ - [Mask2DRequest](docs/Mask2DRequest.md)
  - [Material](docs/Material.md)
  - [MaterialListComponent](docs/MaterialListComponent.md)
  - [MaterialListComponentRequest](docs/MaterialListComponentRequest.md)

bimdata-api-client/api/collaboration_api.py

@@ -8815,7 +8815,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        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  # noqa: E501
+        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  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True