cosmotech-api 3.2.0__2-py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cosmotech-api might be problematic. Click here for more details.

Files changed (255) hide show
  1. cosmotech_api/__init__.py +153 -0
  2. cosmotech_api/api/__init__.py +14 -0
  3. cosmotech_api/api/connector_api.py +1351 -0
  4. cosmotech_api/api/dataset_api.py +9148 -0
  5. cosmotech_api/api/organization_api.py +4692 -0
  6. cosmotech_api/api/run_api.py +2227 -0
  7. cosmotech_api/api/runner_api.py +4551 -0
  8. cosmotech_api/api/scenario_api.py +6688 -0
  9. cosmotech_api/api/scenariorun_api.py +4092 -0
  10. cosmotech_api/api/scenariorunresult_api.py +704 -0
  11. cosmotech_api/api/solution_api.py +6472 -0
  12. cosmotech_api/api/twingraph_api.py +4201 -0
  13. cosmotech_api/api/user_api.py +1291 -0
  14. cosmotech_api/api/validator_api.py +2566 -0
  15. cosmotech_api/api/workspace_api.py +6123 -0
  16. cosmotech_api/api_client.py +759 -0
  17. cosmotech_api/api_response.py +21 -0
  18. cosmotech_api/apis/__init__.py +28 -0
  19. cosmotech_api/configuration.py +453 -0
  20. cosmotech_api/exceptions.py +200 -0
  21. cosmotech_api/model/__init__.py +5 -0
  22. cosmotech_api/model/component_role_permissions.py +260 -0
  23. cosmotech_api/model/connector.py +330 -0
  24. cosmotech_api/model/connector_parameter.py +284 -0
  25. cosmotech_api/model/connector_parameter_group.py +280 -0
  26. cosmotech_api/model/container_resource_size_info.py +268 -0
  27. cosmotech_api/model/container_resource_sizing.py +274 -0
  28. cosmotech_api/model/dataset.py +376 -0
  29. cosmotech_api/model/dataset_access_control.py +268 -0
  30. cosmotech_api/model/dataset_compatibility.py +270 -0
  31. cosmotech_api/model/dataset_connector.py +268 -0
  32. cosmotech_api/model/dataset_copy_parameters.py +264 -0
  33. cosmotech_api/model/dataset_role.py +262 -0
  34. cosmotech_api/model/dataset_search.py +262 -0
  35. cosmotech_api/model/dataset_security.py +274 -0
  36. cosmotech_api/model/dataset_source_type.py +287 -0
  37. cosmotech_api/model/dataset_twin_graph_hash.py +256 -0
  38. cosmotech_api/model/dataset_twin_graph_info.py +264 -0
  39. cosmotech_api/model/dataset_twin_graph_query.py +262 -0
  40. cosmotech_api/model/delete_historical_data.py +272 -0
  41. cosmotech_api/model/file_upload_metadata.py +260 -0
  42. cosmotech_api/model/file_upload_validation.py +266 -0
  43. cosmotech_api/model/graph_properties.py +272 -0
  44. cosmotech_api/model/organization.py +282 -0
  45. cosmotech_api/model/organization_access_control.py +268 -0
  46. cosmotech_api/model/organization_role.py +262 -0
  47. cosmotech_api/model/organization_security.py +274 -0
  48. cosmotech_api/model/organization_service.py +272 -0
  49. cosmotech_api/model/organization_services.py +270 -0
  50. cosmotech_api/model/organization_user.py +277 -0
  51. cosmotech_api/model/resource_size_info.py +268 -0
  52. cosmotech_api/model/run.py +351 -0
  53. cosmotech_api/model/run_container.py +318 -0
  54. cosmotech_api/model/run_container_artifact.py +260 -0
  55. cosmotech_api/model/run_container_logs.py +272 -0
  56. cosmotech_api/model/run_logs.py +268 -0
  57. cosmotech_api/model/run_resource_requested.py +260 -0
  58. cosmotech_api/model/run_search.py +296 -0
  59. cosmotech_api/model/run_start_containers.py +286 -0
  60. cosmotech_api/model/run_state.py +285 -0
  61. cosmotech_api/model/run_status.py +316 -0
  62. cosmotech_api/model/run_status_node.py +307 -0
  63. cosmotech_api/model/run_template.py +408 -0
  64. cosmotech_api/model/run_template_handler_id.py +287 -0
  65. cosmotech_api/model/run_template_orchestrator.py +283 -0
  66. cosmotech_api/model/run_template_parameter.py +296 -0
  67. cosmotech_api/model/run_template_parameter_group.py +288 -0
  68. cosmotech_api/model/run_template_parameter_value.py +273 -0
  69. cosmotech_api/model/run_template_resource_sizing.py +274 -0
  70. cosmotech_api/model/run_template_step_source.py +285 -0
  71. cosmotech_api/model/runner.py +379 -0
  72. cosmotech_api/model/runner_access_control.py +268 -0
  73. cosmotech_api/model/runner_changed_parameter_value.py +272 -0
  74. cosmotech_api/model/runner_comparison_result.py +273 -0
  75. cosmotech_api/model/runner_data_download_info.py +267 -0
  76. cosmotech_api/model/runner_data_download_job.py +257 -0
  77. cosmotech_api/model/runner_job_state.py +287 -0
  78. cosmotech_api/model/runner_last_run.py +268 -0
  79. cosmotech_api/model/runner_resource_sizing.py +274 -0
  80. cosmotech_api/model/runner_role.py +262 -0
  81. cosmotech_api/model/runner_run_template_parameter_value.py +277 -0
  82. cosmotech_api/model/runner_security.py +274 -0
  83. cosmotech_api/model/runner_validation_status.py +285 -0
  84. cosmotech_api/model/scenario.py +379 -0
  85. cosmotech_api/model/scenario_access_control.py +268 -0
  86. cosmotech_api/model/scenario_changed_parameter_value.py +272 -0
  87. cosmotech_api/model/scenario_comparison_result.py +273 -0
  88. cosmotech_api/model/scenario_data_download_info.py +267 -0
  89. cosmotech_api/model/scenario_data_download_job.py +257 -0
  90. cosmotech_api/model/scenario_job_state.py +287 -0
  91. cosmotech_api/model/scenario_last_run.py +268 -0
  92. cosmotech_api/model/scenario_resource_sizing.py +274 -0
  93. cosmotech_api/model/scenario_role.py +262 -0
  94. cosmotech_api/model/scenario_run.py +369 -0
  95. cosmotech_api/model/scenario_run_container.py +318 -0
  96. cosmotech_api/model/scenario_run_container_artifact.py +260 -0
  97. cosmotech_api/model/scenario_run_container_logs.py +272 -0
  98. cosmotech_api/model/scenario_run_logs.py +268 -0
  99. cosmotech_api/model/scenario_run_resource_requested.py +260 -0
  100. cosmotech_api/model/scenario_run_result.py +260 -0
  101. cosmotech_api/model/scenario_run_search.py +296 -0
  102. cosmotech_api/model/scenario_run_start_containers.py +286 -0
  103. cosmotech_api/model/scenario_run_state.py +287 -0
  104. cosmotech_api/model/scenario_run_status.py +308 -0
  105. cosmotech_api/model/scenario_run_status_node.py +307 -0
  106. cosmotech_api/model/scenario_run_template_parameter_value.py +277 -0
  107. cosmotech_api/model/scenario_security.py +274 -0
  108. cosmotech_api/model/scenario_user.py +277 -0
  109. cosmotech_api/model/scenario_validation_status.py +285 -0
  110. cosmotech_api/model/solution.py +335 -0
  111. cosmotech_api/model/solution_access_control.py +268 -0
  112. cosmotech_api/model/solution_role.py +262 -0
  113. cosmotech_api/model/solution_security.py +274 -0
  114. cosmotech_api/model/source_info.py +274 -0
  115. cosmotech_api/model/sub_dataset_graph_query.py +268 -0
  116. cosmotech_api/model/translated_labels.py +252 -0
  117. cosmotech_api/model/twin_graph_batch_result.py +274 -0
  118. cosmotech_api/model/twin_graph_hash.py +256 -0
  119. cosmotech_api/model/twin_graph_import.py +278 -0
  120. cosmotech_api/model/twin_graph_import_info.py +260 -0
  121. cosmotech_api/model/twin_graph_query.py +266 -0
  122. cosmotech_api/model/user.py +281 -0
  123. cosmotech_api/model/user_organization.py +275 -0
  124. cosmotech_api/model/user_workspace.py +266 -0
  125. cosmotech_api/model/validator.py +295 -0
  126. cosmotech_api/model/validator_run.py +302 -0
  127. cosmotech_api/model/workspace.py +351 -0
  128. cosmotech_api/model/workspace_access_control.py +268 -0
  129. cosmotech_api/model/workspace_file.py +256 -0
  130. cosmotech_api/model/workspace_role.py +262 -0
  131. cosmotech_api/model/workspace_secret.py +256 -0
  132. cosmotech_api/model/workspace_security.py +274 -0
  133. cosmotech_api/model/workspace_solution.py +264 -0
  134. cosmotech_api/model/workspace_user.py +278 -0
  135. cosmotech_api/model/workspace_web_app.py +270 -0
  136. cosmotech_api/model_utils.py +2038 -0
  137. cosmotech_api/models/__init__.py +127 -0
  138. cosmotech_api/models/component_role_permissions.py +90 -0
  139. cosmotech_api/models/connector.py +135 -0
  140. cosmotech_api/models/connector_parameter.py +98 -0
  141. cosmotech_api/models/connector_parameter_group.py +100 -0
  142. cosmotech_api/models/container_resource_size_info.py +90 -0
  143. cosmotech_api/models/container_resource_sizing.py +97 -0
  144. cosmotech_api/models/dataset.py +195 -0
  145. cosmotech_api/models/dataset_access_control.py +90 -0
  146. cosmotech_api/models/dataset_compatibility.py +92 -0
  147. cosmotech_api/models/dataset_connector.py +94 -0
  148. cosmotech_api/models/dataset_copy_parameters.py +92 -0
  149. cosmotech_api/models/dataset_role.py +88 -0
  150. cosmotech_api/models/dataset_search.py +88 -0
  151. cosmotech_api/models/dataset_security.py +98 -0
  152. cosmotech_api/models/dataset_source_type.py +42 -0
  153. cosmotech_api/models/dataset_twin_graph_hash.py +88 -0
  154. cosmotech_api/models/dataset_twin_graph_info.py +92 -0
  155. cosmotech_api/models/dataset_twin_graph_query.py +88 -0
  156. cosmotech_api/models/delete_historical_data.py +92 -0
  157. cosmotech_api/models/file_upload_metadata.py +90 -0
  158. cosmotech_api/models/file_upload_validation.py +105 -0
  159. cosmotech_api/models/graph_properties.py +96 -0
  160. cosmotech_api/models/organization.py +108 -0
  161. cosmotech_api/models/organization_access_control.py +90 -0
  162. cosmotech_api/models/organization_role.py +88 -0
  163. cosmotech_api/models/organization_security.py +98 -0
  164. cosmotech_api/models/organization_service.py +96 -0
  165. cosmotech_api/models/organization_services.py +99 -0
  166. cosmotech_api/models/query_result.py +88 -0
  167. cosmotech_api/models/resource_size_info.py +90 -0
  168. cosmotech_api/models/run.py +167 -0
  169. cosmotech_api/models/run_container.py +126 -0
  170. cosmotech_api/models/run_container_artifact.py +90 -0
  171. cosmotech_api/models/run_container_logs.py +102 -0
  172. cosmotech_api/models/run_data.py +92 -0
  173. cosmotech_api/models/run_data_query.py +88 -0
  174. cosmotech_api/models/run_logs.py +107 -0
  175. cosmotech_api/models/run_resource_requested.py +90 -0
  176. cosmotech_api/models/run_search.py +112 -0
  177. cosmotech_api/models/run_start_containers.py +104 -0
  178. cosmotech_api/models/run_state.py +40 -0
  179. cosmotech_api/models/run_status.py +123 -0
  180. cosmotech_api/models/run_status_node.py +116 -0
  181. cosmotech_api/models/run_template.py +164 -0
  182. cosmotech_api/models/run_template_handler_id.py +42 -0
  183. cosmotech_api/models/run_template_orchestrator.py +38 -0
  184. cosmotech_api/models/run_template_parameter.py +102 -0
  185. cosmotech_api/models/run_template_parameter_group.py +98 -0
  186. cosmotech_api/models/run_template_parameter_value.py +94 -0
  187. cosmotech_api/models/run_template_resource_sizing.py +97 -0
  188. cosmotech_api/models/run_template_step_source.py +40 -0
  189. cosmotech_api/models/runner.py +188 -0
  190. cosmotech_api/models/runner_access_control.py +90 -0
  191. cosmotech_api/models/runner_changed_parameter_value.py +102 -0
  192. cosmotech_api/models/runner_comparison_result.py +106 -0
  193. cosmotech_api/models/runner_data_download_info.py +93 -0
  194. cosmotech_api/models/runner_data_download_job.py +90 -0
  195. cosmotech_api/models/runner_job_state.py +42 -0
  196. cosmotech_api/models/runner_last_run.py +94 -0
  197. cosmotech_api/models/runner_parent_last_run.py +94 -0
  198. cosmotech_api/models/runner_resource_sizing.py +97 -0
  199. cosmotech_api/models/runner_role.py +88 -0
  200. cosmotech_api/models/runner_root_last_run.py +94 -0
  201. cosmotech_api/models/runner_run_template_parameter_value.py +96 -0
  202. cosmotech_api/models/runner_security.py +98 -0
  203. cosmotech_api/models/runner_validation_status.py +40 -0
  204. cosmotech_api/models/scenario.py +186 -0
  205. cosmotech_api/models/scenario_access_control.py +90 -0
  206. cosmotech_api/models/scenario_changed_parameter_value.py +102 -0
  207. cosmotech_api/models/scenario_comparison_result.py +106 -0
  208. cosmotech_api/models/scenario_data_download_info.py +93 -0
  209. cosmotech_api/models/scenario_data_download_job.py +90 -0
  210. cosmotech_api/models/scenario_job_state.py +42 -0
  211. cosmotech_api/models/scenario_last_run.py +94 -0
  212. cosmotech_api/models/scenario_resource_sizing.py +97 -0
  213. cosmotech_api/models/scenario_role.py +88 -0
  214. cosmotech_api/models/scenario_run.py +179 -0
  215. cosmotech_api/models/scenario_run_container.py +126 -0
  216. cosmotech_api/models/scenario_run_container_artifact.py +90 -0
  217. cosmotech_api/models/scenario_run_container_logs.py +102 -0
  218. cosmotech_api/models/scenario_run_logs.py +107 -0
  219. cosmotech_api/models/scenario_run_resource_requested.py +90 -0
  220. cosmotech_api/models/scenario_run_result.py +90 -0
  221. cosmotech_api/models/scenario_run_search.py +112 -0
  222. cosmotech_api/models/scenario_run_start_containers.py +104 -0
  223. cosmotech_api/models/scenario_run_state.py +42 -0
  224. cosmotech_api/models/scenario_run_status.py +119 -0
  225. cosmotech_api/models/scenario_run_status_node.py +116 -0
  226. cosmotech_api/models/scenario_run_template_parameter_value.py +96 -0
  227. cosmotech_api/models/scenario_security.py +98 -0
  228. cosmotech_api/models/scenario_validation_status.py +40 -0
  229. cosmotech_api/models/send_run_data_request.py +90 -0
  230. cosmotech_api/models/solution.py +154 -0
  231. cosmotech_api/models/solution_access_control.py +90 -0
  232. cosmotech_api/models/solution_role.py +88 -0
  233. cosmotech_api/models/solution_security.py +98 -0
  234. cosmotech_api/models/source_info.py +94 -0
  235. cosmotech_api/models/sub_dataset_graph_query.py +94 -0
  236. cosmotech_api/models/twin_graph_batch_result.py +92 -0
  237. cosmotech_api/models/twin_graph_hash.py +88 -0
  238. cosmotech_api/models/twin_graph_query.py +90 -0
  239. cosmotech_api/models/validator.py +106 -0
  240. cosmotech_api/models/validator_run.py +126 -0
  241. cosmotech_api/models/workspace.py +142 -0
  242. cosmotech_api/models/workspace_access_control.py +90 -0
  243. cosmotech_api/models/workspace_file.py +88 -0
  244. cosmotech_api/models/workspace_role.py +88 -0
  245. cosmotech_api/models/workspace_secret.py +88 -0
  246. cosmotech_api/models/workspace_security.py +98 -0
  247. cosmotech_api/models/workspace_solution.py +92 -0
  248. cosmotech_api/models/workspace_web_app.py +92 -0
  249. cosmotech_api/py.typed +0 -0
  250. cosmotech_api/rest.py +256 -0
  251. cosmotech_api-3.2.0.dist-info/LICENSE +17 -0
  252. cosmotech_api-3.2.0.dist-info/METADATA +18 -0
  253. cosmotech_api-3.2.0.dist-info/RECORD +255 -0
  254. cosmotech_api-3.2.0.dist-info/WHEEL +5 -0
  255. cosmotech_api-3.2.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,704 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Cosmo Tech Platform API
