Skip to content

Commit f8da5ba

Browse files
committed
MINOR: Add BCF authoring tool (#540)
1 parent 0720880 commit f8da5ba

17 files changed

Lines changed: 39 additions & 32 deletions

bimdata_api_client/api/collaboration_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7686,7 +7686,7 @@ def create_document(
76867686
):
76877687
"""Create a document # noqa: E501
76887688

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

bimdata_api_client/model/model.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ def discriminator():
188188
'id', # noqa: E501
189189
'type', # noqa: E501
190190
'creator', # noqa: E501
191+
'status', # noqa: E501
191192
'created_at', # noqa: E501
192193
'updated_at', # noqa: E501
193194
'document_id', # noqa: E501
@@ -335,10 +336,9 @@ def _from_openapi_data(cls, id, type, creator, status, created_at, updated_at, d
335336
])
336337

337338
@convert_js_args_to_python_args
338-
def __init__(self, status, *args, **kwargs): # noqa: E501
339+
def __init__(self, *args, **kwargs): # noqa: E501
339340
"""Model - a model defined in OpenAPI
340341
341-
status (str):
342342
Keyword Args:
343343
_check_type (bool): if True, values for parameters in openapi_types
344344
will be type checked and a TypeError will be
@@ -403,7 +403,6 @@ def __init__(self, status, *args, **kwargs): # noqa: E501
403403
self._configuration = _configuration
404404
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
405405

406-
self.status = status
407406
for var_name, var_value in kwargs.items():
408407
if var_name not in self.attribute_map and \
409408
self._configuration is not None and \

bimdata_api_client/model/model_request.py

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,6 @@ class ModelRequest(ModelNormal):
6666
}
6767

6868
validations = {
69-
('status',): {
70-
'min_length': 1,
71-
},
7269
('name',): {
7370
'max_length': 512,
7471
},
@@ -104,7 +101,6 @@ def openapi_types():
104101
and the value is attribute type.
105102
"""
106103
return {
107-
'status': (str,), # noqa: E501
108104
'name': (str, none_type,), # noqa: E501
109105
'source': (str,), # noqa: E501
110106
'world_position': ([float], none_type,), # noqa: E501
@@ -121,7 +117,6 @@ def discriminator():
121117

122118

123119
attribute_map = {
124-
'status': 'status', # noqa: E501
125120
'name': 'name', # noqa: E501
126121
'source': 'source', # noqa: E501
127122
'world_position': 'world_position', # noqa: E501
@@ -139,12 +134,9 @@ def discriminator():
139134

140135
@classmethod
141136
@convert_js_args_to_python_args
142-
def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501
137+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
143138
"""ModelRequest - a model defined in OpenAPI
144139
145-
Args:
146-
status (str):
147-
148140
Keyword Args:
149141
_check_type (bool): if True, values for parameters in openapi_types
150142
will be type checked and a TypeError will be
@@ -211,7 +203,6 @@ def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501
211203
self._configuration = _configuration
212204
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
213205

214-
self.status = status
215206
for var_name, var_value in kwargs.items():
216207
if var_name not in self.attribute_map and \
217208
self._configuration is not None and \
@@ -232,12 +223,9 @@ def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501
232223
])
233224

