PATCH: fix(storey): allow to add photosphere as storey plan + fix pro…

…cess_hint on createDocument (#790) * fix(storey): allow to add photosphere as storey plan * fix(storey): create STOREY_CHILD_TYPES list + add 'process_hint' to Docuemnt serializer fields
bimdata · Nov 19, 2024 · 556b744 · 556b744
1 parent f024c41
commit 556b744
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 8 deletions.
diff --git a/bimdata_api_client/api/collaboration_api.py b/bimdata_api_client/api/collaboration_api.py
@@ -962,6 +962,7 @@ def __init__(self, api_client=None):
                     'model_source',
                     'ifc_source',
                     'successor_of',
+                    'process_hint',
                 ],
                 'required': [
                     'cloud_pk',
@@ -976,6 +977,7 @@ def __init__(self, api_client=None):
                 'enum': [
                     'model_source',
                     'ifc_source',
+                    'process_hint',
                 ],
                 'validation': [
                     'name',
@@ -1010,6 +1012,10 @@ def __init__(self, api_client=None):
                         "EXPORT": "EXPORT",
                         "OPTIMIZED": "OPTIMIZED"
                     },
+                    ('process_hint',): {
+
+                        "PHOTOSPHERE": "PHOTOSPHERE"
+                    },
                 },
                 'openapi_types': {
                     'cloud_pk':
@@ -1032,6 +1038,8 @@ def __init__(self, api_client=None):
                         (str,),
                     'successor_of':
                         (int,),
+                    'process_hint':
+                        (str,),
                 },
                 'attribute_map': {
                     'cloud_pk': 'cloud_pk',
@@ -1044,6 +1052,7 @@ def __init__(self, api_client=None):
                     'model_source': 'model_source',
                     'ifc_source': 'ifc_source',
                     'successor_of': 'successor_of',
+                    'process_hint': 'process_hint',
                 },
                 'location_map': {
                     'cloud_pk': 'path',
@@ -1056,6 +1065,7 @@ def __init__(self, api_client=None):
                     'model_source': 'form',
                     'ifc_source': 'form',
                     'successor_of': 'form',
+                    'process_hint': 'form',
                 },
                 'collection_format_map': {
                 }
@@ -8805,7 +8815,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'GLTF', 'OBJ', 'IFC', 'DWG', 'DXF', 'POINT_CLOUD'}, 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 {'OBJ', 'IFC', 'GLTF', '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
 
@@ -8825,6 +8835,7 @@ def create_document(
             model_source (str): Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]
             ifc_source (str): DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]
             successor_of (int): Old document version to replace. Only for create. [optional]
+            process_hint (str): Provide a info about the document in order to customize the way it is processed.  * `PHOTOSPHERE` - PHOTOSPHERE. [optional] if omitted the server will use the default value of "PHOTOSPHERE"
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

diff --git a/bimdata_api_client/api/model_api.py b/bimdata_api_client/api/model_api.py
@@ -13347,7 +13347,7 @@ def create_building_plan(
     ):
         """Create a relation between a 2d model and a building  # noqa: E501
 
-        Create a relation between a 2d model and a building. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG')  Required scopes: ifc:write, model:write  # noqa: E501
+        Create a relation between a 2d model and a building. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG', 'PHOTOSPHERE')  Required scopes: ifc:write, model:write  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -15356,7 +15356,7 @@ def create_storey_plan(
     ):
         """Create a relation between a 2d model and a storey  # noqa: E501
 
-        Create a relation between a 2d model and a storey. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG')  Required scopes: ifc:write, model:write  # noqa: E501
+        Create a relation between a 2d model and a storey. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG', 'PHOTOSPHERE')  Required scopes: ifc:write, model:write  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

diff --git a/bimdata_api_client/model/patched_document_request.py b/bimdata_api_client/model/patched_document_request.py
@@ -70,6 +70,9 @@ class PatchedDocumentRequest(ModelNormal):
             'EXPORT': "EXPORT",
             'OPTIMIZED': "OPTIMIZED",
         },
+        ('process_hint',): {
+            'PHOTOSPHERE': "PHOTOSPHERE",
+        },
     }
 
     validations = {
@@ -112,6 +115,7 @@ def openapi_types():
             'model_source': (str,),  # noqa: E501
             'ifc_source': (str,),  # noqa: E501
             'successor_of': (int,),  # noqa: E501
+            'process_hint': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -128,6 +132,7 @@ def discriminator():
         'model_source': 'model_source',  # noqa: E501
         'ifc_source': 'ifc_source',  # noqa: E501
         'successor_of': 'successor_of',  # noqa: E501
+        'process_hint': 'process_hint',  # noqa: E501
     }
 
     read_only_vars = {
@@ -179,6 +184,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             model_source (str): Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]  # noqa: E501
             ifc_source (str): DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]  # noqa: E501
             successor_of (int): Old document version to replace. Only for create. [optional]  # noqa: E501
+            process_hint (str): Provide a info about the document in order to customize the way it is processed.  * `PHOTOSPHERE` - PHOTOSPHERE. [optional] if omitted the server will use the default value of "PHOTOSPHERE"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -268,6 +274,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             model_source (str): Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]  # noqa: E501
             ifc_source (str): DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]  # noqa: E501
             successor_of (int): Old document version to replace. Only for create. [optional]  # noqa: E501
