MINOR: add element/documents route

Bimdata-io · Bimdata-io · commit 68a02e7d227d · 2021-12-22T16:25:00.000Z
diff --git a/README.md b/README.md
@@ -316,6 +316,7 @@ Class | Method | HTTP request | Description
 *IfcApi* | [**get_classifications_of_element**](docs/IfcApi.md#get_classifications_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification | Retrieve all classifications of an element
 *IfcApi* | [**get_documents_of_element**](docs/IfcApi.md#get_documents_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/documents | Retrieve all documents of an element
 *IfcApi* | [**get_element**](docs/IfcApi.md#get_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Retrieve an element of a model
+*IfcApi* | [**get_element_linked_documents**](docs/IfcApi.md#get_element_linked_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/documents | Retrieve all documents linked to any element
 *IfcApi* | [**get_element_property_set**](docs/IfcApi.md#get_element_property_set) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id} | Retrieve a PropertySet of an element
 *IfcApi* | [**get_element_property_set_properties**](docs/IfcApi.md#get_element_property_set_properties) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Retrieve all Properties of a PropertySet
 *IfcApi* | [**get_element_property_set_property**](docs/IfcApi.md#get_element_property_set_property) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Retrieve a Property of a PropertySet
@@ -413,6 +414,7 @@ Class | Method | HTTP request | Description
  - [ComponentsParent](docs/ComponentsParent.md)
  - [Direction](docs/Direction.md)
  - [Document](docs/Document.md)
+ - [DocumentWithElementList](docs/DocumentWithElementList.md)
  - [Element](docs/Element.md)
  - [ElementClassificationRelation](docs/ElementClassificationRelation.md)
  - [ElementPropertySetRelation](docs/ElementPropertySetRelation.md)
diff --git a/bimdata_api_client/__init__.py b/bimdata_api_client/__init__.py
@@ -48,6 +48,7 @@
 from bimdata_api_client.models.components_parent import ComponentsParent
 from bimdata_api_client.models.direction import Direction
 from bimdata_api_client.models.document import Document
+from bimdata_api_client.models.document_with_element_list import DocumentWithElementList
 from bimdata_api_client.models.element import Element
 from bimdata_api_client.models.element_classification_relation import ElementClassificationRelation
 from bimdata_api_client.models.element_property_set_relation import ElementPropertySetRelation
diff --git a/bimdata_api_client/api/ifc_api.py b/bimdata_api_client/api/ifc_api.py
@@ -7249,6 +7249,153 @@ def get_element_with_http_info(self, cloud_pk, ifc_pk, project_pk, uuid, **kwarg
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def get_element_linked_documents(self, cloud_pk, ifc_pk, project_pk, **kwargs):  # noqa: E501
+        """Retrieve all documents linked to any element  # noqa: E501
+
+        Retrieve all documents linked to any element with the list of uuids Required scopes: ifc:read  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_element_linked_documents(cloud_pk, ifc_pk, project_pk, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str cloud_pk: (required)
+        :param str ifc_pk: (required)
+        :param str project_pk: (required)
+        :param str type: Filter the returned list by type
+        :param str classification: Filter the returned list by classification
+        :param str classification__notation: Filter the returned list by classification__notation
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: list[DocumentWithElementList]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.get_element_linked_documents_with_http_info(cloud_pk, ifc_pk, project_pk, **kwargs)  # noqa: E501
+
+    def get_element_linked_documents_with_http_info(self, cloud_pk, ifc_pk, project_pk, **kwargs):  # noqa: E501
+        """Retrieve all documents linked to any element  # noqa: E501
+
+        Retrieve all documents linked to any element with the list of uuids Required scopes: ifc:read  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_element_linked_documents_with_http_info(cloud_pk, ifc_pk, project_pk, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str cloud_pk: (required)
+        :param str ifc_pk: (required)
+        :param str project_pk: (required)
+        :param str type: Filter the returned list by type
+        :param str classification: Filter the returned list by classification
+        :param str classification__notation: Filter the returned list by classification__notation
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(list[DocumentWithElementList], status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'cloud_pk',
+            'ifc_pk',
+            'project_pk',
+            'type',
+            'classification',
+            'classification__notation'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_element_linked_documents" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'cloud_pk' is set
+        if self.api_client.client_side_validation and ('cloud_pk' not in local_var_params or  # noqa: E501
+                                                        local_var_params['cloud_pk'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `cloud_pk` when calling `get_element_linked_documents`")  # noqa: E501
+        # verify the required parameter 'ifc_pk' is set
+        if self.api_client.client_side_validation and ('ifc_pk' not in local_var_params or  # noqa: E501
+                                                        local_var_params['ifc_pk'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `ifc_pk` when calling `get_element_linked_documents`")  # noqa: E501
+        # verify the required parameter 'project_pk' is set
+        if self.api_client.client_side_validation and ('project_pk' not in local_var_params or  # noqa: E501
+                                                        local_var_params['project_pk'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `project_pk` when calling `get_element_linked_documents`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'cloud_pk' in local_var_params:
+            path_params['cloud_pk'] = local_var_params['cloud_pk']  # noqa: E501
+        if 'ifc_pk' in local_var_params:
+            path_params['ifc_pk'] = local_var_params['ifc_pk']  # noqa: E501
+        if 'project_pk' in local_var_params:
+            path_params['project_pk'] = local_var_params['project_pk']  # noqa: E501
+
+        query_params = []
+        if 'type' in local_var_params and local_var_params['type'] is not None:  # noqa: E501
+            query_params.append(('type', local_var_params['type']))  # noqa: E501
+        if 'classification' in local_var_params and local_var_params['classification'] is not None:  # noqa: E501
+            query_params.append(('classification', local_var_params['classification']))  # noqa: E501
+        if 'classification__notation' in local_var_params and local_var_params['classification__notation'] is not None:  # noqa: E501
+            query_params.append(('classification__notation', local_var_params['classification__notation']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['Bearer', 'bimdata_connect', 'client_credentials']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/documents', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[DocumentWithElementList]',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def get_element_property_set(self, cloud_pk, element_uuid, id, ifc_pk, project_pk, **kwargs):  # noqa: E501
         """Retrieve a PropertySet of an element  # noqa: E501
 
diff --git a/bimdata_api_client/models/__init__.py b/bimdata_api_client/models/__init__.py
@@ -29,6 +29,7 @@
 from bimdata_api_client.models.components_parent import ComponentsParent
 from bimdata_api_client.models.direction import Direction
 from bimdata_api_client.models.document import Document
+from bimdata_api_client.models.document_with_element_list import DocumentWithElementList
 from bimdata_api_client.models.element import Element
 from bimdata_api_client.models.element_classification_relation import ElementClassificationRelation
 from bimdata_api_client.models.element_property_set_relation import ElementPropertySetRelation
diff --git a/bimdata_api_client/models/document_with_element_list.py b/bimdata_api_client/models/document_with_element_list.py
@@ -0,0 +1,147 @@
+# coding: utf-8
+
+"""
+    BIMData API
+
+    BIMData API is a tool to interact with your models stored on BIMData’s servers.     Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints.  # noqa: E501
+
+    The version of the OpenAPI document: v1
+    Contact: support@bimdata.io
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from bimdata_api_client.configuration import Configuration
+
+
+class DocumentWithElementList(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'document': 'Document',
+        'element_ids': 'list[int]'
+    }
+
+    attribute_map = {
+        'document': 'document',
+        'element_ids': 'element_ids'
+    }
+
+    def __init__(self, document=None, element_ids=None, local_vars_configuration=None):  # noqa: E501
+        """DocumentWithElementList - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._document = None
+        self._element_ids = None
+        self.discriminator = None
+
+        if document is not None:
+            self.document = document
+        if element_ids is not None:
+            self.element_ids = element_ids
+
+    @property
+    def document(self):
+        """Gets the document of this DocumentWithElementList.  # noqa: E501
+
+
+        :return: The document of this DocumentWithElementList.  # noqa: E501
+        :rtype: Document
+        """
+        return self._document
+
+    @document.setter
+    def document(self, document):
+        """Sets the document of this DocumentWithElementList.
+
+
+        :param document: The document of this DocumentWithElementList.  # noqa: E501
+        :type: Document
+        """
+
+        self._document = document
+
+    @property
+    def element_ids(self):
+        """Gets the element_ids of this DocumentWithElementList.  # noqa: E501
+
+
+        :return: The element_ids of this DocumentWithElementList.  # noqa: E501
+        :rtype: list[int]
+        """
+        return self._element_ids
+
+    @element_ids.setter
+    def element_ids(self, element_ids):
+        """Sets the element_ids of this DocumentWithElementList.
+
+
+        :param element_ids: The element_ids of this DocumentWithElementList.  # noqa: E501
+        :type: list[int]
+        """
+
+        self._element_ids = element_ids
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, DocumentWithElementList):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, DocumentWithElementList):
+            return True
+
+        return self.to_dict() != other.to_dict()
diff --git a/docs/DocumentWithElementList.md b/docs/DocumentWithElementList.md
@@ -0,0 +1,11 @@
+# DocumentWithElementList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Document**](Document.md) |  | [optional] 
+**element_ids** | **list[int]** |  | [optional] [readonly] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/IfcApi.md b/docs/IfcApi.md
diff --git a/test/test_document_with_element_list.py b/test/test_document_with_element_list.py
diff --git a/test/test_ifc_api.py b/test/test_ifc_api.py