234225
@convert_js_args_to_python_args
235-
def __init__(self, status, *args, **kwargs): # noqa: E501
226+
def __init__(self, *args, **kwargs): # noqa: E501
236227
"""ModelRequest - a model defined in OpenAPI
237228
238-
Args:
239-
status (str):
240-
241229
Keyword Args:
242230
_check_type (bool): if True, values for parameters in openapi_types
243231
will be type checked and a TypeError will be
@@ -302,7 +290,6 @@ def __init__(self, status, *args, **kwargs): # noqa: E501
302290
self._configuration = _configuration
303291
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
304292

305-
self.status = status
306293
for var_name, var_value in kwargs.items():
307294
if var_name not in self.attribute_map and \
308295
self._configuration is not None and \

bimdata_api_client/model/patched_model_request.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,6 @@ class PatchedModelRequest(ModelNormal):
6969
('name',): {
7070
'max_length': 512,
7171
},
72-
('status',): {
73-
'min_length': 1,
74-
},
7572
('world_position',): {
7673
'max_items': 3,
7774
},
@@ -105,7 +102,6 @@ def openapi_types():
105102
"""
106103
return {
107104
'name': (str, none_type,), # noqa: E501
108-
'status': (str,), # noqa: E501
109105
'source': (str,), # noqa: E501
110106
'world_position': ([float], none_type,), # noqa: E501
111107
'size_ratio': (float, none_type,), # noqa: E501
@@ -122,7 +118,6 @@ def discriminator():
122118

123119
attribute_map = {
124120
'name': 'name', # noqa: E501
125-
'status': 'status', # noqa: E501
126121
'source': 'source', # noqa: E501
127122
'world_position': 'world_position', # noqa: E501
128123
'size_ratio': 'size_ratio', # noqa: E501
@@ -174,7 +169,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
174169
through its discriminator because we passed in
175170
_visited_composed_classes = (Animal,)
176171
name (str, none_type): [optional] # noqa: E501
177-
status (str): [optional] # noqa: E501
178172
source (str): [optional] # noqa: E501
179173
world_position ([float], none_type): [x,y,z] array of the position of the local_placement in world coordinates. [optional] # noqa: E501
180174
size_ratio (float, none_type): How many meters a unit represents. [optional] # noqa: E501
@@ -264,7 +258,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
264258
through its discriminator because we passed in
265259
_visited_composed_classes = (Animal,)
266260
name (str, none_type): [optional] # noqa: E501
267-
status (str): [optional] # noqa: E501
268261
source (str): [optional] # noqa: E501
269262
world_position ([float], none_type): [x,y,z] array of the position of the local_placement in world coordinates. [optional] # noqa: E501
270263
size_ratio (float, none_type): How many meters a unit represents. [optional] # noqa: E501

bimdata_api_client/model/patched_viewpoint_request.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ class PatchedViewpointRequest(ModelNormal):
7777
'inclusive_maximum': 2147483647,
7878
'inclusive_minimum': 0,
7979
},
80+
('authoring_view',): {
81+
'max_length': 32,
82+
'min_length': 1,
83+
},
8084
}
8185

8286
@cached_property
@@ -104,6 +108,7 @@ def openapi_types():
104108
return {
105109
'index': (int, none_type,), # noqa: E501
106110
'guid': (str,), # noqa: E501
111+
'authoring_view': (str,), # noqa: E501
107112
'orthogonal_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
108113
'perspective_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
109114
'lines': ([LineRequest], none_type,), # noqa: E501
@@ -122,6 +127,7 @@ def discriminator():
122127
attribute_map = {
123128
'index': 'index', # noqa: E501
124129
'guid': 'guid', # noqa: E501
130+
'authoring_view': 'authoring_view', # noqa: E501
125131
'orthogonal_camera': 'orthogonal_camera', # noqa: E501
126132
'perspective_camera': 'perspective_camera', # noqa: E501
127133
'lines': 'lines', # noqa: E501
@@ -175,6 +181,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
175181
_visited_composed_classes = (Animal,)
176182
index (int, none_type): [optional] # noqa: E501
177183
guid (str): [optional] # noqa: E501
184+
authoring_view (str): [optional] # noqa: E501
178185
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
179186
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
180187
lines ([LineRequest], none_type): [optional] # noqa: E501
@@ -266,6 +273,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
266273
_visited_composed_classes = (Animal,)
267274
index (int, none_type): [optional] # noqa: E501
268275
guid (str): [optional] # noqa: E501
276+
authoring_view (str): [optional] # noqa: E501
269277
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
270278
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
271279
lines ([LineRequest], none_type): [optional] # noqa: E501

bimdata_api_client/model/viewpoint.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ class Viewpoint(ModelNormal):
7777
'inclusive_maximum': 2147483647,
7878
'inclusive_minimum': 0,
7979
},
80+
('authoring_view',): {
81+
'max_length': 32,
82+
},
8083
}
8184

8285
@cached_property
@@ -104,6 +107,7 @@ def openapi_types():
104107
return {
105108
'index': (int, none_type,), # noqa: E501
106109
'guid': (str,), # noqa: E501
110+
'authoring_view': (str,), # noqa: E501
107111
'orthogonal_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
108112
'perspective_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
109113
'lines': ([Line], none_type,), # noqa: E501
@@ -121,6 +125,7 @@ def discriminator():
121125
attribute_map = {
122126
'index': 'index', # noqa: E501
123127
'guid': 'guid', # noqa: E501
128+
'authoring_view': 'authoring_view', # noqa: E501
124129
'orthogonal_camera': 'orthogonal_camera', # noqa: E501
125130
'perspective_camera': 'perspective_camera', # noqa: E501
126131
'lines': 'lines', # noqa: E501
@@ -173,6 +178,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
173178
_visited_composed_classes = (Animal,)
174179
index (int, none_type): [optional] # noqa: E501
175180
guid (str): [optional] # noqa: E501
181+
authoring_view (str): [optional] # noqa: E501
176182
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
177183
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
178184
lines ([Line], none_type): [optional] # noqa: E501
@@ -263,6 +269,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
263269
_visited_composed_classes = (Animal,)
264270
index (int, none_type): [optional] # noqa: E501
265271
guid (str): [optional] # noqa: E501
272+
authoring_view (str): [optional] # noqa: E501
266273
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
267274
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
268275
lines ([Line], none_type): [optional] # noqa: E501

bimdata_api_client/model/viewpoint_request.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ class ViewpointRequest(ModelNormal):
7777
'inclusive_maximum': 2147483647,
7878
'inclusive_minimum': 0,
7979
},
80+
('authoring_view',): {
81+
'max_length': 32,
82+
'min_length': 1,
83+
},
8084
}
8185

