MINOR: add project description (#659)

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

@@ -8303,7 +8303,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'DXF', 'OBJ', 'DWG', 'GLTF', 'IFC', '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 {'GLTF', 'DWG', 'POINT_CLOUD', 'OBJ', 'IFC', 'DXF'}, 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
 
@@ -8320,8 +8320,8 @@ def create_document(
             parent_id (int, none_type): [optional]
             file_name (str): Full name of the file. [optional]
             description (str, none_type): Description of the file. [optional]
-            model_source (str): Define the model.source field if the upload is a Model (IFC, PDF, DWG...). [optional]
-            ifc_source (str): DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...). [optional]
+            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]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.

bimdata_api_client/api/ifc_api.py

@@ -20862,9 +20862,9 @@ def get_ifcs_deprecated(
             project_pk (int):
 
         Keyword Args:
-            source (str): [optional]
-            status ([str]): [optional]
-            type ([str]): [optional]
+            source (str): * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]
+            status ([str]): * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix  * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix. [optional]
+            type ([str]): * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `METABUILDING` - METABUILDING  * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `METABUILDING` - METABUILDING. [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/api/model_api.py

@@ -19692,9 +19692,9 @@ def get_models(
             project_pk (int):
 
         Keyword Args:
-            source (str): [optional]
-            status ([str]): [optional]
-            type ([str]): [optional]
+            source (str): * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED  * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]
+            status ([str]): * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix  * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix. [optional]
+            type ([str]): * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `METABUILDING` - METABUILDING  * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `METABUILDING` - METABUILDING. [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/api/sso_api.py

@@ -621,7 +621,7 @@ def get_invitations(
 
 
         Keyword Args:
-            status (str):          A: Accepted         D: Denied         P: Pending         . [optional]
+            status (str):          A: Accepted         D: Denied         P: Pending           * `A` - accepted * `D` - denied * `P` - pending. [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/check_project_access.py

@@ -157,7 +157,7 @@ def _from_openapi_data(cls, has_read_permission, has_write_permission, has_admin
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            user_role (int): [optional]  # noqa: E501
+            user_role (int): * `100` - admin * `50` - user * `25` - guest. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -251,7 +251,7 @@ def __init__(self, has_read_permission, has_write_permission, has_admin_permissi
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            user_role (int): [optional]  # noqa: E501
+            user_role (int): * `100` - admin * `50` - user * `25` - guest. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/checker_result.py

@@ -158,7 +158,7 @@ def _from_openapi_data(cls, id, created_at, updated_at, *args, **kwargs):  # noq
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            status (str): [optional]  # noqa: E501
+            status (str): * `C` - completed * `P` - pending * `E` - errored. [optional]  # noqa: E501
             result (str, none_type): [optional]  # noqa: E501
             collisions (str, none_type): [optional]  # noqa: E501
         """
@@ -245,7 +245,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            status (str): [optional]  # noqa: E501
+            status (str): * `C` - completed * `P` - pending * `E` - errored. [optional]  # noqa: E501
             result (str, none_type): [optional]  # noqa: E501
             collisions (str, none_type): [optional]  # noqa: E501
         """

bimdata_api_client/model/checker_result_request.py

@@ -149,7 +149,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            status (str): [optional]  # noqa: E501
+            status (str): * `C` - completed * `P` - pending * `E` - errored. [optional]  # noqa: E501
             result (str, none_type): [optional]  # noqa: E501
             collisions (str, none_type): [optional]  # noqa: E501
             error_detail (str): [optional]  # noqa: E501
@@ -234,7 +234,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            status (str): [optional]  # noqa: E501
+            status (str): * `C` - completed * `P` - pending * `E` - errored. [optional]  # noqa: E501
             result (str, none_type): [optional]  # noqa: E501
             collisions (str, none_type): [optional]  # noqa: E501
             error_detail (str): [optional]  # noqa: E501

bimdata_api_client/model/cloud_invitation.py

@@ -126,7 +126,7 @@ def _from_openapi_data(cls, id, email, redirect_uri, role, *args, **kwargs):  #
             id (int):
             email (str): email of the user to invite
             redirect_uri (str): User will be redirected to this uri when they accept the invitation
-            role (int):
+            role (int): * `100` - admin * `50` - user
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types

bimdata_api_client/model/cloud_role.py

@@ -148,7 +148,7 @@ def _from_openapi_data(cls, cloud, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            role (int): Role of the user in the cloud. [optional]  # noqa: E501
+            role (int): Role of the user in the cloud  * `100` - admin * `50` - user. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -234,7 +234,7 @@ def __init__(self, cloud, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            role (int): Role of the user in the cloud. [optional]  # noqa: E501
+            role (int): Role of the user in the cloud  * `100` - admin * `50` - user. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/folder.py

@@ -206,7 +206,7 @@ def _from_openapi_data(cls, id, type, nature, name, created_at, updated_at, crea
                                 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. [optional]  # noqa: E501
+            default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -300,7 +300,7 @@ def __init__(self, name, *args, **kwargs):  # noqa: E501
                                 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. [optional]  # noqa: E501
+            default_permission (int): Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)