wandelbots-api-client 25.9.0.dev2__py3-none-any.whl → 25.10.0.dev47__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 (526) hide show
  1. wandelbots_api_client/__init__.py +1 -1
  2. wandelbots_api_client/api/controller_api.py +9 -3
  3. wandelbots_api_client/api/controller_ios_api.py +2 -4
  4. wandelbots_api_client/api/motion_api.py +16 -4
  5. wandelbots_api_client/api/motion_group_infos_api.py +2 -0
  6. wandelbots_api_client/api/motion_group_jogging_api.py +10 -4
  7. wandelbots_api_client/api/store_collision_components_api.py +9 -6
  8. wandelbots_api_client/api/virtual_robot_behavior_api.py +5 -2
  9. wandelbots_api_client/api_client.py +1 -1
  10. wandelbots_api_client/configuration.py +1 -1
  11. wandelbots_api_client/models/abb_controller.py +4 -4
  12. wandelbots_api_client/models/abb_controller_egm_server.py +2 -2
  13. wandelbots_api_client/models/activate_license_request.py +1 -1
  14. wandelbots_api_client/models/add_request.py +2 -2
  15. wandelbots_api_client/models/all_joint_positions_request.py +2 -2
  16. wandelbots_api_client/models/all_joint_positions_response.py +1 -1
  17. wandelbots_api_client/models/app.py +7 -7
  18. wandelbots_api_client/models/array_input.py +1 -1
  19. wandelbots_api_client/models/array_output.py +1 -1
  20. wandelbots_api_client/models/blending_auto.py +2 -2
  21. wandelbots_api_client/models/blending_position.py +2 -2
  22. wandelbots_api_client/models/box.py +4 -4
  23. wandelbots_api_client/models/box2.py +5 -5
  24. wandelbots_api_client/models/box3.py +5 -5
  25. wandelbots_api_client/models/capsule.py +2 -2
  26. wandelbots_api_client/models/capsule2.py +3 -3
  27. wandelbots_api_client/models/capsule3.py +3 -3
  28. wandelbots_api_client/models/capture.py +1 -1
  29. wandelbots_api_client/models/cell.py +3 -3
  30. wandelbots_api_client/models/circle.py +2 -2
  31. wandelbots_api_client/models/code_with_arguments.py +2 -2
  32. wandelbots_api_client/models/collider.py +3 -3
  33. wandelbots_api_client/models/collider_input.py +3 -3
  34. wandelbots_api_client/models/collider_output.py +3 -3
  35. wandelbots_api_client/models/collision.py +6 -6
  36. wandelbots_api_client/models/collision_contact.py +2 -2
  37. wandelbots_api_client/models/collision_motion_group.py +2 -2
  38. wandelbots_api_client/models/collision_motion_group_assembly.py +4 -4
  39. wandelbots_api_client/models/collision_robot_configuration_input.py +3 -3
  40. wandelbots_api_client/models/collision_robot_configuration_output.py +3 -3
  41. wandelbots_api_client/models/collision_scene.py +2 -2
  42. wandelbots_api_client/models/collision_scene_assembly.py +5 -5
  43. wandelbots_api_client/models/command.py +6 -6
  44. wandelbots_api_client/models/command_settings.py +3 -3
  45. wandelbots_api_client/models/compound.py +1 -1
  46. wandelbots_api_client/models/container_environment_inner.py +2 -2
  47. wandelbots_api_client/models/container_image.py +3 -3
  48. wandelbots_api_client/models/container_image_secrets_inner.py +1 -1
  49. wandelbots_api_client/models/container_resources.py +1 -1
  50. wandelbots_api_client/models/container_storage.py +2 -2
  51. wandelbots_api_client/models/controller_capabilities.py +2 -2
  52. wandelbots_api_client/models/controller_instance.py +8 -8
  53. wandelbots_api_client/models/controller_instance_list.py +1 -1
  54. wandelbots_api_client/models/convex_hull.py +1 -1
  55. wandelbots_api_client/models/convex_hull2.py +2 -2
  56. wandelbots_api_client/models/convex_hull3.py +2 -2
  57. wandelbots_api_client/models/coordinate_system.py +5 -5
  58. wandelbots_api_client/models/coordinate_systems.py +1 -1
  59. wandelbots_api_client/models/create_program_run200_response.py +1 -1
  60. wandelbots_api_client/models/create_program_run_request.py +1 -1
  61. wandelbots_api_client/models/create_trigger200_response.py +1 -1
  62. wandelbots_api_client/models/create_trigger_request.py +4 -4
  63. wandelbots_api_client/models/cubic_spline.py +1 -1
  64. wandelbots_api_client/models/cubic_spline_cubic_spline_parameter.py +2 -2
  65. wandelbots_api_client/models/cubic_spline_parameter.py +2 -2
  66. wandelbots_api_client/models/cycle_time.py +1 -1
  67. wandelbots_api_client/models/cylinder.py +2 -2
  68. wandelbots_api_client/models/cylinder2.py +3 -3
  69. wandelbots_api_client/models/cylinder3.py +3 -3
  70. wandelbots_api_client/models/dh_parameter.py +5 -5
  71. wandelbots_api_client/models/direction_jogging_request.py +9 -9
  72. wandelbots_api_client/models/error.py +2 -2
  73. wandelbots_api_client/models/execution_result.py +3 -3
  74. wandelbots_api_client/models/external_joint_stream_datapoint.py +2 -2
  75. wandelbots_api_client/models/external_joint_stream_datapoint_value.py +4 -4
  76. wandelbots_api_client/models/fanuc_controller.py +2 -2
  77. wandelbots_api_client/models/feedback_collision.py +4 -4
  78. wandelbots_api_client/models/feedback_joint_limit_exceeded.py +3 -3
  79. wandelbots_api_client/models/feedback_out_of_workspace.py +2 -2
  80. wandelbots_api_client/models/feedback_singularity.py +3 -3
  81. wandelbots_api_client/models/flag.py +1 -1
  82. wandelbots_api_client/models/force_vector.py +3 -3
  83. wandelbots_api_client/models/geometry.py +11 -11
  84. wandelbots_api_client/models/get_all_program_runs200_response.py +1 -1
  85. wandelbots_api_client/models/get_all_triggers200_response.py +1 -1
  86. wandelbots_api_client/models/get_mode_response.py +1 -1
  87. wandelbots_api_client/models/get_trajectory_response.py +1 -1
  88. wandelbots_api_client/models/get_trajectory_sample_response.py +1 -1
  89. wandelbots_api_client/models/google_protobuf_any.py +1 -1
  90. wandelbots_api_client/models/http_exception_response.py +1 -1
  91. wandelbots_api_client/models/http_validation_error.py +1 -1
  92. wandelbots_api_client/models/http_validation_error2.py +1 -1
  93. wandelbots_api_client/models/image_credentials.py +3 -3
  94. wandelbots_api_client/models/info_service_capabilities.py +7 -7
  95. wandelbots_api_client/models/initialize_movement_request.py +5 -5
  96. wandelbots_api_client/models/initialize_movement_response.py +1 -1
  97. wandelbots_api_client/models/initialize_movement_response_init_response.py +2 -2
  98. wandelbots_api_client/models/io.py +5 -5
  99. wandelbots_api_client/models/io_description.py +9 -9
  100. wandelbots_api_client/models/io_value.py +4 -4
  101. wandelbots_api_client/models/ios.py +1 -1
  102. wandelbots_api_client/models/jogging_response.py +3 -3
  103. wandelbots_api_client/models/jogging_service_capabilities.py +2 -2
  104. wandelbots_api_client/models/joint_jogging_request.py +5 -5
  105. wandelbots_api_client/models/joint_limit.py +4 -4
  106. wandelbots_api_client/models/joint_limit_exceeded.py +2 -2
  107. wandelbots_api_client/models/joint_position_request.py +3 -3
  108. wandelbots_api_client/models/joint_trajectory.py +3 -3
  109. wandelbots_api_client/models/joints.py +1 -1
  110. wandelbots_api_client/models/kinematic_service_capabilities.py +3 -3
  111. wandelbots_api_client/models/kuka_controller.py +5 -5
  112. wandelbots_api_client/models/kuka_controller_rsi_server.py +2 -2
  113. wandelbots_api_client/models/license.py +10 -10
  114. wandelbots_api_client/models/license_status.py +2 -2
  115. wandelbots_api_client/models/limit_settings.py +12 -12
  116. wandelbots_api_client/models/limits_override.py +6 -6
  117. wandelbots_api_client/models/list_io_descriptions_response.py +1 -1
  118. wandelbots_api_client/models/list_io_values_response.py +1 -1
  119. wandelbots_api_client/models/list_payloads_response.py +1 -1
  120. wandelbots_api_client/models/list_program_metadata_response.py +1 -1
  121. wandelbots_api_client/models/list_recipe_metadata_response.py +1 -1
  122. wandelbots_api_client/models/list_response.py +1 -1
  123. wandelbots_api_client/models/list_tcps_response.py +1 -1
  124. wandelbots_api_client/models/mode_change_response.py +4 -4
  125. wandelbots_api_client/models/motion_command.py +3 -3
  126. wandelbots_api_client/models/motion_group_behavior_getter.py +1 -1
  127. wandelbots_api_client/models/motion_group_info.py +3 -3
  128. wandelbots_api_client/models/motion_group_infos.py +1 -1
  129. wandelbots_api_client/models/motion_group_instance.py +5 -5
  130. wandelbots_api_client/models/motion_group_instance_list.py +1 -1
  131. wandelbots_api_client/models/motion_group_joints.py +4 -4
  132. wandelbots_api_client/models/motion_group_physical.py +5 -5
  133. wandelbots_api_client/models/motion_group_specification.py +2 -2
  134. wandelbots_api_client/models/motion_group_state.py +12 -12
  135. wandelbots_api_client/models/motion_group_state_joint_limit_reached.py +1 -1
  136. wandelbots_api_client/models/motion_group_state_response.py +2 -2
  137. wandelbots_api_client/models/motion_id.py +1 -1
  138. wandelbots_api_client/models/motion_ids_list_response.py +1 -1
  139. wandelbots_api_client/models/motion_vector.py +3 -3
  140. wandelbots_api_client/models/mounting.py +2 -2
  141. wandelbots_api_client/models/move_request.py +8 -8
  142. wandelbots_api_client/models/move_response.py +2 -2
  143. wandelbots_api_client/models/move_to_trajectory_via_joint_ptp_request.py +4 -4
  144. wandelbots_api_client/models/movement.py +1 -1
  145. wandelbots_api_client/models/movement_error.py +1 -1
  146. wandelbots_api_client/models/movement_error_error.py +1 -1
  147. wandelbots_api_client/models/movement_movement.py +3 -3
  148. wandelbots_api_client/models/op_mode.py +1 -1
  149. wandelbots_api_client/models/opcua_node_value_trigger_config.py +3 -3
  150. wandelbots_api_client/models/optimizer_setup.py +7 -7
  151. wandelbots_api_client/models/out_of_workspace.py +1 -1
  152. wandelbots_api_client/models/path.py +1 -1
  153. wandelbots_api_client/models/path_cartesian_ptp.py +2 -2
  154. wandelbots_api_client/models/path_circle.py +3 -3
  155. wandelbots_api_client/models/path_cubic_spline.py +2 -2
  156. wandelbots_api_client/models/path_joint_ptp.py +2 -2
  157. wandelbots_api_client/models/path_line.py +2 -2
  158. wandelbots_api_client/models/pause_movement_request.py +2 -2
  159. wandelbots_api_client/models/pause_movement_response.py +1 -1
  160. wandelbots_api_client/models/pause_movement_response_pause_response.py +2 -2
  161. wandelbots_api_client/models/pause_on_io.py +2 -2
  162. wandelbots_api_client/models/payload.py +4 -4
  163. wandelbots_api_client/models/plan_collision_free_ptp_request.py +5 -5
  164. wandelbots_api_client/models/plan_failed_on_trajectory_response.py +9 -9
  165. wandelbots_api_client/models/plan_failed_response.py +7 -7
  166. wandelbots_api_client/models/plan_request.py +5 -5
  167. wandelbots_api_client/models/plan_response.py +3 -3
  168. wandelbots_api_client/models/plan_successful_response.py +2 -2
  169. wandelbots_api_client/models/plan_trajectory_failed_response.py +3 -3
  170. wandelbots_api_client/models/plan_trajectory_request.py +5 -5
  171. wandelbots_api_client/models/plan_trajectory_response.py +1 -1
  172. wandelbots_api_client/models/plane2.py +1 -1
  173. wandelbots_api_client/models/plane3.py +1 -1
  174. wandelbots_api_client/models/planned_motion.py +5 -5
  175. wandelbots_api_client/models/planner_pose.py +2 -2
  176. wandelbots_api_client/models/planning_limits.py +12 -12
  177. wandelbots_api_client/models/planning_limits_limit_range.py +2 -2
  178. wandelbots_api_client/models/playback_speed_request.py +2 -2
  179. wandelbots_api_client/models/playback_speed_response.py +1 -1
  180. wandelbots_api_client/models/playback_speed_response_playback_speed_response.py +1 -1
  181. wandelbots_api_client/models/point_cloud.py +1 -1
  182. wandelbots_api_client/models/pose.py +3 -3
  183. wandelbots_api_client/models/pose2.py +2 -2
  184. wandelbots_api_client/models/program_metadata.py +6 -6
  185. wandelbots_api_client/models/program_run.py +10 -10
  186. wandelbots_api_client/models/program_run_object.py +6 -6
  187. wandelbots_api_client/models/program_runner_reference.py +2 -2
  188. wandelbots_api_client/models/pyjectory_datatypes_core_pose.py +2 -2
  189. wandelbots_api_client/models/pyjectory_datatypes_serializer_orientation.py +1 -1
  190. wandelbots_api_client/models/pyjectory_datatypes_serializer_pose.py +1 -1
  191. wandelbots_api_client/models/pyjectory_datatypes_serializer_position.py +1 -1
  192. wandelbots_api_client/models/pyriphery_etcd_etcd_configuration.py +4 -4
  193. wandelbots_api_client/models/pyriphery_hardware_isaac_isaac_configuration.py +4 -4
  194. wandelbots_api_client/models/pyriphery_opcua_opcua_configuration.py +3 -3
  195. wandelbots_api_client/models/pyriphery_pyrae_controller_controller_configuration.py +6 -6
  196. wandelbots_api_client/models/pyriphery_pyrae_robot_robot_configuration.py +7 -7
  197. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_input.py +4 -4
  198. wandelbots_api_client/models/pyriphery_robotics_configurable_collision_scene_configurable_collision_scene_configuration_output.py +4 -4
  199. wandelbots_api_client/models/pyriphery_robotics_robotcell_timer_configuration.py +2 -2
  200. wandelbots_api_client/models/pyriphery_robotics_simulation_robot_with_view_open3d_configuration.py +3 -3
  201. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_io_configuration.py +2 -2
  202. wandelbots_api_client/models/pyriphery_robotics_simulation_simulated_opcua_configuration.py +2 -2
  203. wandelbots_api_client/models/quaternion.py +4 -4
  204. wandelbots_api_client/models/recipe_metadata.py +7 -7
  205. wandelbots_api_client/models/rectangle.py +2 -2
  206. wandelbots_api_client/models/rectangle2.py +3 -3
  207. wandelbots_api_client/models/rectangle3.py +3 -3
  208. wandelbots_api_client/models/rectangular_capsule.py +3 -3
  209. wandelbots_api_client/models/rectangular_capsule2.py +4 -4
  210. wandelbots_api_client/models/rectangular_capsule3.py +4 -4
  211. wandelbots_api_client/models/robot_controller.py +2 -2
  212. wandelbots_api_client/models/robot_controller_state.py +7 -7
  213. wandelbots_api_client/models/robot_link_geometry.py +2 -2
  214. wandelbots_api_client/models/robot_state.py +2 -2
  215. wandelbots_api_client/models/robot_tcp.py +4 -4
  216. wandelbots_api_client/models/robot_tcps.py +1 -1
  217. wandelbots_api_client/models/rotation_angles.py +2 -2
  218. wandelbots_api_client/models/safety_configuration.py +5 -5
  219. wandelbots_api_client/models/safety_setup.py +4 -4
  220. wandelbots_api_client/models/safety_setup_safety_settings.py +2 -2
  221. wandelbots_api_client/models/safety_setup_safety_zone.py +4 -4
  222. wandelbots_api_client/models/safety_zone.py +3 -3
  223. wandelbots_api_client/models/safety_zone_limits.py +2 -2
  224. wandelbots_api_client/models/safety_zone_violation.py +1 -1
  225. wandelbots_api_client/models/service_status.py +2 -2
  226. wandelbots_api_client/models/service_status_status.py +3 -3
  227. wandelbots_api_client/models/set_io.py +2 -2
  228. wandelbots_api_client/models/set_playback_speed.py +2 -2
  229. wandelbots_api_client/models/single_joint_limit.py +2 -2
  230. wandelbots_api_client/models/singularity.py +2 -2
  231. wandelbots_api_client/models/sphere.py +1 -1
  232. wandelbots_api_client/models/sphere2.py +2 -2
  233. wandelbots_api_client/models/sphere3.py +2 -2
  234. wandelbots_api_client/models/standstill.py +1 -1
  235. wandelbots_api_client/models/standstill_standstill.py +3 -3
  236. wandelbots_api_client/models/start_movement_request.py +5 -5
  237. wandelbots_api_client/models/start_on_io.py +2 -2
  238. wandelbots_api_client/models/status.py +3 -3
  239. wandelbots_api_client/models/stop_response.py +3 -3
  240. wandelbots_api_client/models/stream_move_backward.py +1 -1
  241. wandelbots_api_client/models/stream_move_forward.py +1 -1
  242. wandelbots_api_client/models/stream_move_playback_speed.py +1 -1
  243. wandelbots_api_client/models/stream_move_response.py +3 -3
  244. wandelbots_api_client/models/stream_move_to_trajectory.py +1 -1
  245. wandelbots_api_client/models/stream_stop.py +1 -1
  246. wandelbots_api_client/models/tcp_pose.py +4 -4
  247. wandelbots_api_client/models/tcp_pose_request.py +4 -4
  248. wandelbots_api_client/models/tool_geometry.py +2 -2
  249. wandelbots_api_client/models/trajectory_sample.py +11 -11
  250. wandelbots_api_client/models/trigger_object.py +8 -8
  251. wandelbots_api_client/models/universalrobots_controller.py +2 -2
  252. wandelbots_api_client/models/update_nova_version_request.py +1 -1
  253. wandelbots_api_client/models/update_program_metadata_request.py +3 -3
  254. wandelbots_api_client/models/update_recipe_metadata_request.py +3 -3
  255. wandelbots_api_client/models/update_trigger_request.py +3 -3
  256. wandelbots_api_client/models/validation_error.py +3 -3
  257. wandelbots_api_client/models/validation_error2.py +3 -3
  258. wandelbots_api_client/models/vector3d.py +3 -3
  259. wandelbots_api_client/models/version_number.py +8 -8
  260. wandelbots_api_client/models/virtual_controller.py +5 -5
  261. wandelbots_api_client/models/virtual_controller_types.py +3 -0
  262. wandelbots_api_client/models/virtual_robot_configuration.py +2 -2
  263. wandelbots_api_client/models/yaskawa_controller.py +2 -2
  264. wandelbots_api_client/v2/__init__.py +1 -1
  265. wandelbots_api_client/v2/api/application_api.py +9 -9
  266. wandelbots_api_client/v2/api/bus_inputs_outputs_api.py +928 -79
  267. wandelbots_api_client/v2/api/cell_api.py +6 -6
  268. wandelbots_api_client/v2/api/controller_api.py +33 -29
  269. wandelbots_api_client/v2/api/controller_inputs_outputs_api.py +12 -10
  270. wandelbots_api_client/v2/api/jogging_api.py +6 -3
  271. wandelbots_api_client/v2/api/kinematics_api.py +12 -13
  272. wandelbots_api_client/v2/api/license_api.py +6 -6
  273. wandelbots_api_client/v2/api/motion_group_api.py +8 -6
  274. wandelbots_api_client/v2/api/motion_group_models_api.py +11 -47
  275. wandelbots_api_client/v2/api/store_collision_components_api.py +799 -25
  276. wandelbots_api_client/v2/api/store_collision_setups_api.py +262 -4
  277. wandelbots_api_client/v2/api/store_object_api.py +9 -9
  278. wandelbots_api_client/v2/api/trajectory_caching_api.py +12 -12
  279. wandelbots_api_client/v2/api/trajectory_execution_api.py +6 -3
  280. wandelbots_api_client/v2/api/trajectory_planning_api.py +15 -16
  281. wandelbots_api_client/v2/api/virtual_controller_api.py +51 -36
  282. wandelbots_api_client/v2/api/virtual_controller_behavior_api.py +18 -9
  283. wandelbots_api_client/v2/api/virtual_controller_inputs_outputs_api.py +3 -3
  284. wandelbots_api_client/v2/api_client.py +1 -1
  285. wandelbots_api_client/v2/configuration.py +1 -1
  286. wandelbots_api_client/v2/models/__init__.py +44 -26
  287. wandelbots_api_client/v2/models/abb_controller.py +6 -9
  288. wandelbots_api_client/v2/models/abb_controller_egm_server.py +2 -2
  289. wandelbots_api_client/v2/models/activate_license_request.py +1 -1
  290. wandelbots_api_client/v2/models/add_trajectory_error.py +3 -3
  291. wandelbots_api_client/v2/models/add_trajectory_error_data.py +56 -56
  292. wandelbots_api_client/v2/models/add_trajectory_request.py +3 -3
  293. wandelbots_api_client/v2/models/add_trajectory_response.py +2 -2
  294. wandelbots_api_client/v2/models/app.py +9 -9
  295. wandelbots_api_client/v2/models/behavior.py +1 -1
  296. wandelbots_api_client/v2/models/blending_auto.py +4 -3
  297. wandelbots_api_client/v2/models/blending_position.py +2 -2
  298. wandelbots_api_client/v2/models/boolean_value.py +4 -7
  299. wandelbots_api_client/v2/models/box.py +5 -5
  300. wandelbots_api_client/v2/models/{io_description2.py → bus_io_description.py} +14 -14
  301. wandelbots_api_client/v2/models/bus_io_modbus_client.py +104 -0
  302. wandelbots_api_client/v2/models/bus_io_modbus_server.py +115 -0
  303. wandelbots_api_client/v2/models/bus_io_modbus_tcp_client.py +106 -0
  304. wandelbots_api_client/v2/models/bus_io_modbus_tcp_server.py +104 -0
  305. wandelbots_api_client/v2/models/bus_io_modbus_virtual.py +98 -0
  306. wandelbots_api_client/v2/models/bus_io_profinet.py +6 -9
  307. wandelbots_api_client/v2/models/bus_io_profinet_default_route.py +2 -2
  308. wandelbots_api_client/v2/models/bus_io_profinet_ip_config.py +3 -3
  309. wandelbots_api_client/v2/models/bus_io_profinet_network.py +3 -3
  310. wandelbots_api_client/v2/models/bus_io_profinet_virtual.py +3 -6
  311. wandelbots_api_client/v2/models/bus_io_type.py +80 -8
  312. wandelbots_api_client/v2/models/bus_ios_state.py +2 -2
  313. wandelbots_api_client/v2/models/capsule.py +3 -3
  314. wandelbots_api_client/v2/models/cartesian_limits.py +4 -4
  315. wandelbots_api_client/v2/models/cell.py +5 -5
  316. wandelbots_api_client/v2/models/collider.py +3 -3
  317. wandelbots_api_client/v2/models/collision.py +6 -6
  318. wandelbots_api_client/v2/models/collision_contact.py +2 -2
  319. wandelbots_api_client/v2/models/collision_error.py +1 -1
  320. wandelbots_api_client/v2/models/collision_setup.py +4 -4
  321. wandelbots_api_client/v2/models/configuration_archive_status_creating.py +2 -2
  322. wandelbots_api_client/v2/models/configuration_archive_status_error.py +2 -2
  323. wandelbots_api_client/v2/models/configuration_archive_status_success.py +1 -1
  324. wandelbots_api_client/v2/models/configuration_resource.py +3 -3
  325. wandelbots_api_client/v2/models/container_environment_inner.py +2 -2
  326. wandelbots_api_client/v2/models/container_image.py +3 -3
  327. wandelbots_api_client/v2/models/container_image_secrets_inner.py +1 -1
  328. wandelbots_api_client/v2/models/container_resources.py +2 -2
  329. wandelbots_api_client/v2/models/container_storage.py +2 -2
  330. wandelbots_api_client/v2/models/controller_description.py +4 -4
  331. wandelbots_api_client/v2/models/convex_hull.py +2 -2
  332. wandelbots_api_client/v2/models/coordinate_system.py +6 -6
  333. wandelbots_api_client/v2/models/coordinate_system_data.py +5 -5
  334. wandelbots_api_client/v2/models/cubic_spline_parameter.py +2 -2
  335. wandelbots_api_client/v2/models/cycle_time.py +3 -2
  336. wandelbots_api_client/v2/models/cylinder.py +3 -3
  337. wandelbots_api_client/v2/models/dh_parameter.py +5 -5
  338. wandelbots_api_client/v2/models/error.py +2 -2
  339. wandelbots_api_client/v2/models/error_invalid_joint_count.py +3 -3
  340. wandelbots_api_client/v2/models/error_joint_limit_exceeded.py +4 -3
  341. wandelbots_api_client/v2/models/error_joint_position_collision.py +4 -4
  342. wandelbots_api_client/v2/models/error_max_iterations_exceeded.py +2 -2
  343. wandelbots_api_client/v2/models/execute.py +2 -2
  344. wandelbots_api_client/v2/models/execute_jogging_request.py +28 -0
  345. wandelbots_api_client/v2/models/execute_jogging_response.py +25 -0
  346. wandelbots_api_client/v2/models/execute_trajectory_request.py +28 -0
  347. wandelbots_api_client/v2/models/execute_trajectory_response.py +25 -0
  348. wandelbots_api_client/v2/models/external_joint_stream_datapoint.py +2 -2
  349. wandelbots_api_client/v2/models/external_joint_stream_request.py +1 -1
  350. wandelbots_api_client/v2/models/fanuc_controller.py +4 -7
  351. wandelbots_api_client/v2/models/feedback_collision.py +4 -4
  352. wandelbots_api_client/v2/models/feedback_joint_limit_exceeded.py +5 -4
  353. wandelbots_api_client/v2/models/feedback_out_of_workspace.py +2 -2
  354. wandelbots_api_client/v2/models/feedback_singularity.py +3 -3
  355. wandelbots_api_client/v2/models/flag.py +1 -1
  356. wandelbots_api_client/v2/models/float_value.py +4 -7
  357. wandelbots_api_client/v2/models/forward_kinematics422_response.py +1 -1
  358. wandelbots_api_client/v2/models/forward_kinematics_request.py +4 -4
  359. wandelbots_api_client/v2/models/forward_kinematics_response.py +1 -1
  360. wandelbots_api_client/v2/models/forward_kinematics_validation_error.py +5 -5
  361. wandelbots_api_client/v2/models/get_trajectory_response.py +3 -3
  362. wandelbots_api_client/v2/models/http_validation_error.py +1 -1
  363. wandelbots_api_client/v2/models/image_credentials.py +3 -3
  364. wandelbots_api_client/v2/models/{inconsitent_trajectory_size.py → inconsistent_trajectory_size_error.py} +7 -7
  365. wandelbots_api_client/v2/models/{inconsitent_trajectory_size_inconsistent_trajectory_size.py → inconsistent_trajectory_size_error_inconsistent_trajectory_size.py} +7 -7
  366. wandelbots_api_client/v2/models/initialize_jogging_request.py +5 -8
  367. wandelbots_api_client/v2/models/initialize_jogging_response.py +2 -2
  368. wandelbots_api_client/v2/models/initialize_movement_request.py +5 -8
  369. wandelbots_api_client/v2/models/initialize_movement_response.py +3 -3
  370. wandelbots_api_client/v2/models/integer_value.py +4 -7
  371. wandelbots_api_client/v2/models/{invalid_dof.py → invalid_dof_error.py} +7 -7
  372. wandelbots_api_client/v2/models/{invalid_dof_invalid_dof.py → invalid_dof_error_invalid_dof.py} +6 -6
  373. wandelbots_api_client/v2/models/inverse_kinematics422_response.py +1 -1
  374. wandelbots_api_client/v2/models/inverse_kinematics_request.py +6 -6
  375. wandelbots_api_client/v2/models/inverse_kinematics_response.py +1 -1
  376. wandelbots_api_client/v2/models/inverse_kinematics_validation_error.py +5 -5
  377. wandelbots_api_client/v2/models/io_boolean_value.py +5 -8
  378. wandelbots_api_client/v2/models/{io_description_min.py → io_boundary.py} +8 -8
  379. wandelbots_api_client/v2/models/io_description.py +11 -11
  380. wandelbots_api_client/v2/models/io_float_value.py +5 -8
  381. wandelbots_api_client/v2/models/io_integer_value.py +5 -8
  382. wandelbots_api_client/v2/models/jogging_details.py +2 -2
  383. wandelbots_api_client/v2/models/jogging_paused_by_user.py +1 -1
  384. wandelbots_api_client/v2/models/jogging_paused_near_collision.py +2 -2
  385. wandelbots_api_client/v2/models/jogging_paused_near_joint_limit.py +4 -3
  386. wandelbots_api_client/v2/models/jogging_paused_on_io.py +1 -1
  387. wandelbots_api_client/v2/models/jogging_running.py +1 -1
  388. wandelbots_api_client/v2/models/{joint_limit_exceeded.py → joint_limit_exceeded_error.py} +5 -5
  389. wandelbots_api_client/v2/models/joint_limits.py +4 -4
  390. wandelbots_api_client/v2/models/joint_trajectory.py +3 -3
  391. wandelbots_api_client/v2/models/joint_velocity_request.py +4 -7
  392. wandelbots_api_client/v2/models/joint_velocity_response.py +2 -2
  393. wandelbots_api_client/v2/models/kuka_controller.py +6 -9
  394. wandelbots_api_client/v2/models/kuka_controller_rsi_server.py +2 -2
  395. wandelbots_api_client/v2/models/license.py +10 -10
  396. wandelbots_api_client/v2/models/license_status.py +2 -2
  397. wandelbots_api_client/v2/models/limit_range.py +2 -2
  398. wandelbots_api_client/v2/models/limit_set.py +5 -5
  399. wandelbots_api_client/v2/models/limits_override.py +6 -6
  400. wandelbots_api_client/v2/models/list_trajectories_response.py +1 -1
  401. wandelbots_api_client/v2/models/midpoint_insertion_algorithm.py +2 -2
  402. wandelbots_api_client/v2/models/modbus_io.py +105 -0
  403. wandelbots_api_client/v2/models/modbus_io_area.py +40 -0
  404. wandelbots_api_client/v2/models/modbus_io_byte_order.py +40 -0
  405. wandelbots_api_client/v2/models/{http_validation_error2.py → modbus_io_data.py} +21 -26
  406. wandelbots_api_client/v2/models/modbus_io_type_enum.py +39 -0
  407. wandelbots_api_client/v2/models/motion_command.py +3 -3
  408. wandelbots_api_client/v2/models/motion_group_description.py +12 -11
  409. wandelbots_api_client/v2/models/motion_group_info.py +5 -4
  410. wandelbots_api_client/v2/models/motion_group_joints.py +4 -4
  411. wandelbots_api_client/v2/models/motion_group_setup.py +9 -8
  412. wandelbots_api_client/v2/models/motion_group_state.py +16 -15
  413. wandelbots_api_client/v2/models/motion_group_state_joint_limit_reached.py +1 -1
  414. wandelbots_api_client/v2/models/movement_error_response.py +2 -2
  415. wandelbots_api_client/v2/models/{nan_value.py → nan_value_error.py} +7 -7
  416. wandelbots_api_client/v2/models/{nan_value_nan_value.py → nan_value_error_nan_value.py} +4 -4
  417. wandelbots_api_client/v2/models/op_mode.py +1 -1
  418. wandelbots_api_client/v2/models/operation_limits.py +4 -4
  419. wandelbots_api_client/v2/models/path_cartesian_ptp.py +2 -2
  420. wandelbots_api_client/v2/models/path_circle.py +3 -3
  421. wandelbots_api_client/v2/models/path_cubic_spline.py +2 -2
  422. wandelbots_api_client/v2/models/path_joint_ptp.py +2 -2
  423. wandelbots_api_client/v2/models/path_line.py +2 -2
  424. wandelbots_api_client/v2/models/pause_jogging_request.py +3 -6
  425. wandelbots_api_client/v2/models/pause_jogging_response.py +2 -2
  426. wandelbots_api_client/v2/models/pause_movement_request.py +3 -6
  427. wandelbots_api_client/v2/models/pause_movement_response.py +2 -2
  428. wandelbots_api_client/v2/models/pause_on_io.py +3 -3
  429. wandelbots_api_client/v2/models/payload.py +4 -4
  430. wandelbots_api_client/v2/models/plan422_response.py +1 -1
  431. wandelbots_api_client/v2/models/plan_collision_free_failed_response.py +1 -1
  432. wandelbots_api_client/v2/models/plan_collision_free_request.py +4 -4
  433. wandelbots_api_client/v2/models/plan_collision_free_response.py +1 -1
  434. wandelbots_api_client/v2/models/plan_trajectory_failed_response.py +3 -3
  435. wandelbots_api_client/v2/models/plan_trajectory_request.py +3 -3
  436. wandelbots_api_client/v2/models/plan_trajectory_response.py +1 -1
  437. wandelbots_api_client/v2/models/plan_validation_error.py +5 -5
  438. wandelbots_api_client/v2/models/plane.py +1 -1
  439. wandelbots_api_client/v2/models/playback_speed_request.py +6 -8
  440. wandelbots_api_client/v2/models/playback_speed_response.py +2 -2
  441. wandelbots_api_client/v2/models/pose.py +2 -2
  442. wandelbots_api_client/v2/models/profinet_description.py +5 -5
  443. wandelbots_api_client/v2/models/profinet_input_output_config.py +3 -3
  444. wandelbots_api_client/v2/models/profinet_io.py +6 -6
  445. wandelbots_api_client/v2/models/profinet_io_data.py +5 -5
  446. wandelbots_api_client/v2/models/profinet_io_direction.py +1 -1
  447. wandelbots_api_client/v2/models/profinet_slot_description.py +4 -4
  448. wandelbots_api_client/v2/models/profinet_sub_slot_description.py +3 -3
  449. wandelbots_api_client/v2/models/program.py +6 -6
  450. wandelbots_api_client/v2/models/program_run.py +14 -12
  451. wandelbots_api_client/v2/models/program_start_request.py +1 -1
  452. wandelbots_api_client/v2/models/rectangle.py +3 -3
  453. wandelbots_api_client/v2/models/rectangular_capsule.py +4 -4
  454. wandelbots_api_client/v2/models/robot_controller.py +2 -2
  455. wandelbots_api_client/v2/models/robot_controller_state.py +11 -10
  456. wandelbots_api_client/v2/models/robot_tcp.py +5 -5
  457. wandelbots_api_client/v2/models/robot_tcp_data.py +4 -4
  458. wandelbots_api_client/v2/models/rrt_connect_algorithm.py +6 -6
  459. wandelbots_api_client/v2/models/service_status.py +3 -3
  460. wandelbots_api_client/v2/models/service_status_response.py +2 -2
  461. wandelbots_api_client/v2/models/service_status_status.py +3 -3
  462. wandelbots_api_client/v2/models/set_io.py +3 -3
  463. wandelbots_api_client/v2/models/sphere.py +2 -2
  464. wandelbots_api_client/v2/models/start_movement_request.py +7 -10
  465. wandelbots_api_client/v2/models/start_movement_response.py +2 -2
  466. wandelbots_api_client/v2/models/start_on_io.py +3 -3
  467. wandelbots_api_client/v2/models/stream_io_values_response.py +5 -4
  468. wandelbots_api_client/v2/models/tcp_offset.py +2 -2
  469. wandelbots_api_client/v2/models/{tcp_required.py → tcp_required_error.py} +4 -4
  470. wandelbots_api_client/v2/models/tcp_velocity_request.py +5 -8
  471. wandelbots_api_client/v2/models/tcp_velocity_response.py +2 -2
  472. wandelbots_api_client/v2/models/{torque_exceeded.py → torque_exceeded_error.py} +7 -7
  473. wandelbots_api_client/v2/models/{torque_exceeded_torque_exceeded.py → torque_exceeded_error_torque_exceeded.py} +6 -6
  474. wandelbots_api_client/v2/models/trajectory_data.py +5 -5
  475. wandelbots_api_client/v2/models/trajectory_details.py +4 -4
  476. wandelbots_api_client/v2/models/trajectory_ended.py +1 -1
  477. wandelbots_api_client/v2/models/trajectory_id.py +3 -3
  478. wandelbots_api_client/v2/models/trajectory_paused_by_user.py +1 -1
  479. wandelbots_api_client/v2/models/trajectory_paused_on_io.py +1 -1
  480. wandelbots_api_client/v2/models/trajectory_running.py +4 -3
  481. wandelbots_api_client/v2/models/trajectory_wait_for_io.py +1 -1
  482. wandelbots_api_client/v2/models/universalrobots_controller.py +4 -7
  483. wandelbots_api_client/v2/models/update_nova_version_request.py +1 -1
  484. wandelbots_api_client/v2/models/validation_error.py +4 -4
  485. wandelbots_api_client/v2/models/validation_error2.py +3 -3
  486. wandelbots_api_client/v2/models/virtual_controller.py +6 -9
  487. wandelbots_api_client/v2/models/virtual_controller_types.py +3 -0
  488. wandelbots_api_client/v2/models/virtual_robot_configuration.py +2 -2
  489. wandelbots_api_client/v2/models/wait_for_io_event_request.py +2 -2
  490. wandelbots_api_client/v2/models/yaskawa_controller.py +4 -7
  491. wandelbots_api_client/v2_pydantic/__init__.py +51 -0
  492. wandelbots_api_client/v2_pydantic/api/__init__.py +49 -0
  493. wandelbots_api_client/v2_pydantic/api/application_api.py +1822 -0
  494. wandelbots_api_client/v2_pydantic/api/bus_inputs_outputs_api.py +4652 -0
  495. wandelbots_api_client/v2_pydantic/api/cell_api.py +2025 -0
  496. wandelbots_api_client/v2_pydantic/api/controller_api.py +3758 -0
  497. wandelbots_api_client/v2_pydantic/api/controller_inputs_outputs_api.py +1408 -0
  498. wandelbots_api_client/v2_pydantic/api/jogging_api.py +126 -0
  499. wandelbots_api_client/v2_pydantic/api/kinematics_api.py +649 -0
  500. wandelbots_api_client/v2_pydantic/api/license_api.py +1074 -0
  501. wandelbots_api_client/v2_pydantic/api/motion_group_api.py +740 -0
  502. wandelbots_api_client/v2_pydantic/api/motion_group_models_api.py +570 -0
  503. wandelbots_api_client/v2_pydantic/api/program_api.py +1200 -0
  504. wandelbots_api_client/v2_pydantic/api/store_collision_components_api.py +4216 -0
  505. wandelbots_api_client/v2_pydantic/api/store_collision_setups_api.py +1435 -0
  506. wandelbots_api_client/v2_pydantic/api/store_object_api.py +1738 -0
  507. wandelbots_api_client/v2_pydantic/api/system_api.py +2454 -0
  508. wandelbots_api_client/v2_pydantic/api/trajectory_caching_api.py +1524 -0
  509. wandelbots_api_client/v2_pydantic/api/trajectory_execution_api.py +126 -0
  510. wandelbots_api_client/v2_pydantic/api/trajectory_planning_api.py +649 -0
  511. wandelbots_api_client/v2_pydantic/api/virtual_controller_api.py +4656 -0
  512. wandelbots_api_client/v2_pydantic/api/virtual_controller_behavior_api.py +1001 -0
  513. wandelbots_api_client/v2_pydantic/api/virtual_controller_inputs_outputs_api.py +1022 -0
  514. wandelbots_api_client/v2_pydantic/api_client.py +810 -0
  515. wandelbots_api_client/v2_pydantic/api_response.py +21 -0
  516. wandelbots_api_client/v2_pydantic/configuration.py +595 -0
  517. wandelbots_api_client/v2_pydantic/exceptions.py +216 -0
  518. wandelbots_api_client/v2_pydantic/models.py +4547 -0
  519. wandelbots_api_client/v2_pydantic/py.typed +0 -0
  520. wandelbots_api_client/v2_pydantic/rest.py +212 -0
  521. {wandelbots_api_client-25.9.0.dev2.dist-info → wandelbots_api_client-25.10.0.dev47.dist-info}/METADATA +16 -15
  522. wandelbots_api_client-25.10.0.dev47.dist-info/RECORD +636 -0
  523. wandelbots_api_client-25.9.0.dev2.dist-info/RECORD +0 -597
  524. {wandelbots_api_client-25.9.0.dev2.dist-info → wandelbots_api_client-25.10.0.dev47.dist-info}/WHEEL +0 -0
  525. {wandelbots_api_client-25.9.0.dev2.dist-info → wandelbots_api_client-25.10.0.dev47.dist-info}/licenses/LICENSE +0 -0
  526. {wandelbots_api_client-25.9.0.dev2.dist-info → wandelbots_api_client-25.10.0.dev47.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,1822 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wandelbots NOVA API
5
+
6
+ Interact with robots in an easy and intuitive way. > **Note:** API version 2 is experimental and will experience functional changes.
7
+
8
+ The version of the OpenAPI document: 2.0.0 beta
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, StrictStr
27
+ from typing import List, Optional
28
+ from typing_extensions import Annotated
29
+ from wandelbots_api_client.v2_pydantic.models import App
30
+
31
+ from wandelbots_api_client.v2_pydantic.api_client import ApiClient, RequestSerialized
32
+ from wandelbots_api_client.v2_pydantic.api_response import ApiResponse
33
+ from wandelbots_api_client.v2_pydantic.rest import RESTResponseType
34
+
35
+ class ApplicationApi:
36
+ """NOTE: This class is auto generated by OpenAPI Generator
37
+ Ref: https://openapi-generator.tech
38
+
39
+ Do not edit the class manually.
40
+ """
41
+
42
+ def __init__(self, api_client=None) -> None:
43
+ if api_client is None:
44
+ api_client = ApiClient.get_default()
45
+ self.api_client = api_client
46
+
47
+ @validate_call
48
+ async def add_app(
49
+ self,
50
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
51
+ app: App,
52
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
53
+ _request_timeout: Union[
54
+ None,
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Tuple[
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Annotated[StrictFloat, Field(gt=0)]
59
+ ]
60
+ ] = None,
61
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
62
+ _content_type: Optional[StrictStr] = None,
63
+ _headers: Optional[Dict[StrictStr, Any]] = None,
64
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
65
+ ) -> None:
66
+ """Add Application
67
+
68
+ Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
69
+
70
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
71
+ :type cell: str
72
+ :param app: (required)
73
+ :type app: App
74
+ :param completion_timeout:
75
+ :type completion_timeout: int
76
+ :param _request_timeout: timeout setting for this request. If one
77
+ number provided, it will be total request
78
+ timeout. It can also be a pair (tuple) of
79
+ (connection, read) timeouts.
80
+ :type _request_timeout: int, tuple(int, int), optional
81
+ :param _request_auth: set to override the auth_settings for an a single
82
+ request; this effectively ignores the
83
+ authentication in the spec for a single request.
84
+ :type _request_auth: dict, optional
85
+ :param _content_type: force content-type for the request.
86
+ :type _content_type: str, Optional
87
+ :param _headers: set to override the headers for a single
88
+ request; this effectively ignores the headers
89
+ in the spec for a single request.
90
+ :type _headers: dict, optional
91
+ :param _host_index: set to override the host_index for a single
92
+ request; this effectively ignores the host_index
93
+ in the spec for a single request.
94
+ :type _host_index: int, optional
95
+ :return: Returns the result object.
96
+ """ # noqa: E501
97
+
98
+ _param = self._add_app_serialize(
99
+ cell=cell,
100
+ app=app,
101
+ completion_timeout=completion_timeout,
102
+ _request_auth=_request_auth,
103
+ _content_type=_content_type,
104
+ _headers=_headers,
105
+ _host_index=_host_index
106
+ )
107
+
108
+ _response_types_map: Dict[str, Optional[str]] = {
109
+ '200': None,
110
+ '202': None,
111
+ '409': None,
112
+ }
113
+
114
+
115
+ response_data = await self.api_client.call_api(
116
+ *_param,
117
+ _request_timeout=_request_timeout
118
+ )
119
+ await response_data.read()
120
+ return self.api_client.response_deserialize(
121
+ response_data=response_data,
122
+ response_types_map=_response_types_map,
123
+ ).data
124
+
125
+
126
+ @validate_call
127
+ async def add_app_with_http_info(
128
+ self,
129
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
130
+ app: App,
131
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
132
+ _request_timeout: Union[
133
+ None,
134
+ Annotated[StrictFloat, Field(gt=0)],
135
+ Tuple[
136
+ Annotated[StrictFloat, Field(gt=0)],
137
+ Annotated[StrictFloat, Field(gt=0)]
138
+ ]
139
+ ] = None,
140
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
141
+ _content_type: Optional[StrictStr] = None,
142
+ _headers: Optional[Dict[StrictStr, Any]] = None,
143
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
144
+ ) -> ApiResponse[None]:
145
+ """Add Application
146
+
147
+ Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
148
+
149
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
150
+ :type cell: str
151
+ :param app: (required)
152
+ :type app: App
153
+ :param completion_timeout:
154
+ :type completion_timeout: int
155
+ :param _request_timeout: timeout setting for this request. If one
156
+ number provided, it will be total request
157
+ timeout. It can also be a pair (tuple) of
158
+ (connection, read) timeouts.
159
+ :type _request_timeout: int, tuple(int, int), optional
160
+ :param _request_auth: set to override the auth_settings for an a single
161
+ request; this effectively ignores the
162
+ authentication in the spec for a single request.
163
+ :type _request_auth: dict, optional
164
+ :param _content_type: force content-type for the request.
165
+ :type _content_type: str, Optional
166
+ :param _headers: set to override the headers for a single
167
+ request; this effectively ignores the headers
168
+ in the spec for a single request.
169
+ :type _headers: dict, optional
170
+ :param _host_index: set to override the host_index for a single
171
+ request; this effectively ignores the host_index
172
+ in the spec for a single request.
173
+ :type _host_index: int, optional
174
+ :return: Returns the result object.
175
+ """ # noqa: E501
176
+
177
+ _param = self._add_app_serialize(
178
+ cell=cell,
179
+ app=app,
180
+ completion_timeout=completion_timeout,
181
+ _request_auth=_request_auth,
182
+ _content_type=_content_type,
183
+ _headers=_headers,
184
+ _host_index=_host_index
185
+ )
186
+
187
+ _response_types_map: Dict[str, Optional[str]] = {
188
+ '200': None,
189
+ '202': None,
190
+ '409': None,
191
+ }
192
+
193
+
194
+ response_data = await self.api_client.call_api(
195
+ *_param,
196
+ _request_timeout=_request_timeout
197
+ )
198
+ await response_data.read()
199
+ return self.api_client.response_deserialize(
200
+ response_data=response_data,
201
+ response_types_map=_response_types_map,
202
+ )
203
+
204
+
205
+ @validate_call
206
+ async def add_app_without_preload_content(
207
+ self,
208
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
209
+ app: App,
210
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
211
+ _request_timeout: Union[
212
+ None,
213
+ Annotated[StrictFloat, Field(gt=0)],
214
+ Tuple[
215
+ Annotated[StrictFloat, Field(gt=0)],
216
+ Annotated[StrictFloat, Field(gt=0)]
217
+ ]
218
+ ] = None,
219
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
220
+ _content_type: Optional[StrictStr] = None,
221
+ _headers: Optional[Dict[StrictStr, Any]] = None,
222
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
223
+ ) -> RESTResponseType:
224
+ """Add Application
225
+
226
+ Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application's root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
227
+
228
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
229
+ :type cell: str
230
+ :param app: (required)
231
+ :type app: App
232
+ :param completion_timeout:
233
+ :type completion_timeout: int
234
+ :param _request_timeout: timeout setting for this request. If one
235
+ number provided, it will be total request
236
+ timeout. It can also be a pair (tuple) of
237
+ (connection, read) timeouts.
238
+ :type _request_timeout: int, tuple(int, int), optional
239
+ :param _request_auth: set to override the auth_settings for an a single
240
+ request; this effectively ignores the
241
+ authentication in the spec for a single request.
242
+ :type _request_auth: dict, optional
243
+ :param _content_type: force content-type for the request.
244
+ :type _content_type: str, Optional
245
+ :param _headers: set to override the headers for a single
246
+ request; this effectively ignores the headers
247
+ in the spec for a single request.
248
+ :type _headers: dict, optional
249
+ :param _host_index: set to override the host_index for a single
250
+ request; this effectively ignores the host_index
251
+ in the spec for a single request.
252
+ :type _host_index: int, optional
253
+ :return: Returns the result object.
254
+ """ # noqa: E501
255
+
256
+ _param = self._add_app_serialize(
257
+ cell=cell,
258
+ app=app,
259
+ completion_timeout=completion_timeout,
260
+ _request_auth=_request_auth,
261
+ _content_type=_content_type,
262
+ _headers=_headers,
263
+ _host_index=_host_index
264
+ )
265
+
266
+ _response_types_map: Dict[str, Optional[str]] = {
267
+ '200': None,
268
+ '202': None,
269
+ '409': None,
270
+ }
271
+
272
+
273
+ response_data = await self.api_client.call_api(
274
+ *_param,
275
+ _request_timeout=_request_timeout
276
+ )
277
+ return response_data.response
278
+
279
+
280
+ def _add_app_serialize(
281
+ self,
282
+ cell,
283
+ app,
284
+ completion_timeout,
285
+ _request_auth,
286
+ _content_type,
287
+ _headers,
288
+ _host_index,
289
+ ) -> RequestSerialized:
290
+
291
+ _host = None
292
+
293
+ _collection_formats: Dict[str, str] = {
294
+ }
295
+
296
+ _path_params: Dict[str, str] = {}
297
+ _query_params: List[Tuple[str, str]] = []
298
+ _header_params: Dict[str, Optional[str]] = _headers or {}
299
+ _form_params: List[Tuple[str, str]] = []
300
+ _files: Dict[str, Union[str, bytes]] = {}
301
+ _body_params: Optional[bytes] = None
302
+
303
+ # process the path parameters
304
+ if cell is not None:
305
+ _path_params['cell'] = cell
306
+ # process the query parameters
307
+ if completion_timeout is not None:
308
+
309
+ _query_params.append(('completion_timeout', completion_timeout))
310
+
311
+ # process the header parameters
312
+ # process the form parameters
313
+ # process the body parameter
314
+ if app is not None:
315
+ _body_params = app
316
+
317
+
318
+
319
+ # set the HTTP header `Content-Type`
320
+ if _content_type:
321
+ _header_params['Content-Type'] = _content_type
322
+ else:
323
+ _default_content_type = (
324
+ self.api_client.select_header_content_type(
325
+ [
326
+ 'application/json'
327
+ ]
328
+ )
329
+ )
330
+ if _default_content_type is not None:
331
+ _header_params['Content-Type'] = _default_content_type
332
+
333
+ # authentication setting
334
+ _auth_settings: List[str] = [
335
+ 'BasicAuth',
336
+ 'BearerAuth'
337
+ ]
338
+
339
+ return self.api_client.param_serialize(
340
+ method='POST',
341
+ resource_path='/cells/{cell}/apps',
342
+ path_params=_path_params,
343
+ query_params=_query_params,
344
+ header_params=_header_params,
345
+ body=_body_params,
346
+ post_params=_form_params,
347
+ files=_files,
348
+ auth_settings=_auth_settings,
349
+ collection_formats=_collection_formats,
350
+ _host=_host,
351
+ _request_auth=_request_auth
352
+ )
353
+
354
+
355
+
356
+ @validate_call
357
+ async def clear_apps(
358
+ self,
359
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
360
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
361
+ _request_timeout: Union[
362
+ None,
363
+ Annotated[StrictFloat, Field(gt=0)],
364
+ Tuple[
365
+ Annotated[StrictFloat, Field(gt=0)],
366
+ Annotated[StrictFloat, Field(gt=0)]
367
+ ]
368
+ ] = None,
369
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
370
+ _content_type: Optional[StrictStr] = None,
371
+ _headers: Optional[Dict[StrictStr, Any]] = None,
372
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
373
+ ) -> None:
374
+ """Clear Applications
375
+
376
+ Delete all GUI applications from the cell.
377
+
378
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
379
+ :type cell: str
380
+ :param completion_timeout:
381
+ :type completion_timeout: int
382
+ :param _request_timeout: timeout setting for this request. If one
383
+ number provided, it will be total request
384
+ timeout. It can also be a pair (tuple) of
385
+ (connection, read) timeouts.
386
+ :type _request_timeout: int, tuple(int, int), optional
387
+ :param _request_auth: set to override the auth_settings for an a single
388
+ request; this effectively ignores the
389
+ authentication in the spec for a single request.
390
+ :type _request_auth: dict, optional
391
+ :param _content_type: force content-type for the request.
392
+ :type _content_type: str, Optional
393
+ :param _headers: set to override the headers for a single
394
+ request; this effectively ignores the headers
395
+ in the spec for a single request.
396
+ :type _headers: dict, optional
397
+ :param _host_index: set to override the host_index for a single
398
+ request; this effectively ignores the host_index
399
+ in the spec for a single request.
400
+ :type _host_index: int, optional
401
+ :return: Returns the result object.
402
+ """ # noqa: E501
403
+
404
+ _param = self._clear_apps_serialize(
405
+ cell=cell,
406
+ completion_timeout=completion_timeout,
407
+ _request_auth=_request_auth,
408
+ _content_type=_content_type,
409
+ _headers=_headers,
410
+ _host_index=_host_index
411
+ )
412
+
413
+ _response_types_map: Dict[str, Optional[str]] = {
414
+ '200': None,
415
+ '202': None,
416
+ '404': "Error",
417
+ }
418
+
419
+
420
+ response_data = await self.api_client.call_api(
421
+ *_param,
422
+ _request_timeout=_request_timeout
423
+ )
424
+ await response_data.read()
425
+ return self.api_client.response_deserialize(
426
+ response_data=response_data,
427
+ response_types_map=_response_types_map,
428
+ ).data
429
+
430
+
431
+ @validate_call
432
+ async def clear_apps_with_http_info(
433
+ self,
434
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
435
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
436
+ _request_timeout: Union[
437
+ None,
438
+ Annotated[StrictFloat, Field(gt=0)],
439
+ Tuple[
440
+ Annotated[StrictFloat, Field(gt=0)],
441
+ Annotated[StrictFloat, Field(gt=0)]
442
+ ]
443
+ ] = None,
444
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
445
+ _content_type: Optional[StrictStr] = None,
446
+ _headers: Optional[Dict[StrictStr, Any]] = None,
447
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
448
+ ) -> ApiResponse[None]:
449
+ """Clear Applications
450
+
451
+ Delete all GUI applications from the cell.
452
+
453
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
454
+ :type cell: str
455
+ :param completion_timeout:
456
+ :type completion_timeout: int
457
+ :param _request_timeout: timeout setting for this request. If one
458
+ number provided, it will be total request
459
+ timeout. It can also be a pair (tuple) of
460
+ (connection, read) timeouts.
461
+ :type _request_timeout: int, tuple(int, int), optional
462
+ :param _request_auth: set to override the auth_settings for an a single
463
+ request; this effectively ignores the
464
+ authentication in the spec for a single request.
465
+ :type _request_auth: dict, optional
466
+ :param _content_type: force content-type for the request.
467
+ :type _content_type: str, Optional
468
+ :param _headers: set to override the headers for a single
469
+ request; this effectively ignores the headers
470
+ in the spec for a single request.
471
+ :type _headers: dict, optional
472
+ :param _host_index: set to override the host_index for a single
473
+ request; this effectively ignores the host_index
474
+ in the spec for a single request.
475
+ :type _host_index: int, optional
476
+ :return: Returns the result object.
477
+ """ # noqa: E501
478
+
479
+ _param = self._clear_apps_serialize(
480
+ cell=cell,
481
+ completion_timeout=completion_timeout,
482
+ _request_auth=_request_auth,
483
+ _content_type=_content_type,
484
+ _headers=_headers,
485
+ _host_index=_host_index
486
+ )
487
+
488
+ _response_types_map: Dict[str, Optional[str]] = {
489
+ '200': None,
490
+ '202': None,
491
+ '404': "Error",
492
+ }
493
+
494
+
495
+ response_data = await self.api_client.call_api(
496
+ *_param,
497
+ _request_timeout=_request_timeout
498
+ )
499
+ await response_data.read()
500
+ return self.api_client.response_deserialize(
501
+ response_data=response_data,
502
+ response_types_map=_response_types_map,
503
+ )
504
+
505
+
506
+ @validate_call
507
+ async def clear_apps_without_preload_content(
508
+ self,
509
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
510
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
511
+ _request_timeout: Union[
512
+ None,
513
+ Annotated[StrictFloat, Field(gt=0)],
514
+ Tuple[
515
+ Annotated[StrictFloat, Field(gt=0)],
516
+ Annotated[StrictFloat, Field(gt=0)]
517
+ ]
518
+ ] = None,
519
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
520
+ _content_type: Optional[StrictStr] = None,
521
+ _headers: Optional[Dict[StrictStr, Any]] = None,
522
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
523
+ ) -> RESTResponseType:
524
+ """Clear Applications
525
+
526
+ Delete all GUI applications from the cell.
527
+
528
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
529
+ :type cell: str
530
+ :param completion_timeout:
531
+ :type completion_timeout: int
532
+ :param _request_timeout: timeout setting for this request. If one
533
+ number provided, it will be total request
534
+ timeout. It can also be a pair (tuple) of
535
+ (connection, read) timeouts.
536
+ :type _request_timeout: int, tuple(int, int), optional
537
+ :param _request_auth: set to override the auth_settings for an a single
538
+ request; this effectively ignores the
539
+ authentication in the spec for a single request.
540
+ :type _request_auth: dict, optional
541
+ :param _content_type: force content-type for the request.
542
+ :type _content_type: str, Optional
543
+ :param _headers: set to override the headers for a single
544
+ request; this effectively ignores the headers
545
+ in the spec for a single request.
546
+ :type _headers: dict, optional
547
+ :param _host_index: set to override the host_index for a single
548
+ request; this effectively ignores the host_index
549
+ in the spec for a single request.
550
+ :type _host_index: int, optional
551
+ :return: Returns the result object.
552
+ """ # noqa: E501
553
+
554
+ _param = self._clear_apps_serialize(
555
+ cell=cell,
556
+ completion_timeout=completion_timeout,
557
+ _request_auth=_request_auth,
558
+ _content_type=_content_type,
559
+ _headers=_headers,
560
+ _host_index=_host_index
561
+ )
562
+
563
+ _response_types_map: Dict[str, Optional[str]] = {
564
+ '200': None,
565
+ '202': None,
566
+ '404': "Error",
567
+ }
568
+
569
+
570
+ response_data = await self.api_client.call_api(
571
+ *_param,
572
+ _request_timeout=_request_timeout
573
+ )
574
+ return response_data.response
575
+
576
+
577
+ def _clear_apps_serialize(
578
+ self,
579
+ cell,
580
+ completion_timeout,
581
+ _request_auth,
582
+ _content_type,
583
+ _headers,
584
+ _host_index,
585
+ ) -> RequestSerialized:
586
+
587
+ _host = None
588
+
589
+ _collection_formats: Dict[str, str] = {
590
+ }
591
+
592
+ _path_params: Dict[str, str] = {}
593
+ _query_params: List[Tuple[str, str]] = []
594
+ _header_params: Dict[str, Optional[str]] = _headers or {}
595
+ _form_params: List[Tuple[str, str]] = []
596
+ _files: Dict[str, Union[str, bytes]] = {}
597
+ _body_params: Optional[bytes] = None
598
+
599
+ # process the path parameters
600
+ if cell is not None:
601
+ _path_params['cell'] = cell
602
+ # process the query parameters
603
+ if completion_timeout is not None:
604
+
605
+ _query_params.append(('completion_timeout', completion_timeout))
606
+
607
+ # process the header parameters
608
+ # process the form parameters
609
+ # process the body parameter
610
+
611
+
612
+ # set the HTTP header `Accept`
613
+ _header_params['Accept'] = self.api_client.select_header_accept(
614
+ [
615
+ 'application/json'
616
+ ]
617
+ )
618
+
619
+
620
+ # authentication setting
621
+ _auth_settings: List[str] = [
622
+ 'BasicAuth',
623
+ 'BearerAuth'
624
+ ]
625
+
626
+ return self.api_client.param_serialize(
627
+ method='DELETE',
628
+ resource_path='/cells/{cell}/apps',
629
+ path_params=_path_params,
630
+ query_params=_query_params,
631
+ header_params=_header_params,
632
+ body=_body_params,
633
+ post_params=_form_params,
634
+ files=_files,
635
+ auth_settings=_auth_settings,
636
+ collection_formats=_collection_formats,
637
+ _host=_host,
638
+ _request_auth=_request_auth
639
+ )
640
+
641
+
642
+
643
+ @validate_call
644
+ async def delete_app(
645
+ self,
646
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
647
+ app: StrictStr,
648
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
649
+ _request_timeout: Union[
650
+ None,
651
+ Annotated[StrictFloat, Field(gt=0)],
652
+ Tuple[
653
+ Annotated[StrictFloat, Field(gt=0)],
654
+ Annotated[StrictFloat, Field(gt=0)]
655
+ ]
656
+ ] = None,
657
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
658
+ _content_type: Optional[StrictStr] = None,
659
+ _headers: Optional[Dict[StrictStr, Any]] = None,
660
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
661
+ ) -> None:
662
+ """Delete Application
663
+
664
+ Delete a GUI application from the cell.
665
+
666
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
667
+ :type cell: str
668
+ :param app: (required)
669
+ :type app: str
670
+ :param completion_timeout:
671
+ :type completion_timeout: int
672
+ :param _request_timeout: timeout setting for this request. If one
673
+ number provided, it will be total request
674
+ timeout. It can also be a pair (tuple) of
675
+ (connection, read) timeouts.
676
+ :type _request_timeout: int, tuple(int, int), optional
677
+ :param _request_auth: set to override the auth_settings for an a single
678
+ request; this effectively ignores the
679
+ authentication in the spec for a single request.
680
+ :type _request_auth: dict, optional
681
+ :param _content_type: force content-type for the request.
682
+ :type _content_type: str, Optional
683
+ :param _headers: set to override the headers for a single
684
+ request; this effectively ignores the headers
685
+ in the spec for a single request.
686
+ :type _headers: dict, optional
687
+ :param _host_index: set to override the host_index for a single
688
+ request; this effectively ignores the host_index
689
+ in the spec for a single request.
690
+ :type _host_index: int, optional
691
+ :return: Returns the result object.
692
+ """ # noqa: E501
693
+
694
+ _param = self._delete_app_serialize(
695
+ cell=cell,
696
+ app=app,
697
+ completion_timeout=completion_timeout,
698
+ _request_auth=_request_auth,
699
+ _content_type=_content_type,
700
+ _headers=_headers,
701
+ _host_index=_host_index
702
+ )
703
+
704
+ _response_types_map: Dict[str, Optional[str]] = {
705
+ '200': None,
706
+ '202': None,
707
+ '404': "Error",
708
+ }
709
+
710
+
711
+ response_data = await self.api_client.call_api(
712
+ *_param,
713
+ _request_timeout=_request_timeout
714
+ )
715
+ await response_data.read()
716
+ return self.api_client.response_deserialize(
717
+ response_data=response_data,
718
+ response_types_map=_response_types_map,
719
+ ).data
720
+
721
+
722
+ @validate_call
723
+ async def delete_app_with_http_info(
724
+ self,
725
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
726
+ app: StrictStr,
727
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
728
+ _request_timeout: Union[
729
+ None,
730
+ Annotated[StrictFloat, Field(gt=0)],
731
+ Tuple[
732
+ Annotated[StrictFloat, Field(gt=0)],
733
+ Annotated[StrictFloat, Field(gt=0)]
734
+ ]
735
+ ] = None,
736
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
737
+ _content_type: Optional[StrictStr] = None,
738
+ _headers: Optional[Dict[StrictStr, Any]] = None,
739
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
740
+ ) -> ApiResponse[None]:
741
+ """Delete Application
742
+
743
+ Delete a GUI application from the cell.
744
+
745
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
746
+ :type cell: str
747
+ :param app: (required)
748
+ :type app: str
749
+ :param completion_timeout:
750
+ :type completion_timeout: int
751
+ :param _request_timeout: timeout setting for this request. If one
752
+ number provided, it will be total request
753
+ timeout. It can also be a pair (tuple) of
754
+ (connection, read) timeouts.
755
+ :type _request_timeout: int, tuple(int, int), optional
756
+ :param _request_auth: set to override the auth_settings for an a single
757
+ request; this effectively ignores the
758
+ authentication in the spec for a single request.
759
+ :type _request_auth: dict, optional
760
+ :param _content_type: force content-type for the request.
761
+ :type _content_type: str, Optional
762
+ :param _headers: set to override the headers for a single
763
+ request; this effectively ignores the headers
764
+ in the spec for a single request.
765
+ :type _headers: dict, optional
766
+ :param _host_index: set to override the host_index for a single
767
+ request; this effectively ignores the host_index
768
+ in the spec for a single request.
769
+ :type _host_index: int, optional
770
+ :return: Returns the result object.
771
+ """ # noqa: E501
772
+
773
+ _param = self._delete_app_serialize(
774
+ cell=cell,
775
+ app=app,
776
+ completion_timeout=completion_timeout,
777
+ _request_auth=_request_auth,
778
+ _content_type=_content_type,
779
+ _headers=_headers,
780
+ _host_index=_host_index
781
+ )
782
+
783
+ _response_types_map: Dict[str, Optional[str]] = {
784
+ '200': None,
785
+ '202': None,
786
+ '404': "Error",
787
+ }
788
+
789
+
790
+ response_data = await self.api_client.call_api(
791
+ *_param,
792
+ _request_timeout=_request_timeout
793
+ )
794
+ await response_data.read()
795
+ return self.api_client.response_deserialize(
796
+ response_data=response_data,
797
+ response_types_map=_response_types_map,
798
+ )
799
+
800
+
801
+ @validate_call
802
+ async def delete_app_without_preload_content(
803
+ self,
804
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
805
+ app: StrictStr,
806
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
807
+ _request_timeout: Union[
808
+ None,
809
+ Annotated[StrictFloat, Field(gt=0)],
810
+ Tuple[
811
+ Annotated[StrictFloat, Field(gt=0)],
812
+ Annotated[StrictFloat, Field(gt=0)]
813
+ ]
814
+ ] = None,
815
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
816
+ _content_type: Optional[StrictStr] = None,
817
+ _headers: Optional[Dict[StrictStr, Any]] = None,
818
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
819
+ ) -> RESTResponseType:
820
+ """Delete Application
821
+
822
+ Delete a GUI application from the cell.
823
+
824
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
825
+ :type cell: str
826
+ :param app: (required)
827
+ :type app: str
828
+ :param completion_timeout:
829
+ :type completion_timeout: int
830
+ :param _request_timeout: timeout setting for this request. If one
831
+ number provided, it will be total request
832
+ timeout. It can also be a pair (tuple) of
833
+ (connection, read) timeouts.
834
+ :type _request_timeout: int, tuple(int, int), optional
835
+ :param _request_auth: set to override the auth_settings for an a single
836
+ request; this effectively ignores the
837
+ authentication in the spec for a single request.
838
+ :type _request_auth: dict, optional
839
+ :param _content_type: force content-type for the request.
840
+ :type _content_type: str, Optional
841
+ :param _headers: set to override the headers for a single
842
+ request; this effectively ignores the headers
843
+ in the spec for a single request.
844
+ :type _headers: dict, optional
845
+ :param _host_index: set to override the host_index for a single
846
+ request; this effectively ignores the host_index
847
+ in the spec for a single request.
848
+ :type _host_index: int, optional
849
+ :return: Returns the result object.
850
+ """ # noqa: E501
851
+
852
+ _param = self._delete_app_serialize(
853
+ cell=cell,
854
+ app=app,
855
+ completion_timeout=completion_timeout,
856
+ _request_auth=_request_auth,
857
+ _content_type=_content_type,
858
+ _headers=_headers,
859
+ _host_index=_host_index
860
+ )
861
+
862
+ _response_types_map: Dict[str, Optional[str]] = {
863
+ '200': None,
864
+ '202': None,
865
+ '404': "Error",
866
+ }
867
+
868
+
869
+ response_data = await self.api_client.call_api(
870
+ *_param,
871
+ _request_timeout=_request_timeout
872
+ )
873
+ return response_data.response
874
+
875
+
876
+ def _delete_app_serialize(
877
+ self,
878
+ cell,
879
+ app,
880
+ completion_timeout,
881
+ _request_auth,
882
+ _content_type,
883
+ _headers,
884
+ _host_index,
885
+ ) -> RequestSerialized:
886
+
887
+ _host = None
888
+
889
+ _collection_formats: Dict[str, str] = {
890
+ }
891
+
892
+ _path_params: Dict[str, str] = {}
893
+ _query_params: List[Tuple[str, str]] = []
894
+ _header_params: Dict[str, Optional[str]] = _headers or {}
895
+ _form_params: List[Tuple[str, str]] = []
896
+ _files: Dict[str, Union[str, bytes]] = {}
897
+ _body_params: Optional[bytes] = None
898
+
899
+ # process the path parameters
900
+ if cell is not None:
901
+ _path_params['cell'] = cell
902
+ if app is not None:
903
+ _path_params['app'] = app
904
+ # process the query parameters
905
+ if completion_timeout is not None:
906
+
907
+ _query_params.append(('completion_timeout', completion_timeout))
908
+
909
+ # process the header parameters
910
+ # process the form parameters
911
+ # process the body parameter
912
+
913
+
914
+ # set the HTTP header `Accept`
915
+ _header_params['Accept'] = self.api_client.select_header_accept(
916
+ [
917
+ 'application/json'
918
+ ]
919
+ )
920
+
921
+
922
+ # authentication setting
923
+ _auth_settings: List[str] = [
924
+ 'BasicAuth',
925
+ 'BearerAuth'
926
+ ]
927
+
928
+ return self.api_client.param_serialize(
929
+ method='DELETE',
930
+ resource_path='/cells/{cell}/apps/{app}',
931
+ path_params=_path_params,
932
+ query_params=_query_params,
933
+ header_params=_header_params,
934
+ body=_body_params,
935
+ post_params=_form_params,
936
+ files=_files,
937
+ auth_settings=_auth_settings,
938
+ collection_formats=_collection_formats,
939
+ _host=_host,
940
+ _request_auth=_request_auth
941
+ )
942
+
943
+
944
+
945
+ @validate_call
946
+ async def get_app(
947
+ self,
948
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
949
+ app: StrictStr,
950
+ _request_timeout: Union[
951
+ None,
952
+ Annotated[StrictFloat, Field(gt=0)],
953
+ Tuple[
954
+ Annotated[StrictFloat, Field(gt=0)],
955
+ Annotated[StrictFloat, Field(gt=0)]
956
+ ]
957
+ ] = None,
958
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
959
+ _content_type: Optional[StrictStr] = None,
960
+ _headers: Optional[Dict[StrictStr, Any]] = None,
961
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
962
+ ) -> App:
963
+ """Configuration
964
+
965
+ Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
966
+
967
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
968
+ :type cell: str
969
+ :param app: (required)
970
+ :type app: str
971
+ :param _request_timeout: timeout setting for this request. If one
972
+ number provided, it will be total request
973
+ timeout. It can also be a pair (tuple) of
974
+ (connection, read) timeouts.
975
+ :type _request_timeout: int, tuple(int, int), optional
976
+ :param _request_auth: set to override the auth_settings for an a single
977
+ request; this effectively ignores the
978
+ authentication in the spec for a single request.
979
+ :type _request_auth: dict, optional
980
+ :param _content_type: force content-type for the request.
981
+ :type _content_type: str, Optional
982
+ :param _headers: set to override the headers for a single
983
+ request; this effectively ignores the headers
984
+ in the spec for a single request.
985
+ :type _headers: dict, optional
986
+ :param _host_index: set to override the host_index for a single
987
+ request; this effectively ignores the host_index
988
+ in the spec for a single request.
989
+ :type _host_index: int, optional
990
+ :return: Returns the result object.
991
+ """ # noqa: E501
992
+
993
+ _param = self._get_app_serialize(
994
+ cell=cell,
995
+ app=app,
996
+ _request_auth=_request_auth,
997
+ _content_type=_content_type,
998
+ _headers=_headers,
999
+ _host_index=_host_index
1000
+ )
1001
+
1002
+ _response_types_map: Dict[str, Optional[str]] = {
1003
+ '200': "App",
1004
+ '404': "Error",
1005
+ }
1006
+
1007
+
1008
+ response_data = await self.api_client.call_api(
1009
+ *_param,
1010
+ _request_timeout=_request_timeout
1011
+ )
1012
+ await response_data.read()
1013
+ return self.api_client.response_deserialize(
1014
+ response_data=response_data,
1015
+ response_types_map=_response_types_map,
1016
+ ).data
1017
+
1018
+
1019
+ @validate_call
1020
+ async def get_app_with_http_info(
1021
+ self,
1022
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1023
+ app: StrictStr,
1024
+ _request_timeout: Union[
1025
+ None,
1026
+ Annotated[StrictFloat, Field(gt=0)],
1027
+ Tuple[
1028
+ Annotated[StrictFloat, Field(gt=0)],
1029
+ Annotated[StrictFloat, Field(gt=0)]
1030
+ ]
1031
+ ] = None,
1032
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1033
+ _content_type: Optional[StrictStr] = None,
1034
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1035
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1036
+ ) -> ApiResponse[App]:
1037
+ """Configuration
1038
+
1039
+ Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
1040
+
1041
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1042
+ :type cell: str
1043
+ :param app: (required)
1044
+ :type app: str
1045
+ :param _request_timeout: timeout setting for this request. If one
1046
+ number provided, it will be total request
1047
+ timeout. It can also be a pair (tuple) of
1048
+ (connection, read) timeouts.
1049
+ :type _request_timeout: int, tuple(int, int), optional
1050
+ :param _request_auth: set to override the auth_settings for an a single
1051
+ request; this effectively ignores the
1052
+ authentication in the spec for a single request.
1053
+ :type _request_auth: dict, optional
1054
+ :param _content_type: force content-type for the request.
1055
+ :type _content_type: str, Optional
1056
+ :param _headers: set to override the headers for a single
1057
+ request; this effectively ignores the headers
1058
+ in the spec for a single request.
1059
+ :type _headers: dict, optional
1060
+ :param _host_index: set to override the host_index for a single
1061
+ request; this effectively ignores the host_index
1062
+ in the spec for a single request.
1063
+ :type _host_index: int, optional
1064
+ :return: Returns the result object.
1065
+ """ # noqa: E501
1066
+
1067
+ _param = self._get_app_serialize(
1068
+ cell=cell,
1069
+ app=app,
1070
+ _request_auth=_request_auth,
1071
+ _content_type=_content_type,
1072
+ _headers=_headers,
1073
+ _host_index=_host_index
1074
+ )
1075
+
1076
+ _response_types_map: Dict[str, Optional[str]] = {
1077
+ '200': "App",
1078
+ '404': "Error",
1079
+ }
1080
+
1081
+
1082
+ response_data = await self.api_client.call_api(
1083
+ *_param,
1084
+ _request_timeout=_request_timeout
1085
+ )
1086
+ await response_data.read()
1087
+ return self.api_client.response_deserialize(
1088
+ response_data=response_data,
1089
+ response_types_map=_response_types_map,
1090
+ )
1091
+
1092
+
1093
+ @validate_call
1094
+ async def get_app_without_preload_content(
1095
+ self,
1096
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1097
+ app: StrictStr,
1098
+ _request_timeout: Union[
1099
+ None,
1100
+ Annotated[StrictFloat, Field(gt=0)],
1101
+ Tuple[
1102
+ Annotated[StrictFloat, Field(gt=0)],
1103
+ Annotated[StrictFloat, Field(gt=0)]
1104
+ ]
1105
+ ] = None,
1106
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1107
+ _content_type: Optional[StrictStr] = None,
1108
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1109
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1110
+ ) -> RESTResponseType:
1111
+ """Configuration
1112
+
1113
+ Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
1114
+
1115
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1116
+ :type cell: str
1117
+ :param app: (required)
1118
+ :type app: str
1119
+ :param _request_timeout: timeout setting for this request. If one
1120
+ number provided, it will be total request
1121
+ timeout. It can also be a pair (tuple) of
1122
+ (connection, read) timeouts.
1123
+ :type _request_timeout: int, tuple(int, int), optional
1124
+ :param _request_auth: set to override the auth_settings for an a single
1125
+ request; this effectively ignores the
1126
+ authentication in the spec for a single request.
1127
+ :type _request_auth: dict, optional
1128
+ :param _content_type: force content-type for the request.
1129
+ :type _content_type: str, Optional
1130
+ :param _headers: set to override the headers for a single
1131
+ request; this effectively ignores the headers
1132
+ in the spec for a single request.
1133
+ :type _headers: dict, optional
1134
+ :param _host_index: set to override the host_index for a single
1135
+ request; this effectively ignores the host_index
1136
+ in the spec for a single request.
1137
+ :type _host_index: int, optional
1138
+ :return: Returns the result object.
1139
+ """ # noqa: E501
1140
+
1141
+ _param = self._get_app_serialize(
1142
+ cell=cell,
1143
+ app=app,
1144
+ _request_auth=_request_auth,
1145
+ _content_type=_content_type,
1146
+ _headers=_headers,
1147
+ _host_index=_host_index
1148
+ )
1149
+
1150
+ _response_types_map: Dict[str, Optional[str]] = {
1151
+ '200': "App",
1152
+ '404': "Error",
1153
+ }
1154
+
1155
+
1156
+ response_data = await self.api_client.call_api(
1157
+ *_param,
1158
+ _request_timeout=_request_timeout
1159
+ )
1160
+ return response_data.response
1161
+
1162
+
1163
+ def _get_app_serialize(
1164
+ self,
1165
+ cell,
1166
+ app,
1167
+ _request_auth,
1168
+ _content_type,
1169
+ _headers,
1170
+ _host_index,
1171
+ ) -> RequestSerialized:
1172
+
1173
+ _host = None
1174
+
1175
+ _collection_formats: Dict[str, str] = {
1176
+ }
1177
+
1178
+ _path_params: Dict[str, str] = {}
1179
+ _query_params: List[Tuple[str, str]] = []
1180
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1181
+ _form_params: List[Tuple[str, str]] = []
1182
+ _files: Dict[str, Union[str, bytes]] = {}
1183
+ _body_params: Optional[bytes] = None
1184
+
1185
+ # process the path parameters
1186
+ if cell is not None:
1187
+ _path_params['cell'] = cell
1188
+ if app is not None:
1189
+ _path_params['app'] = app
1190
+ # process the query parameters
1191
+ # process the header parameters
1192
+ # process the form parameters
1193
+ # process the body parameter
1194
+
1195
+
1196
+ # set the HTTP header `Accept`
1197
+ _header_params['Accept'] = self.api_client.select_header_accept(
1198
+ [
1199
+ 'application/json'
1200
+ ]
1201
+ )
1202
+
1203
+
1204
+ # authentication setting
1205
+ _auth_settings: List[str] = [
1206
+ 'BasicAuth',
1207
+ 'BearerAuth'
1208
+ ]
1209
+
1210
+ return self.api_client.param_serialize(
1211
+ method='GET',
1212
+ resource_path='/cells/{cell}/apps/{app}',
1213
+ path_params=_path_params,
1214
+ query_params=_query_params,
1215
+ header_params=_header_params,
1216
+ body=_body_params,
1217
+ post_params=_form_params,
1218
+ files=_files,
1219
+ auth_settings=_auth_settings,
1220
+ collection_formats=_collection_formats,
1221
+ _host=_host,
1222
+ _request_auth=_request_auth
1223
+ )
1224
+
1225
+
1226
+
1227
+ @validate_call
1228
+ async def list_apps(
1229
+ self,
1230
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1231
+ _request_timeout: Union[
1232
+ None,
1233
+ Annotated[StrictFloat, Field(gt=0)],
1234
+ Tuple[
1235
+ Annotated[StrictFloat, Field(gt=0)],
1236
+ Annotated[StrictFloat, Field(gt=0)]
1237
+ ]
1238
+ ] = None,
1239
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1240
+ _content_type: Optional[StrictStr] = None,
1241
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1242
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1243
+ ) -> List[str]:
1244
+ """List Applications
1245
+
1246
+ List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
1247
+
1248
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1249
+ :type cell: str
1250
+ :param _request_timeout: timeout setting for this request. If one
1251
+ number provided, it will be total request
1252
+ timeout. It can also be a pair (tuple) of
1253
+ (connection, read) timeouts.
1254
+ :type _request_timeout: int, tuple(int, int), optional
1255
+ :param _request_auth: set to override the auth_settings for an a single
1256
+ request; this effectively ignores the
1257
+ authentication in the spec for a single request.
1258
+ :type _request_auth: dict, optional
1259
+ :param _content_type: force content-type for the request.
1260
+ :type _content_type: str, Optional
1261
+ :param _headers: set to override the headers for a single
1262
+ request; this effectively ignores the headers
1263
+ in the spec for a single request.
1264
+ :type _headers: dict, optional
1265
+ :param _host_index: set to override the host_index for a single
1266
+ request; this effectively ignores the host_index
1267
+ in the spec for a single request.
1268
+ :type _host_index: int, optional
1269
+ :return: Returns the result object.
1270
+ """ # noqa: E501
1271
+
1272
+ _param = self._list_apps_serialize(
1273
+ cell=cell,
1274
+ _request_auth=_request_auth,
1275
+ _content_type=_content_type,
1276
+ _headers=_headers,
1277
+ _host_index=_host_index
1278
+ )
1279
+
1280
+ _response_types_map: Dict[str, Optional[str]] = {
1281
+ '200': "List[str]",
1282
+ }
1283
+
1284
+
1285
+ response_data = await self.api_client.call_api(
1286
+ *_param,
1287
+ _request_timeout=_request_timeout
1288
+ )
1289
+ await response_data.read()
1290
+ return self.api_client.response_deserialize(
1291
+ response_data=response_data,
1292
+ response_types_map=_response_types_map,
1293
+ ).data
1294
+
1295
+
1296
+ @validate_call
1297
+ async def list_apps_with_http_info(
1298
+ self,
1299
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1300
+ _request_timeout: Union[
1301
+ None,
1302
+ Annotated[StrictFloat, Field(gt=0)],
1303
+ Tuple[
1304
+ Annotated[StrictFloat, Field(gt=0)],
1305
+ Annotated[StrictFloat, Field(gt=0)]
1306
+ ]
1307
+ ] = None,
1308
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1309
+ _content_type: Optional[StrictStr] = None,
1310
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1311
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1312
+ ) -> ApiResponse[List[str]]:
1313
+ """List Applications
1314
+
1315
+ List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
1316
+
1317
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1318
+ :type cell: str
1319
+ :param _request_timeout: timeout setting for this request. If one
1320
+ number provided, it will be total request
1321
+ timeout. It can also be a pair (tuple) of
1322
+ (connection, read) timeouts.
1323
+ :type _request_timeout: int, tuple(int, int), optional
1324
+ :param _request_auth: set to override the auth_settings for an a single
1325
+ request; this effectively ignores the
1326
+ authentication in the spec for a single request.
1327
+ :type _request_auth: dict, optional
1328
+ :param _content_type: force content-type for the request.
1329
+ :type _content_type: str, Optional
1330
+ :param _headers: set to override the headers for a single
1331
+ request; this effectively ignores the headers
1332
+ in the spec for a single request.
1333
+ :type _headers: dict, optional
1334
+ :param _host_index: set to override the host_index for a single
1335
+ request; this effectively ignores the host_index
1336
+ in the spec for a single request.
1337
+ :type _host_index: int, optional
1338
+ :return: Returns the result object.
1339
+ """ # noqa: E501
1340
+
1341
+ _param = self._list_apps_serialize(
1342
+ cell=cell,
1343
+ _request_auth=_request_auth,
1344
+ _content_type=_content_type,
1345
+ _headers=_headers,
1346
+ _host_index=_host_index
1347
+ )
1348
+
1349
+ _response_types_map: Dict[str, Optional[str]] = {
1350
+ '200': "List[str]",
1351
+ }
1352
+
1353
+
1354
+ response_data = await self.api_client.call_api(
1355
+ *_param,
1356
+ _request_timeout=_request_timeout
1357
+ )
1358
+ await response_data.read()
1359
+ return self.api_client.response_deserialize(
1360
+ response_data=response_data,
1361
+ response_types_map=_response_types_map,
1362
+ )
1363
+
1364
+
1365
+ @validate_call
1366
+ async def list_apps_without_preload_content(
1367
+ self,
1368
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1369
+ _request_timeout: Union[
1370
+ None,
1371
+ Annotated[StrictFloat, Field(gt=0)],
1372
+ Tuple[
1373
+ Annotated[StrictFloat, Field(gt=0)],
1374
+ Annotated[StrictFloat, Field(gt=0)]
1375
+ ]
1376
+ ] = None,
1377
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1378
+ _content_type: Optional[StrictStr] = None,
1379
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1380
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1381
+ ) -> RESTResponseType:
1382
+ """List Applications
1383
+
1384
+ List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
1385
+
1386
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1387
+ :type cell: str
1388
+ :param _request_timeout: timeout setting for this request. If one
1389
+ number provided, it will be total request
1390
+ timeout. It can also be a pair (tuple) of
1391
+ (connection, read) timeouts.
1392
+ :type _request_timeout: int, tuple(int, int), optional
1393
+ :param _request_auth: set to override the auth_settings for an a single
1394
+ request; this effectively ignores the
1395
+ authentication in the spec for a single request.
1396
+ :type _request_auth: dict, optional
1397
+ :param _content_type: force content-type for the request.
1398
+ :type _content_type: str, Optional
1399
+ :param _headers: set to override the headers for a single
1400
+ request; this effectively ignores the headers
1401
+ in the spec for a single request.
1402
+ :type _headers: dict, optional
1403
+ :param _host_index: set to override the host_index for a single
1404
+ request; this effectively ignores the host_index
1405
+ in the spec for a single request.
1406
+ :type _host_index: int, optional
1407
+ :return: Returns the result object.
1408
+ """ # noqa: E501
1409
+
1410
+ _param = self._list_apps_serialize(
1411
+ cell=cell,
1412
+ _request_auth=_request_auth,
1413
+ _content_type=_content_type,
1414
+ _headers=_headers,
1415
+ _host_index=_host_index
1416
+ )
1417
+
1418
+ _response_types_map: Dict[str, Optional[str]] = {
1419
+ '200': "List[str]",
1420
+ }
1421
+
1422
+
1423
+ response_data = await self.api_client.call_api(
1424
+ *_param,
1425
+ _request_timeout=_request_timeout
1426
+ )
1427
+ return response_data.response
1428
+
1429
+
1430
+ def _list_apps_serialize(
1431
+ self,
1432
+ cell,
1433
+ _request_auth,
1434
+ _content_type,
1435
+ _headers,
1436
+ _host_index,
1437
+ ) -> RequestSerialized:
1438
+
1439
+ _host = None
1440
+
1441
+ _collection_formats: Dict[str, str] = {
1442
+ }
1443
+
1444
+ _path_params: Dict[str, str] = {}
1445
+ _query_params: List[Tuple[str, str]] = []
1446
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1447
+ _form_params: List[Tuple[str, str]] = []
1448
+ _files: Dict[str, Union[str, bytes]] = {}
1449
+ _body_params: Optional[bytes] = None
1450
+
1451
+ # process the path parameters
1452
+ if cell is not None:
1453
+ _path_params['cell'] = cell
1454
+ # process the query parameters
1455
+ # process the header parameters
1456
+ # process the form parameters
1457
+ # process the body parameter
1458
+
1459
+
1460
+ # set the HTTP header `Accept`
1461
+ _header_params['Accept'] = self.api_client.select_header_accept(
1462
+ [
1463
+ 'application/json'
1464
+ ]
1465
+ )
1466
+
1467
+
1468
+ # authentication setting
1469
+ _auth_settings: List[str] = [
1470
+ 'BasicAuth',
1471
+ 'BearerAuth'
1472
+ ]
1473
+
1474
+ return self.api_client.param_serialize(
1475
+ method='GET',
1476
+ resource_path='/cells/{cell}/apps',
1477
+ path_params=_path_params,
1478
+ query_params=_query_params,
1479
+ header_params=_header_params,
1480
+ body=_body_params,
1481
+ post_params=_form_params,
1482
+ files=_files,
1483
+ auth_settings=_auth_settings,
1484
+ collection_formats=_collection_formats,
1485
+ _host=_host,
1486
+ _request_auth=_request_auth
1487
+ )
1488
+
1489
+
1490
+
1491
+ @validate_call
1492
+ async def update_app(
1493
+ self,
1494
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1495
+ app: StrictStr,
1496
+ app2: App,
1497
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
1498
+ _request_timeout: Union[
1499
+ None,
1500
+ Annotated[StrictFloat, Field(gt=0)],
1501
+ Tuple[
1502
+ Annotated[StrictFloat, Field(gt=0)],
1503
+ Annotated[StrictFloat, Field(gt=0)]
1504
+ ]
1505
+ ] = None,
1506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1507
+ _content_type: Optional[StrictStr] = None,
1508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1510
+ ) -> None:
1511
+ """Update Configuration
1512
+
1513
+ Update the configuration of a GUI application in the cell.
1514
+
1515
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1516
+ :type cell: str
1517
+ :param app: (required)
1518
+ :type app: str
1519
+ :param app2: (required)
1520
+ :type app2: App
1521
+ :param completion_timeout:
1522
+ :type completion_timeout: int
1523
+ :param _request_timeout: timeout setting for this request. If one
1524
+ number provided, it will be total request
1525
+ timeout. It can also be a pair (tuple) of
1526
+ (connection, read) timeouts.
1527
+ :type _request_timeout: int, tuple(int, int), optional
1528
+ :param _request_auth: set to override the auth_settings for an a single
1529
+ request; this effectively ignores the
1530
+ authentication in the spec for a single request.
1531
+ :type _request_auth: dict, optional
1532
+ :param _content_type: force content-type for the request.
1533
+ :type _content_type: str, Optional
1534
+ :param _headers: set to override the headers for a single
1535
+ request; this effectively ignores the headers
1536
+ in the spec for a single request.
1537
+ :type _headers: dict, optional
1538
+ :param _host_index: set to override the host_index for a single
1539
+ request; this effectively ignores the host_index
1540
+ in the spec for a single request.
1541
+ :type _host_index: int, optional
1542
+ :return: Returns the result object.
1543
+ """ # noqa: E501
1544
+
1545
+ _param = self._update_app_serialize(
1546
+ cell=cell,
1547
+ app=app,
1548
+ app2=app2,
1549
+ completion_timeout=completion_timeout,
1550
+ _request_auth=_request_auth,
1551
+ _content_type=_content_type,
1552
+ _headers=_headers,
1553
+ _host_index=_host_index
1554
+ )
1555
+
1556
+ _response_types_map: Dict[str, Optional[str]] = {
1557
+ '200': None,
1558
+ '202': None,
1559
+ '400': "Error",
1560
+ '404': "Error",
1561
+ }
1562
+
1563
+
1564
+ response_data = await self.api_client.call_api(
1565
+ *_param,
1566
+ _request_timeout=_request_timeout
1567
+ )
1568
+ await response_data.read()
1569
+ return self.api_client.response_deserialize(
1570
+ response_data=response_data,
1571
+ response_types_map=_response_types_map,
1572
+ ).data
1573
+
1574
+
1575
+ @validate_call
1576
+ async def update_app_with_http_info(
1577
+ self,
1578
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1579
+ app: StrictStr,
1580
+ app2: App,
1581
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
1582
+ _request_timeout: Union[
1583
+ None,
1584
+ Annotated[StrictFloat, Field(gt=0)],
1585
+ Tuple[
1586
+ Annotated[StrictFloat, Field(gt=0)],
1587
+ Annotated[StrictFloat, Field(gt=0)]
1588
+ ]
1589
+ ] = None,
1590
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1591
+ _content_type: Optional[StrictStr] = None,
1592
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1593
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1594
+ ) -> ApiResponse[None]:
1595
+ """Update Configuration
1596
+
1597
+ Update the configuration of a GUI application in the cell.
1598
+
1599
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1600
+ :type cell: str
1601
+ :param app: (required)
1602
+ :type app: str
1603
+ :param app2: (required)
1604
+ :type app2: App
1605
+ :param completion_timeout:
1606
+ :type completion_timeout: int
1607
+ :param _request_timeout: timeout setting for this request. If one
1608
+ number provided, it will be total request
1609
+ timeout. It can also be a pair (tuple) of
1610
+ (connection, read) timeouts.
1611
+ :type _request_timeout: int, tuple(int, int), optional
1612
+ :param _request_auth: set to override the auth_settings for an a single
1613
+ request; this effectively ignores the
1614
+ authentication in the spec for a single request.
1615
+ :type _request_auth: dict, optional
1616
+ :param _content_type: force content-type for the request.
1617
+ :type _content_type: str, Optional
1618
+ :param _headers: set to override the headers for a single
1619
+ request; this effectively ignores the headers
1620
+ in the spec for a single request.
1621
+ :type _headers: dict, optional
1622
+ :param _host_index: set to override the host_index for a single
1623
+ request; this effectively ignores the host_index
1624
+ in the spec for a single request.
1625
+ :type _host_index: int, optional
1626
+ :return: Returns the result object.
1627
+ """ # noqa: E501
1628
+
1629
+ _param = self._update_app_serialize(
1630
+ cell=cell,
1631
+ app=app,
1632
+ app2=app2,
1633
+ completion_timeout=completion_timeout,
1634
+ _request_auth=_request_auth,
1635
+ _content_type=_content_type,
1636
+ _headers=_headers,
1637
+ _host_index=_host_index
1638
+ )
1639
+
1640
+ _response_types_map: Dict[str, Optional[str]] = {
1641
+ '200': None,
1642
+ '202': None,
1643
+ '400': "Error",
1644
+ '404': "Error",
1645
+ }
1646
+
1647
+
1648
+ response_data = await self.api_client.call_api(
1649
+ *_param,
1650
+ _request_timeout=_request_timeout
1651
+ )
1652
+ await response_data.read()
1653
+ return self.api_client.response_deserialize(
1654
+ response_data=response_data,
1655
+ response_types_map=_response_types_map,
1656
+ )
1657
+
1658
+
1659
+ @validate_call
1660
+ async def update_app_without_preload_content(
1661
+ self,
1662
+ cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
1663
+ app: StrictStr,
1664
+ app2: App,
1665
+ completion_timeout: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
1666
+ _request_timeout: Union[
1667
+ None,
1668
+ Annotated[StrictFloat, Field(gt=0)],
1669
+ Tuple[
1670
+ Annotated[StrictFloat, Field(gt=0)],
1671
+ Annotated[StrictFloat, Field(gt=0)]
1672
+ ]
1673
+ ] = None,
1674
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1675
+ _content_type: Optional[StrictStr] = None,
1676
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1677
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1678
+ ) -> RESTResponseType:
1679
+ """Update Configuration
1680
+
1681
+ Update the configuration of a GUI application in the cell.
1682
+
1683
+ :param cell: Unique identifier addressing a cell in all API calls. (required)
1684
+ :type cell: str
1685
+ :param app: (required)
1686
+ :type app: str
1687
+ :param app2: (required)
1688
+ :type app2: App
1689
+ :param completion_timeout:
1690
+ :type completion_timeout: int
1691
+ :param _request_timeout: timeout setting for this request. If one
1692
+ number provided, it will be total request
1693
+ timeout. It can also be a pair (tuple) of
1694
+ (connection, read) timeouts.
1695
+ :type _request_timeout: int, tuple(int, int), optional
1696
+ :param _request_auth: set to override the auth_settings for an a single
1697
+ request; this effectively ignores the
1698
+ authentication in the spec for a single request.
1699
+ :type _request_auth: dict, optional
1700
+ :param _content_type: force content-type for the request.
1701
+ :type _content_type: str, Optional
1702
+ :param _headers: set to override the headers for a single
1703
+ request; this effectively ignores the headers
1704
+ in the spec for a single request.
1705
+ :type _headers: dict, optional
1706
+ :param _host_index: set to override the host_index for a single
1707
+ request; this effectively ignores the host_index
1708
+ in the spec for a single request.
1709
+ :type _host_index: int, optional
1710
+ :return: Returns the result object.
1711
+ """ # noqa: E501
1712
+
1713
+ _param = self._update_app_serialize(
1714
+ cell=cell,
1715
+ app=app,
1716
+ app2=app2,
1717
+ completion_timeout=completion_timeout,
1718
+ _request_auth=_request_auth,
1719
+ _content_type=_content_type,
1720
+ _headers=_headers,
1721
+ _host_index=_host_index
1722
+ )
1723
+
1724
+ _response_types_map: Dict[str, Optional[str]] = {
1725
+ '200': None,
1726
+ '202': None,
1727
+ '400': "Error",
1728
+ '404': "Error",
1729
+ }
1730
+
1731
+
1732
+ response_data = await self.api_client.call_api(
1733
+ *_param,
1734
+ _request_timeout=_request_timeout
1735
+ )
1736
+ return response_data.response
1737
+
1738
+
1739
+ def _update_app_serialize(
1740
+ self,
1741
+ cell,
1742
+ app,
1743
+ app2,
1744
+ completion_timeout,
1745
+ _request_auth,
1746
+ _content_type,
1747
+ _headers,
1748
+ _host_index,
1749
+ ) -> RequestSerialized:
1750
+
1751
+ _host = None
1752
+
1753
+ _collection_formats: Dict[str, str] = {
1754
+ }
1755
+
1756
+ _path_params: Dict[str, str] = {}
1757
+ _query_params: List[Tuple[str, str]] = []
1758
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1759
+ _form_params: List[Tuple[str, str]] = []
1760
+ _files: Dict[str, Union[str, bytes]] = {}
1761
+ _body_params: Optional[bytes] = None
1762
+
1763
+ # process the path parameters
1764
+ if cell is not None:
1765
+ _path_params['cell'] = cell
1766
+ if app is not None:
1767
+ _path_params['app'] = app
1768
+ # process the query parameters
1769
+ if completion_timeout is not None:
1770
+
1771
+ _query_params.append(('completion_timeout', completion_timeout))
1772
+
1773
+ # process the header parameters
1774
+ # process the form parameters
1775
+ # process the body parameter
1776
+ if app2 is not None:
1777
+ _body_params = app2
1778
+
1779
+
1780
+ # set the HTTP header `Accept`
1781
+ _header_params['Accept'] = self.api_client.select_header_accept(
1782
+ [
1783
+ 'application/json'
1784
+ ]
1785
+ )
1786
+
1787
+ # set the HTTP header `Content-Type`
1788
+ if _content_type:
1789
+ _header_params['Content-Type'] = _content_type
1790
+ else:
1791
+ _default_content_type = (
1792
+ self.api_client.select_header_content_type(
1793
+ [
1794
+ 'application/json'
1795
+ ]
1796
+ )
1797
+ )
1798
+ if _default_content_type is not None:
1799
+ _header_params['Content-Type'] = _default_content_type
1800
+
1801
+ # authentication setting
1802
+ _auth_settings: List[str] = [
1803
+ 'BasicAuth',
1804
+ 'BearerAuth'
1805
+ ]
1806
+
1807
+ return self.api_client.param_serialize(
1808
+ method='PUT',
1809
+ resource_path='/cells/{cell}/apps/{app}',
1810
+ path_params=_path_params,
1811
+ query_params=_query_params,
1812
+ header_params=_header_params,
1813
+ body=_body_params,
1814
+ post_params=_form_params,
1815
+ files=_files,
1816
+ auth_settings=_auth_settings,
1817
+ collection_formats=_collection_formats,
1818
+ _host=_host,
1819
+ _request_auth=_request_auth
1820
+ )
1821
+
1822
+