8286
@cached_property
@@ -104,6 +108,7 @@ def openapi_types():
104108
return {
105109
'index': (int, none_type,), # noqa: E501
106110
'guid': (str,), # noqa: E501
111+
'authoring_view': (str,), # noqa: E501
107112
'orthogonal_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
108113
'perspective_camera': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501
109114
'lines': ([LineRequest], none_type,), # noqa: E501
@@ -122,6 +127,7 @@ def discriminator():
122127
attribute_map = {
123128
'index': 'index', # noqa: E501
124129
'guid': 'guid', # noqa: E501
130+
'authoring_view': 'authoring_view', # noqa: E501
125131
'orthogonal_camera': 'orthogonal_camera', # noqa: E501
126132
'perspective_camera': 'perspective_camera', # noqa: E501
127133
'lines': 'lines', # noqa: E501
@@ -175,6 +181,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
175181
_visited_composed_classes = (Animal,)
176182
index (int, none_type): [optional] # noqa: E501
177183
guid (str): [optional] # noqa: E501
184+
authoring_view (str): [optional] # noqa: E501
178185
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
179186
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
180187
lines ([LineRequest], none_type): [optional] # noqa: E501
@@ -266,6 +273,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
266273
_visited_composed_classes = (Animal,)
267274
index (int, none_type): [optional] # noqa: E501
268275
guid (str): [optional] # noqa: E501
276+
authoring_view (str): [optional] # noqa: E501
269277
orthogonal_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
270278
perspective_camera (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501
271279
lines ([LineRequest], none_type): [optional] # noqa: E501

docs/BcfApi.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -841,6 +841,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
841841
ViewpointRequest(
842842
index=0,
843843
guid="guid_example",
844+
authoring_view="authoring_view_example",
844845
orthogonal_camera=None,
845846
perspective_camera=None,
846847
lines=[
@@ -1140,6 +1141,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
11401141
viewpoint_request = ViewpointRequest(
11411142
index=0,
11421143
guid="guid_example",
1144+
authoring_view="authoring_view_example",
11431145
orthogonal_camera=None,
11441146
perspective_camera=None,
11451147
lines=[
@@ -2539,6 +2541,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
25392541
ViewpointRequest(
25402542
index=0,
25412543
guid="guid_example",
2544+
authoring_view="authoring_view_example",
25422545
orthogonal_camera=None,
25432546
perspective_camera=None,
25442547
lines=[
@@ -2842,6 +2845,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
28422845
viewpoint_request = ViewpointRequest(
28432846
index=0,
28442847
guid="guid_example",
2848+
authoring_view="authoring_view_example",
28452849
orthogonal_camera=None,
28462850
perspective_camera=None,
28472851
lines=[
@@ -5956,6 +5960,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
59565960
ViewpointRequest(
59575961
index=0,
59585962
guid="guid_example",
5963+
authoring_view="authoring_view_example",
59595964
orthogonal_camera=None,
59605965
perspective_camera=None,
59615966
lines=[
@@ -6267,6 +6272,7 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
62676272
patched_viewpoint_request = PatchedViewpointRequest(
62686273
index=0,
62696274
guid="guid_example",
6275+
authoring_view="authoring_view_example",
62706276
orthogonal_camera=None,
62716277
perspective_camera=None,
62726278
lines=[

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1307,7 +1307,7 @@ void (empty response body)
13071307
13081308
Create a document
13091309

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

13121312
### Example
13131313

docs/IfcApi.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16085,7 +16085,6 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
1608516085
project_pk = 1 # int |
1608616086
patched_model_request = PatchedModelRequest(
1608716087
name="name_example",
16088-
status="status_example",
1608916088
source="UPLOAD",
1609016089
world_position=[
1609116090
3.14,

0 commit comments

Comments
 (0)