wandelbots-api-client 25.11.0.dev12__py3-none-any.whl → 26.1.0.dev50__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 (31) hide show
  1. wandelbots_api_client/__init__.py +1 -1
  2. wandelbots_api_client/api/motion_api.py +3 -3
  3. wandelbots_api_client/api_client.py +1 -1
  4. wandelbots_api_client/configuration.py +1 -1
  5. wandelbots_api_client/v2/__init__.py +1 -1
  6. wandelbots_api_client/v2/api/bus_inputs_outputs_api.py +579 -0
  7. wandelbots_api_client/v2/api/jogging_api.py +1 -1
  8. wandelbots_api_client/v2/api/motion_group_models_api.py +530 -2
  9. wandelbots_api_client/v2/api/program_api.py +12 -12
  10. wandelbots_api_client/v2/api/trajectory_execution_api.py +1 -1
  11. wandelbots_api_client/v2/api_client.py +1 -1
  12. wandelbots_api_client/v2/configuration.py +1 -1
  13. wandelbots_api_client/v2/models/__init__.py +2 -0
  14. wandelbots_api_client/v2/models/blending_auto.py +1 -1
  15. wandelbots_api_client/v2/models/blending_position.py +15 -1
  16. wandelbots_api_client/v2/models/blending_space.py +37 -0
  17. wandelbots_api_client/v2/models/motion_group_description.py +4 -2
  18. wandelbots_api_client/v2_pydantic/__init__.py +1 -1
  19. wandelbots_api_client/v2_pydantic/api/bus_inputs_outputs_api.py +585 -0
  20. wandelbots_api_client/v2_pydantic/api/jogging_api.py +1 -1
  21. wandelbots_api_client/v2_pydantic/api/motion_group_models_api.py +536 -2
  22. wandelbots_api_client/v2_pydantic/api/program_api.py +12 -12
  23. wandelbots_api_client/v2_pydantic/api/trajectory_execution_api.py +1 -1
  24. wandelbots_api_client/v2_pydantic/api_client.py +1 -1
  25. wandelbots_api_client/v2_pydantic/configuration.py +1 -1
  26. wandelbots_api_client/v2_pydantic/models.py +401 -374
  27. {wandelbots_api_client-25.11.0.dev12.dist-info → wandelbots_api_client-26.1.0.dev50.dist-info}/METADATA +2 -2
  28. {wandelbots_api_client-25.11.0.dev12.dist-info → wandelbots_api_client-26.1.0.dev50.dist-info}/RECORD +31 -30
  29. {wandelbots_api_client-25.11.0.dev12.dist-info → wandelbots_api_client-26.1.0.dev50.dist-info}/WHEEL +0 -0
  30. {wandelbots_api_client-25.11.0.dev12.dist-info → wandelbots_api_client-26.1.0.dev50.dist-info}/licenses/LICENSE +0 -0
  31. {wandelbots_api_client-25.11.0.dev12.dist-info → wandelbots_api_client-26.1.0.dev50.dist-info}/top_level.txt +0 -0
@@ -47,7 +47,7 @@ class JoggingApi:
47
47
  async def execute_jogging(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], client_request_generator: Callable[[AsyncGenerator[ExecuteJoggingResponse, None]], AsyncGenerator[ExecuteJoggingRequest, None]]) -> None: # noqa: E501
