Skip to content

Commit

Permalink
MINOR: Add bcf bimdata_viewer_layout (#759)
Browse files Browse the repository at this point in the history
* Add bcf bimdata_layout

* Rename into bimdata_viewer_layout

* Fix test...
  • Loading branch information
Bimdata-io committed Jul 4, 2024
1 parent 6f92c36 commit e6e043b
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 2 deletions.
2 changes: 1 addition & 1 deletion bimdata_api_client/api/collaboration_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -8859,7 +8859,7 @@ def create_document(
):
"""Create a document # noqa: E501

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
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
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/full_topic.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def openapi_types():
'due_date': (datetime, none_type,), # noqa: E501
'comments': ([Comment],), # noqa: E501
'viewpoints': ([Viewpoint],), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -158,6 +159,7 @@ def discriminator():
'due_date': 'due_date', # noqa: E501
'comments': 'comments', # noqa: E501
'viewpoints': 'viewpoints', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -226,6 +228,7 @@ def _from_openapi_data(cls, modified_date, title, project, *args, **kwargs): #
due_date (datetime, none_type): [optional] # noqa: E501
comments ([Comment]): [optional] # noqa: E501
viewpoints ([Viewpoint]): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -332,6 +335,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
due_date (datetime, none_type): [optional] # noqa: E501
comments ([Comment]): [optional] # noqa: E501
viewpoints ([Viewpoint]): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/full_topic_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ def openapi_types():
'due_date': (datetime, none_type,), # noqa: E501
'comments': ([CommentRequest],), # noqa: E501
'viewpoints': ([ViewpointRequest],), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -172,6 +173,7 @@ def discriminator():
'due_date': 'due_date', # noqa: E501
'comments': 'comments', # noqa: E501
'viewpoints': 'viewpoints', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -238,6 +240,7 @@ def _from_openapi_data(cls, title, project, *args, **kwargs): # noqa: E501
due_date (datetime, none_type): [optional] # noqa: E501
comments ([CommentRequest]): [optional] # noqa: E501
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -344,6 +347,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
due_date (datetime, none_type): [optional] # noqa: E501
comments ([CommentRequest]): [optional] # noqa: E501
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/patched_full_topic_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ def openapi_types():
'comments': ([CommentRequest],), # noqa: E501
'viewpoints': ([ViewpointRequest],), # noqa: E501
'project': (int,), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -172,6 +173,7 @@ def discriminator():
'comments': 'comments', # noqa: E501
'viewpoints': 'viewpoints', # noqa: E501
'project': 'project', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -236,6 +238,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
comments ([CommentRequest]): [optional] # noqa: E501
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
project (int): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -338,6 +341,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
comments ([CommentRequest]): [optional] # noqa: E501
viewpoints ([ViewpointRequest]): [optional] # noqa: E501
project (int): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/patched_topic_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ def openapi_types():
'format': (str,), # noqa: E501
'index': (int, none_type,), # noqa: E501
'project': (int,), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -160,6 +161,7 @@ def discriminator():
'format': 'format', # noqa: E501
'index': 'index', # noqa: E501
'project': 'project', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -222,6 +224,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
project (int): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -322,6 +325,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
project (int): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/topic.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ def openapi_types():
'models': ([int],), # noqa: E501
'format': (str,), # noqa: E501
'index': (int, none_type,), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -146,6 +147,7 @@ def discriminator():
'models': 'models', # noqa: E501
'format': 'format', # noqa: E501
'index': 'index', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -212,6 +214,7 @@ def _from_openapi_data(cls, title, modified_date, project, *args, **kwargs): #
models ([int]): [optional] # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -317,6 +320,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
models ([int]): [optional] # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions bimdata_api_client/model/topic_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ def openapi_types():
'models': ([int],), # noqa: E501
'format': (str,), # noqa: E501
'index': (int, none_type,), # noqa: E501
'bimdata_viewer_layout': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}

@cached_property
Expand Down Expand Up @@ -160,6 +161,7 @@ def discriminator():
'models': 'models', # noqa: E501
'format': 'format', # noqa: E501
'index': 'index', # noqa: E501
'bimdata_viewer_layout': 'bimdata_viewer_layout', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -224,6 +226,7 @@ def _from_openapi_data(cls, title, project, *args, **kwargs): # noqa: E501
models ([int]): [optional] # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -328,6 +331,7 @@ def __init__(self, title, project, *args, **kwargs): # noqa: E501
models ([int]): [optional] # noqa: E501
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
index (int, none_type): [optional] # noqa: E501
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
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
18 changes: 18 additions & 0 deletions docs/BcfApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -905,6 +905,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
),
],
project=1,
bimdata_viewer_layout={
"key": None,
},
) # FullTopicRequest |
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"

Expand Down Expand Up @@ -1172,6 +1175,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
format="format_example",
index=0,
project=1,
bimdata_viewer_layout={
"key": None,
},
) # TopicRequest |

# example passing only required values which don't have defaults set
Expand Down Expand Up @@ -2975,6 +2981,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
),
],
project=1,
bimdata_viewer_layout={
"key": None,
},
) # FullTopicRequest |
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"

Expand Down Expand Up @@ -3246,6 +3255,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
format="format_example",
index=0,
project=1,
bimdata_viewer_layout={
"key": None,
},
) # TopicRequest |

# example passing only required values which don't have defaults set
Expand Down Expand Up @@ -7020,6 +7032,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
),
],
project=1,
bimdata_viewer_layout={
"key": None,
},
) # PatchedFullTopicRequest | (optional)

# example passing only required values which don't have defaults set
Expand Down Expand Up @@ -7299,6 +7314,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
format="format_example",
index=0,
project=1,
bimdata_viewer_layout={
"key": None,
},
) # PatchedTopicRequest | (optional)

# example passing only required values which don't have defaults set
Expand Down
2 changes: 1 addition & 1 deletion docs/CollaborationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1541,7 +1541,7 @@ Name | Type | Description | Notes

Create a document

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
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

### Example

Expand Down
1 change: 1 addition & 0 deletions docs/FullTopic.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Name | Type | Description | Notes
**due_date** | **datetime, none_type** | | [optional]
**comments** | [**[Comment]**](Comment.md) | | [optional]
**viewpoints** | [**[Viewpoint]**](Viewpoint.md) | | [optional]
**bimdata_viewer_layout** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Non standard field. JSON describing bimdataViewerLayout. | [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)
Expand Down
1 change: 1 addition & 0 deletions docs/FullTopicRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**due_date** | **datetime, none_type** | | [optional]
**comments** | [**[CommentRequest]**](CommentRequest.md) | | [optional]
**viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) | | [optional]
**bimdata_viewer_layout** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Non standard field. JSON describing bimdataViewerLayout. | [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)
Expand Down
1 change: 1 addition & 0 deletions docs/PatchedFullTopicRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**comments** | [**[CommentRequest]**](CommentRequest.md) | | [optional]
**viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) | | [optional]
**project** | **int** | | [optional]
**bimdata_viewer_layout** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Non standard field. JSON describing bimdataViewerLayout. | [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)
Expand Down
1 change: 1 addition & 0 deletions docs/PatchedTopicRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Name | Type | Description | Notes
**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]
**index** | **int, none_type** | | [optional]
**project** | **int** | | [optional]
**bimdata_viewer_layout** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Non standard field. JSON describing bimdataViewerLayout. | [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)
Expand Down
Loading

0 comments on commit e6e043b

Please sign in to comment.