wandelbots-isaacsim-api 2.2.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. wandelbots_isaacsim_api/__init__.py +50 -0
  2. wandelbots_isaacsim_api/api/__init__.py +25 -0
  3. wandelbots_isaacsim_api/api/collision_world_api.py +316 -0
  4. wandelbots_isaacsim_api/api/default_api.py +800 -0
  5. wandelbots_isaacsim_api/api/manipulators_motion_group_api.py +1619 -0
  6. wandelbots_isaacsim_api/api/periphery_camera_api.py +3434 -0
  7. wandelbots_isaacsim_api/api/prims_api.py +4963 -0
  8. wandelbots_isaacsim_api/api/stage_api.py +2351 -0
  9. wandelbots_isaacsim_api/api/teaching_api.py +1312 -0
  10. wandelbots_isaacsim_api/api/trajectory_api.py +1686 -0
  11. wandelbots_isaacsim_api/api/ui_api.py +562 -0
  12. wandelbots_isaacsim_api/api_client.py +800 -0
  13. wandelbots_isaacsim_api/api_response.py +21 -0
  14. wandelbots_isaacsim_api/collision/__init__.py +0 -0
  15. wandelbots_isaacsim_api/collision/utils.py +99 -0
  16. wandelbots_isaacsim_api/configuration.py +561 -0
  17. wandelbots_isaacsim_api/exceptions.py +216 -0
  18. wandelbots_isaacsim_api/models/__init__.py +135 -0
  19. wandelbots_isaacsim_api/models/auth0_credentials.py +100 -0
  20. wandelbots_isaacsim_api/models/body_apply_relative_pose.py +99 -0
  21. wandelbots_isaacsim_api/models/body_assign_default_poses.py +91 -0
  22. wandelbots_isaacsim_api/models/body_reset_to_default_poses.py +91 -0
  23. wandelbots_isaacsim_api/models/body_set_joint_state.py +93 -0
  24. wandelbots_isaacsim_api/models/body_set_prim_metadata.py +97 -0
  25. wandelbots_isaacsim_api/models/body_set_prim_visibility.py +103 -0
  26. wandelbots_isaacsim_api/models/body_set_semantic_label.py +93 -0
  27. wandelbots_isaacsim_api/models/body_update_colliders.py +93 -0
  28. wandelbots_isaacsim_api/models/body_update_pose.py +97 -0
  29. wandelbots_isaacsim_api/models/bounding_box2_d.py +98 -0
  30. wandelbots_isaacsim_api/models/bounding_box3_d.py +100 -0
  31. wandelbots_isaacsim_api/models/box.py +119 -0
  32. wandelbots_isaacsim_api/models/box_sweep_parameters.py +111 -0
  33. wandelbots_isaacsim_api/models/capsule.py +105 -0
  34. wandelbots_isaacsim_api/models/collider.py +101 -0
  35. wandelbots_isaacsim_api/models/convex_hull.py +103 -0
  36. wandelbots_isaacsim_api/models/create_ghost_object.py +102 -0
  37. wandelbots_isaacsim_api/models/custom_prim.py +100 -0
  38. wandelbots_isaacsim_api/models/custom_prim_data.py +93 -0
  39. wandelbots_isaacsim_api/models/cylinder.py +105 -0
  40. wandelbots_isaacsim_api/models/ghost_object.py +106 -0
  41. wandelbots_isaacsim_api/models/ghost_object_source.py +93 -0
  42. wandelbots_isaacsim_api/models/gizmo_prim.py +98 -0
  43. wandelbots_isaacsim_api/models/http_validation_error.py +108 -0
  44. wandelbots_isaacsim_api/models/instance_segmentation_data.py +97 -0
  45. wandelbots_isaacsim_api/models/instance_segmentation_info.py +91 -0
  46. wandelbots_isaacsim_api/models/motion_group_configuration.py +99 -0
  47. wandelbots_isaacsim_api/models/motion_stream_configuration.py +101 -0
  48. wandelbots_isaacsim_api/models/patch_trajectory_data.py +107 -0
  49. wandelbots_isaacsim_api/models/plane.py +101 -0
  50. wandelbots_isaacsim_api/models/point_cloud.py +95 -0
  51. wandelbots_isaacsim_api/models/pose.py +137 -0
  52. wandelbots_isaacsim_api/models/pose_position_inner.py +138 -0
  53. wandelbots_isaacsim_api/models/prim.py +165 -0
  54. wandelbots_isaacsim_api/models/prim_selection.py +91 -0
  55. wandelbots_isaacsim_api/models/quat_pose.py +92 -0
  56. wandelbots_isaacsim_api/models/relative_pose_mode.py +39 -0
  57. wandelbots_isaacsim_api/models/response_get_pose.py +134 -0
  58. wandelbots_isaacsim_api/models/response_get_relative_pose.py +134 -0
  59. wandelbots_isaacsim_api/models/response_list_default_poses_value.py +140 -0
  60. wandelbots_isaacsim_api/models/semantic_segmentation_data.py +97 -0
  61. wandelbots_isaacsim_api/models/semantic_segmentation_info.py +91 -0
  62. wandelbots_isaacsim_api/models/shape.py +194 -0
  63. wandelbots_isaacsim_api/models/simulation_state.py +101 -0
  64. wandelbots_isaacsim_api/models/sphere.py +103 -0
  65. wandelbots_isaacsim_api/models/sphere_sweep_parameters.py +107 -0
  66. wandelbots_isaacsim_api/models/stage_units.py +91 -0
  67. wandelbots_isaacsim_api/models/sweep_arguments.py +134 -0
  68. wandelbots_isaacsim_api/models/tcp_source.py +99 -0
  69. wandelbots_isaacsim_api/models/trajectory_data.py +101 -0
  70. wandelbots_isaacsim_api/models/trajectory_marker.py +97 -0
  71. wandelbots_isaacsim_api/models/trajectory_object.py +101 -0
  72. wandelbots_isaacsim_api/models/trajectory_options.py +94 -0
  73. wandelbots_isaacsim_api/models/usd_stage_model.py +91 -0
  74. wandelbots_isaacsim_api/models/validation_error.py +112 -0
  75. wandelbots_isaacsim_api/models/validation_error_loc_inner.py +138 -0
  76. wandelbots_isaacsim_api/models/ws_pose.py +92 -0
  77. wandelbots_isaacsim_api/py.typed +0 -0
  78. wandelbots_isaacsim_api/rest.py +212 -0
  79. wandelbots_isaacsim_api/trajectory/__init__.py +17 -0
  80. wandelbots_isaacsim_api/trajectory/trajectory_viewer.py +111 -0
  81. wandelbots_isaacsim_api/trajectory/utils.py +154 -0
  82. wandelbots_isaacsim_api-2.2.2.dist-info/LICENSE +201 -0
  83. wandelbots_isaacsim_api-2.2.2.dist-info/METADATA +60 -0
  84. wandelbots_isaacsim_api-2.2.2.dist-info/RECORD +85 -0
  85. wandelbots_isaacsim_api-2.2.2.dist-info/WHEEL +4 -0
