MINOR: add model layout_name for DWG models (#780)

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

@@ -8860,7 +8860,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'OBJ', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', '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 {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, 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
 

bimdata_api_client/model/create_multi_page_model_request.py

@@ -83,6 +83,7 @@ def openapi_types():
         """
         return {
             'map_files': ([file_type],),  # noqa: E501
+            'layout_names': ([str], none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -92,6 +93,7 @@ def discriminator():
 
     attribute_map = {
         'map_files': 'map_files',  # noqa: E501
+        'layout_names': 'layout_names',  # noqa: E501
     }
 
     read_only_vars = {
@@ -138,6 +140,7 @@ def _from_openapi_data(cls, map_files, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            layout_names ([str], none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -223,6 +226,7 @@ def __init__(self, map_files, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            layout_names ([str], none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/model.py

@@ -102,6 +102,9 @@ class Model(ModelNormal):
         ('north_vector',): {
             'max_items': 2,
         },
+        ('layout_name',): {
+            'max_length': 256,
+        },
     }
 
     @cached_property
@@ -158,6 +161,7 @@ def openapi_types():
             'version': (str, none_type,),  # noqa: E501
             'north_vector': ([[float]], none_type,),  # noqa: E501
             'recommanded_2d_angle': (float, none_type,),  # noqa: E501
+            'layout_name': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -197,6 +201,7 @@ def discriminator():
         'version': 'version',  # noqa: E501
         'north_vector': 'north_vector',  # noqa: E501
         'recommanded_2d_angle': 'recommanded_2d_angle',  # noqa: E501
+        'layout_name': 'layout_name',  # noqa: E501
     }
 
     read_only_vars = {
@@ -296,6 +301,7 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -408,6 +414,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/model_serializer_without_children.py

@@ -100,6 +100,9 @@ class ModelSerializerWithoutChildren(ModelNormal):
         ('north_vector',): {
             'max_items': 2,
         },
+        ('layout_name',): {
+            'max_length': 256,
+        },
     }
 
     @cached_property
@@ -155,6 +158,7 @@ def openapi_types():
             'version': (str, none_type,),  # noqa: E501
             'north_vector': ([[float]], none_type,),  # noqa: E501
             'recommanded_2d_angle': (float, none_type,),  # noqa: E501
+            'layout_name': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -193,6 +197,7 @@ def discriminator():
         'version': 'version',  # noqa: E501
         'north_vector': 'north_vector',  # noqa: E501
         'recommanded_2d_angle': 'recommanded_2d_angle',  # noqa: E501
+        'layout_name': 'layout_name',  # noqa: E501
     }
 
     read_only_vars = {
@@ -290,6 +295,7 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -401,6 +407,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/patched_model_request.py

@@ -78,6 +78,9 @@ class PatchedModelRequest(ModelNormal):
         ('north_vector',): {
             'max_items': 2,
         },
+        ('layout_name',): {
+            'max_length': 256,
+        },
     }
 
     @cached_property
@@ -109,6 +112,7 @@ def openapi_types():
             'version': (str, none_type,),  # noqa: E501
             'north_vector': ([[float]], none_type,),  # noqa: E501
             'recommanded_2d_angle': (float, none_type,),  # noqa: E501
+            'layout_name': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -125,6 +129,7 @@ def discriminator():
         'version': 'version',  # noqa: E501
         'north_vector': 'north_vector',  # noqa: E501
         'recommanded_2d_angle': 'recommanded_2d_angle',  # noqa: E501
+        'layout_name': 'layout_name',  # noqa: E501
     }
 
     read_only_vars = {
@@ -176,6 +181,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -265,6 +271,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             version (str, none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             north_vector ([[float]], none_type): This field is only for information. Updating it won't impact the export.. [optional]  # noqa: E501
             recommanded_2d_angle (float, none_type): 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]  # noqa: E501
+            layout_name (str, none_type): The name of the DWG layout (only set when type==DWG). [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

docs/CollaborationApi.md

@@ -1482,9 +1482,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     id = 1 # int | A unique integer value identifying this project.
     write_folder_request = [
         WriteFolderRequest(
+            name="name_example",
             default_permission=1,
             parent_id=1,
-            name="name_example",
             children=[
                 WriteFolderRequest(),
             ],
@@ -1541,7 +1541,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'OBJ', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/CreateMultiPageModelRequest.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **map_files** | **[file_type]** |  | 
+**layout_names** | **[str], none_type** |  | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/Model.md

@@ -35,6 +35,7 @@ Name | Type | Description | Notes
 **version** | **str, none_type** | This field is only for information. Updating it won't impact the export. | [optional] 
 **north_vector** | **[[float]], none_type** | This field is only for information. Updating it won't impact the export. | [optional] 
 **recommanded_2d_angle** | **float, none_type** | 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] 
+**layout_name** | **str, none_type** | The name of the DWG layout (only set when type==DWG) | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ModelApi.md

@@ -3986,6 +3986,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
         map_files=[
             open('/path/to/file', 'rb'),
         ],
+        layout_names=[
+            "layout_names_example",
+        ],
     ) # CreateMultiPageModelRequest | 
 
     # example passing only required values which don't have defaults set
@@ -16431,6 +16434,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
             ],
         ],
         recommanded_2d_angle=3.14,
+        layout_name="layout_name_example",
     ) # PatchedModelRequest |  (optional)
 
     # example passing only required values which don't have defaults set

docs/ModelSerializerWithoutChildren.md

@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **version** | **str, none_type** | This field is only for information. Updating it won't impact the export. | [optional] 
 **north_vector** | **[[float]], none_type** | This field is only for information. Updating it won't impact the export. | [optional] 
 **recommanded_2d_angle** | **float, none_type** | 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] 
+**layout_name** | **str, none_type** | The name of the DWG layout (only set when type==DWG) | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)