MINOR: use without_urls instead of with_urls /dms-tree

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

@@ -4889,7 +4889,7 @@ def __init__(self, api_client=None):
                 'all': [
                     'cloud_pk',
                     'id',
-                    'with_urls',
+                    'without_urls',
                 ],
                 'required': [
                     'cloud_pk',
@@ -4898,7 +4898,7 @@ def __init__(self, api_client=None):
                 'nullable': [
                 ],
                 'enum': [
-                    'with_urls',
+                    'without_urls',
                 ],
                 'validation': [
                 ]
@@ -4907,7 +4907,7 @@ def __init__(self, api_client=None):
                 'validations': {
                 },
                 'allowed_values': {
-                    ('with_urls',): {
+                    ('without_urls',): {
 
                         "FALSE": "false",
                         "TRUE": "true"
@@ -4918,18 +4918,18 @@ def __init__(self, api_client=None):
                         (int,),
                     'id':
                         (int,),
-                    'with_urls':
+                    'without_urls':
                         (str,),
                 },
                 'attribute_map': {
                     'cloud_pk': 'cloud_pk',
                     'id': 'id',
-                    'with_urls': 'with_urls',
+                    'without_urls': 'without_urls',
                 },
                 'location_map': {
                     'cloud_pk': 'path',
                     'id': 'path',
-                    'with_urls': 'query',
+                    'without_urls': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -9344,7 +9344,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'GLTF', 'OBJ', 'POINT_CLOUD', 'DXF', 'PHOTOSPHERE', 'DWG', 'IFC'}, 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', 'PHOTOSPHERE', 'POINT_CLOUD', 'IFC', 'DWG', 'DXF', '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
 
@@ -13678,7 +13678,7 @@ def get_project_dms_tree(
             id (int): A unique integer value identifying this project.
 
         Keyword Args:
-            with_urls (str):  By default, `file` and `office_preview` fields are set to None for performance reasons. If you want those fields, set `?with_urls=true`. . [optional]
+            without_urls (str):  Serializing many file fields is slow and CPU heavy. If you don't need those fields, you can skip them. File fields will be set to None, even if they are set. . [optional]
             _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

bimdata_api_client/model/document_text.py

@@ -58,11 +58,11 @@ class DocumentText(ModelNormal):
     allowed_values = {
         ('language',): {
             'None': None,
-            'ENGLISH': "english",
-            'SPANISH': "spanish",
             'FRENCH': "french",
-            'ITALIAN': "italian",
+            'SPANISH': "spanish",
             'GERMAN': "german",
+            'ITALIAN': "italian",
+            'ENGLISH': "english",
             'NULL': "null",
         },
     }
@@ -153,7 +153,7 @@ def _from_openapi_data(cls, id, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional]  # noqa: E501
-            language (str, none_type): * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german. [optional]  # noqa: E501
+            language (str, none_type): * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -237,7 +237,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional]  # noqa: E501
-            language (str, none_type): * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german. [optional]  # noqa: E501
+            language (str, none_type): * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/patched_document_text_request.py

@@ -58,11 +58,11 @@ class PatchedDocumentTextRequest(ModelNormal):
     allowed_values = {
         ('language',): {
             'None': None,
-            'ENGLISH': "english",
-            'SPANISH': "spanish",
             'FRENCH': "french",
-            'ITALIAN': "italian",
+            'SPANISH': "spanish",
             'GERMAN': "german",
+            'ITALIAN': "italian",
+            'ENGLISH': "english",
             'NULL': "null",
         },
     }
@@ -147,7 +147,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional]  # noqa: E501
-            language (str, none_type): * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german. [optional]  # noqa: E501
+            language (str, none_type): * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -230,7 +230,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional]  # noqa: E501
-            language (str, none_type): * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german. [optional]  # noqa: E501
+            language (str, none_type): * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/write_folder.py

@@ -108,16 +108,16 @@ def openapi_types():
         lazy_import()
         return {
             'created_by': (bool, date, datetime, dict, float, int, list, str, none_type,),  # noqa: E501
-            'id': (int,),  # noqa: E501
+            'nature': (str,),  # noqa: E501
             'updated_at': (datetime,),  # noqa: E501
-            'type': (str,),  # noqa: E501
-            'user_permission': (int,),  # noqa: E501
             'groups_permissions': ([GroupFolderRead],),  # noqa: E501
-            'nature': (str,),  # noqa: E501
+            'user_permission': (int,),  # noqa: E501
             'name': (str,),  # noqa: E501
             'created_at': (datetime,),  # noqa: E501
-            'parent_id': (int, none_type,),  # noqa: E501
+            'type': (str,),  # noqa: E501
+            'id': (int,),  # noqa: E501
             'default_permission': (int,),  # noqa: E501
+            'parent_id': (int, none_type,),  # noqa: E501
             'children': ([WriteFolder], none_type,),  # noqa: E501
         }
 
@@ -128,47 +128,47 @@ def discriminator():
 
     attribute_map = {
         'created_by': 'created_by',  # noqa: E501
-        'id': 'id',  # noqa: E501
+        'nature': 'nature',  # noqa: E501
         'updated_at': 'updated_at',  # noqa: E501
-        'type': 'type',  # noqa: E501
-        'user_permission': 'user_permission',  # noqa: E501
         'groups_permissions': 'groups_permissions',  # noqa: E501
-        'nature': 'nature',  # noqa: E501
+        'user_permission': 'user_permission',  # noqa: E501
         'name': 'name',  # noqa: E501
         'created_at': 'created_at',  # noqa: E501
-        'parent_id': 'parent_id',  # noqa: E501
+        'type': 'type',  # noqa: E501
+        'id': 'id',  # noqa: E501
         'default_permission': 'default_permission',  # noqa: E501
+        'parent_id': 'parent_id',  # noqa: E501
         'children': 'children',  # noqa: E501
     }
 
     read_only_vars = {
         'created_by',  # noqa: E501
-        'id',  # noqa: E501
+        'nature',  # noqa: E501
         'updated_at',  # noqa: E501
-        'type',  # noqa: E501
-        'user_permission',  # noqa: E501
         'groups_permissions',  # noqa: E501
-        'nature',  # noqa: E501
+        'user_permission',  # noqa: E501
         'created_at',  # noqa: E501
+        'type',  # noqa: E501
+        'id',  # noqa: E501
     }
 
     _composed_schemas = {}
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, created_by, id, updated_at, type, user_permission, groups_permissions, nature, name, created_at, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, created_by, nature, updated_at, groups_permissions, user_permission, name, created_at, type, id, *args, **kwargs):  # noqa: E501
         """WriteFolder - a model defined in OpenAPI
 
         Args:
             created_by (bool, date, datetime, dict, float, int, list, str, none_type):
-            id (int):
+            nature (str): Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
             updated_at (datetime): Date of the last update
-            type (str): DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
-            user_permission (int): Aggregate of group user permissions and folder default permission
             groups_permissions ([GroupFolderRead]): List of group permissions
-            nature (str): Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
+            user_permission (int): Aggregate of group user permissions and folder default permission
             name (str): Name of the folder
             created_at (datetime): Creation date
+            type (str): DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
+            id (int):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -201,8 +201,8 @@ def _from_openapi_data(cls, created_by, id, updated_at, type, user_permission, g
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            parent_id (int, none_type): [optional]  # noqa: E501
             default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
+            parent_id (int, none_type): [optional]  # noqa: E501
             children ([WriteFolder], none_type): [optional]  # noqa: E501
         """
 