@@ -0,0 +1,2351 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wandelbots Omniservice
5
+
6
+ A microservice-based framework for managing Omniverse functionalities
7
+
8
+ The version of the OpenAPI document: 2.2.2
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from furl import furl
16
+ import json
17
+ import humps
18
+ import re
19
+ import warnings
20
+ import websockets
21
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
22
+ from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, Union
23
+ from typing_extensions import Annotated
24
+ from urllib.parse import quote
25
+
26
+ from pydantic import Field, StrictBytes, StrictStr, field_validator
27
+ from typing import Any, List, Tuple, Union
28
+ from typing_extensions import Annotated
29
+ from wandelbots_isaacsim_api.models.simulation_state import SimulationState
30
+ from wandelbots_isaacsim_api.models.stage_units import StageUnits
31
+ from wandelbots_isaacsim_api.models.usd_stage_model import UsdStageModel
32
+
33
+ from wandelbots_isaacsim_api.api_client import ApiClient, RequestSerialized
34
+ from wandelbots_isaacsim_api.api_response import ApiResponse
35
+ from wandelbots_isaacsim_api.rest import RESTResponseType
36
+
37
+ class StageApi:
38
+ """NOTE: This class is auto generated by OpenAPI Generator
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+ """
43
+
44
+ def __init__(self, api_client=None) -> None:
45
+ if api_client is None:
46
+ api_client = ApiClient.get_default()
47
+ self.api_client = api_client
48
+
49
+ @validate_call
50
+ async def export_configuration(
51
+ self,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> object:
65
+ """Export Configuration
66
+
67
+ Exports the configured scene setup as a `.yaml` file
68
+
69
+ :param _request_timeout: timeout setting for this request. If one
70
+ number provided, it will be total request
71
+ timeout. It can also be a pair (tuple) of
72
+ (connection, read) timeouts.
73
+ :type _request_timeout: int, tuple(int, int), optional
74
+ :param _request_auth: set to override the auth_settings for an a single
75
+ request; this effectively ignores the
76
+ authentication in the spec for a single request.
77
+ :type _request_auth: dict, optional
78
+ :param _content_type: force content-type for the request.
79
+ :type _content_type: str, Optional
80
+ :param _headers: set to override the headers for a single
81
+ request; this effectively ignores the headers
82
+ in the spec for a single request.
83
+ :type _headers: dict, optional
84
+ :param _host_index: set to override the host_index for a single
85
+ request; this effectively ignores the host_index
86
+ in the spec for a single request.
87
+ :type _host_index: int, optional
88
+ :return: Returns the result object.
89
+ """ # noqa: E501
90
+
91
+ _param = self._export_configuration_serialize(
92
+ _request_auth=_request_auth,
93
+ _content_type=_content_type,
94
+ _headers=_headers,
95
+ _host_index=_host_index
96
+ )
97
+
98
+ _response_types_map: Dict[str, Optional[str]] = {
99
+ '200': "object",
100
+ '500': None,
101
+ }
102
+ response_data = await self.api_client.call_api(
103
+ *_param,
104
+ _request_timeout=_request_timeout
105
+ )
106
+ await response_data.read()
107
+ return self.api_client.response_deserialize(
108
+ response_data=response_data,
109
+ response_types_map=_response_types_map,
110
+ ).data
111
+
112
+
113
+ @validate_call
114
+ async def export_configuration_with_http_info(
115
+ self,
116
+ _request_timeout: Union[
117
+ None,
118
+ Annotated[StrictFloat, Field(gt=0)],
119
+ Tuple[
120
+ Annotated[StrictFloat, Field(gt=0)],
121
+ Annotated[StrictFloat, Field(gt=0)]
122
+ ]
123
+ ] = None,
124
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
125
+ _content_type: Optional[StrictStr] = None,
126
+ _headers: Optional[Dict[StrictStr, Any]] = None,
127
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
128
+ ) -> ApiResponse[object]:
129
+ """Export Configuration
130
+
131
+ Exports the configured scene setup as a `.yaml` file
132
+
133
+ :param _request_timeout: timeout setting for this request. If one
134
+ number provided, it will be total request
135
+ timeout. It can also be a pair (tuple) of
136
+ (connection, read) timeouts.
137
+ :type _request_timeout: int, tuple(int, int), optional
138
+ :param _request_auth: set to override the auth_settings for an a single
139
+ request; this effectively ignores the
140
+ authentication in the spec for a single request.
141
+ :type _request_auth: dict, optional
142
+ :param _content_type: force content-type for the request.
143
+ :type _content_type: str, Optional
144
+ :param _headers: set to override the headers for a single
145
+ request; this effectively ignores the headers
146
+ in the spec for a single request.
147
+ :type _headers: dict, optional
148
+ :param _host_index: set to override the host_index for a single
149
+ request; this effectively ignores the host_index
150
+ in the spec for a single request.
151
+ :type _host_index: int, optional
152
+ :return: Returns the result object.
153
+ """ # noqa: E501
154
+
155
+ _param = self._export_configuration_serialize(
156
+ _request_auth=_request_auth,
157
+ _content_type=_content_type,
158
+ _headers=_headers,
159
+ _host_index=_host_index
160
+ )
161
+
162
+ _response_types_map: Dict[str, Optional[str]] = {
163
+ '200': "object",
164
+ '500': None,
165
+ }
166
+ response_data = await self.api_client.call_api(
167
+ *_param,
168
+ _request_timeout=_request_timeout
169
+ )
170
+ await response_data.read()
171
+ return self.api_client.response_deserialize(
172
+ response_data=response_data,
173
+ response_types_map=_response_types_map,
174
+ )
175
+
176
+
177
+ @validate_call
178
+ async def export_configuration_without_preload_content(
179
+ self,
180
+ _request_timeout: Union[
181
+ None,
182
+ Annotated[StrictFloat, Field(gt=0)],
183
+ Tuple[
184
+ Annotated[StrictFloat, Field(gt=0)],
185
+ Annotated[StrictFloat, Field(gt=0)]
186
+ ]
187
+ ] = None,
188
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
189
+ _content_type: Optional[StrictStr] = None,
190
+ _headers: Optional[Dict[StrictStr, Any]] = None,
191
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
192
+ ) -> RESTResponseType:
193
+ """Export Configuration
194
+
195
+ Exports the configured scene setup as a `.yaml` file
196
+
197
+ :param _request_timeout: timeout setting for this request. If one
198
+ number provided, it will be total request
199
+ timeout. It can also be a pair (tuple) of
200
+ (connection, read) timeouts.
201
+ :type _request_timeout: int, tuple(int, int), optional
202
+ :param _request_auth: set to override the auth_settings for an a single
203
+ request; this effectively ignores the
204
+ authentication in the spec for a single request.
205
+ :type _request_auth: dict, optional
206
+ :param _content_type: force content-type for the request.
207
+ :type _content_type: str, Optional
208
+ :param _headers: set to override the headers for a single
209
+ request; this effectively ignores the headers
210
+ in the spec for a single request.
211
+ :type _headers: dict, optional
212
+ :param _host_index: set to override the host_index for a single
213
+ request; this effectively ignores the host_index
214
+ in the spec for a single request.
215
+ :type _host_index: int, optional
216
+ :return: Returns the result object.
217
+ """ # noqa: E501
218
+
219
+ _param = self._export_configuration_serialize(
220
+ _request_auth=_request_auth,
221
+ _content_type=_content_type,
222
+ _headers=_headers,
223
+ _host_index=_host_index
224
+ )
225
+
226
+ _response_types_map: Dict[str, Optional[str]] = {
227
+ '200': "object",
228
+ '500': None,
229
+ }
230
+ response_data = await self.api_client.call_api(
231
+ *_param,
232
+ _request_timeout=_request_timeout
233
+ )
234
+ return response_data.response
235
+
236
+
237
+ def _export_configuration_serialize(
238
+ self,
239
+ _request_auth,
240
+ _content_type,
241
+ _headers,
242
+ _host_index,
243
+ ) -> RequestSerialized:
244
+
245
+ _host = None
246
+
247
+ _collection_formats: Dict[str, str] = {
248
+ }
249
+
250
+ _path_params: Dict[str, str] = {}
251
+ _query_params: List[Tuple[str, str]] = []
252
+ _header_params: Dict[str, Optional[str]] = _headers or {}
253
+ _form_params: List[Tuple[str, str]] = []
254
+ _files: Dict[str, Union[str, bytes]] = {}
255
+ _body_params: Optional[bytes] = None
256
+
257
+ # process the path parameters
258
+ # process the query parameters
259
+ # process the header parameters
260
+ # process the form parameters
261
+ # process the body parameter
262
+
263
+
264
+ # set the HTTP header `Accept`
265
+ _header_params['Accept'] = self.api_client.select_header_accept(
266
+ [
267
+ 'application/json'
268
+ ]
269
+ )
270
+
271
+
272
+ # authentication setting
273
+ _auth_settings: List[str] = [
274
+ ]
275
+
276
+ return self.api_client.param_serialize(
277
+ method='GET',
278
+ resource_path='/stage/configuration',
279
+ path_params=_path_params,
280
+ query_params=_query_params,
281
+ header_params=_header_params,
282
+ body=_body_params,
283
+ post_params=_form_params,
284
+ files=_files,
285
+ auth_settings=_auth_settings,
286
+ collection_formats=_collection_formats,
287
+ _host=_host,
288
+ _request_auth=_request_auth
289
+ )
290
+
291
+
292
+
293
+ @validate_call
294
+ async def get_active_scene(
295
+ self,
296
+ _request_timeout: Union[
297
+ None,
298
+ Annotated[StrictFloat, Field(gt=0)],
299
+ Tuple[
300
+ Annotated[StrictFloat, Field(gt=0)],
301
+ Annotated[StrictFloat, Field(gt=0)]
302
+ ]
303
+ ] = None,
304
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
305
+ _content_type: Optional[StrictStr] = None,
306
+ _headers: Optional[Dict[StrictStr, Any]] = None,
307
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
308
+ ) -> str:
309
+ """Get Active Scene
310
+
311
+ Fetches the current active scene in the scene
312
+
313
+ :param _request_timeout: timeout setting for this request. If one
314
+ number provided, it will be total request
315
+ timeout. It can also be a pair (tuple) of
316
+ (connection, read) timeouts.
317
+ :type _request_timeout: int, tuple(int, int), optional
318
+ :param _request_auth: set to override the auth_settings for an a single
319
+ request; this effectively ignores the
320
+ authentication in the spec for a single request.
321
+ :type _request_auth: dict, optional
322
+ :param _content_type: force content-type for the request.
323
+ :type _content_type: str, Optional
324
+ :param _headers: set to override the headers for a single
325
+ request; this effectively ignores the headers
326
+ in the spec for a single request.
327
+ :type _headers: dict, optional
328
+ :param _host_index: set to override the host_index for a single
329
+ request; this effectively ignores the host_index
330
+ in the spec for a single request.
331
+ :type _host_index: int, optional
332
+ :return: Returns the result object.
333
+ """ # noqa: E501
334
+
335
+ _param = self._get_active_scene_serialize(
336
+ _request_auth=_request_auth,
337
+ _content_type=_content_type,
338
+ _headers=_headers,
339
+ _host_index=_host_index
340
+ )
341
+
342
+ _response_types_map: Dict[str, Optional[str]] = {
343
+ '200': "str",
344
+ '500': None,
345
+ }
346
+ response_data = await self.api_client.call_api(
347
+ *_param,
348
+ _request_timeout=_request_timeout
349
+ )
350
+ await response_data.read()
351
+ return self.api_client.response_deserialize(
352
+ response_data=response_data,
353
+ response_types_map=_response_types_map,
354
+ ).data
355
+
356
+
357
+ @validate_call
358
+ async def get_active_scene_with_http_info(
359
+ self,
360
+ _request_timeout: Union[
361
+ None,
362
+ Annotated[StrictFloat, Field(gt=0)],
363
+ Tuple[
364
+ Annotated[StrictFloat, Field(gt=0)],
365
+ Annotated[StrictFloat, Field(gt=0)]
366
+ ]
367
+ ] = None,
368
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
369
+ _content_type: Optional[StrictStr] = None,
370
+ _headers: Optional[Dict[StrictStr, Any]] = None,
371
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
372
+ ) -> ApiResponse[str]:
373
+ """Get Active Scene
374
+
375
+ Fetches the current active scene in the scene
376
+
377
+ :param _request_timeout: timeout setting for this request. If one
378
+ number provided, it will be total request
379
+ timeout. It can also be a pair (tuple) of
380
+ (connection, read) timeouts.
381
+ :type _request_timeout: int, tuple(int, int), optional
382
+ :param _request_auth: set to override the auth_settings for an a single
383
+ request; this effectively ignores the
384
+ authentication in the spec for a single request.
385
+ :type _request_auth: dict, optional
386
+ :param _content_type: force content-type for the request.
387
+ :type _content_type: str, Optional
388
+ :param _headers: set to override the headers for a single
389
+ request; this effectively ignores the headers
390
+ in the spec for a single request.
391
+ :type _headers: dict, optional
392
+ :param _host_index: set to override the host_index for a single
393
+ request; this effectively ignores the host_index
394
+ in the spec for a single request.
395
+ :type _host_index: int, optional
396
+ :return: Returns the result object.
397
+ """ # noqa: E501
398
+
399
+ _param = self._get_active_scene_serialize(
400
+ _request_auth=_request_auth,
401
+ _content_type=_content_type,
402
+ _headers=_headers,
403
+ _host_index=_host_index
404
+ )
405
+
406
+ _response_types_map: Dict[str, Optional[str]] = {
407
+ '200': "str",
408
+ '500': None,
409
+ }
410
+ response_data = await self.api_client.call_api(
411
+ *_param,
412
+ _request_timeout=_request_timeout
413
+ )
414
+ await response_data.read()
415
+ return self.api_client.response_deserialize(
416
+ response_data=response_data,
417
+ response_types_map=_response_types_map,
418
+ )
419
+
420
+
421
+ @validate_call
422
+ async def get_active_scene_without_preload_content(
423
+ self,
424
+ _request_timeout: Union[
425
+ None,
426
+ Annotated[StrictFloat, Field(gt=0)],
427
+ Tuple[
428
+ Annotated[StrictFloat, Field(gt=0)],
429
+ Annotated[StrictFloat, Field(gt=0)]
430
+ ]
431
+ ] = None,
432
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
433
+ _content_type: Optional[StrictStr] = None,
434
+ _headers: Optional[Dict[StrictStr, Any]] = None,
435
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
436
+ ) -> RESTResponseType:
437
+ """Get Active Scene
438
+
439
+ Fetches the current active scene in the scene
440
+
441
+ :param _request_timeout: timeout setting for this request. If one
442
+ number provided, it will be total request
443
+ timeout. It can also be a pair (tuple) of
444
+ (connection, read) timeouts.
445
+ :type _request_timeout: int, tuple(int, int), optional
446
+ :param _request_auth: set to override the auth_settings for an a single
447
+ request; this effectively ignores the
448
+ authentication in the spec for a single request.
449
+ :type _request_auth: dict, optional
450
+ :param _content_type: force content-type for the request.
451
+ :type _content_type: str, Optional
452
+ :param _headers: set to override the headers for a single
453
+ request; this effectively ignores the headers
454
+ in the spec for a single request.
455
+ :type _headers: dict, optional
456
+ :param _host_index: set to override the host_index for a single
457
+ request; this effectively ignores the host_index
458
+ in the spec for a single request.
459
+ :type _host_index: int, optional
460
+ :return: Returns the result object.
461
+ """ # noqa: E501
462
+
463
+ _param = self._get_active_scene_serialize(
464
+ _request_auth=_request_auth,
465
+ _content_type=_content_type,
466
+ _headers=_headers,
467
+ _host_index=_host_index
468
+ )
469
+
470
+ _response_types_map: Dict[str, Optional[str]] = {
471
+ '200': "str",
472
+ '500': None,
473
+ }
474
+ response_data = await self.api_client.call_api(
475
+ *_param,
476
+ _request_timeout=_request_timeout
477
+ )
478
+ return response_data.response
479
+
480
+
481
+ def _get_active_scene_serialize(
482
+ self,
483
+ _request_auth,
484
+ _content_type,
485
+ _headers,
486
+ _host_index,
487
+ ) -> RequestSerialized:
488
+
489
+ _host = None
490
+
491
+ _collection_formats: Dict[str, str] = {
492
+ }
493
+
494
+ _path_params: Dict[str, str] = {}
495
+ _query_params: List[Tuple[str, str]] = []
496
+ _header_params: Dict[str, Optional[str]] = _headers or {}
497
+ _form_params: List[Tuple[str, str]] = []
498
+ _files: Dict[str, Union[str, bytes]] = {}
499
+ _body_params: Optional[bytes] = None
500
+
501
+ # process the path parameters
502
+ # process the query parameters
503
+ # process the header parameters
504
+ # process the form parameters
505
+ # process the body parameter
506
+
507
+
508
+ # set the HTTP header `Accept`
509
+ _header_params['Accept'] = self.api_client.select_header_accept(
510
+ [
511
+ 'application/json'
512
+ ]
513
+ )
514
+
515
+
516
+ # authentication setting
517
+ _auth_settings: List[str] = [
518
+ ]
519
+
520
+ return self.api_client.param_serialize(
521
+ method='GET',
522
+ resource_path='/stage/scene',
523
+ path_params=_path_params,
524
+ query_params=_query_params,
525
+ header_params=_header_params,
526
+ body=_body_params,
527
+ post_params=_form_params,
528
+ files=_files,
529
+ auth_settings=_auth_settings,
530
+ collection_formats=_collection_formats,
531
+ _host=_host,
532
+ _request_auth=_request_auth
533
+ )
534
+
535
+
536
+
537
+ @validate_call
538
+ async def get_stage_units(
539
+ self,
540
+ _request_timeout: Union[
541
+ None,
542
+ Annotated[StrictFloat, Field(gt=0)],
543
+ Tuple[
544
+ Annotated[StrictFloat, Field(gt=0)],
545
+ Annotated[StrictFloat, Field(gt=0)]
546
+ ]
547
+ ] = None,
548
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
549
+ _content_type: Optional[StrictStr] = None,
550
+ _headers: Optional[Dict[StrictStr, Any]] = None,
551
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
552
+ ) -> StageUnits:
553
+ """Get Stage Units
554
+
555
+ Retrieves the current unit scale of the scene.
556
+
557
+ :param _request_timeout: timeout setting for this request. If one
558
+ number provided, it will be total request
559
+ timeout. It can also be a pair (tuple) of
560
+ (connection, read) timeouts.
561
+ :type _request_timeout: int, tuple(int, int), optional
562
+ :param _request_auth: set to override the auth_settings for an a single
563
+ request; this effectively ignores the
564
+ authentication in the spec for a single request.
565
+ :type _request_auth: dict, optional
566
+ :param _content_type: force content-type for the request.
567
+ :type _content_type: str, Optional
568
+ :param _headers: set to override the headers for a single
569
+ request; this effectively ignores the headers
570
+ in the spec for a single request.
571
+ :type _headers: dict, optional
572
+ :param _host_index: set to override the host_index for a single
573
+ request; this effectively ignores the host_index
574
+ in the spec for a single request.
575
+ :type _host_index: int, optional
576
+ :return: Returns the result object.
577
+ """ # noqa: E501
578
+
579
+ _param = self._get_stage_units_serialize(
580
+ _request_auth=_request_auth,
581
+ _content_type=_content_type,
582
+ _headers=_headers,
583
+ _host_index=_host_index
584
+ )
585
+
586
+ _response_types_map: Dict[str, Optional[str]] = {
587
+ '200': "StageUnits",
588
+ '422': None,
589
+ '500': None,
590
+ }
591
+ response_data = await self.api_client.call_api(
592
+ *_param,
593
+ _request_timeout=_request_timeout
594
+ )
595
+ await response_data.read()
596
+ return self.api_client.response_deserialize(
597
+ response_data=response_data,
598
+ response_types_map=_response_types_map,
599
+ ).data
600
+
601
+
602
+ @validate_call
603
+ async def get_stage_units_with_http_info(
604
+ self,
605
+ _request_timeout: Union[
606
+ None,
607
+ Annotated[StrictFloat, Field(gt=0)],
608
+ Tuple[
609
+ Annotated[StrictFloat, Field(gt=0)],
610
+ Annotated[StrictFloat, Field(gt=0)]
611
+ ]
612
+ ] = None,
613
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
614
+ _content_type: Optional[StrictStr] = None,
615
+ _headers: Optional[Dict[StrictStr, Any]] = None,
616
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
617
+ ) -> ApiResponse[StageUnits]:
618
+ """Get Stage Units
619
+
620
+ Retrieves the current unit scale of the scene.
621
+
622
+ :param _request_timeout: timeout setting for this request. If one
623
+ number provided, it will be total request
624
+ timeout. It can also be a pair (tuple) of
625
+ (connection, read) timeouts.
626
+ :type _request_timeout: int, tuple(int, int), optional
627
+ :param _request_auth: set to override the auth_settings for an a single
628
+ request; this effectively ignores the
629
+ authentication in the spec for a single request.
630
+ :type _request_auth: dict, optional
631
+ :param _content_type: force content-type for the request.
632
+ :type _content_type: str, Optional
633
+ :param _headers: set to override the headers for a single
634
+ request; this effectively ignores the headers
635
+ in the spec for a single request.
636
+ :type _headers: dict, optional
637
+ :param _host_index: set to override the host_index for a single
638
+ request; this effectively ignores the host_index
639
+ in the spec for a single request.
640
+ :type _host_index: int, optional
641
+ :return: Returns the result object.
642
+ """ # noqa: E501
643
+
644
+ _param = self._get_stage_units_serialize(
645
+ _request_auth=_request_auth,
646
+ _content_type=_content_type,
647
+ _headers=_headers,
648
+ _host_index=_host_index
649
+ )
650
+
651
+ _response_types_map: Dict[str, Optional[str]] = {
652
+ '200': "StageUnits",
653
+ '422': None,
654
+ '500': None,
655
+ }
656
+ response_data = await self.api_client.call_api(
657
+ *_param,
658
+ _request_timeout=_request_timeout
659
+ )
660
+ await response_data.read()
661
+ return self.api_client.response_deserialize(
662
+ response_data=response_data,
663
+ response_types_map=_response_types_map,
664
+ )
665
+
666
+
667
+ @validate_call
668
+ async def get_stage_units_without_preload_content(
669
+ self,
670
+ _request_timeout: Union[
671
+ None,
672
+ Annotated[StrictFloat, Field(gt=0)],
673
+ Tuple[
674
+ Annotated[StrictFloat, Field(gt=0)],
675
+ Annotated[StrictFloat, Field(gt=0)]
676
+ ]
677
+ ] = None,
678
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
679
+ _content_type: Optional[StrictStr] = None,
680
+ _headers: Optional[Dict[StrictStr, Any]] = None,
681
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
682
+ ) -> RESTResponseType:
683
+ """Get Stage Units
684
+
685
+ Retrieves the current unit scale of the scene.
686
+
687
+ :param _request_timeout: timeout setting for this request. If one
688
+ number provided, it will be total request
689
+ timeout. It can also be a pair (tuple) of
690
+ (connection, read) timeouts.
691
+ :type _request_timeout: int, tuple(int, int), optional
692
+ :param _request_auth: set to override the auth_settings for an a single
693
+ request; this effectively ignores the
694
+ authentication in the spec for a single request.
695
+ :type _request_auth: dict, optional
696
+ :param _content_type: force content-type for the request.
697
+ :type _content_type: str, Optional
698
+ :param _headers: set to override the headers for a single
699
+ request; this effectively ignores the headers
700
+ in the spec for a single request.
701
+ :type _headers: dict, optional
702
+ :param _host_index: set to override the host_index for a single
703
+ request; this effectively ignores the host_index
704
+ in the spec for a single request.
705
+ :type _host_index: int, optional
706
+ :return: Returns the result object.
707
+ """ # noqa: E501
708
+
709
+ _param = self._get_stage_units_serialize(
710
+ _request_auth=_request_auth,
711
+ _content_type=_content_type,
712
+ _headers=_headers,
713
+ _host_index=_host_index
714
+ )
715
+
716
+ _response_types_map: Dict[str, Optional[str]] = {
717
+ '200': "StageUnits",
718
+ '422': None,
719
+ '500': None,
720
+ }
721
+ response_data = await self.api_client.call_api(
722
+ *_param,
723
+ _request_timeout=_request_timeout
724
+ )
725
+ return response_data.response
726
+
727
+
728
+ def _get_stage_units_serialize(
729
+ self,
730
+ _request_auth,
731
+ _content_type,
732
+ _headers,
733
+ _host_index,
734
+ ) -> RequestSerialized:
735
+
736
+ _host = None
737
+
738
+ _collection_formats: Dict[str, str] = {
739
+ }
740
+
741
+ _path_params: Dict[str, str] = {}
742
+ _query_params: List[Tuple[str, str]] = []
743
+ _header_params: Dict[str, Optional[str]] = _headers or {}
744
+ _form_params: List[Tuple[str, str]] = []
745
+ _files: Dict[str, Union[str, bytes]] = {}
746
+ _body_params: Optional[bytes] = None
747
+
748
+ # process the path parameters
749
+ # process the query parameters
750
+ # process the header parameters
751
+ # process the form parameters
752
+ # process the body parameter
753
+
754
+
755
+ # set the HTTP header `Accept`
756
+ _header_params['Accept'] = self.api_client.select_header_accept(
757
+ [
758
+ 'application/json'
759
+ ]
760
+ )
761
+
762
+
763
+ # authentication setting
764
+ _auth_settings: List[str] = [
765
+ ]
766
+
767
+ return self.api_client.param_serialize(
768
+ method='GET',
769
+ resource_path='/stage/units',
770
+ path_params=_path_params,
771
+ query_params=_query_params,
772
+ header_params=_header_params,
773
+ body=_body_params,
774
+ post_params=_form_params,
775
+ files=_files,
776
+ auth_settings=_auth_settings,
777
+ collection_formats=_collection_formats,
778
+ _host=_host,
779
+ _request_auth=_request_auth
780
+ )
781
+
782
+
783
+
784
+ @validate_call
785
+ async def import_configuration(
786
+ self,
787
+ file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file containing configuration for the scene in YAML format.")],
788
+ _request_timeout: Union[
789
+ None,
790
+ Annotated[StrictFloat, Field(gt=0)],
791
+ Tuple[
792
+ Annotated[StrictFloat, Field(gt=0)],
793
+ Annotated[StrictFloat, Field(gt=0)]
794
+ ]
795
+ ] = None,
796
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
797
+ _content_type: Optional[StrictStr] = None,
798
+ _headers: Optional[Dict[StrictStr, Any]] = None,
799
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
800
+ ) -> None:
801
+ """Import Configuration
802
+
803
+ Configures the scene using the uploaded configuration. It can have the following keys: - `scene`: uri of the scene which has to be loaded - `robots`: the robots which you want to configure - `streams`: the streams which you want to configure
804
+
805
+ :param file: The file containing configuration for the scene in YAML format. (required)
806
+ :type file: bytearray
807
+ :param _request_timeout: timeout setting for this request. If one
808
+ number provided, it will be total request
809
+ timeout. It can also be a pair (tuple) of
810
+ (connection, read) timeouts.
811
+ :type _request_timeout: int, tuple(int, int), optional
812
+ :param _request_auth: set to override the auth_settings for an a single
813
+ request; this effectively ignores the
814
+ authentication in the spec for a single request.
815
+ :type _request_auth: dict, optional
816
+ :param _content_type: force content-type for the request.
817
+ :type _content_type: str, Optional
818
+ :param _headers: set to override the headers for a single
819
+ request; this effectively ignores the headers
820
+ in the spec for a single request.
821
+ :type _headers: dict, optional
822
+ :param _host_index: set to override the host_index for a single
823
+ request; this effectively ignores the host_index
824
+ in the spec for a single request.
825
+ :type _host_index: int, optional
826
+ :return: Returns the result object.
827
+ """ # noqa: E501
828
+
829
+ _param = self._import_configuration_serialize(
830
+ file=file,
831
+ _request_auth=_request_auth,
832
+ _content_type=_content_type,
833
+ _headers=_headers,
834
+ _host_index=_host_index
835
+ )
836
+
837
+ _response_types_map: Dict[str, Optional[str]] = {
838
+ '204': None,
839
+ '400': None,
840
+ '500': None,
841
+ '422': "HTTPValidationError",
842
+ }
843
+ response_data = await self.api_client.call_api(
844
+ *_param,
845
+ _request_timeout=_request_timeout
846
+ )
847
+ await response_data.read()
848
+ return self.api_client.response_deserialize(
849
+ response_data=response_data,
850
+ response_types_map=_response_types_map,
851
+ ).data
852
+
853
+
854
+ @validate_call
855
+ async def import_configuration_with_http_info(
856
+ self,
857
+ file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file containing configuration for the scene in YAML format.")],
858
+ _request_timeout: Union[
859
+ None,
860
+ Annotated[StrictFloat, Field(gt=0)],
861
+ Tuple[
862
+ Annotated[StrictFloat, Field(gt=0)],
863
+ Annotated[StrictFloat, Field(gt=0)]
864
+ ]
865
+ ] = None,
866
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
867
+ _content_type: Optional[StrictStr] = None,
868
+ _headers: Optional[Dict[StrictStr, Any]] = None,
869
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
870
+ ) -> ApiResponse[None]:
871
+ """Import Configuration
872
+
873
+ Configures the scene using the uploaded configuration. It can have the following keys: - `scene`: uri of the scene which has to be loaded - `robots`: the robots which you want to configure - `streams`: the streams which you want to configure
874
+
875
+ :param file: The file containing configuration for the scene in YAML format. (required)
876
+ :type file: bytearray
877
+ :param _request_timeout: timeout setting for this request. If one
878
+ number provided, it will be total request
879
+ timeout. It can also be a pair (tuple) of
880
+ (connection, read) timeouts.
881
+ :type _request_timeout: int, tuple(int, int), optional
882
+ :param _request_auth: set to override the auth_settings for an a single
883
+ request; this effectively ignores the
884
+ authentication in the spec for a single request.
885
+ :type _request_auth: dict, optional
886
+ :param _content_type: force content-type for the request.
887
+ :type _content_type: str, Optional
888
+ :param _headers: set to override the headers for a single
889
+ request; this effectively ignores the headers
890
+ in the spec for a single request.
891
+ :type _headers: dict, optional
892
+ :param _host_index: set to override the host_index for a single
893
+ request; this effectively ignores the host_index
894
+ in the spec for a single request.
895
+ :type _host_index: int, optional
896
+ :return: Returns the result object.
897
+ """ # noqa: E501
898
+
899
+ _param = self._import_configuration_serialize(
900
+ file=file,
901
+ _request_auth=_request_auth,
902
+ _content_type=_content_type,
903
+ _headers=_headers,
904
+ _host_index=_host_index
905
+ )
906
+
907
+ _response_types_map: Dict[str, Optional[str]] = {
908
+ '204': None,
909
+ '400': None,
910
+ '500': None,
911
+ '422': "HTTPValidationError",
912
+ }
913
+ response_data = await self.api_client.call_api(
914
+ *_param,
915
+ _request_timeout=_request_timeout
916
+ )
917
+ await response_data.read()
918
+ return self.api_client.response_deserialize(
919
+ response_data=response_data,
920
+ response_types_map=_response_types_map,
921
+ )
922
+
923
+
924
+ @validate_call
925
+ async def import_configuration_without_preload_content(
926
+ self,
927
+ file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file containing configuration for the scene in YAML format.")],
928
+ _request_timeout: Union[
929
+ None,
930
+ Annotated[StrictFloat, Field(gt=0)],
931
+ Tuple[
932
+ Annotated[StrictFloat, Field(gt=0)],
933
+ Annotated[StrictFloat, Field(gt=0)]
934
+ ]
935
+ ] = None,
936
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
937
+ _content_type: Optional[StrictStr] = None,
938
+ _headers: Optional[Dict[StrictStr, Any]] = None,
939
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
940
+ ) -> RESTResponseType:
941
+ """Import Configuration
942
+
943
+ Configures the scene using the uploaded configuration. It can have the following keys: - `scene`: uri of the scene which has to be loaded - `robots`: the robots which you want to configure - `streams`: the streams which you want to configure
944
+
945
+ :param file: The file containing configuration for the scene in YAML format. (required)
946
+ :type file: bytearray
947
+ :param _request_timeout: timeout setting for this request. If one
948
+ number provided, it will be total request
949
+ timeout. It can also be a pair (tuple) of
950
+ (connection, read) timeouts.
951
+ :type _request_timeout: int, tuple(int, int), optional
952
+ :param _request_auth: set to override the auth_settings for an a single
953
+ request; this effectively ignores the
954
+ authentication in the spec for a single request.
955
+ :type _request_auth: dict, optional
956
+ :param _content_type: force content-type for the request.
957
+ :type _content_type: str, Optional
958
+ :param _headers: set to override the headers for a single
959
+ request; this effectively ignores the headers
960
+ in the spec for a single request.
961
+ :type _headers: dict, optional
962
+ :param _host_index: set to override the host_index for a single
963
+ request; this effectively ignores the host_index
964
+ in the spec for a single request.
965
+ :type _host_index: int, optional
966
+ :return: Returns the result object.
967
+ """ # noqa: E501
968
+
969
+ _param = self._import_configuration_serialize(
970
+ file=file,
971
+ _request_auth=_request_auth,
972
+ _content_type=_content_type,
973
+ _headers=_headers,
974
+ _host_index=_host_index
975
+ )
976
+
977
+ _response_types_map: Dict[str, Optional[str]] = {
978
+ '204': None,
979
+ '400': None,
980
+ '500': None,
981
+ '422': "HTTPValidationError",
982
+ }
983
+ response_data = await self.api_client.call_api(
984
+ *_param,
985
+ _request_timeout=_request_timeout
986
+ )
987
+ return response_data.response
988
+
989
+
990
+ def _import_configuration_serialize(
991
+ self,
992
+ file,
993
+ _request_auth,
994
+ _content_type,
995
+ _headers,
996
+ _host_index,
997
+ ) -> RequestSerialized:
998
+
999
+ _host = None
1000
+
1001
+ _collection_formats: Dict[str, str] = {
1002
+ }
1003
+
1004
+ _path_params: Dict[str, str] = {}
1005
+ _query_params: List[Tuple[str, str]] = []
1006
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1007
+ _form_params: List[Tuple[str, str]] = []
1008
+ _files: Dict[str, Union[str, bytes]] = {}
1009
+ _body_params: Optional[bytes] = None
1010
+
1011
+ # process the path parameters
1012
+ # process the query parameters
1013
+ # process the header parameters
1014
+ # process the form parameters
1015
+ if file is not None:
1016
+ _files['file'] = file
1017
+ # process the body parameter
1018
+
1019
+
1020
+ # set the HTTP header `Accept`
1021
+ _header_params['Accept'] = self.api_client.select_header_accept(
1022
+ [
1023
+ 'application/json'
1024
+ ]
1025
+ )
1026
+
1027
+ # set the HTTP header `Content-Type`
1028
+ if _content_type:
1029
+ _header_params['Content-Type'] = _content_type
1030
+ else:
1031
+ _default_content_type = (
1032
+ self.api_client.select_header_content_type(
1033
+ [
1034
+ 'multipart/form-data'
1035
+ ]
1036
+ )
1037
+ )
1038
+ if _default_content_type is not None:
1039
+ _header_params['Content-Type'] = _default_content_type
1040
+
1041
+ # authentication setting
1042
+ _auth_settings: List[str] = [
1043
+ ]
1044
+
1045
+ return self.api_client.param_serialize(
1046
+ method='POST',
1047
+ resource_path='/stage/configuration',
1048
+ path_params=_path_params,
1049
+ query_params=_query_params,
1050
+ header_params=_header_params,
1051
+ body=_body_params,
1052
+ post_params=_form_params,
1053
+ files=_files,
1054
+ auth_settings=_auth_settings,
1055
+ collection_formats=_collection_formats,
1056
+ _host=_host,
1057
+ _request_auth=_request_auth
1058
+ )
1059
+
1060
+
1061
+
1062
+ @validate_call
1063
+ async def list_stage_motion_groups(
1064
+ self,
1065
+ _request_timeout: Union[
1066
+ None,
1067
+ Annotated[StrictFloat, Field(gt=0)],
1068
+ Tuple[
1069
+ Annotated[StrictFloat, Field(gt=0)],
1070
+ Annotated[StrictFloat, Field(gt=0)]
1071
+ ]
1072
+ ] = None,
1073
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1074
+ _content_type: Optional[StrictStr] = None,
1075
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1076
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1077
+ ) -> List[str]:
1078
+ """List Stage Motion Groups
1079
+
1080
+ Fetches all the robot prim paths in the scene Returns: list of robot prim paths
1081
+
1082
+ :param _request_timeout: timeout setting for this request. If one
1083
+ number provided, it will be total request
1084
+ timeout. It can also be a pair (tuple) of
1085
+ (connection, read) timeouts.
1086
+ :type _request_timeout: int, tuple(int, int), optional
1087
+ :param _request_auth: set to override the auth_settings for an a single
1088
+ request; this effectively ignores the
1089
+ authentication in the spec for a single request.
1090
+ :type _request_auth: dict, optional
1091
+ :param _content_type: force content-type for the request.
1092
+ :type _content_type: str, Optional
1093
+ :param _headers: set to override the headers for a single
1094
+ request; this effectively ignores the headers
1095
+ in the spec for a single request.
1096
+ :type _headers: dict, optional
1097
+ :param _host_index: set to override the host_index for a single
1098
+ request; this effectively ignores the host_index
1099
+ in the spec for a single request.
1100
+ :type _host_index: int, optional
1101
+ :return: Returns the result object.
1102
+ """ # noqa: E501
1103
+
1104
+ _param = self._list_stage_motion_groups_serialize(
1105
+ _request_auth=_request_auth,
1106
+ _content_type=_content_type,
1107
+ _headers=_headers,
1108
+ _host_index=_host_index
1109
+ )
1110
+
1111
+ _response_types_map: Dict[str, Optional[str]] = {
1112
+ '200': "List[str]",
1113
+ }
1114
+ response_data = await self.api_client.call_api(
1115
+ *_param,
1116
+ _request_timeout=_request_timeout
1117
+ )
1118
+ await response_data.read()
1119
+ return self.api_client.response_deserialize(
1120
+ response_data=response_data,
1121
+ response_types_map=_response_types_map,
1122
+ ).data
1123
+
1124
+
1125
+ @validate_call
1126
+ async def list_stage_motion_groups_with_http_info(
1127
+ self,
1128
+ _request_timeout: Union[
1129
+ None,
1130
+ Annotated[StrictFloat, Field(gt=0)],
1131
+ Tuple[
1132
+ Annotated[StrictFloat, Field(gt=0)],
1133
+ Annotated[StrictFloat, Field(gt=0)]
1134
+ ]
1135
+ ] = None,
1136
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1137
+ _content_type: Optional[StrictStr] = None,
1138
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1139
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1140
+ ) -> ApiResponse[List[str]]:
1141
+ """List Stage Motion Groups
1142
+
1143
+ Fetches all the robot prim paths in the scene Returns: list of robot prim paths
1144
+
1145
+ :param _request_timeout: timeout setting for this request. If one
1146
+ number provided, it will be total request
1147
+ timeout. It can also be a pair (tuple) of
1148
+ (connection, read) timeouts.
1149
+ :type _request_timeout: int, tuple(int, int), optional
1150
+ :param _request_auth: set to override the auth_settings for an a single
1151
+ request; this effectively ignores the
1152
+ authentication in the spec for a single request.
1153
+ :type _request_auth: dict, optional
1154
+ :param _content_type: force content-type for the request.
1155
+ :type _content_type: str, Optional
1156
+ :param _headers: set to override the headers for a single
1157
+ request; this effectively ignores the headers
1158
+ in the spec for a single request.
1159
+ :type _headers: dict, optional
1160
+ :param _host_index: set to override the host_index for a single
1161
+ request; this effectively ignores the host_index
1162
+ in the spec for a single request.
1163
+ :type _host_index: int, optional
1164
+ :return: Returns the result object.
1165
+ """ # noqa: E501
1166
+
1167
+ _param = self._list_stage_motion_groups_serialize(
1168
+ _request_auth=_request_auth,
1169
+ _content_type=_content_type,
1170
+ _headers=_headers,
1171
+ _host_index=_host_index
1172
+ )
1173
+
1174
+ _response_types_map: Dict[str, Optional[str]] = {
1175
+ '200': "List[str]",
1176
+ }
1177
+ response_data = await self.api_client.call_api(
1178
+ *_param,
1179
+ _request_timeout=_request_timeout
1180
+ )
1181
+ await response_data.read()
1182
+ return self.api_client.response_deserialize(
1183
+ response_data=response_data,
1184
+ response_types_map=_response_types_map,
1185
+ )
1186
+
1187
+
1188
+ @validate_call
1189
+ async def list_stage_motion_groups_without_preload_content(
1190
+ self,
1191
+ _request_timeout: Union[
1192
+ None,
1193
+ Annotated[StrictFloat, Field(gt=0)],
1194
+ Tuple[
1195
+ Annotated[StrictFloat, Field(gt=0)],
1196
+ Annotated[StrictFloat, Field(gt=0)]
1197
+ ]
1198
+ ] = None,
1199
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1200
+ _content_type: Optional[StrictStr] = None,
1201
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1202
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1203
+ ) -> RESTResponseType:
1204
+ """List Stage Motion Groups
1205
+
1206
+ Fetches all the robot prim paths in the scene Returns: list of robot prim paths
1207
+
1208
+ :param _request_timeout: timeout setting for this request. If one
1209
+ number provided, it will be total request
1210
+ timeout. It can also be a pair (tuple) of
1211
+ (connection, read) timeouts.
1212
+ :type _request_timeout: int, tuple(int, int), optional
1213
+ :param _request_auth: set to override the auth_settings for an a single
1214
+ request; this effectively ignores the
1215
+ authentication in the spec for a single request.
1216
+ :type _request_auth: dict, optional
1217
+ :param _content_type: force content-type for the request.
1218
+ :type _content_type: str, Optional
1219
+ :param _headers: set to override the headers for a single
1220
+ request; this effectively ignores the headers
1221
+ in the spec for a single request.
1222
+ :type _headers: dict, optional
1223
+ :param _host_index: set to override the host_index for a single
1224
+ request; this effectively ignores the host_index
1225
+ in the spec for a single request.
1226
+ :type _host_index: int, optional
1227
+ :return: Returns the result object.
1228
+ """ # noqa: E501
1229
+
1230
+ _param = self._list_stage_motion_groups_serialize(
1231
+ _request_auth=_request_auth,
1232
+ _content_type=_content_type,
1233
+ _headers=_headers,
1234
+ _host_index=_host_index
1235
+ )
1236
+
1237
+ _response_types_map: Dict[str, Optional[str]] = {
1238
+ '200': "List[str]",
1239
+ }
1240
+ response_data = await self.api_client.call_api(
1241
+ *_param,
1242
+ _request_timeout=_request_timeout
1243
+ )
1244
+ return response_data.response
1245
+
1246
+
1247
+ def _list_stage_motion_groups_serialize(
1248
+ self,
1249
+ _request_auth,
1250
+ _content_type,
1251
+ _headers,
1252
+ _host_index,
1253
+ ) -> RequestSerialized:
1254
+
1255
+ _host = None
1256
+
1257
+ _collection_formats: Dict[str, str] = {
1258
+ }
1259
+
1260
+ _path_params: Dict[str, str] = {}
1261
+ _query_params: List[Tuple[str, str]] = []
1262
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1263
+ _form_params: List[Tuple[str, str]] = []
1264
+ _files: Dict[str, Union[str, bytes]] = {}
1265
+ _body_params: Optional[bytes] = None
1266
+
1267
+ # process the path parameters
1268
+ # process the query parameters
1269
+ # process the header parameters
1270
+ # process the form parameters
1271
+ # process the body parameter
1272
+
1273
+
1274
+ # set the HTTP header `Accept`
1275
+ _header_params['Accept'] = self.api_client.select_header_accept(
1276
+ [
1277
+ 'application/json'
1278
+ ]
1279
+ )
1280
+
1281
+
1282
+ # authentication setting
1283
+ _auth_settings: List[str] = [
1284
+ ]
1285
+
1286
+ return self.api_client.param_serialize(
1287
+ method='GET',
1288
+ resource_path='/stage/motion-groups',
1289
+ path_params=_path_params,
1290
+ query_params=_query_params,
1291
+ header_params=_header_params,
1292
+ body=_body_params,
1293
+ post_params=_form_params,
1294
+ files=_files,
1295
+ auth_settings=_auth_settings,
1296
+ collection_formats=_collection_formats,
1297
+ _host=_host,
1298
+ _request_auth=_request_auth
1299
+ )
1300
+
1301
+
1302
+
1303
+ @validate_call
1304
+ async def open_scene(
1305
+ self,
1306
+ usd_stage_model: UsdStageModel,
1307
+ _request_timeout: Union[
1308
+ None,
1309
+ Annotated[StrictFloat, Field(gt=0)],
1310
+ Tuple[
1311
+ Annotated[StrictFloat, Field(gt=0)],
1312
+ Annotated[StrictFloat, Field(gt=0)]
1313
+ ]
1314
+ ] = None,
1315
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1316
+ _content_type: Optional[StrictStr] = None,
1317
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1318
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1319
+ ) -> None:
1320
+ """Open Scene
1321
+
1322
+ Opens the scene given path or uri of the scene
1323
+
1324
+ :param usd_stage_model: (required)
1325
+ :type usd_stage_model: UsdStageModel
1326
+ :param _request_timeout: timeout setting for this request. If one
1327
+ number provided, it will be total request
1328
+ timeout. It can also be a pair (tuple) of
1329
+ (connection, read) timeouts.
1330
+ :type _request_timeout: int, tuple(int, int), optional
1331
+ :param _request_auth: set to override the auth_settings for an a single
1332
+ request; this effectively ignores the
1333
+ authentication in the spec for a single request.
1334
+ :type _request_auth: dict, optional
1335
+ :param _content_type: force content-type for the request.
1336
+ :type _content_type: str, Optional
1337
+ :param _headers: set to override the headers for a single
1338
+ request; this effectively ignores the headers
1339
+ in the spec for a single request.
1340
+ :type _headers: dict, optional
1341
+ :param _host_index: set to override the host_index for a single
1342
+ request; this effectively ignores the host_index
1343
+ in the spec for a single request.
1344
+ :type _host_index: int, optional
1345
+ :return: Returns the result object.
1346
+ """ # noqa: E501
1347
+
1348
+ _param = self._open_scene_serialize(
1349
+ usd_stage_model=usd_stage_model,
1350
+ _request_auth=_request_auth,
1351
+ _content_type=_content_type,
1352
+ _headers=_headers,
1353
+ _host_index=_host_index
1354
+ )
1355
+
1356
+ _response_types_map: Dict[str, Optional[str]] = {
1357
+ '204': None,
1358
+ '500': None,
1359
+ '422': "HTTPValidationError",
1360
+ }
1361
+ response_data = await self.api_client.call_api(
1362
+ *_param,
1363
+ _request_timeout=_request_timeout
1364
+ )
1365
+ await response_data.read()
1366
+ return self.api_client.response_deserialize(
1367
+ response_data=response_data,
1368
+ response_types_map=_response_types_map,
1369
+ ).data
1370
+
1371
+
1372
+ @validate_call
1373
+ async def open_scene_with_http_info(
1374
+ self,
1375
+ usd_stage_model: UsdStageModel,
1376
+ _request_timeout: Union[
1377
+ None,
1378
+ Annotated[StrictFloat, Field(gt=0)],
1379
+ Tuple[
1380
+ Annotated[StrictFloat, Field(gt=0)],
1381
+ Annotated[StrictFloat, Field(gt=0)]
1382
+ ]
1383
+ ] = None,
1384
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1385
+ _content_type: Optional[StrictStr] = None,
1386
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1387
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1388
+ ) -> ApiResponse[None]:
1389
+ """Open Scene
1390
+
1391
+ Opens the scene given path or uri of the scene
1392
+
1393
+ :param usd_stage_model: (required)
1394
+ :type usd_stage_model: UsdStageModel
1395
+ :param _request_timeout: timeout setting for this request. If one
1396
+ number provided, it will be total request
1397
+ timeout. It can also be a pair (tuple) of
1398
+ (connection, read) timeouts.
1399
+ :type _request_timeout: int, tuple(int, int), optional
1400
+ :param _request_auth: set to override the auth_settings for an a single
1401
+ request; this effectively ignores the
1402
+ authentication in the spec for a single request.
1403
+ :type _request_auth: dict, optional
1404
+ :param _content_type: force content-type for the request.
1405
+ :type _content_type: str, Optional
1406
+ :param _headers: set to override the headers for a single
1407
+ request; this effectively ignores the headers
1408
+ in the spec for a single request.
1409
+ :type _headers: dict, optional
1410
+ :param _host_index: set to override the host_index for a single
1411
+ request; this effectively ignores the host_index
1412
+ in the spec for a single request.
1413
+ :type _host_index: int, optional
1414
+ :return: Returns the result object.
1415
+ """ # noqa: E501
1416
+
1417
+ _param = self._open_scene_serialize(
1418
+ usd_stage_model=usd_stage_model,
1419
+ _request_auth=_request_auth,
1420
+ _content_type=_content_type,
1421
+ _headers=_headers,
1422
+ _host_index=_host_index
1423
+ )
1424
+
1425
+ _response_types_map: Dict[str, Optional[str]] = {
1426
+ '204': None,
1427
+ '500': None,
1428
+ '422': "HTTPValidationError",
1429
+ }
1430
+ response_data = await self.api_client.call_api(
1431
+ *_param,
1432
+ _request_timeout=_request_timeout
1433
+ )
1434
+ await response_data.read()
1435
+ return self.api_client.response_deserialize(
1436
+ response_data=response_data,
1437
+ response_types_map=_response_types_map,
1438
+ )
1439
+
1440
+
1441
+ @validate_call
1442
+ async def open_scene_without_preload_content(
1443
+ self,
1444
+ usd_stage_model: UsdStageModel,
1445
+ _request_timeout: Union[
1446
+ None,
1447
+ Annotated[StrictFloat, Field(gt=0)],
1448
+ Tuple[
1449
+ Annotated[StrictFloat, Field(gt=0)],
1450
+ Annotated[StrictFloat, Field(gt=0)]
1451
+ ]
1452
+ ] = None,
1453
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1454
+ _content_type: Optional[StrictStr] = None,
1455
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1456
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1457
+ ) -> RESTResponseType:
1458
+ """Open Scene
1459
+
1460
+ Opens the scene given path or uri of the scene
1461
+
1462
+ :param usd_stage_model: (required)
1463
+ :type usd_stage_model: UsdStageModel
1464
+ :param _request_timeout: timeout setting for this request. If one
1465
+ number provided, it will be total request
1466
+ timeout. It can also be a pair (tuple) of
1467
+ (connection, read) timeouts.
1468
+ :type _request_timeout: int, tuple(int, int), optional
1469
+ :param _request_auth: set to override the auth_settings for an a single
1470
+ request; this effectively ignores the
1471
+ authentication in the spec for a single request.
1472
+ :type _request_auth: dict, optional
1473
+ :param _content_type: force content-type for the request.
1474
+ :type _content_type: str, Optional
1475
+ :param _headers: set to override the headers for a single
1476
+ request; this effectively ignores the headers
1477
+ in the spec for a single request.
1478
+ :type _headers: dict, optional
1479
+ :param _host_index: set to override the host_index for a single
1480
+ request; this effectively ignores the host_index
1481
+ in the spec for a single request.
1482
+ :type _host_index: int, optional
1483
+ :return: Returns the result object.
1484
+ """ # noqa: E501
1485
+
1486
+ _param = self._open_scene_serialize(
1487
+ usd_stage_model=usd_stage_model,
1488
+ _request_auth=_request_auth,
1489
+ _content_type=_content_type,
1490
+ _headers=_headers,
1491
+ _host_index=_host_index
1492
+ )
1493
+
1494
+ _response_types_map: Dict[str, Optional[str]] = {
1495
+ '204': None,
1496
+ '500': None,
1497
+ '422': "HTTPValidationError",
1498
+ }
1499
+ response_data = await self.api_client.call_api(
1500
+ *_param,
1501
+ _request_timeout=_request_timeout
1502
+ )
1503
+ return response_data.response
1504
+
1505
+
1506
+ def _open_scene_serialize(
1507
+ self,
1508
+ usd_stage_model,
1509
+ _request_auth,
1510
+ _content_type,
1511
+ _headers,
1512
+ _host_index,
1513
+ ) -> RequestSerialized:
1514
+
1515
+ _host = None
1516
+
1517
+ _collection_formats: Dict[str, str] = {
1518
+ }
1519
+
1520
+ _path_params: Dict[str, str] = {}
1521
+ _query_params: List[Tuple[str, str]] = []
1522
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1523
+ _form_params: List[Tuple[str, str]] = []
1524
+ _files: Dict[str, Union[str, bytes]] = {}
1525
+ _body_params: Optional[bytes] = None
1526
+
1527
+ # process the path parameters
1528
+ # process the query parameters
1529
+ # process the header parameters
1530
+ # process the form parameters
1531
+ # process the body parameter
1532
+ if usd_stage_model is not None:
1533
+ _body_params = usd_stage_model
1534
+
1535
+
1536
+ # set the HTTP header `Accept`
1537
+ _header_params['Accept'] = self.api_client.select_header_accept(
1538
+ [
1539
+ 'application/json'
1540
+ ]
1541
+ )
1542
+
1543
+ # set the HTTP header `Content-Type`
1544
+ if _content_type:
1545
+ _header_params['Content-Type'] = _content_type
1546
+ else:
1547
+ _default_content_type = (
1548
+ self.api_client.select_header_content_type(
1549
+ [
1550
+ 'application/json'
1551
+ ]
1552
+ )
1553
+ )
1554
+ if _default_content_type is not None:
1555
+ _header_params['Content-Type'] = _default_content_type
1556
+
1557
+ # authentication setting
1558
+ _auth_settings: List[str] = [
1559
+ ]
1560
+
1561
+ return self.api_client.param_serialize(
1562
+ method='PUT',
1563
+ resource_path='/stage/scene',
1564
+ path_params=_path_params,
1565
+ query_params=_query_params,
1566
+ header_params=_header_params,
1567
+ body=_body_params,
1568
+ post_params=_form_params,
1569
+ files=_files,
1570
+ auth_settings=_auth_settings,
1571
+ collection_formats=_collection_formats,
1572
+ _host=_host,
1573
+ _request_auth=_request_auth
1574
+ )
1575
+
1576
+
1577
+
1578
+ @validate_call
1579
+ async def simulation_state(
1580
+ self,
1581
+ _request_timeout: Union[
1582
+ None,
1583
+ Annotated[StrictFloat, Field(gt=0)],
1584
+ Tuple[
1585
+ Annotated[StrictFloat, Field(gt=0)],
1586
+ Annotated[StrictFloat, Field(gt=0)]
1587
+ ]
1588
+ ] = None,
1589
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1590
+ _content_type: Optional[StrictStr] = None,
1591
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1592
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1593
+ ) -> SimulationState:
1594
+ """Simulation State
1595
+
1596
+ Fetches if the simulation is running or stopped as a boolean
1597
+
1598
+ :param _request_timeout: timeout setting for this request. If one
1599
+ number provided, it will be total request
1600
+ timeout. It can also be a pair (tuple) of
1601
+ (connection, read) timeouts.
1602
+ :type _request_timeout: int, tuple(int, int), optional
1603
+ :param _request_auth: set to override the auth_settings for an a single
1604
+ request; this effectively ignores the
1605
+ authentication in the spec for a single request.
1606
+ :type _request_auth: dict, optional
1607
+ :param _content_type: force content-type for the request.
1608
+ :type _content_type: str, Optional
1609
+ :param _headers: set to override the headers for a single
1610
+ request; this effectively ignores the headers
1611
+ in the spec for a single request.
1612
+ :type _headers: dict, optional
1613
+ :param _host_index: set to override the host_index for a single
1614
+ request; this effectively ignores the host_index
1615
+ in the spec for a single request.
1616
+ :type _host_index: int, optional
1617
+ :return: Returns the result object.
1618
+ """ # noqa: E501
1619
+
1620
+ _param = self._simulation_state_serialize(
1621
+ _request_auth=_request_auth,
1622
+ _content_type=_content_type,
1623
+ _headers=_headers,
1624
+ _host_index=_host_index
1625
+ )
1626
+
1627
+ _response_types_map: Dict[str, Optional[str]] = {
1628
+ '200': "SimulationState",
1629
+ }
1630
+ response_data = await self.api_client.call_api(
1631
+ *_param,
1632
+ _request_timeout=_request_timeout
1633
+ )
1634
+ await response_data.read()
1635
+ return self.api_client.response_deserialize(
1636
+ response_data=response_data,
1637
+ response_types_map=_response_types_map,
1638
+ ).data
1639
+
1640
+
1641
+ @validate_call
1642
+ async def simulation_state_with_http_info(
1643
+ self,
1644
+ _request_timeout: Union[
1645
+ None,
1646
+ Annotated[StrictFloat, Field(gt=0)],
1647
+ Tuple[
1648
+ Annotated[StrictFloat, Field(gt=0)],
1649
+ Annotated[StrictFloat, Field(gt=0)]
1650
+ ]
1651
+ ] = None,
1652
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1653
+ _content_type: Optional[StrictStr] = None,
1654
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1655
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1656
+ ) -> ApiResponse[SimulationState]:
1657
+ """Simulation State
1658
+
1659
+ Fetches if the simulation is running or stopped as a boolean
1660
+
1661
+ :param _request_timeout: timeout setting for this request. If one
1662
+ number provided, it will be total request
1663
+ timeout. It can also be a pair (tuple) of
1664
+ (connection, read) timeouts.
1665
+ :type _request_timeout: int, tuple(int, int), optional
1666
+ :param _request_auth: set to override the auth_settings for an a single
1667
+ request; this effectively ignores the
1668
+ authentication in the spec for a single request.
1669
+ :type _request_auth: dict, optional
1670
+ :param _content_type: force content-type for the request.
1671
+ :type _content_type: str, Optional
1672
+ :param _headers: set to override the headers for a single
1673
+ request; this effectively ignores the headers
1674
+ in the spec for a single request.
1675
+ :type _headers: dict, optional
1676
+ :param _host_index: set to override the host_index for a single
1677
+ request; this effectively ignores the host_index
1678
+ in the spec for a single request.
1679
+ :type _host_index: int, optional
1680
+ :return: Returns the result object.
1681
+ """ # noqa: E501
1682
+
1683
+ _param = self._simulation_state_serialize(
1684
+ _request_auth=_request_auth,
1685
+ _content_type=_content_type,
1686
+ _headers=_headers,
1687
+ _host_index=_host_index
1688
+ )
1689
+
1690
+ _response_types_map: Dict[str, Optional[str]] = {
1691
+ '200': "SimulationState",
1692
+ }
1693
+ response_data = await self.api_client.call_api(
1694
+ *_param,
1695
+ _request_timeout=_request_timeout
1696
+ )
1697
+ await response_data.read()
1698
+ return self.api_client.response_deserialize(
1699
+ response_data=response_data,
1700
+ response_types_map=_response_types_map,
1701
+ )
1702
+
1703
+
1704
+ @validate_call
1705
+ async def simulation_state_without_preload_content(
1706
+ self,
1707
+ _request_timeout: Union[
1708
+ None,
1709
+ Annotated[StrictFloat, Field(gt=0)],
1710
+ Tuple[
1711
+ Annotated[StrictFloat, Field(gt=0)],
1712
+ Annotated[StrictFloat, Field(gt=0)]
1713
+ ]
1714
+ ] = None,
1715
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1716
+ _content_type: Optional[StrictStr] = None,
1717
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1718
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1719
+ ) -> RESTResponseType:
1720
+ """Simulation State
1721
+
1722
+ Fetches if the simulation is running or stopped as a boolean
1723
+
1724
+ :param _request_timeout: timeout setting for this request. If one
1725
+ number provided, it will be total request
1726
+ timeout. It can also be a pair (tuple) of
1727
+ (connection, read) timeouts.
1728
+ :type _request_timeout: int, tuple(int, int), optional
1729
+ :param _request_auth: set to override the auth_settings for an a single
1730
+ request; this effectively ignores the
1731
+ authentication in the spec for a single request.
1732
+ :type _request_auth: dict, optional
1733
+ :param _content_type: force content-type for the request.
1734
+ :type _content_type: str, Optional
1735
+ :param _headers: set to override the headers for a single
1736
+ request; this effectively ignores the headers
1737
+ in the spec for a single request.
1738
+ :type _headers: dict, optional
1739
+ :param _host_index: set to override the host_index for a single
1740
+ request; this effectively ignores the host_index
1741
+ in the spec for a single request.
1742
+ :type _host_index: int, optional
1743
+ :return: Returns the result object.
1744
+ """ # noqa: E501
1745
+
1746
+ _param = self._simulation_state_serialize(
1747
+ _request_auth=_request_auth,
1748
+ _content_type=_content_type,
1749
+ _headers=_headers,
1750
+ _host_index=_host_index
1751
+ )
1752
+
1753
+ _response_types_map: Dict[str, Optional[str]] = {
1754
+ '200': "SimulationState",
1755
+ }
1756
+ response_data = await self.api_client.call_api(
1757
+ *_param,
1758
+ _request_timeout=_request_timeout
1759
+ )
1760
+ return response_data.response
1761
+
1762
+
1763
+ def _simulation_state_serialize(
1764
+ self,
1765
+ _request_auth,
1766
+ _content_type,
1767
+ _headers,
1768
+ _host_index,
1769
+ ) -> RequestSerialized:
1770
+
1771
+ _host = None
1772
+
1773
+ _collection_formats: Dict[str, str] = {
1774
+ }
1775
+
1776
+ _path_params: Dict[str, str] = {}
1777
+ _query_params: List[Tuple[str, str]] = []
1778
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1779
+ _form_params: List[Tuple[str, str]] = []
1780
+ _files: Dict[str, Union[str, bytes]] = {}
1781
+ _body_params: Optional[bytes] = None
1782
+
1783
+ # process the path parameters
1784
+ # process the query parameters
1785
+ # process the header parameters
1786
+ # process the form parameters
1787
+ # process the body parameter
1788
+
1789
+
1790
+ # set the HTTP header `Accept`
1791
+ _header_params['Accept'] = self.api_client.select_header_accept(
1792
+ [
1793
+ 'application/json'
1794
+ ]
1795
+ )
1796
+
1797
+
1798
+ # authentication setting
1799
+ _auth_settings: List[str] = [
1800
+ ]
1801
+
1802
+ return self.api_client.param_serialize(
1803
+ method='GET',
1804
+ resource_path='/stage/simulation',
1805
+ path_params=_path_params,
1806
+ query_params=_query_params,
1807
+ header_params=_header_params,
1808
+ body=_body_params,
1809
+ post_params=_form_params,
1810
+ files=_files,
1811
+ auth_settings=_auth_settings,
1812
+ collection_formats=_collection_formats,
1813
+ _host=_host,
1814
+ _request_auth=_request_auth
1815
+ )
1816
+
1817
+
1818
+
1819
+ @validate_call
1820
+ async def timeline_action(
1821
+ self,
1822
+ action: StrictStr,
1823
+ _request_timeout: Union[
1824
+ None,
1825
+ Annotated[StrictFloat, Field(gt=0)],
1826
+ Tuple[
1827
+ Annotated[StrictFloat, Field(gt=0)],
1828
+ Annotated[StrictFloat, Field(gt=0)]
1829
+ ]
1830
+ ] = None,
1831
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1832
+ _content_type: Optional[StrictStr] = None,
1833
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1834
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1835
+ ) -> None:
1836
+ """Timeline Action
1837
+
1838
+ Controls the simulation in the scene - `play`: starts the simulation - `pause`: pauses the simulation - `stop`: stops the simulation
1839
+
1840
+ :param action: (required)
1841
+ :type action: str
1842
+ :param _request_timeout: timeout setting for this request. If one
1843
+ number provided, it will be total request
1844
+ timeout. It can also be a pair (tuple) of
1845
+ (connection, read) timeouts.
1846
+ :type _request_timeout: int, tuple(int, int), optional
1847
+ :param _request_auth: set to override the auth_settings for an a single
1848
+ request; this effectively ignores the
1849
+ authentication in the spec for a single request.
1850
+ :type _request_auth: dict, optional
1851
+ :param _content_type: force content-type for the request.
1852
+ :type _content_type: str, Optional
1853
+ :param _headers: set to override the headers for a single
1854
+ request; this effectively ignores the headers
1855
+ in the spec for a single request.
1856
+ :type _headers: dict, optional
1857
+ :param _host_index: set to override the host_index for a single
1858
+ request; this effectively ignores the host_index
1859
+ in the spec for a single request.
1860
+ :type _host_index: int, optional
1861
+ :return: Returns the result object.
1862
+ """ # noqa: E501
1863
+
1864
+ _param = self._timeline_action_serialize(
1865
+ action=action,
1866
+ _request_auth=_request_auth,
1867
+ _content_type=_content_type,
1868
+ _headers=_headers,
1869
+ _host_index=_host_index
1870
+ )
1871
+
1872
+ _response_types_map: Dict[str, Optional[str]] = {
1873
+ '204': None,
1874
+ '422': "HTTPValidationError",
1875
+ }
1876
+ response_data = await self.api_client.call_api(
1877
+ *_param,
1878
+ _request_timeout=_request_timeout
1879
+ )
1880
+ await response_data.read()
1881
+ return self.api_client.response_deserialize(
1882
+ response_data=response_data,
1883
+ response_types_map=_response_types_map,
1884
+ ).data
1885
+
1886
+
1887
+ @validate_call
1888
+ async def timeline_action_with_http_info(
1889
+ self,
1890
+ action: StrictStr,
1891
+ _request_timeout: Union[
1892
+ None,
1893
+ Annotated[StrictFloat, Field(gt=0)],
1894
+ Tuple[
1895
+ Annotated[StrictFloat, Field(gt=0)],
1896
+ Annotated[StrictFloat, Field(gt=0)]
1897
+ ]
1898
+ ] = None,
1899
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1900
+ _content_type: Optional[StrictStr] = None,
1901
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1902
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1903
+ ) -> ApiResponse[None]:
1904
+ """Timeline Action
1905
+
1906
+ Controls the simulation in the scene - `play`: starts the simulation - `pause`: pauses the simulation - `stop`: stops the simulation
1907
+
1908
+ :param action: (required)
1909
+ :type action: str
1910
+ :param _request_timeout: timeout setting for this request. If one
1911
+ number provided, it will be total request
1912
+ timeout. It can also be a pair (tuple) of
1913
+ (connection, read) timeouts.
1914
+ :type _request_timeout: int, tuple(int, int), optional
1915
+ :param _request_auth: set to override the auth_settings for an a single
1916
+ request; this effectively ignores the
1917
+ authentication in the spec for a single request.
1918
+ :type _request_auth: dict, optional
1919
+ :param _content_type: force content-type for the request.
1920
+ :type _content_type: str, Optional
1921
+ :param _headers: set to override the headers for a single
1922
+ request; this effectively ignores the headers
1923
+ in the spec for a single request.
1924
+ :type _headers: dict, optional
1925
+ :param _host_index: set to override the host_index for a single
1926
+ request; this effectively ignores the host_index
1927
+ in the spec for a single request.
1928
+ :type _host_index: int, optional
1929
+ :return: Returns the result object.
1930
+ """ # noqa: E501
1931
+
1932
+ _param = self._timeline_action_serialize(
1933
+ action=action,
1934
+ _request_auth=_request_auth,
1935
+ _content_type=_content_type,
1936
+ _headers=_headers,
1937
+ _host_index=_host_index
1938
+ )
1939
+
1940
+ _response_types_map: Dict[str, Optional[str]] = {
1941
+ '204': None,
1942
+ '422': "HTTPValidationError",
1943
+ }
1944
+ response_data = await self.api_client.call_api(
1945
+ *_param,
1946
+ _request_timeout=_request_timeout
1947
+ )
1948
+ await response_data.read()
1949
+ return self.api_client.response_deserialize(
1950
+ response_data=response_data,
1951
+ response_types_map=_response_types_map,
1952
+ )
1953
+
1954
+
1955
+ @validate_call
1956
+ async def timeline_action_without_preload_content(
1957
+ self,
1958
+ action: StrictStr,
1959
+ _request_timeout: Union[
1960
+ None,
1961
+ Annotated[StrictFloat, Field(gt=0)],
1962
+ Tuple[
1963
+ Annotated[StrictFloat, Field(gt=0)],
1964
+ Annotated[StrictFloat, Field(gt=0)]
1965
+ ]
1966
+ ] = None,
1967
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1968
+ _content_type: Optional[StrictStr] = None,
1969
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1970
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1971
+ ) -> RESTResponseType:
1972
+ """Timeline Action
1973
+
1974
+ Controls the simulation in the scene - `play`: starts the simulation - `pause`: pauses the simulation - `stop`: stops the simulation
1975
+
1976
+ :param action: (required)
1977
+ :type action: str
1978
+ :param _request_timeout: timeout setting for this request. If one
1979
+ number provided, it will be total request
1980
+ timeout. It can also be a pair (tuple) of
1981
+ (connection, read) timeouts.
1982
+ :type _request_timeout: int, tuple(int, int), optional
1983
+ :param _request_auth: set to override the auth_settings for an a single
1984
+ request; this effectively ignores the
1985
+ authentication in the spec for a single request.
1986
+ :type _request_auth: dict, optional
1987
+ :param _content_type: force content-type for the request.
1988
+ :type _content_type: str, Optional
1989
+ :param _headers: set to override the headers for a single
1990
+ request; this effectively ignores the headers
1991
+ in the spec for a single request.
1992
+ :type _headers: dict, optional
1993
+ :param _host_index: set to override the host_index for a single
1994
+ request; this effectively ignores the host_index
1995
+ in the spec for a single request.
1996
+ :type _host_index: int, optional
1997
+ :return: Returns the result object.
1998
+ """ # noqa: E501
1999
+
2000
+ _param = self._timeline_action_serialize(
2001
+ action=action,
2002
+ _request_auth=_request_auth,
2003
+ _content_type=_content_type,
2004
+ _headers=_headers,
2005
+ _host_index=_host_index
2006
+ )
2007
+
2008
+ _response_types_map: Dict[str, Optional[str]] = {
2009
+ '204': None,
2010
+ '422': "HTTPValidationError",
2011
+ }
2012
+ response_data = await self.api_client.call_api(
2013
+ *_param,
2014
+ _request_timeout=_request_timeout
2015
+ )
2016
+ return response_data.response
2017
+
2018
+
2019
+ def _timeline_action_serialize(
2020
+ self,
2021
+ action,
2022
+ _request_auth,
2023
+ _content_type,
2024
+ _headers,
2025
+ _host_index,
2026
+ ) -> RequestSerialized:
2027
+
2028
+ _host = None
2029
+
2030
+ _collection_formats: Dict[str, str] = {
2031
+ }
2032
+
2033
+ _path_params: Dict[str, str] = {}
2034
+ _query_params: List[Tuple[str, str]] = []
2035
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2036
+ _form_params: List[Tuple[str, str]] = []
2037
+ _files: Dict[str, Union[str, bytes]] = {}
2038
+ _body_params: Optional[bytes] = None
2039
+
2040
+ # process the path parameters
2041
+ if action is not None:
2042
+ _path_params['action'] = action
2043
+ # process the query parameters
2044
+ # process the header parameters
2045
+ # process the form parameters
2046
+ # process the body parameter
2047
+
2048
+
2049
+ # set the HTTP header `Accept`
2050
+ _header_params['Accept'] = self.api_client.select_header_accept(
2051
+ [
2052
+ 'application/json'
2053
+ ]
2054
+ )
2055
+
2056
+
2057
+ # authentication setting
2058
+ _auth_settings: List[str] = [
2059
+ ]
2060
+
2061
+ return self.api_client.param_serialize(
2062
+ method='PATCH',
2063
+ resource_path='/stage/simulation/timeline/{action}',
2064
+ path_params=_path_params,
2065
+ query_params=_query_params,
2066
+ header_params=_header_params,
2067
+ body=_body_params,
2068
+ post_params=_form_params,
2069
+ files=_files,
2070
+ auth_settings=_auth_settings,
2071
+ collection_formats=_collection_formats,
2072
+ _host=_host,
2073
+ _request_auth=_request_auth
2074
+ )
2075
+
2076
+
2077
+
2078
+ @validate_call
2079
+ async def update_stage_units(
2080
+ self,
2081
+ stage_units: StageUnits,
2082
+ _request_timeout: Union[
2083
+ None,
2084
+ Annotated[StrictFloat, Field(gt=0)],
2085
+ Tuple[
2086
+ Annotated[StrictFloat, Field(gt=0)],
2087
+ Annotated[StrictFloat, Field(gt=0)]
2088
+ ]
2089
+ ] = None,
2090
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2091
+ _content_type: Optional[StrictStr] = None,
2092
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2093
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2094
+ ) -> None:
2095
+ """Update Stage Units
2096
+
2097
+ Sets units for the scene
2098
+
2099
+ :param stage_units: (required)
2100
+ :type stage_units: StageUnits
2101
+ :param _request_timeout: timeout setting for this request. If one
2102
+ number provided, it will be total request
2103
+ timeout. It can also be a pair (tuple) of
2104
+ (connection, read) timeouts.
2105
+ :type _request_timeout: int, tuple(int, int), optional
2106
+ :param _request_auth: set to override the auth_settings for an a single
2107
+ request; this effectively ignores the
2108
+ authentication in the spec for a single request.
2109
+ :type _request_auth: dict, optional
2110
+ :param _content_type: force content-type for the request.
2111
+ :type _content_type: str, Optional
2112
+ :param _headers: set to override the headers for a single
2113
+ request; this effectively ignores the headers
2114
+ in the spec for a single request.
2115
+ :type _headers: dict, optional
2116
+ :param _host_index: set to override the host_index for a single
2117
+ request; this effectively ignores the host_index
2118
+ in the spec for a single request.
2119
+ :type _host_index: int, optional
2120
+ :return: Returns the result object.
2121
+ """ # noqa: E501
2122
+
2123
+ _param = self._update_stage_units_serialize(
2124
+ stage_units=stage_units,
2125
+ _request_auth=_request_auth,
2126
+ _content_type=_content_type,
2127
+ _headers=_headers,
2128
+ _host_index=_host_index
2129
+ )
2130
+
2131
+ _response_types_map: Dict[str, Optional[str]] = {
2132
+ '204': None,
2133
+ '500': None,
2134
+ '422': "HTTPValidationError",
2135
+ }
2136
+ response_data = await self.api_client.call_api(
2137
+ *_param,
2138
+ _request_timeout=_request_timeout
2139
+ )
2140
+ await response_data.read()
2141
+ return self.api_client.response_deserialize(
2142
+ response_data=response_data,
2143
+ response_types_map=_response_types_map,
2144
+ ).data
2145
+
2146
+
2147
+ @validate_call
2148
+ async def update_stage_units_with_http_info(
2149
+ self,
2150
+ stage_units: StageUnits,
2151
+ _request_timeout: Union[
2152
+ None,
2153
+ Annotated[StrictFloat, Field(gt=0)],
2154
+ Tuple[
2155
+ Annotated[StrictFloat, Field(gt=0)],
2156
+ Annotated[StrictFloat, Field(gt=0)]
2157
+ ]
2158
+ ] = None,
2159
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2160
+ _content_type: Optional[StrictStr] = None,
2161
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2162
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2163
+ ) -> ApiResponse[None]:
2164
+ """Update Stage Units
2165
+
2166
+ Sets units for the scene
2167
+
2168
+ :param stage_units: (required)
2169
+ :type stage_units: StageUnits
2170
+ :param _request_timeout: timeout setting for this request. If one
2171
+ number provided, it will be total request
2172
+ timeout. It can also be a pair (tuple) of
2173
+ (connection, read) timeouts.
2174
+ :type _request_timeout: int, tuple(int, int), optional
2175
+ :param _request_auth: set to override the auth_settings for an a single
2176
+ request; this effectively ignores the
2177
+ authentication in the spec for a single request.
2178
+ :type _request_auth: dict, optional
2179
+ :param _content_type: force content-type for the request.
2180
+ :type _content_type: str, Optional
2181
+ :param _headers: set to override the headers for a single
2182
+ request; this effectively ignores the headers
2183
+ in the spec for a single request.
2184
+ :type _headers: dict, optional
2185
+ :param _host_index: set to override the host_index for a single
2186
+ request; this effectively ignores the host_index
2187
+ in the spec for a single request.
2188
+ :type _host_index: int, optional
2189
+ :return: Returns the result object.
2190
+ """ # noqa: E501
2191
+
2192
+ _param = self._update_stage_units_serialize(
2193
+ stage_units=stage_units,
2194
+ _request_auth=_request_auth,
2195
+ _content_type=_content_type,
2196
+ _headers=_headers,
2197
+ _host_index=_host_index
2198
+ )
2199
+
2200
+ _response_types_map: Dict[str, Optional[str]] = {
2201
+ '204': None,
2202
+ '500': None,
2203
+ '422': "HTTPValidationError",
2204
+ }
2205
+ response_data = await self.api_client.call_api(
2206
+ *_param,
2207
+ _request_timeout=_request_timeout
2208
+ )
2209
+ await response_data.read()
2210
+ return self.api_client.response_deserialize(
2211
+ response_data=response_data,
2212
+ response_types_map=_response_types_map,
2213
+ )
2214
+
2215
+
2216
+ @validate_call
2217
+ async def update_stage_units_without_preload_content(
2218
+ self,
2219
+ stage_units: StageUnits,
2220
+ _request_timeout: Union[
2221
+ None,
2222
+ Annotated[StrictFloat, Field(gt=0)],
2223
+ Tuple[
2224
+ Annotated[StrictFloat, Field(gt=0)],
2225
+ Annotated[StrictFloat, Field(gt=0)]
2226
+ ]
2227
+ ] = None,
2228
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2229
+ _content_type: Optional[StrictStr] = None,
2230
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2231
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2232
+ ) -> RESTResponseType:
2233
+ """Update Stage Units
2234
+
2235
+ Sets units for the scene
2236
+
2237
+ :param stage_units: (required)
2238
+ :type stage_units: StageUnits
2239
+ :param _request_timeout: timeout setting for this request. If one
2240
+ number provided, it will be total request
2241
+ timeout. It can also be a pair (tuple) of
2242
+ (connection, read) timeouts.
2243
+ :type _request_timeout: int, tuple(int, int), optional
2244
+ :param _request_auth: set to override the auth_settings for an a single
2245
+ request; this effectively ignores the
2246
+ authentication in the spec for a single request.
2247
+ :type _request_auth: dict, optional
2248
+ :param _content_type: force content-type for the request.
2249
+ :type _content_type: str, Optional
2250
+ :param _headers: set to override the headers for a single
2251
+ request; this effectively ignores the headers
2252
+ in the spec for a single request.
2253
+ :type _headers: dict, optional
2254
+ :param _host_index: set to override the host_index for a single
2255
+ request; this effectively ignores the host_index
2256
+ in the spec for a single request.
2257
+ :type _host_index: int, optional
2258
+ :return: Returns the result object.
2259
+ """ # noqa: E501
2260
+
2261
+ _param = self._update_stage_units_serialize(
2262
+ stage_units=stage_units,
2263
+ _request_auth=_request_auth,
2264
+ _content_type=_content_type,
2265
+ _headers=_headers,
2266
+ _host_index=_host_index
2267
+ )
2268
+
2269
+ _response_types_map: Dict[str, Optional[str]] = {
2270
+ '204': None,
2271
+ '500': None,
2272
+ '422': "HTTPValidationError",
2273
+ }
2274
+ response_data = await self.api_client.call_api(
2275
+ *_param,
2276
+ _request_timeout=_request_timeout
2277
+ )
2278
+ return response_data.response
2279
+
2280
+
2281
+ def _update_stage_units_serialize(
2282
+ self,
2283
+ stage_units,
2284
+ _request_auth,
2285
+ _content_type,
2286
+ _headers,
2287
+ _host_index,
2288
+ ) -> RequestSerialized:
2289
+
2290
+ _host = None
2291
+
2292
+ _collection_formats: Dict[str, str] = {
2293
+ }
2294
+
2295
+ _path_params: Dict[str, str] = {}
2296
+ _query_params: List[Tuple[str, str]] = []
2297
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2298
+ _form_params: List[Tuple[str, str]] = []
2299
+ _files: Dict[str, Union[str, bytes]] = {}
2300
+ _body_params: Optional[bytes] = None
2301
+
2302
+ # process the path parameters
2303
+ # process the query parameters
2304
+ # process the header parameters
2305
+ # process the form parameters
2306
+ # process the body parameter
2307
+ if stage_units is not None:
2308
+ _body_params = stage_units
2309
+
2310
+
2311
+ # set the HTTP header `Accept`
2312
+ _header_params['Accept'] = self.api_client.select_header_accept(
2313
+ [
2314
+ 'application/json'
2315
+ ]
2316
+ )
2317
+
2318
+ # set the HTTP header `Content-Type`
2319
+ if _content_type:
2320
+ _header_params['Content-Type'] = _content_type
2321
+ else:
2322
+ _default_content_type = (
2323
+ self.api_client.select_header_content_type(
2324
+ [
2325
+ 'application/json'
2326
+ ]
2327
+ )
2328
+ )
2329
+ if _default_content_type is not None:
2330
+ _header_params['Content-Type'] = _default_content_type
2331
+
2332
+ # authentication setting
2333
+ _auth_settings: List[str] = [
2334
+ ]
2335
+
2336
+ return self.api_client.param_serialize(
2337
+ method='PUT',
2338
+ resource_path='/stage/units',
2339
+ path_params=_path_params,
2340
+ query_params=_query_params,
2341
+ header_params=_header_params,
2342
+ body=_body_params,
2343
+ post_params=_form_params,
2344
+ files=_files,
2345
+ auth_settings=_auth_settings,
2346
+ collection_formats=_collection_formats,
2347
+ _host=_host,
2348
+ _request_auth=_request_auth
2349
+ )
2350
+
2351
+