+            process_hint (str): Provide a info about the document in order to customize the way it is processed.  * `PHOTOSPHERE` - PHOTOSPHERE. [optional] if omitted the server will use the default value of "PHOTOSPHERE"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -1481,9 +1481,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(),
             ],
@@ -1540,7 +1540,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'GLTF', 'OBJ', 'IFC', 'DWG', 'DXF', 'POINT_CLOUD'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -1604,6 +1604,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     model_source = "UPLOAD" # str | Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED (optional)
     ifc_source = "UPLOAD" # str | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED (optional)
     successor_of = 1 # int | Old document version to replace. Only for create (optional)
+    process_hint = "PHOTOSPHERE" # str | Provide a info about the document in order to customize the way it is processed.  * `PHOTOSPHERE` - PHOTOSPHERE (optional) if omitted the server will use the default value of "PHOTOSPHERE"
 
     # example passing only required values which don't have defaults set
     try:
@@ -1617,7 +1618,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Create a document
-        api_response = api_instance.create_document(cloud_pk, project_pk, name, file, parent_id=parent_id, file_name=file_name, description=description, model_source=model_source, ifc_source=ifc_source, successor_of=successor_of)
+        api_response = api_instance.create_document(cloud_pk, project_pk, name, file, parent_id=parent_id, file_name=file_name, description=description, model_source=model_source, ifc_source=ifc_source, successor_of=successor_of, process_hint=process_hint)
         pprint(api_response)
     except bimdata_api_client.ApiException as e:
         print("Exception when calling CollaborationApi->create_document: %s\n" % e)
@@ -1638,6 +1639,7 @@ Name | Type | Description  | Notes
  **model_source** | **str**| Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * &#x60;UPLOAD&#x60; - UPLOAD * &#x60;SPLIT&#x60; - SPLIT * &#x60;MERGE&#x60; - MERGE * &#x60;EXPORT&#x60; - EXPORT * &#x60;OPTIMIZED&#x60; - OPTIMIZED | [optional]
  **ifc_source** | **str**| DEPRECATED: Use &#39;model_source&#39; instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * &#x60;UPLOAD&#x60; - UPLOAD * &#x60;SPLIT&#x60; - SPLIT * &#x60;MERGE&#x60; - MERGE * &#x60;EXPORT&#x60; - EXPORT * &#x60;OPTIMIZED&#x60; - OPTIMIZED | [optional]
  **successor_of** | **int**| Old document version to replace. Only for create | [optional]
+ **process_hint** | **str**| Provide a info about the document in order to customize the way it is processed.  * &#x60;PHOTOSPHERE&#x60; - PHOTOSPHERE | [optional] if omitted the server will use the default value of "PHOTOSPHERE"
 
 ### Return type
 
@@ -10875,6 +10877,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
         model_source="UPLOAD",
         ifc_source="UPLOAD",
         successor_of=1,
+        process_hint="PHOTOSPHERE",
     ) # PatchedDocumentRequest |  (optional)
 
     # example passing only required values which don't have defaults set

diff --git a/docs/ModelApi.md b/docs/ModelApi.md
@@ -2160,7 +2160,7 @@ Name | Type | Description  | Notes
 
 Create a relation between a 2d model and a building
 
-Create a relation between a 2d model and a building. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG')  Required scopes: ifc:write, model:write
+Create a relation between a 2d model and a building. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG', 'PHOTOSPHERE')  Required scopes: ifc:write, model:write
 
 ### Example
 
@@ -4942,7 +4942,7 @@ Name | Type | Description  | Notes
 
 Create a relation between a 2d model and a storey
 
-Create a relation between a 2d model and a storey. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG')  Required scopes: ifc:write, model:write
+Create a relation between a 2d model and a storey. The model type must be one of : ('DWG', 'DXF', 'PDF', 'JPEG', 'PNG', 'PHOTOSPHERE')  Required scopes: ifc:write, model:write
 
 ### Example
 

diff --git a/docs/PatchedDocumentRequest.md b/docs/PatchedDocumentRequest.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **model_source** | **str** | Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * &#x60;UPLOAD&#x60; - UPLOAD * &#x60;SPLIT&#x60; - SPLIT * &#x60;MERGE&#x60; - MERGE * &#x60;EXPORT&#x60; - EXPORT * &#x60;OPTIMIZED&#x60; - OPTIMIZED | [optional] 
 **ifc_source** | **str** | DEPRECATED: Use &#39;model_source&#39; instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)  * &#x60;UPLOAD&#x60; - UPLOAD * &#x60;SPLIT&#x60; - SPLIT * &#x60;MERGE&#x60; - MERGE * &#x60;EXPORT&#x60; - EXPORT * &#x60;OPTIMIZED&#x60; - OPTIMIZED | [optional] 
 **successor_of** | **int** | Old document version to replace. Only for create | [optional] 
+**process_hint** | **str** | Provide a info about the document in order to customize the way it is processed.  * &#x60;PHOTOSPHERE&#x60; - PHOTOSPHERE | [optional]  if omitted the server will use the default value of "PHOTOSPHERE"
 **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)