48
48
  """Execute Jogging # noqa: E501
49
49
 
50
- <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops. # noqa: E501
50
+ <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops. # noqa: E501
51
51
  :param client_request_generator: An AsyncGenerator that yields request of type ExecuteJoggingRequest and takes an AsyncGenerator of ExecuteJoggingResponse as an input argument (required)
52
52
  :info All responses from the server will be yielded to client_request_generator through the (AsyncGenerator[ExecuteJoggingResponse, None])
53
53
  :type AsyncGenerator[ExecuteJoggingRequest, None]
@@ -22,8 +22,8 @@ from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, U
22
22
  from typing_extensions import Annotated
23
23
  from urllib.parse import quote
24
24
 
25
- from pydantic import Field, StrictStr
26
- from typing import Dict, List
25
+ from pydantic import Field, StrictBytes, StrictStr
26
+ from typing import Dict, List, Tuple, Union
27
27
  from typing_extensions import Annotated
28
28
  from wandelbots_api_client.v2_pydantic.models import Collider
29
29
 
@@ -310,6 +310,273 @@ class MotionGroupModelsApi:
310
310
 
311
311
 
312
312
 
313
+ @validate_call
314
+ async def get_motion_group_glb_model(
315
+ self,
316
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
317
+ _request_timeout: Union[
318
+ None,
319
+ Annotated[StrictFloat, Field(gt=0)],
320
+ Tuple[
321
+ Annotated[StrictFloat, Field(gt=0)],
322
+ Annotated[StrictFloat, Field(gt=0)]
323
+ ]
324
+ ] = None,
325
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
326
+ _content_type: Optional[StrictStr] = None,
327
+ _headers: Optional[Dict[StrictStr, Any]] = None,
328
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
329
+ ) -> bytearray:
330
+ """Download GLB Model
331
+
332
+ Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
333
+
334
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
335
+ :type motion_group_model: str
336
+ :param _request_timeout: timeout setting for this request. If one
337
+ number provided, it will be total request
338
+ timeout. It can also be a pair (tuple) of
339
+ (connection, read) timeouts.
340
+ :type _request_timeout: int, tuple(int, int), optional
341
+ :param _request_auth: set to override the auth_settings for an a single
342
+ request; this effectively ignores the
343
+ authentication in the spec for a single request.
344
+ :type _request_auth: dict, optional
345
+ :param _content_type: force content-type for the request.
346
+ :type _content_type: str, Optional
347
+ :param _headers: set to override the headers for a single
348
+ request; this effectively ignores the headers
349
+ in the spec for a single request.
350
+ :type _headers: dict, optional
351
+ :param _host_index: set to override the host_index for a single
352
+ request; this effectively ignores the host_index
353
+ in the spec for a single request.
354
+ :type _host_index: int, optional
355
+ :return: Returns the result object.
356
+ """ # noqa: E501
357
+
358
+ _param = self._get_motion_group_glb_model_serialize(
359
+ motion_group_model=motion_group_model,
360
+ _request_auth=_request_auth,
361
+ _content_type=_content_type,
362
+ _headers=_headers,
363
+ _host_index=_host_index
364
+ )
365
+
366
+ _response_types_map: Dict[str, Optional[str]] = {
367
+ '200': "bytearray",
368
+ '404': None,
369
+ '500': None,
370
+ }
371
+
372
+ response_data = await self.api_client.call_api(
373
+ *_param,
374
+ _request_timeout=_request_timeout
375
+ )
376
+ await response_data.read()
377
+ return self.api_client.response_deserialize(
378
+ response_data=response_data,
379
+ response_types_map=_response_types_map,
380
+ ).data
381
+
382
+
383
+ @validate_call
384
+ async def get_motion_group_glb_model_with_http_info(
385
+ self,
386
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
387
+ _request_timeout: Union[
388
+ None,
389
+ Annotated[StrictFloat, Field(gt=0)],
390
+ Tuple[
391
+ Annotated[StrictFloat, Field(gt=0)],
392
+ Annotated[StrictFloat, Field(gt=0)]
393
+ ]
394
+ ] = None,
395
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
396
+ _content_type: Optional[StrictStr] = None,
397
+ _headers: Optional[Dict[StrictStr, Any]] = None,
398
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
399
+ ) -> ApiResponse[bytearray]:
400
+ """Download GLB Model
401
+
402
+ Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
403
+
404
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
405
+ :type motion_group_model: str
406
+ :param _request_timeout: timeout setting for this request. If one
407
+ number provided, it will be total request
408
+ timeout. It can also be a pair (tuple) of
409
+ (connection, read) timeouts.
410
+ :type _request_timeout: int, tuple(int, int), optional
411
+ :param _request_auth: set to override the auth_settings for an a single
412
+ request; this effectively ignores the
413
+ authentication in the spec for a single request.
414
+ :type _request_auth: dict, optional
415
+ :param _content_type: force content-type for the request.
416
+ :type _content_type: str, Optional
417
+ :param _headers: set to override the headers for a single
418
+ request; this effectively ignores the headers
419
+ in the spec for a single request.
420
+ :type _headers: dict, optional
421
+ :param _host_index: set to override the host_index for a single
422
+ request; this effectively ignores the host_index
423
+ in the spec for a single request.
424
+ :type _host_index: int, optional
425
+ :return: Returns the result object.
426
+ """ # noqa: E501
427
+
428
+ _param = self._get_motion_group_glb_model_serialize(
429
+ motion_group_model=motion_group_model,
430
+ _request_auth=_request_auth,
431
+ _content_type=_content_type,
432
+ _headers=_headers,
433
+ _host_index=_host_index
434
+ )
435
+
436
+ _response_types_map: Dict[str, Optional[str]] = {
437
+ '200': "bytearray",
438
+ '404': None,
439
+ '500': None,
440
+ }
441
+
442
+ response_data = await self.api_client.call_api(
443
+ *_param,
444
+ _request_timeout=_request_timeout
445
+ )
446
+ await response_data.read()
447
+ return self.api_client.response_deserialize(
448
+ response_data=response_data,
449
+ response_types_map=_response_types_map,
450
+ )
451
+
452
+
453
+ @validate_call
454
+ async def get_motion_group_glb_model_without_preload_content(
455
+ self,
456
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
457
+ _request_timeout: Union[
458
+ None,
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Tuple[
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Annotated[StrictFloat, Field(gt=0)]
463
+ ]
464
+ ] = None,
465
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
466
+ _content_type: Optional[StrictStr] = None,
467
+ _headers: Optional[Dict[StrictStr, Any]] = None,
468
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
469
+ ) -> RESTResponseType:
470
+ """Download GLB Model
471
+
472
+ Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
473
+
474
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
475
+ :type motion_group_model: str
476
+ :param _request_timeout: timeout setting for this request. If one
477
+ number provided, it will be total request
478
+ timeout. It can also be a pair (tuple) of
479
+ (connection, read) timeouts.
480
+ :type _request_timeout: int, tuple(int, int), optional
481
+ :param _request_auth: set to override the auth_settings for an a single
482
+ request; this effectively ignores the
483
+ authentication in the spec for a single request.
484
+ :type _request_auth: dict, optional
485
+ :param _content_type: force content-type for the request.
486
+ :type _content_type: str, Optional
487
+ :param _headers: set to override the headers for a single
488
+ request; this effectively ignores the headers
489
+ in the spec for a single request.
490
+ :type _headers: dict, optional
491
+ :param _host_index: set to override the host_index for a single
492
+ request; this effectively ignores the host_index
493
+ in the spec for a single request.
494
+ :type _host_index: int, optional
495
+ :return: Returns the result object.
496
+ """ # noqa: E501
497
+
498
+ _param = self._get_motion_group_glb_model_serialize(
499
+ motion_group_model=motion_group_model,
500
+ _request_auth=_request_auth,
501
+ _content_type=_content_type,
502
+ _headers=_headers,
503
+ _host_index=_host_index
504
+ )
505
+
506
+ _response_types_map: Dict[str, Optional[str]] = {
507
+ '200': "bytearray",
508
+ '404': None,
509
+ '500': None,
510
+ }
511
+
512
+ response_data = await self.api_client.call_api(
513
+ *_param,
514
+ _request_timeout=_request_timeout
515
+ )
516
+ return response_data.response
517
+
518
+
519
+ def _get_motion_group_glb_model_serialize(
520
+ self,
521
+ motion_group_model,
522
+ _request_auth,
523
+ _content_type,
524
+ _headers,
525
+ _host_index,
526
+ ) -> RequestSerialized:
527
+
528
+ _host = None
529
+
530
+ _collection_formats: Dict[str, str] = {
531
+ }
532
+
533
+ _path_params: Dict[str, str] = {}
534
+ _query_params: List[Tuple[str, str]] = []
535
+ _header_params: Dict[str, Optional[str]] = _headers or {}
536
+ _form_params: List[Tuple[str, str]] = []
537
+ _files: Dict[str, Union[str, bytes]] = {}
538
+ _body_params: Optional[bytes] = None
539
+
540
+ # process the path parameters
541
+ if motion_group_model is not None:
542
+ _path_params['motion-group-model'] = motion_group_model
543
+ # process the query parameters
544
+ # process the header parameters
545
+ # process the form parameters
546
+ # process the body parameter
547
+
548
+
549
+ # set the HTTP header `Accept`
550
+ _header_params['Accept'] = self.api_client.select_header_accept(
551
+ [
552
+ 'application/octet-stream'
553
+ ]
554
+ )
555
+
556
+
557
+ # authentication setting
558
+ _auth_settings: List[str] = [
559
+ 'BasicAuth',
560
+ 'BearerAuth'
561
+ ]
562
+
563
+ return self.api_client.param_serialize(
564
+ method='GET',
565
+ resource_path='/motion-group-models/{motion-group-model}/glb',
566
+ path_params=_path_params,
567
+ query_params=_query_params,
568
+ header_params=_header_params,
569
+ body=_body_params,
570
+ post_params=_form_params,
571
+ files=_files,
572
+ auth_settings=_auth_settings,
573
+ collection_formats=_collection_formats,
574
+ _host=_host,
575
+ _request_auth=_request_auth
576
+ )
577
+
578
+
579
+
313
580
  @validate_call
314
581
  async def get_motion_group_models(
315
582
  self,
@@ -561,3 +828,270 @@ class MotionGroupModelsApi:
561
828
  )
562
829
 
563
830
 
831
+
832
+ @validate_call
833
+ async def get_motion_group_usd_model(
834
+ self,
835
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
836
+ _request_timeout: Union[
837
+ None,
838
+ Annotated[StrictFloat, Field(gt=0)],
839
+ Tuple[
840
+ Annotated[StrictFloat, Field(gt=0)],
841
+ Annotated[StrictFloat, Field(gt=0)]
842
+ ]
843
+ ] = None,
844
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
845
+ _content_type: Optional[StrictStr] = None,
846
+ _headers: Optional[Dict[StrictStr, Any]] = None,
847
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
848
+ ) -> bytearray:
849
+ """Download USD Model
850
+
851
+ Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
852
+
853
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
854
+ :type motion_group_model: str
855
+ :param _request_timeout: timeout setting for this request. If one
856
+ number provided, it will be total request
857
+ timeout. It can also be a pair (tuple) of
858
+ (connection, read) timeouts.
859
+ :type _request_timeout: int, tuple(int, int), optional
860
+ :param _request_auth: set to override the auth_settings for an a single
861
+ request; this effectively ignores the
862
+ authentication in the spec for a single request.
863
+ :type _request_auth: dict, optional
864
+ :param _content_type: force content-type for the request.
865
+ :type _content_type: str, Optional
866
+ :param _headers: set to override the headers for a single
867
+ request; this effectively ignores the headers
868
+ in the spec for a single request.
869
+ :type _headers: dict, optional
870
+ :param _host_index: set to override the host_index for a single
871
+ request; this effectively ignores the host_index
872
+ in the spec for a single request.
873
+ :type _host_index: int, optional
874
+ :return: Returns the result object.
875
+ """ # noqa: E501
876
+
877
+ _param = self._get_motion_group_usd_model_serialize(
878
+ motion_group_model=motion_group_model,
879
+ _request_auth=_request_auth,
880
+ _content_type=_content_type,
881
+ _headers=_headers,
882
+ _host_index=_host_index
883
+ )
884
+
885
+ _response_types_map: Dict[str, Optional[str]] = {
886
+ '200': "bytearray",
887
+ '404': None,
888
+ '500': None,
889
+ }
890
+
891
+ response_data = await self.api_client.call_api(
892
+ *_param,
893
+ _request_timeout=_request_timeout
894
+ )
895
+ await response_data.read()
896
+ return self.api_client.response_deserialize(
897
+ response_data=response_data,
898
+ response_types_map=_response_types_map,
899
+ ).data
900
+
901
+
902
+ @validate_call
903
+ async def get_motion_group_usd_model_with_http_info(
904
+ self,
905
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
906
+ _request_timeout: Union[
907
+ None,
908
+ Annotated[StrictFloat, Field(gt=0)],
909
+ Tuple[
910
+ Annotated[StrictFloat, Field(gt=0)],
911
+ Annotated[StrictFloat, Field(gt=0)]
912
+ ]
913
+ ] = None,
914
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
915
+ _content_type: Optional[StrictStr] = None,
916
+ _headers: Optional[Dict[StrictStr, Any]] = None,
917
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
918
+ ) -> ApiResponse[bytearray]:
919
+ """Download USD Model
920
+
921
+ Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
922
+
923
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
924
+ :type motion_group_model: str
925
+ :param _request_timeout: timeout setting for this request. If one
926
+ number provided, it will be total request
927
+ timeout. It can also be a pair (tuple) of
928
+ (connection, read) timeouts.
929
+ :type _request_timeout: int, tuple(int, int), optional
930
+ :param _request_auth: set to override the auth_settings for an a single
931
+ request; this effectively ignores the
932
+ authentication in the spec for a single request.
933
+ :type _request_auth: dict, optional
934
+ :param _content_type: force content-type for the request.
935
+ :type _content_type: str, Optional
936
+ :param _headers: set to override the headers for a single
937
+ request; this effectively ignores the headers
938
+ in the spec for a single request.
939
+ :type _headers: dict, optional
940
+ :param _host_index: set to override the host_index for a single
941
+ request; this effectively ignores the host_index
942
+ in the spec for a single request.
943
+ :type _host_index: int, optional
944
+ :return: Returns the result object.
945
+ """ # noqa: E501
946
+
947
+ _param = self._get_motion_group_usd_model_serialize(
948
+ motion_group_model=motion_group_model,
949
+ _request_auth=_request_auth,
950
+ _content_type=_content_type,
951
+ _headers=_headers,
952
+ _host_index=_host_index
953
+ )
954
+
955
+ _response_types_map: Dict[str, Optional[str]] = {
956
+ '200': "bytearray",
957
+ '404': None,
958
+ '500': None,
959
+ }
960
+
961
+ response_data = await self.api_client.call_api(
962
+ *_param,
963
+ _request_timeout=_request_timeout
964
+ )
965
+ await response_data.read()
966
+ return self.api_client.response_deserialize(
967
+ response_data=response_data,
968
+ response_types_map=_response_types_map,
969
+ )
970
+
971
+
972
+ @validate_call
973
+ async def get_motion_group_usd_model_without_preload_content(
974
+ self,
975
+ motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
976
+ _request_timeout: Union[
977
+ None,
978
+ Annotated[StrictFloat, Field(gt=0)],
979
+ Tuple[
980
+ Annotated[StrictFloat, Field(gt=0)],
981
+ Annotated[StrictFloat, Field(gt=0)]
982
+ ]
983
+ ] = None,
984
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
985
+ _content_type: Optional[StrictStr] = None,
986
+ _headers: Optional[Dict[StrictStr, Any]] = None,
987
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
988
+ ) -> RESTResponseType:
989
+ """Download USD Model
990
+
991
+ Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
992
+
993
+ :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). (required)
994
+ :type motion_group_model: str
995
+ :param _request_timeout: timeout setting for this request. If one
996
+ number provided, it will be total request
997
+ timeout. It can also be a pair (tuple) of
998
+ (connection, read) timeouts.
999
+ :type _request_timeout: int, tuple(int, int), optional
1000
+ :param _request_auth: set to override the auth_settings for an a single
1001
+ request; this effectively ignores the
1002
+ authentication in the spec for a single request.
1003
+ :type _request_auth: dict, optional
1004
+ :param _content_type: force content-type for the request.
1005
+ :type _content_type: str, Optional
1006
+ :param _headers: set to override the headers for a single
1007
+ request; this effectively ignores the headers
1008
+ in the spec for a single request.
1009
+ :type _headers: dict, optional
1010
+ :param _host_index: set to override the host_index for a single
1011
+ request; this effectively ignores the host_index
1012
+ in the spec for a single request.
1013
+ :type _host_index: int, optional
1014
+ :return: Returns the result object.
1015
+ """ # noqa: E501
1016
+
1017
+ _param = self._get_motion_group_usd_model_serialize(
1018
+ motion_group_model=motion_group_model,
1019
+ _request_auth=_request_auth,
1020
+ _content_type=_content_type,
1021
+ _headers=_headers,
1022
+ _host_index=_host_index
1023
+ )
1024
+
1025
+ _response_types_map: Dict[str, Optional[str]] = {
1026
+ '200': "bytearray",
1027
+ '404': None,
1028
+ '500': None,
1029
+ }
1030
+
1031
+ response_data = await self.api_client.call_api(
1032
+ *_param,
1033
+ _request_timeout=_request_timeout
1034
+ )
1035
+ return response_data.response
1036
+
1037
+
1038
+ def _get_motion_group_usd_model_serialize(
1039
+ self,
1040
+ motion_group_model,
1041
+ _request_auth,
1042
+ _content_type,
1043
+ _headers,
1044
+ _host_index,
1045
+ ) -> RequestSerialized:
1046
+
1047
+ _host = None
1048
+
1049
+ _collection_formats: Dict[str, str] = {
1050
+ }
1051
+
1052
+ _path_params: Dict[str, str] = {}
1053
+ _query_params: List[Tuple[str, str]] = []
1054
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1055
+ _form_params: List[Tuple[str, str]] = []
1056
+ _files: Dict[str, Union[str, bytes]] = {}
1057
+ _body_params: Optional[bytes] = None
1058
+
1059
+ # process the path parameters
1060
+ if motion_group_model is not None:
1061
+ _path_params['motion-group-model'] = motion_group_model
1062
+ # process the query parameters
1063
+ # process the header parameters
1064
+ # process the form parameters
1065
+ # process the body parameter
1066
+
1067
+
1068
+ # set the HTTP header `Accept`
1069
+ _header_params['Accept'] = self.api_client.select_header_accept(
1070
+ [
1071
+ 'application/octet-stream'
1072
+ ]
1073
+ )
1074
+
1075
+
1076
+ # authentication setting
1077
+ _auth_settings: List[str] = [
1078
+ 'BasicAuth',
1079
+ 'BearerAuth'
1080
+ ]
1081
+
1082
+ return self.api_client.param_serialize(
1083
+ method='GET',
1084
+ resource_path='/motion-group-models/{motion-group-model}/usd',
1085
+ path_params=_path_params,
1086
+ query_params=_query_params,
1087
+ header_params=_header_params,
1088
+ body=_body_params,
1089
+ post_params=_form_params,
1090
+ files=_files,
1091
+ auth_settings=_auth_settings,
1092
+ collection_formats=_collection_formats,
1093
+ _host=_host,
1094
+ _request_auth=_request_auth
1095
+ )
1096
+
1097
+
@@ -65,7 +65,7 @@ class ProgramApi:
65
65
  ) -> Program:
66
66
  """Get program
