Skip to content

Commit e6e043b

Browse files
committed
MINOR: Add bcf bimdata_viewer_layout (#759)
* Add bcf bimdata_layout * Rename into bimdata_viewer_layout * Fix test...
1 parent 6f92c36 commit e6e043b

15 files changed

+50
-2
lines changed

bimdata_api_client/api/collaboration_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8859,7 +8859,7 @@ def create_document(
88598859
):
88608860
"""Create a document # noqa: E501
88618861

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

bimdata_api_client/model/full_topic.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ def openapi_types():
128128
'due_date': (datetime, none_type,), # noqa: E501
129129
'comments': ([Comment],), # noqa: E501
130130
'viewpoints': ([Viewpoint],), # noqa: E501
131+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
131132
}
132133

133134
@cached_property
@@ -158,6 +159,7 @@ def discriminator():
158159
'due_date': 'due_date', # noqa: E501
159160
'comments': 'comments', # noqa: E501
160161
'viewpoints': 'viewpoints', # noqa: E501
162+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
161163
}
162164

163165
read_only_vars = {
@@ -226,6 +228,7 @@ def _from_openapi_data(cls, modified_date, title, project, *args, **kwargs): #
226228
due_date (datetime, none_type): [optional] # noqa: E501
227229
comments ([Comment]): [optional] # noqa: E501
228230
viewpoints ([Viewpoint]): [optional] # noqa: E501
231+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
229232
"""
230233

231234
_check_type = kwargs.pop('_check_type', True)
@@ -332,6 +335,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
332335
due_date (datetime, none_type): [optional] # noqa: E501
333336
comments ([Comment]): [optional] # noqa: E501
334337
viewpoints ([Viewpoint]): [optional] # noqa: E501
338+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
335339
"""
336340

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

bimdata_api_client/model/full_topic_request.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ def openapi_types():
143143
'due_date': (datetime, none_type,), # noqa: E501
144144
'comments': ([CommentRequest],), # noqa: E501
145145
'viewpoints': ([ViewpointRequest],), # noqa: E501
146+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
146147
}
147148

148149
@cached_property
@@ -172,6 +173,7 @@ def discriminator():
172173
'due_date': 'due_date', # noqa: E501
173174
'comments': 'comments', # noqa: E501
174175
'viewpoints': 'viewpoints', # noqa: E501
176+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
175177
}
176178

177179
read_only_vars = {
@@ -238,6 +240,7 @@ def _from_openapi_data(cls, title, project, *args, **kwargs): # noqa: E501
238240
due_date (datetime, none_type): [optional] # noqa: E501
239241
comments ([CommentRequest]): [optional] # noqa: E501
240242
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
243+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
241244
"""
242245

243246
_check_type = kwargs.pop('_check_type', True)
@@ -344,6 +347,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
344347
due_date (datetime, none_type): [optional] # noqa: E501
345348
comments ([CommentRequest]): [optional] # noqa: E501
346349
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
350+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
347351
"""
348352

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

bimdata_api_client/model/patched_full_topic_request.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ def openapi_types():
143143
'comments': ([CommentRequest],), # noqa: E501
144144
'viewpoints': ([ViewpointRequest],), # noqa: E501
145145
'project': (int,), # noqa: E501
146+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
146147
}
147148

148149
@cached_property
@@ -172,6 +173,7 @@ def discriminator():
172173
'comments': 'comments', # noqa: E501
173174
'viewpoints': 'viewpoints', # noqa: E501
174175
'project': 'project', # noqa: E501
176+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
175177
}
176178

177179
read_only_vars = {
@@ -236,6 +238,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
236238
comments ([CommentRequest]): [optional] # noqa: E501
237239
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
238240
project (int): [optional] # noqa: E501
241+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
239242
"""
240243

241244
_check_type = kwargs.pop('_check_type', True)
@@ -338,6 +341,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
338341
comments ([CommentRequest]): [optional] # noqa: E501
339342
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
340343
project (int): [optional] # noqa: E501
344+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
341345
"""
342346

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

bimdata_api_client/model/patched_topic_request.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ def openapi_types():
133133
'format': (str,), # noqa: E501
134134
'index': (int, none_type,), # noqa: E501
135135
'project': (int,), # noqa: E501
136+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
136137
}
137138

138139
@cached_property
@@ -160,6 +161,7 @@ def discriminator():
160161
'format': 'format', # noqa: E501
161162
'index': 'index', # noqa: E501
162163
'project': 'project', # noqa: E501
164+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
163165
}
164166

165167
read_only_vars = {
@@ -222,6 +224,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
222224
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
223225
index (int, none_type): [optional] # noqa: E501
224226
project (int): [optional] # noqa: E501
227+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
225228
"""
226229

227230
_check_type = kwargs.pop('_check_type', True)
@@ -322,6 +325,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
322325
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
323326
index (int, none_type): [optional] # noqa: E501
324327
project (int): [optional] # noqa: E501
328+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
325329
"""
326330

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

bimdata_api_client/model/topic.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ def openapi_types():
118118
'models': ([int],), # noqa: E501
119119
'format': (str,), # noqa: E501
120120
'index': (int, none_type,), # noqa: E501
121+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
121122
}
122123

123124
@cached_property
@@ -146,6 +147,7 @@ def discriminator():
146147
'models': 'models', # noqa: E501
147148
'format': 'format', # noqa: E501
148149
'index': 'index', # noqa: E501
150+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
149151
}
150152

151153
read_only_vars = {
@@ -212,6 +214,7 @@ def _from_openapi_data(cls, title, modified_date, project, *args, **kwargs): #
212214
models ([int]): [optional] # noqa: E501
213215
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
214216
index (int, none_type): [optional] # noqa: E501
217+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
215218
"""
216219

217220
_check_type = kwargs.pop('_check_type', True)
@@ -317,6 +320,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
317320
models ([int]): [optional] # noqa: E501
318321
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
319322
index (int, none_type): [optional] # noqa: E501
323+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
320324
"""
321325

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

bimdata_api_client/model/topic_request.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ def openapi_types():
133133
'models': ([int],), # noqa: E501
134134
'format': (str,), # noqa: E501
135135
'index': (int, none_type,), # noqa: E501
136+
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
136137
}
137138

138139
@cached_property
@@ -160,6 +161,7 @@ def discriminator():
160161
'models': 'models', # noqa: E501
161162
'format': 'format', # noqa: E501
162163
'index': 'index', # noqa: E501
164+
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
163165
}
164166

165167
read_only_vars = {
@@ -224,6 +226,7 @@ def _from_openapi_data(cls, title, project, *args, **kwargs): # noqa: E501
224226
models ([int]): [optional] # noqa: E501
225227
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
226228
index (int, none_type): [optional] # noqa: E501
229+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
227230
"""
228231

229232
_check_type = kwargs.pop('_check_type', True)
@@ -328,6 +331,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
328331
models ([int]): [optional] # noqa: E501
329332
format (str): The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc) The default value is \"standard\". If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else. You must add a query string filter if you want to fetch topics with a non \"standard\" format. . [optional] # noqa: E501
330333
index (int, none_type): [optional] # noqa: E501
334+
bimdata_viewer_layout ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Non standard field. JSON describing bimdataViewerLayout.. [optional] # noqa: E501
331335
"""
332336

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

docs/BcfApi.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -905,6 +905,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
905905
),
906906
],
907907
project=1,
908+
bimdata_viewer_layout={
909+
"key": None,
910+
},
908911
) # FullTopicRequest |
909912
img_format = "url" # str | All snapshot_data will be returned as url instead of base64 (optional) if omitted the server will use the default value of "url"
910913

@@ -1172,6 +1175,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
11721175
format="format_example",
11731176
index=0,
11741177
project=1,
1178+
bimdata_viewer_layout={
1179+
"key": None,
1180+
},
11751181
) # TopicRequest |
11761182

11771183
# example passing only required values which don't have defaults set
@@ -2975,6 +2981,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
29752981
),
29762982
],
29772983
project=1,
2984+
bimdata_viewer_layout={
2985+
"key": None,
2986+
},
29782987
) # FullTopicRequest |
29792988
img_format = "url" # str | All snapshot_data will be returned as url instead of base64 (optional) if omitted the server will use the default value of "url"
29802989

@@ -3246,6 +3255,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
32463255
format="format_example",
32473256
index=0,
32483257
project=1,
3258+
bimdata_viewer_layout={
3259+
"key": None,
3260+
},
32493261
) # TopicRequest |
32503262

32513263
# example passing only required values which don't have defaults set
@@ -7020,6 +7032,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
70207032
),
70217033
],
70227034
project=1,
7035+
bimdata_viewer_layout={
7036+
"key": None,
7037+
},
70237038
) # PatchedFullTopicRequest | (optional)
70247039

70257040
# example passing only required values which don't have defaults set
@@ -7299,6 +7314,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
72997314
format="format_example",
73007315
index=0,
73017316
project=1,
7317+
bimdata_viewer_layout={
7318+
"key": None,
7319+
},
73027320
) # PatchedTopicRequest | (optional)
73037321

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

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1541,7 +1541,7 @@ Name | Type | Description | Notes
15411541
15421542
Create a document
15431543

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

15461546
### Example
15471547

docs/FullTopic.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
2626
**due_date** | **datetime, none_type** | | [optional]
2727
**comments** | [**[Comment]**](Comment.md) | | [optional]
2828
**viewpoints** | [**[Viewpoint]**](Viewpoint.md) | | [optional]
29+
**bimdata_viewer_layout** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Non standard field. JSON describing bimdataViewerLayout. | [optional]
2930
**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]
3031

3132
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)