MINOR: add available_models to ProjectAccessToken (#1025)

* MINOR: add available_models to ProjectAccessToken

* add migration

* remove prints, better doc

* Fixes after rebase

---------

Co-authored-by: Amoki <hugo@bimdata.io>

Author: Bimdata-io

bimdata_api_client/api/collaboration_api.py

@@ -9344,7 +9344,7 @@ def create_document(
     ):
         """Create a document  # noqa: E501
 
-        Create a document. If the document is one of {'DXF', 'DWG', 'IFC', 'GLTF', 'POINT_CLOUD', 'PHOTOSPHERE', 'OBJ'}, 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 {'IFC', 'OBJ', 'PHOTOSPHERE', 'DWG', 'GLTF', 'DXF', 'POINT_CLOUD'}, 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
 

bimdata_api_client/model/document_text.py

@@ -58,11 +58,11 @@ class DocumentText(ModelNormal):
     allowed_values = {
         ('language',): {
             'None': None,
-            'SPANISH': "spanish",
-            'GERMAN': "german",
             'ENGLISH': "english",
-            'FRENCH': "french",
+            'GERMAN': "german",
+            'SPANISH': "spanish",
             'ITALIAN': "italian",
+            'FRENCH': "french",
             '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): * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian. [optional]  # noqa: E501
+            language (str, none_type): * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french. [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): * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian. [optional]  # noqa: E501
+            language (str, none_type): * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french. [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,
-            'SPANISH': "spanish",
-            'GERMAN': "german",
             'ENGLISH': "english",
-            'FRENCH': "french",
+            'GERMAN': "german",
+            'SPANISH': "spanish",
             'ITALIAN': "italian",
+            'FRENCH': "french",
             '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): * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian. [optional]  # noqa: E501
+            language (str, none_type): * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french. [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): * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian. [optional]  # noqa: E501
+            language (str, none_type): * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/project_access_token.py

@@ -96,6 +96,7 @@ def openapi_types():
             'scopes': ([str],),  # noqa: E501
             'expires_at': (datetime,),  # noqa: E501
             'email_impersonation': (str, none_type,),  # noqa: E501
+            'available_models': ([int],),  # noqa: E501
         }
 
     @cached_property
@@ -108,6 +109,7 @@ def discriminator():
         'scopes': 'scopes',  # noqa: E501
         'expires_at': 'expires_at',  # noqa: E501
         'email_impersonation': 'email_impersonation',  # noqa: E501
+        'available_models': 'available_models',  # noqa: E501
     }
 
     read_only_vars = {
@@ -157,7 +159,8 @@ def _from_openapi_data(cls, token, scopes, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             expires_at (datetime): [optional]  # noqa: E501
-            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         . [optional]  # noqa: E501
+            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         `available_models` can't be set when a user is impersonated.         . [optional]  # noqa: E501
+            available_models ([int]):          List of model IDs that the token can access.         If not specified, the token can access all models of the project.         This field can't be set if email_impersonation is set.         This field can't be set if `document:read` is in scopes.         . [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -244,7 +247,8 @@ def __init__(self, scopes, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             expires_at (datetime): [optional]  # noqa: E501
-            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         . [optional]  # noqa: E501
+            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         `available_models` can't be set when a user is impersonated.         . [optional]  # noqa: E501
+            available_models ([int]):          List of model IDs that the token can access.         If not specified, the token can access all models of the project.         This field can't be set if email_impersonation is set.         This field can't be set if `document:read` is in scopes.         . [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/project_access_token_request.py

@@ -98,6 +98,7 @@ def openapi_types():
             'scopes': ([str],),  # noqa: E501
             'expires_at': (datetime,),  # noqa: E501
             'email_impersonation': (str, none_type,),  # noqa: E501
+            'available_models': ([int],),  # noqa: E501
         }
 
     @cached_property
@@ -109,6 +110,7 @@ def discriminator():
         'scopes': 'scopes',  # noqa: E501
         'expires_at': 'expires_at',  # noqa: E501
         'email_impersonation': 'email_impersonation',  # noqa: E501
+        'available_models': 'available_models',  # noqa: E501
     }
 
     read_only_vars = {
@@ -156,7 +158,8 @@ def _from_openapi_data(cls, scopes, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             expires_at (datetime): [optional]  # noqa: E501
-            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         . [optional]  # noqa: E501
+            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         `available_models` can't be set when a user is impersonated.         . [optional]  # noqa: E501
+            available_models ([int]):          List of model IDs that the token can access.         If not specified, the token can access all models of the project.         This field can't be set if email_impersonation is set.         This field can't be set if `document:read` is in scopes.         . [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -243,7 +246,8 @@ def __init__(self, scopes, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             expires_at (datetime): [optional]  # noqa: E501
-            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         . [optional]  # noqa: E501
+            email_impersonation (str, none_type):          If the request is made from an SSO application, you can link the token to a user.         All calls made with the token will populate created_by fields with the user.         If the user don't have access to some data, the token won't have access.         `available_models` can't be set when a user is impersonated.         . [optional]  # noqa: E501
+            available_models ([int]):          List of model IDs that the token can access.         If not specified, the token can access all models of the project.         This field can't be set if email_impersonation is set.         This field can't be set if `document:read` is in scopes.         . [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

bimdata_api_client/model/write_folder.py

@@ -107,15 +107,15 @@ def openapi_types():
         """
         lazy_import()
         return {
-            'groups_permissions': ([GroupFolderRead],),  # noqa: E501
-            'type': (str,),  # noqa: E501
             'created_at': (datetime,),  # noqa: E501
-            'nature': (str,),  # noqa: E501
-            'created_by': (bool, date, datetime, dict, float, int, list, str, none_type,),  # noqa: E501
             'updated_at': (datetime,),  # noqa: E501
-            'user_permission': (int,),  # noqa: E501
             'name': (str,),  # noqa: E501
+            'groups_permissions': ([GroupFolderRead],),  # noqa: E501
+            'type': (str,),  # noqa: E501
+            'user_permission': (int,),  # noqa: E501
+            'created_by': (bool, date, datetime, dict, float, int, list, str, none_type,),  # noqa: E501
             'id': (int,),  # noqa: E501
+            'nature': (str,),  # noqa: E501
             'default_permission': (int,),  # noqa: E501
             'parent_id': (int, none_type,),  # noqa: E501
             'children': ([WriteFolder], none_type,),  # noqa: E501
@@ -127,48 +127,48 @@ def discriminator():
 
 
     attribute_map = {
-        'groups_permissions': 'groups_permissions',  # noqa: E501
-        'type': 'type',  # noqa: E501
         'created_at': 'created_at',  # noqa: E501
-        'nature': 'nature',  # noqa: E501
-        'created_by': 'created_by',  # noqa: E501
         'updated_at': 'updated_at',  # noqa: E501
-        'user_permission': 'user_permission',  # noqa: E501
         'name': 'name',  # noqa: E501
+        'groups_permissions': 'groups_permissions',  # noqa: E501
+        'type': 'type',  # noqa: E501
+        'user_permission': 'user_permission',  # noqa: E501
+        'created_by': 'created_by',  # noqa: E501
         'id': 'id',  # noqa: E501
+        'nature': 'nature',  # noqa: E501
         'default_permission': 'default_permission',  # noqa: E501
         'parent_id': 'parent_id',  # noqa: E501
         'children': 'children',  # noqa: E501
     }
 
     read_only_vars = {
-        'groups_permissions',  # noqa: E501
-        'type',  # noqa: E501
         'created_at',  # noqa: E501
-        'nature',  # noqa: E501
-        'created_by',  # noqa: E501
         'updated_at',  # noqa: E501
+        'groups_permissions',  # noqa: E501
+        'type',  # noqa: E501
         'user_permission',  # noqa: E501
+        'created_by',  # noqa: E501
         'id',  # noqa: E501
+        'nature',  # noqa: E501
     }
 
     _composed_schemas = {}
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, groups_permissions, type, created_at, nature, created_by, updated_at, user_permission, name, id, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, created_at, updated_at, name, groups_permissions, type, user_permission, created_by, id, nature, *args, **kwargs):  # noqa: E501
         """WriteFolder - a model defined in OpenAPI
 
         Args:
-            groups_permissions ([GroupFolderRead]): List of group permissions
-            type (str): DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
             created_at (datetime): Creation date
-            nature (str): Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
-            created_by (bool, date, datetime, dict, float, int, list, str, none_type):
             updated_at (datetime): Date of the last update
-            user_permission (int): Aggregate of group user permissions and folder default permission
             name (str): Name of the folder
+            groups_permissions ([GroupFolderRead]): List of group permissions
+            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
+            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
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -231,15 +231,15 @@ def _from_openapi_data(cls, groups_permissions, type, created_at, nature, create
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.groups_permissions = groups_permissions
-        self.type = type
         self.created_at = created_at
-        self.nature = nature
-        self.created_by = created_by
         self.updated_at = updated_at
-        self.user_permission = user_permission
         self.name = name
+        self.groups_permissions = groups_permissions
+        self.type = type
+        self.user_permission = user_permission
+        self.created_by = created_by
         self.id = id
+        self.nature = nature
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

docs/CollaborationApi.md

@@ -1872,7 +1872,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'DXF', 'DWG', 'IFC', 'GLTF', 'POINT_CLOUD', 'PHOTOSPHERE', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'IFC', 'OBJ', 'PHOTOSPHERE', 'DWG', 'GLTF', 'DXF', 'POINT_CLOUD'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
@@ -2407,6 +2407,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
         ],
         expires_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
         email_impersonation="email_impersonation_example",
+        available_models=[
+            1,
+        ],
     ) # ProjectAccessTokenRequest | 
 
     # example passing only required values which don't have defaults set
@@ -11262,7 +11265,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="spanish",
+        language="english",
     ) # 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** | * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian | [optional] 
+**language** | **str, none_type** | * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french | [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)

docs/PatchedDocumentTextRequest.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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** | * `spanish` - spanish * `german` - german * `english` - english * `french` - french * `italian` - italian | [optional] 
+**language** | **str, none_type** | * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian * `french` - french | [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)