@@ -25,7 +25,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2525
2626Then import the package:
2727``` python
28- import bimdata_api_client
28+ import bimdata - api - client
2929```
3030
3131### Setuptools
@@ -39,7 +39,7 @@ python setup.py install --user
3939
4040Then import the package:
4141``` python
42- import bimdata_api_client
42+ import bimdata - api - client
4343```
4444
4545## Getting Started
@@ -49,53 +49,53 @@ Please follow the [installation procedure](#installation--usage) and then run th
4949``` python
5050
5151import time
52- import bimdata_api_client
52+ import bimdata - api - client
5353from pprint import pprint
54- from bimdata_api_client .api import bcf_api
55- from bimdata_api_client .model.auth import Auth
56- from bimdata_api_client .model.bcf_project import BcfProject
57- from bimdata_api_client .model.bcf_project_request import BcfProjectRequest
58- from bimdata_api_client .model.coloring import Coloring
59- from bimdata_api_client .model.comment import Comment
60- from bimdata_api_client .model.comment_request import CommentRequest
61- from bimdata_api_client .model.component import Component
62- from bimdata_api_client .model.detailed_extensions import DetailedExtensions
63- from bimdata_api_client .model.extensions import Extensions
64- from bimdata_api_client .model.full_topic import FullTopic
65- from bimdata_api_client .model.full_topic_request import FullTopicRequest
66- from bimdata_api_client .model.label import Label
67- from bimdata_api_client .model.label_request import LabelRequest
68- from bimdata_api_client .model.patched_bcf_project_request import PatchedBcfProjectRequest
69- from bimdata_api_client .model.patched_comment_request import PatchedCommentRequest
70- from bimdata_api_client .model.patched_full_topic_request import PatchedFullTopicRequest
71- from bimdata_api_client .model.patched_label_request import PatchedLabelRequest
72- from bimdata_api_client .model.patched_pin_request import PatchedPinRequest
73- from bimdata_api_client .model.patched_priority_request import PatchedPriorityRequest
74- from bimdata_api_client .model.patched_stage_request import PatchedStageRequest
75- from bimdata_api_client .model.patched_topic_request import PatchedTopicRequest
76- from bimdata_api_client .model.patched_topic_status_request import PatchedTopicStatusRequest
77- from bimdata_api_client .model.patched_topic_type_request import PatchedTopicTypeRequest
78- from bimdata_api_client .model.patched_viewpoint_request import PatchedViewpointRequest
79- from bimdata_api_client .model.pin import Pin
80- from bimdata_api_client .model.pin_request import PinRequest
81- from bimdata_api_client .model.priority import Priority
82- from bimdata_api_client .model.priority_request import PriorityRequest
83- from bimdata_api_client .model.self_bcf_user import SelfBcfUser
84- from bimdata_api_client .model.stage import Stage
85- from bimdata_api_client .model.stage_request import StageRequest
86- from bimdata_api_client .model.topic import Topic
87- from bimdata_api_client .model.topic_request import TopicRequest
88- from bimdata_api_client .model.topic_status import TopicStatus
89- from bimdata_api_client .model.topic_status_request import TopicStatusRequest
90- from bimdata_api_client .model.topic_type import TopicType
91- from bimdata_api_client .model.topic_type_request import TopicTypeRequest
92- from bimdata_api_client .model.version import Version
93- from bimdata_api_client .model.viewpoint import Viewpoint
94- from bimdata_api_client .model.viewpoint_request import ViewpointRequest
95- from bimdata_api_client .model.visibility import Visibility
54+ from bimdata - api - client .api import bcf_api
55+ from bimdata - api - client .model.auth import Auth
56+ from bimdata - api - client .model.bcf_project import BcfProject
57+ from bimdata - api - client .model.bcf_project_request import BcfProjectRequest
58+ from bimdata - api - client .model.coloring_definition import ColoringDefinition
59+ from bimdata - api - client .model.comment import Comment
60+ from bimdata - api - client .model.comment_request import CommentRequest
61+ from bimdata - api - client .model.detailed_extensions import DetailedExtensions
62+ from bimdata - api - client .model.extensions import Extensions
63+ from bimdata - api - client .model.full_topic import FullTopic
64+ from bimdata - api - client .model.full_topic_request import FullTopicRequest
65+ from bimdata - api - client .model.label import Label
66+ from bimdata - api - client .model.label_request import LabelRequest
67+ from bimdata - api - client .model.patched_bcf_project_request import PatchedBcfProjectRequest
68+ from bimdata - api - client .model.patched_comment_request import PatchedCommentRequest
69+ from bimdata - api - client .model.patched_full_topic_request import PatchedFullTopicRequest
70+ from bimdata - api - client .model.patched_label_request import PatchedLabelRequest
71+ from bimdata - api - client .model.patched_pin_request import PatchedPinRequest
72+ from bimdata - api - client .model.patched_priority_request import PatchedPriorityRequest
73+ from bimdata - api - client .model.patched_stage_request import PatchedStageRequest
74+ from bimdata - api - client .model.patched_topic_request import PatchedTopicRequest
75+ from bimdata - api - client .model.patched_topic_status_request import PatchedTopicStatusRequest
76+ from bimdata - api - client .model.patched_topic_type_request import PatchedTopicTypeRequest
77+ from bimdata - api - client .model.patched_viewpoint_request import PatchedViewpointRequest
78+ from bimdata - api - client .model.pin import Pin
79+ from bimdata - api - client .model.pin_request import PinRequest
80+ from bimdata - api - client .model.priority import Priority
81+ from bimdata - api - client .model.priority_request import PriorityRequest
82+ from bimdata - api - client .model.selection_definition import SelectionDefinition
83+ from bimdata - api - client .model.self_bcf_user import SelfBcfUser
84+ from bimdata - api - client .model.stage import Stage
85+ from bimdata - api - client .model.stage_request import StageRequest
86+ from bimdata - api - client .model.topic import Topic
87+ from bimdata - api - client .model.topic_request import TopicRequest
88+ from bimdata - api - client .model.topic_status import TopicStatus
89+ from bimdata - api - client .model.topic_status_request import TopicStatusRequest
90+ from bimdata - api - client .model.topic_type import TopicType
91+ from bimdata - api - client .model.topic_type_request import TopicTypeRequest
92+ from bimdata - api - client .model.version import Version
93+ from bimdata - api - client .model.viewpoint import Viewpoint
94+ from bimdata - api - client .model.viewpoint_request import ViewpointRequest
95+ from bimdata - api - client .model.visibility_definition import VisibilityDefinition
9696# Defining the host is optional and defaults to http://localhost
9797# See configuration.py for a list of all supported configuration parameters.
98- configuration = bimdata_api_client .Configuration(
98+ configuration = bimdata - api - client .Configuration(
9999 host = " http://localhost"
100100)
101101
@@ -111,13 +111,13 @@ configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
111111# configuration.api_key_prefix['ApiKey'] = 'Bearer'
112112
113113# Configure OAuth2 access token for authorization: BIMData_Connect
114- configuration = bimdata_api_client .Configuration(
114+ configuration = bimdata - api - client .Configuration(
115115 host = " http://localhost"
116116)
117117configuration.access_token = ' YOUR_ACCESS_TOKEN'
118118
119119# Configure OAuth2 access token for authorization: BIMData_Connect
120- configuration = bimdata_api_client .Configuration(
120+ configuration = bimdata - api - client .Configuration(
121121 host = " http://localhost"
122122)
123123configuration.access_token = ' YOUR_ACCESS_TOKEN'
@@ -130,7 +130,7 @@ configuration.api_key['Bearer'] = 'YOUR_API_KEY'
130130
131131
132132# Enter a context with an instance of the API client
133- with bimdata_api_client .ApiClient(configuration) as api_client:
133+ with bimdata - api - client .ApiClient(configuration) as api_client:
134134 # Create an instance of the API class
135135 api_instance = bcf_api.BcfApi(api_client)
136136 projects_pk = 1 # int | A unique integer value identifying this project.
@@ -150,7 +150,7 @@ comment_request = CommentRequest(
150150 # Create a comment
151151 api_response = api_instance.create_comment(projects_pk, topics_guid, comment_request = comment_request)
152152 pprint(api_response)
153- except bimdata_api_client .ApiException as e:
153+ except bimdata - api - client .ApiException as e:
154154 print (" Exception when calling BcfApi->create_comment: %s \n " % e)
155155```
156156
@@ -517,6 +517,7 @@ Class | Method | HTTP request | Description
517517 - [ CloudRequest] ( docs/CloudRequest.md )
518518 - [ CloudRole] ( docs/CloudRole.md )
519519 - [ Coloring] ( docs/Coloring.md )
520+ - [ ColoringDefinition] ( docs/ColoringDefinition.md )
520521 - [ ColoringRequest] ( docs/ColoringRequest.md )
521522 - [ Comment] ( docs/Comment.md )
522523 - [ CommentRequest] ( docs/CommentRequest.md )
@@ -690,6 +691,7 @@ Class | Method | HTTP request | Description
690691 - [ RawUnitRequest] ( docs/RawUnitRequest.md )
691692 - [ RecursiveFolderChildren] ( docs/RecursiveFolderChildren.md )
692693 - [ SelectUserRequest] ( docs/SelectUserRequest.md )
694+ - [ SelectionDefinition] ( docs/SelectionDefinition.md )
693695 - [ SelfBcfUser] ( docs/SelfBcfUser.md )
694696 - [ SelfUser] ( docs/SelfUser.md )
695697 - [ ShortUser] ( docs/ShortUser.md )
@@ -736,9 +738,11 @@ Class | Method | HTTP request | Description
736738 - [ VisaValidationRequest] ( docs/VisaValidationRequest.md )
737739 - [ VisaWithDocument] ( docs/VisaWithDocument.md )
738740 - [ Visibility] ( docs/Visibility.md )
741+ - [ VisibilityDefinition] ( docs/VisibilityDefinition.md )
739742 - [ VisibilityRequest] ( docs/VisibilityRequest.md )
740743 - [ WebHook] ( docs/WebHook.md )
741744 - [ WebHookRequest] ( docs/WebHookRequest.md )
745+ - [ WriteFolder] ( docs/WriteFolder.md )
742746 - [ WriteFolderRequest] ( docs/WriteFolderRequest.md )
743747 - [ XktFile] ( docs/XktFile.md )
744748 - [ Zone] ( docs/Zone.md )
@@ -787,21 +791,21 @@ support@bimdata.io
787791
788792
789793## Notes for Large OpenAPI documents
790- If the OpenAPI document is large, imports in bimdata_api_client .apis and bimdata_api_client .models may fail with a
794+ If the OpenAPI document is large, imports in bimdata-api-client .apis and bimdata-api-client .models may fail with a
791795RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
792796
793797Solution 1:
794798Use specific imports for apis and models like:
795- - ` from bimdata_api_client .api.default_api import DefaultApi `
796- - ` from bimdata_api_client .model.pet import Pet `
799+ - ` from bimdata-api-client .api.default_api import DefaultApi `
800+ - ` from bimdata-api-client .model.pet import Pet `
797801
798802Solution 2:
799803Before importing the package, adjust the maximum recursion limit as shown below:
800804```
801805import sys
802806sys.setrecursionlimit(1500)
803- import bimdata_api_client
804- from bimdata_api_client .apis import *
805- from bimdata_api_client .models import *
807+ import bimdata-api-client
808+ from bimdata-api-client .apis import *
809+ from bimdata-api-client .models import *
806810```
807811
0 commit comments