67
67
 
68
- Get details of a program.
68
+ <!-- theme: danger --> > **Experimental** Get details of a program.
69
69
 
70
70
  :param cell: Unique identifier addressing a cell in all API calls. (required)
71
71
  :type cell: str
@@ -138,7 +138,7 @@ class ProgramApi:
138
138
  ) -> ApiResponse[Program]:
139
139
  """Get program
140
140
 
141
- Get details of a program.
141
+ <!-- theme: danger --> > **Experimental** Get details of a program.
142
142
 
143
143
  :param cell: Unique identifier addressing a cell in all API calls. (required)
144
144
  :type cell: str
@@ -211,7 +211,7 @@ class ProgramApi:
211
211
  ) -> RESTResponseType:
212
212
  """Get program
213
213
 
214
- Get details of a program.
214
+ <!-- theme: danger --> > **Experimental** Get details of a program.
215
215
 
216
216
  :param cell: Unique identifier addressing a cell in all API calls. (required)
217
217
  :type cell: str
@@ -343,7 +343,7 @@ class ProgramApi:
343
343
  ) -> List[Program]:
344
344
  """List programs
345
345
 
346
- List details of all existing programs.
346
+ <!-- theme: danger --> > **Experimental** List details of all existing programs.
347
347
 
348
348
  :param cell: Unique identifier addressing a cell in all API calls. (required)
349
349
  :type cell: str
@@ -412,7 +412,7 @@ class ProgramApi:
412
412
  ) -> ApiResponse[List[Program]]:
413
413
  """List programs
