bimdata-api-client 10.2.2__tar.gz → 10.4.0__tar.gz

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bimdata-api-client
-Version: 10.2.2
+Version: 10.4.0
 Summary: BIMData API
 Home-page: https://github.com/bimdata/python-api-client
 Author: BIMData.io
@@ -579,6 +579,7 @@ Class | Method | HTTP request | Description
  - [LayerElement](docs/LayerElement.md)
  - [LayerElementRequest](docs/LayerElementRequest.md)
  - [LayerRequest](docs/LayerRequest.md)
+ - [LightDocument](docs/LightDocument.md)
  - [Line](docs/Line.md)
  - [LineRequest](docs/LineRequest.md)
  - [LogEntry](docs/LogEntry.md)
@@ -741,6 +742,7 @@ Class | Method | HTTP request | Description
  - [VisaRequest](docs/VisaRequest.md)
  - [VisaValidation](docs/VisaValidation.md)
  - [VisaValidationRequest](docs/VisaValidationRequest.md)
+ - [VisaWithDocument](docs/VisaWithDocument.md)
  - [Visibility](docs/Visibility.md)
  - [VisibilityRequest](docs/VisibilityRequest.md)
  - [WebHook](docs/WebHook.md)

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/README.md

@@ -569,6 +569,7 @@ Class | Method | HTTP request | Description
  - [LayerElement](docs/LayerElement.md)
  - [LayerElementRequest](docs/LayerElementRequest.md)
  - [LayerRequest](docs/LayerRequest.md)
+ - [LightDocument](docs/LightDocument.md)
  - [Line](docs/Line.md)
  - [LineRequest](docs/LineRequest.md)
  - [LogEntry](docs/LogEntry.md)
@@ -731,6 +732,7 @@ Class | Method | HTTP request | Description
  - [VisaRequest](docs/VisaRequest.md)
  - [VisaValidation](docs/VisaValidation.md)
  - [VisaValidationRequest](docs/VisaValidationRequest.md)
+ - [VisaWithDocument](docs/VisaWithDocument.md)
  - [Visibility](docs/Visibility.md)
  - [VisibilityRequest](docs/VisibilityRequest.md)
  - [WebHook](docs/WebHook.md)

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/bimdata_api_client/api/collaboration_api.py

@@ -79,6 +79,7 @@ from bimdata_api_client.model.visa_comment_request import VisaCommentRequest
 from bimdata_api_client.model.visa_request import VisaRequest
 from bimdata_api_client.model.visa_validation import VisaValidation
 from bimdata_api_client.model.visa_validation_request import VisaValidationRequest
+from bimdata_api_client.model.visa_with_document import VisaWithDocument
 from bimdata_api_client.model.write_folder_request import WriteFolderRequest
 
 