@@ -232,14 +232,14 @@ def _from_openapi_data(cls, created_by, id, updated_at, type, user_permission, g
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.created_by = created_by
-        self.id = id
+        self.nature = nature
         self.updated_at = updated_at
-        self.type = type
-        self.user_permission = user_permission
         self.groups_permissions = groups_permissions
-        self.nature = nature
+        self.user_permission = user_permission
         self.name = name
         self.created_at = created_at
+        self.type = type
+        self.id = id
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -295,8 +295,8 @@ def __init__(self, name, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            parent_id (int, none_type): [optional]  # noqa: E501
             default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
+            parent_id (int, none_type): [optional]  # noqa: E501
             children ([WriteFolder], none_type): [optional]  # noqa: E501
         """
 

bimdata_api_client/model/write_folder_request.py

@@ -102,8 +102,8 @@ def openapi_types():
         lazy_import()
         return {
             'name': (str,),  # noqa: E501
-            'parent_id': (int, none_type,),  # noqa: E501
             'default_permission': (int,),  # noqa: E501
+            'parent_id': (int, none_type,),  # noqa: E501
             'children': ([WriteFolder], none_type,),  # noqa: E501
         }
 
@@ -114,8 +114,8 @@ def discriminator():
 
     attribute_map = {
         'name': 'name',  # noqa: E501
-        'parent_id': 'parent_id',  # noqa: E501
         'default_permission': 'default_permission',  # noqa: E501
+        'parent_id': 'parent_id',  # noqa: E501
         'children': 'children',  # noqa: E501
     }
 
@@ -163,8 +163,8 @@ def _from_openapi_data(cls, name, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            parent_id (int, none_type): [optional]  # noqa: E501
             default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
+            parent_id (int, none_type): [optional]  # noqa: E501
             children ([WriteFolder], none_type): [optional]  # noqa: E501
         """
 
@@ -251,8 +251,8 @@ def __init__(self, name, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            parent_id (int, none_type): [optional]  # noqa: E501
             default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
+            parent_id (int, none_type): [optional]  # noqa: E501
             children ([WriteFolder], none_type): [optional]  # noqa: E501
         """
 

docs/CollaborationApi.md

@@ -1808,14 +1808,14 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     id = 1 # int | A unique integer value identifying this project.
     write_folder_request = [
         WriteFolderRequest(
+            default_permission=1,
             parent_id=1,
             name="name_example",
-            default_permission=1,
             children=[
                 WriteFolder(
+                    default_permission=1,
                     parent_id=1,
                     name="name_example",
-                    default_permission=1,
                     children=None,
                 ),
             ],
@@ -1872,7 +1872,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'GLTF', 'OBJ', 'POINT_CLOUD', 'DXF', 'PHOTOSPHERE', 'DWG', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'GLTF', 'PHOTOSPHERE', 'POINT_CLOUD', 'IFC', 'DWG', 'DXF', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -7520,7 +7520,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     api_instance = collaboration_api.CollaborationApi(api_client)
     cloud_pk = 1 # int | 
     id = 1 # int | A unique integer value identifying this project.
-    with_urls = "false" # str |  By default, `file` and `office_preview` fields are set to None for performance reasons. If you want those fields, set `?with_urls=true`.  (optional)
+    without_urls = "false" # str |  Serializing many file fields is slow and CPU heavy. If you don't need those fields, you can skip them. File fields will be set to None, even if they are set.  (optional)
 
     # example passing only required values which don't have defaults set
     try:
@@ -7534,7 +7534,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Retrieve the complete DMS tree
-        api_response = api_instance.get_project_dms_tree(cloud_pk, id, with_urls=with_urls)
+        api_response = api_instance.get_project_dms_tree(cloud_pk, id, without_urls=without_urls)
         pprint(api_response)
     except bimdata_api_client.ApiException as e:
         print("Exception when calling CollaborationApi->get_project_dms_tree: %s\n" % e)
@@ -7547,7 +7547,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cloud_pk** | **int**|  |
  **id** | **int**| A unique integer value identifying this project. |
- **with_urls** | **str**|  By default, `file` and `office_preview` fields are set to None for performance reasons. If you want those fields, set `?with_urls=true`.  | [optional]
+ **without_urls** | **str**|  Serializing many file fields is slow and CPU heavy. If you don't need those fields, you can skip them. File fields will be set to None, even if they are set.  | [optional]
 
 ### Return type
 
@@ -11262,7 +11262,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
     project_pk = 1 # int | A unique integer value identifying this project.
     patched_document_text_request = PatchedDocumentTextRequest(
         text="text_example",
-        language="english",
+        language="french",
     ) # PatchedDocumentTextRequest |  (optional)
 
     # example passing only required values which don't have defaults set

docs/DocumentText.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [readonly] 
 **text** | **str, none_type** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
-**language** | **str, none_type** | * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german | [optional] 
+**language** | **str, none_type** | * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english | [optional] 
 **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)