Skip to content

Commit 5929f66

Browse files
Bimdata-ioBimdata-io
committed
PATCH: fix model_type documentation
1 parent 4a65ef2 commit 5929f66

File tree

10 files changed

+54
-56
lines changed

10 files changed

+54
-56
lines changed

‎bimdata_api_client/api/collaboration_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8940,7 +8940,7 @@ def create_document(
89408940
):
89418941
"""Create a document # noqa: E501
89428942

8943-
Create a document. If the document is one of {'DWG', 'PHOTOSPHERE', 'GLTF', 'IFC', 'DXF', 'POINT_CLOUD', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
8943+
Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
89448944
This method makes a synchronous HTTP request by default. To make an
89458945
asynchronous HTTP request, please pass async_req=True
89468946

‎bimdata_api_client/api/model_api.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8203,7 +8203,6 @@ def __init__(self, api_client=None):
82038203
"OBJ": "OBJ",
82048204
"PDF": "PDF",
82058205
"PHOTOSPHERE": "PHOTOSPHERE",
8206-
"PHOTOSPHERE": "PHOTOSPHERE",
82078206
"PHOTOSPHERE_BUILDING": "PHOTOSPHERE_BUILDING",
82088207
"PNG": "PNG",
82098208
"POINT_CLOUD": "POINT_CLOUD"
@@ -22895,7 +22894,7 @@ def get_models(
2289522894
Keyword Args:
2289622895
source (str): * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED. [optional]
2289722896
status ([str]): * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix. [optional]
22898-
type ([str]): * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING. [optional]
22897+
type ([str]): * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING. [optional]
2289922898
_return_http_data_only (bool): response data without head status
2290022899
code and headers. Default is True.
2290122900
_preload_content (bool): if False, the urllib3.HTTPResponse object

‎bimdata_api_client/model/document_text.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ class DocumentText(ModelNormal):
5858
allowed_values = {
5959
('language',): {
6060
'None': None,
61-
'GERMAN': "german",
61+
'FRENCH': "french",
62+
'ITALIAN': "italian",
6263
'ENGLISH': "english",
6364
'SPANISH': "spanish",
64-
'ITALIAN': "italian",
65-
'FRENCH': "french",
65+
'GERMAN': "german",
6666
'NULL': "null",
6767
},
6868
}
@@ -153,7 +153,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501
153153
through its discriminator because we passed in
154154
_visited_composed_classes = (Animal,)
155155
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
156-
language (str, none_type): * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french. [optional] # noqa: E501
156+
language (str, none_type): * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german. [optional] # noqa: E501
157157
"""
158158

159159
_check_type = kwargs.pop('_check_type', True)
@@ -237,7 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
237237
through its discriminator because we passed in
238238
_visited_composed_classes = (Animal,)
239239
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
240-
language (str, none_type): * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french. [optional] # noqa: E501
240+
language (str, none_type): * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german. [optional] # noqa: E501
241241
"""
242242

243243
_check_type = kwargs.pop('_check_type', True)

‎bimdata_api_client/model/patched_document_text_request.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ class PatchedDocumentTextRequest(ModelNormal):
5858
allowed_values = {
5959
('language',): {
6060
'None': None,
61-
'GERMAN': "german",
61+
'FRENCH': "french",
62+
'ITALIAN': "italian",
6263
'ENGLISH': "english",
6364
'SPANISH': "spanish",
64-
'ITALIAN': "italian",
65-
'FRENCH': "french",
65+
'GERMAN': "german",
6666
'NULL': "null",
6767
},
6868
}
@@ -147,7 +147,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
147147
through its discriminator because we passed in
148148
_visited_composed_classes = (Animal,)
149149
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
150-
language (str, none_type): * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french. [optional] # noqa: E501
150+
language (str, none_type): * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german. [optional] # noqa: E501
151151
"""
152152