414
414
 
415
- List details of all existing programs.
415
+ <!-- theme: danger --> > **Experimental** List details of all existing programs.
416
416
 
417
417
  :param cell: Unique identifier addressing a cell in all API calls. (required)
418
418
  :type cell: str
@@ -481,7 +481,7 @@ class ProgramApi:
481
481
  ) -> RESTResponseType:
482
482
  """List programs
483
483
 
484
- List details of all existing programs.
484
+ <!-- theme: danger --> > **Experimental** List details of all existing programs.
485
485
 
486
486
  :param cell: Unique identifier addressing a cell in all API calls. (required)
487
487
  :type cell: str
@@ -609,7 +609,7 @@ class ProgramApi:
609
609
  ) -> ProgramRun:
610
610
  """Start the program
611
611
 
612
- This endpoint starts a new program execution. The program will be executed asynchronously.
612
+ <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
613
613
 
614
614
  :param cell: Unique identifier addressing a cell in all API calls. (required)
615
615
  :type cell: str
@@ -691,7 +691,7 @@ class ProgramApi:
691
691
  ) -> ApiResponse[ProgramRun]:
692
692
  """Start the program
693
693
 
694
- This endpoint starts a new program execution. The program will be executed asynchronously.
694
+ <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
695
695
 
696
696
  :param cell: Unique identifier addressing a cell in all API calls. (required)
697
697
  :type cell: str
@@ -773,7 +773,7 @@ class ProgramApi:
773
773
  ) -> RESTResponseType:
774
774
  """Start the program
