PATCH: add head_id field to Document serializer (#669)

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

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

@@ -129,8 +129,9 @@ def openapi_types():
             'model_id': (int, none_type,),  # noqa: E501
             'model_type': (str, none_type,),  # noqa: E501
             'ifc_id': (int, none_type,),  # noqa: E501
-            'user_permission': (int,),  # noqa: E501
+            'head_id': (int, none_type,),  # noqa: E501
             'is_head_version': (bool,),  # noqa: E501
+            'user_permission': (int,),  # noqa: E501
             'office_preview': (str, none_type,),  # noqa: E501
             'parent_id': (int, none_type,),  # noqa: E501
             'file_name': (str,),  # noqa: E501
@@ -156,8 +157,9 @@ def discriminator():
         'model_id': 'model_id',  # noqa: E501
         'model_type': 'model_type',  # noqa: E501
         'ifc_id': 'ifc_id',  # noqa: E501
-        'user_permission': 'user_permission',  # noqa: E501
+        'head_id': 'head_id',  # noqa: E501
         'is_head_version': 'is_head_version',  # noqa: E501
+        'user_permission': 'user_permission',  # noqa: E501
         'office_preview': 'office_preview',  # noqa: E501
         'parent_id': 'parent_id',  # noqa: E501
         'file_name': 'file_name',  # noqa: E501
@@ -176,16 +178,17 @@ def discriminator():
         'model_id',  # noqa: E501
         'model_type',  # noqa: E501
         'ifc_id',  # noqa: E501
-        'user_permission',  # noqa: E501
+        'head_id',  # noqa: E501
         'is_head_version',  # noqa: E501
+        'user_permission',  # noqa: E501
         'office_preview',  # noqa: E501
     }
 
     _composed_schemas = {}
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, id, created_by, project, name, file, size, tags, visas, created_at, updated_at, model_id, model_type, ifc_id, user_permission, is_head_version, office_preview, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, id, created_by, project, name, file, size, tags, visas, created_at, updated_at, model_id, model_type, ifc_id, head_id, is_head_version, user_permission, office_preview, *args, **kwargs):  # noqa: E501
         """Document - a model defined in OpenAPI
 
         Args:
@@ -202,8 +205,9 @@ def _from_openapi_data(cls, id, created_by, project, name, file, size, tags, vis
             model_id (int, none_type):
             model_type (str, none_type): Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD
             ifc_id (int, none_type): DEPRECATED: Use 'model_id' instead.
-            user_permission (int): Aggregate of group user permissions and folder default permission
+            head_id (int, none_type): Document id of head version
             is_head_version (bool): Document is a head of version or is owned by another document
+            user_permission (int): Aggregate of group user permissions and folder default permission
             office_preview (str, none_type): Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
 
         Keyword Args:
@@ -280,8 +284,9 @@ def _from_openapi_data(cls, id, created_by, project, name, file, size, tags, vis
         self.model_id = model_id
         self.model_type = model_type
         self.ifc_id = ifc_id
-        self.user_permission = user_permission
+        self.head_id = head_id
         self.is_head_version = is_head_version
+        self.user_permission = user_permission
         self.office_preview = office_preview
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \

docs/CollaborationApi.md

@@ -1527,7 +1527,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'GLTF', 'POINT_CLOUD', 'DWG', 'OBJ', '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', 'DXF', 'POINT_CLOUD', 'OBJ', 'IFC', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/Document.md

@@ -17,8 +17,9 @@ Name | Type | Description | Notes
 **model_id** | **int, none_type** |  | [readonly] 
 **model_type** | **str, none_type** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD | [readonly] 
 **ifc_id** | **int, none_type** | DEPRECATED: Use 'model_id' instead. | [readonly] 
-**user_permission** | **int** | Aggregate of group user permissions and folder default permission | [readonly] 
+**head_id** | **int, none_type** | Document id of head version | [readonly] 
 **is_head_version** | **bool** | Document is a head of version or is owned by another document | [readonly] 
+**user_permission** | **int** | Aggregate of group user permissions and folder default permission | [readonly] 
 **office_preview** | **str, none_type** | 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] 
 **parent_id** | **int, none_type** |  | [optional] 
 **file_name** | **str** | Full name of the file | [optional]