5
+
6
+ Cosmo Tech Platform API
7
+
8
+ The version of the OpenAPI document: 3.1.1-SNAPSHOT
9
+ Contact: platform@cosmotech.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+ import warnings
16
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
+ from typing import Any, Dict, List, Optional, Tuple, Union
18
+ from typing_extensions import Annotated
19
+
20
+ from pydantic import Field, StrictStr
21
+ from typing import Dict
22
+ from typing_extensions import Annotated
23
+ from cosmotech_api.models.scenario_run_result import ScenarioRunResult
24
+
25
+ from cosmotech_api.api_client import ApiClient, RequestSerialized
26
+ from cosmotech_api.api_response import ApiResponse
27
+ from cosmotech_api.rest import RESTResponseType
28
+
29
+
30
+ class ScenariorunresultApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def get_scenario_run_result(
45
+ self,
46
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
47
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
48
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
49
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
50
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
51
+ _request_timeout: Union[
52
+ None,
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Tuple[
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Annotated[StrictFloat, Field(gt=0)]
57
+ ]
58
+ ] = None,
59
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
+ _content_type: Optional[StrictStr] = None,
61
+ _headers: Optional[Dict[StrictStr, Any]] = None,
62
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
+ ) -> ScenarioRunResult:
64
+ """Get a ScenarioRunResult in the Organization
65
+
66
+
67
+ :param organization_id: the Organization identifier (required)
68
+ :type organization_id: str
69
+ :param workspace_id: the Workspace identifier (required)
70
+ :type workspace_id: str
71
+ :param scenario_id: the Scenario identifier (required)
72
+ :type scenario_id: str
73
+ :param scenariorun_id: the ScenarioRun identifier (required)
74
+ :type scenariorun_id: str
75
+ :param probe_id: the Probe identifier (required)
76
+ :type probe_id: str
77
+ :param _request_timeout: timeout setting for this request. If one
78
+ number provided, it will be total request
79
+ timeout. It can also be a pair (tuple) of
80
+ (connection, read) timeouts.
81
+ :type _request_timeout: int, tuple(int, int), optional
82
+ :param _request_auth: set to override the auth_settings for an a single
83
+ request; this effectively ignores the
84
+ authentication in the spec for a single request.
85
+ :type _request_auth: dict, optional
86
+ :param _content_type: force content-type for the request.
87
+ :type _content_type: str, Optional
88
+ :param _headers: set to override the headers for a single
89
+ request; this effectively ignores the headers
90
+ in the spec for a single request.
91
+ :type _headers: dict, optional
92
+ :param _host_index: set to override the host_index for a single
93
+ request; this effectively ignores the host_index
94
+ in the spec for a single request.
95
+ :type _host_index: int, optional
96
+ :return: Returns the result object.
97
+ """ # noqa: E501
98
+
99
+ _param = self._get_scenario_run_result_serialize(
100
+ organization_id=organization_id,
101
+ workspace_id=workspace_id,
102
+ scenario_id=scenario_id,
103
+ scenariorun_id=scenariorun_id,
104
+ probe_id=probe_id,
105
+ _request_auth=_request_auth,
106
+ _content_type=_content_type,
107
+ _headers=_headers,
108
+ _host_index=_host_index
109
+ )
110
+
111
+ _response_types_map: Dict[str, Optional[str]] = {
112
+ '200': "ScenarioRunResult",
113
+ '404': None,
114
+ }
115
+ response_data = self.api_client.call_api(
116
+ *_param,
117
+ _request_timeout=_request_timeout
118
+ )
119
+ 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
+ def get_scenario_run_result_with_http_info(
128
+ self,
129
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
130
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
131
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
132
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
133
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
134
+ _request_timeout: Union[
135
+ None,
136
+ Annotated[StrictFloat, Field(gt=0)],
137
+ Tuple[
138
+ Annotated[StrictFloat, Field(gt=0)],
139
+ Annotated[StrictFloat, Field(gt=0)]
140
+ ]
141
+ ] = None,
142
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
143
+ _content_type: Optional[StrictStr] = None,
144
+ _headers: Optional[Dict[StrictStr, Any]] = None,
145
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
146
+ ) -> ApiResponse[ScenarioRunResult]:
147
+ """Get a ScenarioRunResult in the Organization
148
+
149
+
150
+ :param organization_id: the Organization identifier (required)
151
+ :type organization_id: str
152
+ :param workspace_id: the Workspace identifier (required)
153
+ :type workspace_id: str
154
+ :param scenario_id: the Scenario identifier (required)
155
+ :type scenario_id: str
156
+ :param scenariorun_id: the ScenarioRun identifier (required)
157
+ :type scenariorun_id: str
158
+ :param probe_id: the Probe identifier (required)
159
+ :type probe_id: str
160
+ :param _request_timeout: timeout setting for this request. If one
161
+ number provided, it will be total request
162
+ timeout. It can also be a pair (tuple) of
163
+ (connection, read) timeouts.
164
+ :type _request_timeout: int, tuple(int, int), optional
165
+ :param _request_auth: set to override the auth_settings for an a single
166
+ request; this effectively ignores the
167
+ authentication in the spec for a single request.
168
+ :type _request_auth: dict, optional
169
+ :param _content_type: force content-type for the request.
170
+ :type _content_type: str, Optional
171
+ :param _headers: set to override the headers for a single
172
+ request; this effectively ignores the headers
173
+ in the spec for a single request.
174
+ :type _headers: dict, optional
175
+ :param _host_index: set to override the host_index for a single
176
+ request; this effectively ignores the host_index
177
+ in the spec for a single request.
178
+ :type _host_index: int, optional
179
+ :return: Returns the result object.
180
+ """ # noqa: E501
181
+
182
+ _param = self._get_scenario_run_result_serialize(
183
+ organization_id=organization_id,
184
+ workspace_id=workspace_id,
185
+ scenario_id=scenario_id,
186
+ scenariorun_id=scenariorun_id,
187
+ probe_id=probe_id,
188
+ _request_auth=_request_auth,
189
+ _content_type=_content_type,
190
+ _headers=_headers,
191
+ _host_index=_host_index
192
+ )
193
+
194
+ _response_types_map: Dict[str, Optional[str]] = {
195
+ '200': "ScenarioRunResult",
196
+ '404': None,
197
+ }
198
+ response_data = self.api_client.call_api(
199
+ *_param,
200
+ _request_timeout=_request_timeout
201
+ )
202
+ response_data.read()
203
+ return self.api_client.response_deserialize(
204
+ response_data=response_data,
205
+ response_types_map=_response_types_map,
206
+ )
207
+
208
+
209
+ @validate_call
210
+ def get_scenario_run_result_without_preload_content(
211
+ self,
212
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
213
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
214
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
215
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
216
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
217
+ _request_timeout: Union[
218
+ None,
219
+ Annotated[StrictFloat, Field(gt=0)],
220
+ Tuple[
221
+ Annotated[StrictFloat, Field(gt=0)],
222
+ Annotated[StrictFloat, Field(gt=0)]
223
+ ]
224
+ ] = None,
225
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
226
+ _content_type: Optional[StrictStr] = None,
227
+ _headers: Optional[Dict[StrictStr, Any]] = None,
228
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
229
+ ) -> RESTResponseType:
230
+ """Get a ScenarioRunResult in the Organization
231
+
232
+
233
+ :param organization_id: the Organization identifier (required)
234
+ :type organization_id: str
235
+ :param workspace_id: the Workspace identifier (required)
236
+ :type workspace_id: str
237
+ :param scenario_id: the Scenario identifier (required)
238
+ :type scenario_id: str
239
+ :param scenariorun_id: the ScenarioRun identifier (required)
240
+ :type scenariorun_id: str
241
+ :param probe_id: the Probe identifier (required)
242
+ :type probe_id: str
243
+ :param _request_timeout: timeout setting for this request. If one
244
+ number provided, it will be total request
245
+ timeout. It can also be a pair (tuple) of
246
+ (connection, read) timeouts.
247
+ :type _request_timeout: int, tuple(int, int), optional
248
+ :param _request_auth: set to override the auth_settings for an a single
249
+ request; this effectively ignores the
250
+ authentication in the spec for a single request.
251
+ :type _request_auth: dict, optional
252
+ :param _content_type: force content-type for the request.
253
+ :type _content_type: str, Optional
254
+ :param _headers: set to override the headers for a single
255
+ request; this effectively ignores the headers
256
+ in the spec for a single request.
257
+ :type _headers: dict, optional
258
+ :param _host_index: set to override the host_index for a single
259
+ request; this effectively ignores the host_index
260
+ in the spec for a single request.
261
+ :type _host_index: int, optional
262
+ :return: Returns the result object.
263
+ """ # noqa: E501
264
+
265
+ _param = self._get_scenario_run_result_serialize(
266
+ organization_id=organization_id,
267
+ workspace_id=workspace_id,
268
+ scenario_id=scenario_id,
269
+ scenariorun_id=scenariorun_id,
270
+ probe_id=probe_id,
271
+ _request_auth=_request_auth,
272
+ _content_type=_content_type,
273
+ _headers=_headers,
274
+ _host_index=_host_index
275
+ )
276
+
277
+ _response_types_map: Dict[str, Optional[str]] = {
278
+ '200': "ScenarioRunResult",
279
+ '404': None,
280
+ }
281
+ response_data = self.api_client.call_api(
282
+ *_param,
283
+ _request_timeout=_request_timeout
284
+ )
285
+ return response_data.response
286
+
287
+
288
+ def _get_scenario_run_result_serialize(
289
+ self,
290
+ organization_id,
291
+ workspace_id,
292
+ scenario_id,
293
+ scenariorun_id,
294
+ probe_id,
295
+ _request_auth,
296
+ _content_type,
297
+ _headers,
298
+ _host_index,
299
+ ) -> RequestSerialized:
300
+
301
+ _host = None
302
+
303
+ _collection_formats: Dict[str, str] = {
304
+ }
305
+
306
+ _path_params: Dict[str, str] = {}
307
+ _query_params: List[Tuple[str, str]] = []
308
+ _header_params: Dict[str, Optional[str]] = _headers or {}
309
+ _form_params: List[Tuple[str, str]] = []
310
+ _files: Dict[str, str] = {}
311
+ _body_params: Optional[bytes] = None
312
+
313
+ # process the path parameters
314
+ if organization_id is not None:
315
+ _path_params['organization_id'] = organization_id
316
+ if workspace_id is not None:
317
+ _path_params['workspace_id'] = workspace_id
318
+ if scenario_id is not None:
319
+ _path_params['scenario_id'] = scenario_id
320
+ if scenariorun_id is not None:
321
+ _path_params['scenariorun_id'] = scenariorun_id
322
+ if probe_id is not None:
323
+ _path_params['probe_id'] = probe_id
324
+ # process the query parameters
325
+ # process the header parameters
326
+ # process the form parameters
327
+ # process the body parameter
328
+
329
+
330
+ # set the HTTP header `Accept`
331
+ _header_params['Accept'] = self.api_client.select_header_accept(
332
+ [
333
+ 'application/json'
334
+ ]
335
+ )
336
+
337
+
338
+ # authentication setting
339
+ _auth_settings: List[str] = [
340
+ 'oAuth2AuthCode'
341
+ ]
342
+
343
+ return self.api_client.param_serialize(
344
+ method='GET',
345
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/{scenariorun_id}/probes/{probe_id}',
346
+ path_params=_path_params,
347
+ query_params=_query_params,
348
+ header_params=_header_params,
349
+ body=_body_params,
350
+ post_params=_form_params,
351
+ files=_files,
352
+ auth_settings=_auth_settings,
353
+ collection_formats=_collection_formats,
354
+ _host=_host,
355
+ _request_auth=_request_auth
356
+ )
357
+
358
+
359
+
360
+
361
+ @validate_call
362
+ def send_scenario_run_result(
363
+ self,
364
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
365
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
366
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
367
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
368
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
369
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the ScenarioRunResult to register")],
370
+ _request_timeout: Union[
371
+ None,
372
+ Annotated[StrictFloat, Field(gt=0)],
373
+ Tuple[
374
+ Annotated[StrictFloat, Field(gt=0)],
375
+ Annotated[StrictFloat, Field(gt=0)]
376
+ ]
377
+ ] = None,
378
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
379
+ _content_type: Optional[StrictStr] = None,
380
+ _headers: Optional[Dict[StrictStr, Any]] = None,
381
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
382
+ ) -> ScenarioRunResult:
383
+ """Create a new ScenarioRunResult in the Organization
384
+
385
+
386
+ :param organization_id: the Organization identifier (required)
387
+ :type organization_id: str
388
+ :param workspace_id: the Workspace identifier (required)
389
+ :type workspace_id: str
390
+ :param scenario_id: the Scenario identifier (required)
391
+ :type scenario_id: str
392
+ :param scenariorun_id: the ScenarioRun identifier (required)
393
+ :type scenariorun_id: str
394
+ :param probe_id: the Probe identifier (required)
395
+ :type probe_id: str
396
+ :param request_body: the ScenarioRunResult to register (required)
397
+ :type request_body: Dict[str, str]
398
+ :param _request_timeout: timeout setting for this request. If one
399
+ number provided, it will be total request
400
+ timeout. It can also be a pair (tuple) of
401
+ (connection, read) timeouts.
402
+ :type _request_timeout: int, tuple(int, int), optional
403
+ :param _request_auth: set to override the auth_settings for an a single
404
+ request; this effectively ignores the
405
+ authentication in the spec for a single request.
406
+ :type _request_auth: dict, optional
407
+ :param _content_type: force content-type for the request.
408
+ :type _content_type: str, Optional
409
+ :param _headers: set to override the headers for a single
410
+ request; this effectively ignores the headers
411
+ in the spec for a single request.
412
+ :type _headers: dict, optional
413
+ :param _host_index: set to override the host_index for a single
414
+ request; this effectively ignores the host_index
415
+ in the spec for a single request.
416
+ :type _host_index: int, optional
417
+ :return: Returns the result object.
418
+ """ # noqa: E501
419
+
420
+ _param = self._send_scenario_run_result_serialize(
421
+ organization_id=organization_id,
422
+ workspace_id=workspace_id,
423
+ scenario_id=scenario_id,
424
+ scenariorun_id=scenariorun_id,
425
+ probe_id=probe_id,
426
+ request_body=request_body,
427
+ _request_auth=_request_auth,
428
+ _content_type=_content_type,
429
+ _headers=_headers,
430
+ _host_index=_host_index
431
+ )
432
+
433
+ _response_types_map: Dict[str, Optional[str]] = {
434
+ '200': "ScenarioRunResult",
435
+ '400': None,
436
+ }
437
+ response_data = self.api_client.call_api(
438
+ *_param,
439
+ _request_timeout=_request_timeout
440
+ )
441
+ response_data.read()
442
+ return self.api_client.response_deserialize(
443
+ response_data=response_data,
444
+ response_types_map=_response_types_map,
445
+ ).data
446
+
447
+
448
+ @validate_call
449
+ def send_scenario_run_result_with_http_info(
450
+ self,
451
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
452
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
453
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
454
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
455
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
456
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the ScenarioRunResult to register")],
457
+ _request_timeout: Union[
458
+ None,
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Tuple[
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Annotated[StrictFloat, Field(gt=0)]
463
+ ]
464
+ ] = None,
465
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
466
+ _content_type: Optional[StrictStr] = None,
467
+ _headers: Optional[Dict[StrictStr, Any]] = None,
468
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
469
+ ) -> ApiResponse[ScenarioRunResult]:
470
+ """Create a new ScenarioRunResult in the Organization
471
+
472
+
473
+ :param organization_id: the Organization identifier (required)
474
+ :type organization_id: str
475
+ :param workspace_id: the Workspace identifier (required)
476
+ :type workspace_id: str
477
+ :param scenario_id: the Scenario identifier (required)
478
+ :type scenario_id: str
479
+ :param scenariorun_id: the ScenarioRun identifier (required)
480
+ :type scenariorun_id: str
481
+ :param probe_id: the Probe identifier (required)
482
+ :type probe_id: str
483
+ :param request_body: the ScenarioRunResult to register (required)
484
+ :type request_body: Dict[str, str]
485
+ :param _request_timeout: timeout setting for this request. If one
486
+ number provided, it will be total request
487
+ timeout. It can also be a pair (tuple) of
488
+ (connection, read) timeouts.
489
+ :type _request_timeout: int, tuple(int, int), optional
490
+ :param _request_auth: set to override the auth_settings for an a single
491
+ request; this effectively ignores the
492
+ authentication in the spec for a single request.
493
+ :type _request_auth: dict, optional
494
+ :param _content_type: force content-type for the request.
495
+ :type _content_type: str, Optional
496
+ :param _headers: set to override the headers for a single
497
+ request; this effectively ignores the headers
498
+ in the spec for a single request.
499
+ :type _headers: dict, optional
500
+ :param _host_index: set to override the host_index for a single
501
+ request; this effectively ignores the host_index
502
+ in the spec for a single request.
503
+ :type _host_index: int, optional
504
+ :return: Returns the result object.
505
+ """ # noqa: E501
506
+
507
+ _param = self._send_scenario_run_result_serialize(
508
+ organization_id=organization_id,
509
+ workspace_id=workspace_id,
510
+ scenario_id=scenario_id,
511
+ scenariorun_id=scenariorun_id,
512
+ probe_id=probe_id,
513
+ request_body=request_body,
514
+ _request_auth=_request_auth,
515
+ _content_type=_content_type,
516
+ _headers=_headers,
517
+ _host_index=_host_index
518
+ )
519
+
520
+ _response_types_map: Dict[str, Optional[str]] = {
521
+ '200': "ScenarioRunResult",
522
+ '400': None,
523
+ }
524
+ response_data = self.api_client.call_api(
525
+ *_param,
526
+ _request_timeout=_request_timeout
527
+ )
528
+ response_data.read()
529
+ return self.api_client.response_deserialize(
530
+ response_data=response_data,
531
+ response_types_map=_response_types_map,
532
+ )
533
+
534
+
535
+ @validate_call
536
+ def send_scenario_run_result_without_preload_content(
537
+ self,
538
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
539
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
540
+ scenario_id: Annotated[StrictStr, Field(description="the Scenario identifier")],
541
+ scenariorun_id: Annotated[StrictStr, Field(description="the ScenarioRun identifier")],
542
+ probe_id: Annotated[StrictStr, Field(description="the Probe identifier")],
543
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the ScenarioRunResult to register")],
544
+ _request_timeout: Union[
545
+ None,
546
+ Annotated[StrictFloat, Field(gt=0)],
547
+ Tuple[
548
+ Annotated[StrictFloat, Field(gt=0)],
549
+ Annotated[StrictFloat, Field(gt=0)]
550
+ ]
551
+ ] = None,
552
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
553
+ _content_type: Optional[StrictStr] = None,
554
+ _headers: Optional[Dict[StrictStr, Any]] = None,
555
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
556
+ ) -> RESTResponseType:
557
+ """Create a new ScenarioRunResult in the Organization
558
+
559
+
560
+ :param organization_id: the Organization identifier (required)
561
+ :type organization_id: str
562
+ :param workspace_id: the Workspace identifier (required)
563
+ :type workspace_id: str
564
+ :param scenario_id: the Scenario identifier (required)
565
+ :type scenario_id: str
566
+ :param scenariorun_id: the ScenarioRun identifier (required)
567
+ :type scenariorun_id: str
568
+ :param probe_id: the Probe identifier (required)
569
+ :type probe_id: str
570
+ :param request_body: the ScenarioRunResult to register (required)
571
+ :type request_body: Dict[str, str]
572
+ :param _request_timeout: timeout setting for this request. If one
573
+ number provided, it will be total request
574
+ timeout. It can also be a pair (tuple) of
575
+ (connection, read) timeouts.
576
+ :type _request_timeout: int, tuple(int, int), optional
577
+ :param _request_auth: set to override the auth_settings for an a single
578
+ request; this effectively ignores the
579
+ authentication in the spec for a single request.
580
+ :type _request_auth: dict, optional
581
+ :param _content_type: force content-type for the request.
582
+ :type _content_type: str, Optional
583
+ :param _headers: set to override the headers for a single
584
+ request; this effectively ignores the headers
585
+ in the spec for a single request.
586
+ :type _headers: dict, optional
587
+ :param _host_index: set to override the host_index for a single
588
+ request; this effectively ignores the host_index
589
+ in the spec for a single request.
590
+ :type _host_index: int, optional
591
+ :return: Returns the result object.
592
+ """ # noqa: E501
593
+
594
+ _param = self._send_scenario_run_result_serialize(
595
+ organization_id=organization_id,
596
+ workspace_id=workspace_id,
597
+ scenario_id=scenario_id,
598
+ scenariorun_id=scenariorun_id,
599
+ probe_id=probe_id,
600
+ request_body=request_body,
601
+ _request_auth=_request_auth,
602
+ _content_type=_content_type,
603
+ _headers=_headers,
604
+ _host_index=_host_index
605
+ )
606
+
607
+ _response_types_map: Dict[str, Optional[str]] = {
608
+ '200': "ScenarioRunResult",
609
+ '400': None,
610
+ }
611
+ response_data = self.api_client.call_api(
612
+ *_param,
613
+ _request_timeout=_request_timeout
614
+ )
615
+ return response_data.response
616
+
617
+
618
+ def _send_scenario_run_result_serialize(
619
+ self,
620
+ organization_id,
621
+ workspace_id,
622
+ scenario_id,
623
+ scenariorun_id,
624
+ probe_id,
625
+ request_body,
626
+ _request_auth,
627
+ _content_type,
628
+ _headers,
629
+ _host_index,
630
+ ) -> RequestSerialized:
631
+
632
+ _host = None
633
+
634
+ _collection_formats: Dict[str, str] = {
635
+ }
636
+
637
+ _path_params: Dict[str, str] = {}
638
+ _query_params: List[Tuple[str, str]] = []
639
+ _header_params: Dict[str, Optional[str]] = _headers or {}
640
+ _form_params: List[Tuple[str, str]] = []
641
+ _files: Dict[str, str] = {}
642
+ _body_params: Optional[bytes] = None
643
+
644
+ # process the path parameters
645
+ if organization_id is not None:
646
+ _path_params['organization_id'] = organization_id
647
+ if workspace_id is not None:
648
+ _path_params['workspace_id'] = workspace_id
649
+ if scenario_id is not None:
650
+ _path_params['scenario_id'] = scenario_id
651
+ if scenariorun_id is not None:
652
+ _path_params['scenariorun_id'] = scenariorun_id
653
+ if probe_id is not None:
654
+ _path_params['probe_id'] = probe_id
655
+ # process the query parameters
656
+ # process the header parameters
657
+ # process the form parameters
658
+ # process the body parameter
659
+ if request_body is not None:
660
+ _body_params = request_body
661
+
662
+
663
+ # set the HTTP header `Accept`
664
+ _header_params['Accept'] = self.api_client.select_header_accept(
665
+ [
666
+ 'application/json'
667
+ ]
668
+ )
669
+
670
+ # set the HTTP header `Content-Type`
671
+ if _content_type:
672
+ _header_params['Content-Type'] = _content_type
673
+ else:
674
+ _default_content_type = (
675
+ self.api_client.select_header_content_type(
676
+ [
677
+ 'application/json'
678
+ ]
679
+ )
680
+ )
681
+ if _default_content_type is not None:
682
+ _header_params['Content-Type'] = _default_content_type
683
+
684
+ # authentication setting
685
+ _auth_settings: List[str] = [
686
+ 'oAuth2AuthCode'
687
+ ]
688
+
689
+ return self.api_client.param_serialize(
690
+ method='POST',
691
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/{scenariorun_id}/probes/{probe_id}',
692
+ path_params=_path_params,
693
+ query_params=_query_params,
694
+ header_params=_header_params,
695
+ body=_body_params,
696
+ post_params=_form_params,
697
+ files=_files,
698
+ auth_settings=_auth_settings,
699
+ collection_formats=_collection_formats,
700
+ _host=_host,
701
+ _request_auth=_request_auth
702
+ )
703
+
704
+