@@ -4584,7 +4585,7 @@ class CollaborationApi(object):
         )
         self.get_project_creator_visas_endpoint = _Endpoint(
             settings={
-                'response_type': ([Visa],),
+                'response_type': ([VisaWithDocument],),
                 'auth': [
                     'ApiKey',
                     'BIMData_Connect',
@@ -5110,7 +5111,7 @@ class CollaborationApi(object):
         )
         self.get_project_validator_visas_endpoint = _Endpoint(
             settings={
-                'response_type': ([Visa],),
+                'response_type': ([VisaWithDocument],),
                 'auth': [
                     'ApiKey',
                     'BIMData_Connect',
@@ -8859,7 +8860,7 @@ class CollaborationApi(object):
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'DWG', 'OBJ', 'DXF', 'POINT_CLOUD', 'IFC', '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 {'POINT_CLOUD', 'DXF', 'GLTF', 'DWG', 'IFC', 'OBJ'}, 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
 
@@ -13214,7 +13215,7 @@ class CollaborationApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            [Visa]
+            [VisaWithDocument]
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -13875,7 +13876,7 @@ class CollaborationApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            [Visa]
+            [VisaWithDocument]
                 If the method is called asynchronously, returns the request
                 thread.
         """

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/bimdata_api_client/model/building.py

@@ -90,6 +90,7 @@ class Building(ModelNormal):
         return {
             'uuid': (str,),  # noqa: E501
             'name': (str,),  # noqa: E501
+            'bimdata_elevation': (str,),  # noqa: E501
             'plans': ([ModelWithPositioningPlan],),  # noqa: E501
             'plans_unreachable_count': (int,),  # noqa: E501
         }
@@ -102,6 +103,7 @@ class Building(ModelNormal):
     attribute_map = {
         'uuid': 'uuid',  # noqa: E501
         'name': 'name',  # noqa: E501
+        'bimdata_elevation': 'bimdata_elevation',  # noqa: E501
         'plans': 'plans',  # noqa: E501
         'plans_unreachable_count': 'plans_unreachable_count',  # noqa: E501
     }
@@ -109,6 +111,7 @@ class Building(ModelNormal):
     read_only_vars = {
         'uuid',  # noqa: E501
         'name',  # noqa: E501
+        'bimdata_elevation',  # noqa: E501
         'plans',  # noqa: E501
         'plans_unreachable_count',  # noqa: E501
     }
@@ -117,12 +120,13 @@ class Building(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, uuid, name, plans, plans_unreachable_count, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, uuid, name, bimdata_elevation, plans, plans_unreachable_count, *args, **kwargs):  # noqa: E501
         """Building - a model defined in OpenAPI
 
         Args:
             uuid (str): IFC element or element type UUID
             name (str): Name of the building
+            bimdata_elevation (str): Elevation computed by BIMData on storey's objects geometries.
             plans ([ModelWithPositioningPlan]):
             plans_unreachable_count (int):
 
@@ -186,6 +190,7 @@ class Building(ModelNormal):
 
         self.uuid = uuid
         self.name = name
+        self.bimdata_elevation = bimdata_elevation
         self.plans = plans
         self.plans_unreachable_count = plans_unreachable_count
         for var_name, var_value in kwargs.items():

bimdata-api-client-10.4.0/bimdata_api_client/model/light_document.py

@@ -0,0 +1,284 @@
+"""
+    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 (v1)
+    Contact: support@bimdata.io
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from bimdata_api_client.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from bimdata_api_client.exceptions import ApiAttributeError
+
+
+
+class LightDocument(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'id': (int,),  # noqa: E501
+            'parent_id': (int,),  # noqa: E501
+            'name': (str,),  # noqa: E501
+            'description': (str, none_type,),  # noqa: E501
+            'head_id': (int, none_type,),  # noqa: E501
+            'is_head_version': (bool,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'id': 'id',  # noqa: E501
+        'parent_id': 'parent_id',  # noqa: E501
+        'name': 'name',  # noqa: E501
+        'description': 'description',  # noqa: E501
+        'head_id': 'head_id',  # noqa: E501
+        'is_head_version': 'is_head_version',  # noqa: E501
+    }
+
+    read_only_vars = {
+        'id',  # noqa: E501
+        'parent_id',  # noqa: E501
+        'name',  # noqa: E501
+        'description',  # noqa: E501
+        'head_id',  # noqa: E501
+        'is_head_version',  # noqa: E501
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, id, parent_id, name, description, head_id, is_head_version, *args, **kwargs):  # noqa: E501
+        """LightDocument - a model defined in OpenAPI
+
+        Args:
+            id (int):
+            parent_id (int):
+            name (str): Shown name of the file
+            description (str, none_type): Description of the file
+            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
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            raise ApiTypeError(
+                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                    args,
+                    self.__class__.__name__,
+                ),
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.id = id
+        self.parent_id = parent_id
+        self.name = name
+        self.description = description
+        self.head_id = head_id
+        self.is_head_version = is_head_version
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """LightDocument - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            raise ApiTypeError(
+                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                    args,
+                    self.__class__.__name__,
+                ),
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/bimdata_api_client/model/patched_storey_building_request.py

@@ -86,6 +86,7 @@ class PatchedStoreyBuildingRequest(ModelNormal):
         """
         return {
             'name': (str,),  # noqa: E501
+            'bimdata_elevation': (float,),  # noqa: E501
         }
 
     @cached_property
@@ -95,6 +96,7 @@ class PatchedStoreyBuildingRequest(ModelNormal):
 
     attribute_map = {
         'name': 'name',  # noqa: E501
+        'bimdata_elevation': 'bimdata_elevation',  # noqa: E501
     }
 
     read_only_vars = {
@@ -139,6 +141,7 @@ class PatchedStoreyBuildingRequest(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             name (str): [optional]  # noqa: E501
+            bimdata_elevation (float): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -221,6 +224,7 @@ class PatchedStoreyBuildingRequest(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             name (str): [optional]  # noqa: E501
+            bimdata_elevation (float): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

{bimdata-api-client-10.2.2 → bimdata-api-client-10.4.0}/bimdata_api_client/model/storey.py

@@ -90,6 +90,7 @@ class Storey(ModelNormal):
         return {
             'uuid': (str,),  # noqa: E501
             'name': (str,),  # noqa: E501
+            'bimdata_elevation': (str,),  # noqa: E501
             'plans': ([ModelWithPositioningPlan],),  # noqa: E501
             'plans_unreachable_count': (int,),  # noqa: E501
         }
@@ -102,6 +103,7 @@ class Storey(ModelNormal):
     attribute_map = {
         'uuid': 'uuid',  # noqa: E501
         'name': 'name',  # noqa: E501
+        'bimdata_elevation': 'bimdata_elevation',  # noqa: E501
         'plans': 'plans',  # noqa: E501
         'plans_unreachable_count': 'plans_unreachable_count',  # noqa: E501
     }
@@ -109,6 +111,7 @@ class Storey(ModelNormal):
     read_only_vars = {
         'uuid',  # noqa: E501
         'name',  # noqa: E501
+        'bimdata_elevation',  # noqa: E501
         'plans',  # noqa: E501
         'plans_unreachable_count',  # noqa: E501
     }
@@ -117,12 +120,13 @@ class Storey(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, uuid, name, plans, plans_unreachable_count, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, uuid, name, bimdata_elevation, plans, plans_unreachable_count, *args, **kwargs):  # noqa: E501
         """Storey - a model defined in OpenAPI
 
         Args:
             uuid (str): IFC element or element type UUID
             name (str): Name of the storey
+            bimdata_elevation (str): Elevation computed by BIMData on storey's objects geometries.
             plans ([ModelWithPositioningPlan]):
             plans_unreachable_count (int):
 
@@ -186,6 +190,7 @@ class Storey(ModelNormal):
 
         self.uuid = uuid
         self.name = name
+        self.bimdata_elevation = bimdata_elevation
         self.plans = plans
         self.plans_unreachable_count = plans_unreachable_count
         for var_name, var_value in kwargs.items():