153153
_check_type = kwargs.pop('_check_type', True)
@@ -230,7 +230,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
230230
through its discriminator because we passed in
231231
_visited_composed_classes = (Animal,)
232232
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
233-
language (str, none_type): * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french. [optional] # noqa: E501
233+
language (str, none_type): * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german. [optional] # noqa: E501
234234
"""
235235

236236
_check_type = kwargs.pop('_check_type', True)

‎bimdata_api_client/model/write_folder.py‎

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,15 @@ def openapi_types():
107107
"""
108108
lazy_import()
109109
return {
110-
'name': (str,), # noqa: E501
111-
'created_at': (datetime,), # noqa: E501
110+
'created_by': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
112111
'user_permission': (int,), # noqa: E501
113-
'id': (int,), # noqa: E501
112+
'name': (str,), # noqa: E501
114113
'type': (str,), # noqa: E501
115-
'nature': (str,), # noqa: E501
116-
'created_by': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
117-
'groups_permissions': ([GroupFolderRead],), # noqa: E501
114+
'id': (int,), # noqa: E501
118115
'updated_at': (datetime,), # noqa: E501
116+
'groups_permissions': ([GroupFolderRead],), # noqa: E501
117+
'created_at': (datetime,), # noqa: E501
118+
'nature': (str,), # noqa: E501
119119
'default_permission': (int,), # noqa: E501
120120
'parent_id': (int, none_type,), # noqa: E501
121121
'children': ([WriteFolder], none_type,), # noqa: E501
@@ -127,48 +127,48 @@ def discriminator():
127127

128128

129129
attribute_map = {
130-
'name': 'name', # noqa: E501
131-
'created_at': 'created_at', # noqa: E501
130+
'created_by': 'created_by', # noqa: E501
132131
'user_permission': 'user_permission', # noqa: E501
133-
'id': 'id', # noqa: E501
132+
'name': 'name', # noqa: E501
134133
'type': 'type', # noqa: E501
135-
'nature': 'nature', # noqa: E501
136-
'created_by': 'created_by', # noqa: E501
137-
'groups_permissions': 'groups_permissions', # noqa: E501
134+
'id': 'id', # noqa: E501
138135
'updated_at': 'updated_at', # noqa: E501
136+
'groups_permissions': 'groups_permissions', # noqa: E501
137+
'created_at': 'created_at', # noqa: E501
138+
'nature': 'nature', # noqa: E501
139139
'default_permission': 'default_permission', # noqa: E501
140140
'parent_id': 'parent_id', # noqa: E501
141141
'children': 'children', # noqa: E501
142142
}
143143

144144
read_only_vars = {
145-
'created_at', # noqa: E501
145+
'created_by', # noqa: E501
146146
'user_permission', # noqa: E501
147-
'id', # noqa: E501
148147
'type', # noqa: E501
149-
'nature', # noqa: E501
150-
'created_by', # noqa: E501
151-
'groups_permissions', # noqa: E501
148+
'id', # noqa: E501
152149
'updated_at', # noqa: E501
150+
'groups_permissions', # noqa: E501
151+
'created_at', # noqa: E501
152+
'nature', # noqa: E501
153153
}
154154

155155
_composed_schemas = {}
156156

157157
@classmethod
158158
@convert_js_args_to_python_args
159-
def _from_openapi_data(cls, name, created_at, user_permission, id, type, nature, created_by, groups_permissions, updated_at, *args, **kwargs): # noqa: E501
159+
def _from_openapi_data(cls, created_by, user_permission, name, type, id, updated_at, groups_permissions, created_at, nature, *args, **kwargs): # noqa: E501
160160
"""WriteFolder - a model defined in OpenAPI
161161
162162
Args:
163-
name (str): Name of the folder
164-
created_at (datetime): Creation date
163+
created_by (bool, date, datetime, dict, float, int, list, str, none_type):
165164
user_permission (int): Aggregate of group user permissions and folder default permission
166-
id (int):
165+
name (str): Name of the folder
167166
type (str): DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
168-
nature (str): Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
169-
created_by (bool, date, datetime, dict, float, int, list, str, none_type):
170-
groups_permissions ([GroupFolderRead]): List of group permissions
167+
id (int):
171168
updated_at (datetime): Date of the last update
169+
groups_permissions ([GroupFolderRead]): List of group permissions
170+
created_at (datetime): Creation date
171+
nature (str): Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
172172
173173
Keyword Args:
174174
_check_type (bool): if True, values for parameters in openapi_types
@@ -231,15 +231,15 @@ def _from_openapi_data(cls, name, created_at, user_permission, id, type, nature,
231231
self._configuration = _configuration
232232
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
233233

234-
self.name = name
235-
self.created_at = created_at
234+
self.created_by = created_by
236235
self.user_permission = user_permission
237-
self.id = id
236+
self.name = name
238237
self.type = type
239-
self.nature = nature
240-
self.created_by = created_by
241-
self.groups_permissions = groups_permissions
238+
self.id = id
242239
self.updated_at = updated_at
240+
self.groups_permissions = groups_permissions
241+
self.created_at = created_at
242+
self.nature = nature
243243
for var_name, var_value in kwargs.items():
244244
if var_name not in self.attribute_map and \
245245
self._configuration is not None and \
@@ -263,7 +263,6 @@ def _from_openapi_data(cls, name, created_at, user_permission, id, type, nature,
263263
def __init__(self, name, *args, **kwargs): # noqa: E501
264264
"""WriteFolder - a model defined in OpenAPI
265265
266-
Args:
267266
name (str): Name of the folder
268267
Keyword Args:
269268
_check_type (bool): if True, values for parameters in openapi_types

‎docs/CollaborationApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1546,7 +1546,7 @@ Name | Type | Description | Notes
15461546

15471547
Create a document
15481548

1549-
Create a document. If the document is one of {'DWG', 'PHOTOSPHERE', 'GLTF', 'IFC', 'DXF', 'POINT_CLOUD', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write
1549+
Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write
15501550

15511551
### Example
15521552

@@ -11032,7 +11032,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
1103211032
project_pk = 1 # int | A unique integer value identifying this project.
1103311033
patched_document_text_request = PatchedDocumentTextRequest(
1103411034
text="text_example",
11035-
language="german",
11035+
language="french",
1103611036
) # PatchedDocumentTextRequest | (optional)
1103711037

1103811038
# example passing only required values which don't have defaults set

‎docs/DocumentText.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **int** | | [readonly]
88
**text** | **str, none_type** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
9-
**language** | **str, none_type** | * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french | [optional]
9+
**language** | **str, none_type** | * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german | [optional]
1010
**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]
1111

1212
[[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/ModelApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12778,7 +12778,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
1277812778
] # [str] | * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix (optional)
1277912779
type = [
1278012780
"DWG",
12781-
] # [str] | * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING (optional)
12781+
] # [str] | * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING (optional)
1278212782

1278312783
# example passing only required values which don't have defaults set
1278412784
try:
@@ -12807,7 +12807,7 @@ Name | Type | Description | Notes
1280712807
**project_pk** | **int**| |
1280812808
**source** | **str**| * `UPLOAD` - UPLOAD * `SPLIT` - SPLIT * `MERGE` - MERGE * `EXPORT` - EXPORT * `OPTIMIZED` - OPTIMIZED | [optional]
1280912809
**status** | **[str]**| * `C` - completed * `D` - deleted * `P` - pending * `W` - waiting * `I` - in process * `E` - errored * `X` - won't fix | [optional]
12810-
**type** | **[str]**| * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE` - PHOTOSPHERE * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING | [optional]
12810+
**type** | **[str]**| * `IFC` - IFC * `DWG` - DWG * `DXF` - DXF * `GLTF` - GLTF * `PDF` - PDF * `JPEG` - JPEG * `PNG` - PNG * `OBJ` - OBJ * `POINT_CLOUD` - POINT_CLOUD * `PHOTOSPHERE` - PHOTOSPHERE * `METABUILDING` - METABUILDING * `PHOTOSPHERE_BUILDING` - PHOTOSPHERE_BUILDING | [optional]
1281112811

1281212812
### Return type
1281312813

‎docs/PatchedDocumentTextRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**text** | **str, none_type** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
8-
**language** | **str, none_type** | * `german` - german * `english` - english * `spanish` - spanish * `italian` - italian * `french` - french | [optional]
8+
**language** | **str, none_type** | * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german | [optional]
99
**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]
1010

1111
[[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/WriteFolder.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**name** | **str** | Name of the folder |
8-
**created_at** | **datetime** | Creation date | [readonly]
7+
**created_by** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [readonly]
98
**user_permission** | **int** | Aggregate of group user permissions and folder default permission | [readonly]
10-
**id** | **int** | | [readonly]
9+
**name** | **str** | Name of the folder |
1110
**type** | **str** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
12-
**nature** | **str** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
13-
**created_by** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [readonly]
14-
**groups_permissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
11+
**id** | **int** | | [readonly]
1512
**updated_at** | **datetime** | Date of the last update | [readonly]
13+
**groups_permissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
14+
**created_at** | **datetime** | Creation date | [readonly]
15+
**nature** | **str** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
1616
**default_permission** | **int** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1717
**parent_id** | **int, none_type** | | [optional]
1818
**children** | [**[WriteFolder], none_type**](WriteFolder.md) | | [optional]

0 commit comments

Comments
 (0)