PATCH: rename model 360 field (#576)

* rename model 360 field

* keep viewer_360_file field

* remove useless field in write only serializer

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

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

@@ -10577,7 +10577,7 @@ def __init__(self, api_client=None):
                     'gltf_file',
                     'gltf_with_openings_file',
                     'bvh_tree_file',
-                    'viewer_360_file',
+                    'preview_file',
                     'xkt_file',
                 ],
                 'required': [
@@ -10592,7 +10592,7 @@ def __init__(self, api_client=None):
                     'gltf_file',
                     'gltf_with_openings_file',
                     'bvh_tree_file',
-                    'viewer_360_file',
+                    'preview_file',
                     'xkt_file',
                 ],
                 'enum': [
@@ -10624,7 +10624,7 @@ def __init__(self, api_client=None):
                         (file_type, none_type,),
                     'bvh_tree_file':
                         (file_type, none_type,),
-                    'viewer_360_file':
+                    'preview_file':
                         (file_type, none_type,),
                     'xkt_file':
                         (file_type, none_type,),
@@ -10639,7 +10639,7 @@ def __init__(self, api_client=None):
                     'gltf_file': 'gltf_file',
                     'gltf_with_openings_file': 'gltf_with_openings_file',
                     'bvh_tree_file': 'bvh_tree_file',
-                    'viewer_360_file': 'viewer_360_file',
+                    'preview_file': 'preview_file',
                     'xkt_file': 'xkt_file',
                 },
                 'location_map': {
@@ -10652,7 +10652,7 @@ def __init__(self, api_client=None):
                     'gltf_file': 'form',
                     'gltf_with_openings_file': 'form',
                     'bvh_tree_file': 'form',
-                    'viewer_360_file': 'form',
+                    'preview_file': 'form',
                     'xkt_file': 'form',
                 },
                 'collection_format_map': {
@@ -24604,7 +24604,7 @@ def update_ifc_files_deprecated(
             gltf_file (file_type, none_type): [optional]
             gltf_with_openings_file (file_type, none_type): [optional]
             bvh_tree_file (file_type, none_type): [optional]
-            viewer_360_file (file_type, none_type): [optional]
+            preview_file (file_type, none_type): [optional]
             xkt_file (file_type, none_type): [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.

bimdata_api_client/api/model_api.py

@@ -9819,7 +9819,7 @@ def __init__(self, api_client=None):
                     'gltf_file',
                     'gltf_with_openings_file',
                     'bvh_tree_file',
-                    'viewer_360_file',
+                    'preview_file',
                     'xkt_file',
                 ],
                 'required': [
@@ -9834,7 +9834,7 @@ def __init__(self, api_client=None):
                     'gltf_file',
                     'gltf_with_openings_file',
                     'bvh_tree_file',
-                    'viewer_360_file',
+                    'preview_file',
                     'xkt_file',
                 ],
                 'enum': [
@@ -9866,7 +9866,7 @@ def __init__(self, api_client=None):
                         (file_type, none_type,),
                     'bvh_tree_file':
                         (file_type, none_type,),
-                    'viewer_360_file':
+                    'preview_file':
                         (file_type, none_type,),
                     'xkt_file':
                         (file_type, none_type,),
@@ -9881,7 +9881,7 @@ def __init__(self, api_client=None):
                     'gltf_file': 'gltf_file',
                     'gltf_with_openings_file': 'gltf_with_openings_file',
                     'bvh_tree_file': 'bvh_tree_file',
-                    'viewer_360_file': 'viewer_360_file',
+                    'preview_file': 'preview_file',
                     'xkt_file': 'xkt_file',
                 },
                 'location_map': {
@@ -9894,7 +9894,7 @@ def __init__(self, api_client=None):
                     'gltf_file': 'form',
                     'gltf_with_openings_file': 'form',
                     'bvh_tree_file': 'form',
-                    'viewer_360_file': 'form',
+                    'preview_file': 'form',
                     'xkt_file': 'form',
                 },
                 'collection_format_map': {
@@ -22858,7 +22858,7 @@ def update_model_files(
             gltf_file (file_type, none_type): [optional]
             gltf_with_openings_file (file_type, none_type): [optional]
             bvh_tree_file (file_type, none_type): [optional]
-            viewer_360_file (file_type, none_type): [optional]
+            preview_file (file_type, none_type): [optional]
             xkt_file (file_type, none_type): [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.

bimdata_api_client/model/model.py

@@ -136,7 +136,8 @@ def openapi_types():
             'map_file': (str, none_type,),  # noqa: E501
             'gltf_file': (str, none_type,),  # noqa: E501
             'bvh_tree_file': (str, none_type,),  # noqa: E501
-            'viewer_360_file': (str, none_type,),  # noqa: E501
+            'preview_file': (str, none_type,),  # noqa: E501
+            'viewer_360_file': (str,),  # noqa: E501
             'xkt_file': (str, none_type,),  # noqa: E501
             'project_id': (int, none_type,),  # noqa: E501
             'errors': ([str], none_type,),  # noqa: E501
@@ -170,6 +171,7 @@ def discriminator():
         'map_file': 'map_file',  # noqa: E501
         'gltf_file': 'gltf_file',  # noqa: E501
         'bvh_tree_file': 'bvh_tree_file',  # noqa: E501
+        'preview_file': 'preview_file',  # noqa: E501
         'viewer_360_file': 'viewer_360_file',  # noqa: E501
         'xkt_file': 'xkt_file',  # noqa: E501
         'project_id': 'project_id',  # noqa: E501
@@ -199,7 +201,7 @@ def discriminator():
         'map_file',  # noqa: E501
         'gltf_file',  # noqa: E501
         'bvh_tree_file',  # noqa: E501
-        'viewer_360_file',  # noqa: E501
+        'preview_file',  # noqa: E501
         'xkt_file',  # noqa: E501
         'project_id',  # noqa: E501
         'errors',  # noqa: E501
@@ -210,7 +212,7 @@ def discriminator():
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, document_id, document, structure_file, systems_file, map_file, gltf_file, bvh_tree_file, viewer_360_file, xkt_file, project_id, errors, warnings, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, document_id, document, structure_file, systems_file, map_file, gltf_file, bvh_tree_file, preview_file, viewer_360_file, xkt_file, project_id, errors, warnings, *args, **kwargs):  # noqa: E501
         """Model - a model defined in OpenAPI
 
         Args:
@@ -227,7 +229,8 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
             map_file (str, none_type):
             gltf_file (str, none_type):
             bvh_tree_file (str, none_type):
-            viewer_360_file (str, none_type):
+            preview_file (str, none_type):
+            viewer_360_file (str): DEPRECATED: Use 'preview_file' instead.
             xkt_file (str, none_type):
             project_id (int, none_type):
             errors ([str], none_type): List of errors that happened during IFC processing
@@ -312,6 +315,7 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
         self.map_file = map_file
         self.gltf_file = gltf_file
         self.bvh_tree_file = bvh_tree_file
+        self.preview_file = preview_file
         self.viewer_360_file = viewer_360_file
         self.xkt_file = xkt_file
         self.project_id = project_id
@@ -337,9 +341,10 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
+    def __init__(self, viewer_360_file, *args, **kwargs):  # noqa: E501
         """Model - a model defined in OpenAPI
 
+            viewer_360_file (str): DEPRECATED: Use 'preview_file' instead.
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -404,6 +409,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.viewer_360_file = viewer_360_file
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

bimdata_api_client/model/model_files.py

@@ -88,7 +88,7 @@ def openapi_types():
             'gltf_file': (str, none_type,),  # noqa: E501
             'gltf_with_openings_file': (str, none_type,),  # noqa: E501
             'bvh_tree_file': (str, none_type,),  # noqa: E501
-            'viewer_360_file': (str, none_type,),  # noqa: E501
+            'preview_file': (str, none_type,),  # noqa: E501
             'xkt_file': (str, none_type,),  # noqa: E501
         }
 
@@ -104,7 +104,7 @@ def discriminator():
         'gltf_file': 'gltf_file',  # noqa: E501
         'gltf_with_openings_file': 'gltf_with_openings_file',  # noqa: E501
         'bvh_tree_file': 'bvh_tree_file',  # noqa: E501
-        'viewer_360_file': 'viewer_360_file',  # noqa: E501
+        'preview_file': 'preview_file',  # noqa: E501
         'xkt_file': 'xkt_file',  # noqa: E501
     }
 
@@ -155,7 +155,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             gltf_file (str, none_type): [optional]  # noqa: E501
             gltf_with_openings_file (str, none_type): [optional]  # noqa: E501
             bvh_tree_file (str, none_type): [optional]  # noqa: E501
-            viewer_360_file (str, none_type): [optional]  # noqa: E501
+            preview_file (str, none_type): [optional]  # noqa: E501
             xkt_file (str, none_type): [optional]  # noqa: E501
         """
 
@@ -244,7 +244,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             gltf_file (str, none_type): [optional]  # noqa: E501
             gltf_with_openings_file (str, none_type): [optional]  # noqa: E501
             bvh_tree_file (str, none_type): [optional]  # noqa: E501
-            viewer_360_file (str, none_type): [optional]  # noqa: E501
+            preview_file (str, none_type): [optional]  # noqa: E501
             xkt_file (str, none_type): [optional]  # noqa: E501
         """
 

bimdata_api_client/model/model_request.py

@@ -101,6 +101,7 @@ def openapi_types():
                 and the value is attribute type.
         """
         return {
+            'viewer_360_file': (file_type,),  # noqa: E501
             'name': (str, none_type,),  # noqa: E501
             'source': (str,),  # noqa: E501
             'world_position': ([float], none_type,),  # noqa: E501
@@ -117,6 +118,7 @@ def discriminator():
 
 
     attribute_map = {
+        'viewer_360_file': 'viewer_360_file',  # noqa: E501
         'name': 'name',  # noqa: E501
         'source': 'source',  # noqa: E501
         'world_position': 'world_position',  # noqa: E501
@@ -134,9 +136,12 @@ def discriminator():
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, viewer_360_file, *args, **kwargs):  # noqa: E501
         """ModelRequest - a model defined in OpenAPI
 
+        Args:
+            viewer_360_file (file_type): DEPRECATED: Use 'preview_file' instead.
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -203,6 +208,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.viewer_360_file = viewer_360_file
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -223,9 +229,12 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
+    def __init__(self, viewer_360_file, *args, **kwargs):  # noqa: E501
         """ModelRequest - a model defined in OpenAPI
 
+        Args:
+            viewer_360_file (file_type): DEPRECATED: Use 'preview_file' instead.
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -290,6 +299,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.viewer_360_file = viewer_360_file
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

bimdata_api_client/model/patched_model_request.py

@@ -103,6 +103,7 @@ def openapi_types():
         return {
             'name': (str, none_type,),  # noqa: E501
             'source': (str,),  # noqa: E501
+            'viewer_360_file': (file_type,),  # noqa: E501
             'world_position': ([float], none_type,),  # noqa: E501
             'size_ratio': (float, none_type,),  # noqa: E501
             'archived': (bool,),  # noqa: E501
@@ -119,6 +120,7 @@ def discriminator():
     attribute_map = {
         'name': 'name',  # noqa: E501
         'source': 'source',  # noqa: E501
+        'viewer_360_file': 'viewer_360_file',  # noqa: E501
         'world_position': 'world_position',  # noqa: E501
         'size_ratio': 'size_ratio',  # noqa: E501
         'archived': 'archived',  # noqa: E501
@@ -170,6 +172,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 _visited_composed_classes = (Animal,)
             name (str, none_type): [optional]  # noqa: E501
             source (str): [optional]  # noqa: E501
+            viewer_360_file (file_type): DEPRECATED: Use 'preview_file' instead.. [optional]  # noqa: E501
             world_position ([float], none_type): [x,y,z] array of the position of the local_placement in world coordinates. [optional]  # noqa: E501
             size_ratio (float, none_type): How many meters a unit represents. [optional]  # noqa: E501
             archived (bool): [optional]  # noqa: E501
@@ -259,6 +262,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 _visited_composed_classes = (Animal,)
             name (str, none_type): [optional]  # noqa: E501
             source (str): [optional]  # noqa: E501
+            viewer_360_file (file_type): DEPRECATED: Use 'preview_file' instead.. [optional]  # noqa: E501
             world_position ([float], none_type): [x,y,z] array of the position of the local_placement in world coordinates. [optional]  # noqa: E501
             size_ratio (float, none_type): How many meters a unit represents. [optional]  # noqa: E501
             archived (bool): [optional]  # noqa: E501

docs/CollaborationApi.md

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

docs/IfcApi.md

@@ -16347,6 +16347,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     patched_model_request = PatchedModelRequest(
         name="name_example",
         source="UPLOAD",
+        viewer_360_file=open('/path/to/file', 'rb'),
         world_position=[
             3.14,
         ],
@@ -16484,7 +16485,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     gltf_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
     gltf_with_openings_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
     bvh_tree_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
-    viewer_360_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
+    preview_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
     xkt_file = open('/path/to/file', 'rb') # file_type, none_type |  (optional)
 
     # example passing only required values which don't have defaults set
@@ -16499,7 +16500,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Update models file (gltf, svg, structure, etc)
-        api_response = api_instance.update_ifc_files_deprecated(cloud_pk, id, project_pk, structure_file=structure_file, systems_file=systems_file, map_file=map_file, gltf_file=gltf_file, gltf_with_openings_file=gltf_with_openings_file, bvh_tree_file=bvh_tree_file, viewer_360_file=viewer_360_file, xkt_file=xkt_file)
+        api_response = api_instance.update_ifc_files_deprecated(cloud_pk, id, project_pk, structure_file=structure_file, systems_file=systems_file, map_file=map_file, gltf_file=gltf_file, gltf_with_openings_file=gltf_with_openings_file, bvh_tree_file=bvh_tree_file, preview_file=preview_file, xkt_file=xkt_file)
         pprint(api_response)
     except bimdata_api_client.ApiException as e:
         print("Exception when calling IfcApi->update_ifc_files_deprecated: %s\n" % e)
@@ -16519,7 +16520,7 @@ Name | Type | Description  | Notes
  **gltf_file** | **file_type, none_type**|  | [optional]
  **gltf_with_openings_file** | **file_type, none_type**|  | [optional]
  **bvh_tree_file** | **file_type, none_type**|  | [optional]
- **viewer_360_file** | **file_type, none_type**|  | [optional]
+ **preview_file** | **file_type, none_type**|  | [optional]
  **xkt_file** | **file_type, none_type**|  | [optional]
 
 ### Return type

docs/Model.md

@@ -17,7 +17,8 @@ Name | Type | Description | Notes
 **map_file** | **str, none_type** |  | [readonly] 
 **gltf_file** | **str, none_type** |  | [readonly] 
 **bvh_tree_file** | **str, none_type** |  | [readonly] 
-**viewer_360_file** | **str, none_type** |  | [readonly] 
+**preview_file** | **str, none_type** |  | [readonly] 
+**viewer_360_file** | **str** | DEPRECATED: Use 'preview_file' instead. | 
 **xkt_file** | **str, none_type** |  | [readonly] 
 **project_id** | **int, none_type** |  | [readonly] 
 **errors** | **[str], none_type** | List of errors that happened during IFC processing | [readonly]