775
775
 
776
- This endpoint starts a new program execution. The program will be executed asynchronously.
776
+ <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
777
777
 
778
778
  :param cell: Unique identifier addressing a cell in all API calls. (required)
779
779
  :type cell: str
@@ -930,7 +930,7 @@ class ProgramApi:
930
930
  ) -> None:
931
931
  """Stop program run
932
932
 
933
- Stop a specific program run.
933
+ <!-- theme: danger --> > **Experimental** Stop a specific program run.
934
934
 
935
935
  :param cell: Unique identifier addressing a cell in all API calls. (required)
936
936
  :type cell: str
@@ -1004,7 +1004,7 @@ class ProgramApi:
1004
1004
  ) -> ApiResponse[None]:
1005
1005
  """Stop program run
1006
1006
 
1007
- Stop a specific program run.
1007
+ <!-- theme: danger --> > **Experimental** Stop a specific program run.
1008
1008
 
1009
1009
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1010
1010
  :type cell: str
@@ -1078,7 +1078,7 @@ class ProgramApi:
1078
1078
  ) -> RESTResponseType:
1079
1079
  """Stop program run
1080
1080
 
1081
- Stop a specific program run.
1081
+ <!-- theme: danger --> > **Experimental** Stop a specific program run.
1082
1082
 
1083
1083
  :param cell: Unique identifier addressing a cell in all API calls. (required)
1084
1084
  :type cell: str