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,4201 @@
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.2.0
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, StrictBytes, StrictStr, field_validator
21
+ from typing import Dict, List, Optional, Union
22
+ from typing_extensions import Annotated
23
+ from cosmotech_api.models.graph_properties import GraphProperties
24
+ from cosmotech_api.models.twin_graph_batch_result import TwinGraphBatchResult
25
+ from cosmotech_api.models.twin_graph_hash import TwinGraphHash
26
+ from cosmotech_api.models.twin_graph_query import TwinGraphQuery
27
+
28
+ from cosmotech_api.api_client import ApiClient, RequestSerialized
29
+ from cosmotech_api.api_response import ApiResponse
30
+ from cosmotech_api.rest import RESTResponseType
31
+
32
+
33
+ class TwingraphApi:
34
+ """NOTE: This class is auto generated by OpenAPI Generator
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+ """
39
+
40
+ def __init__(self, api_client=None) -> None:
41
+ if api_client is None:
42
+ api_client = ApiClient.get_default()
43
+ self.api_client = api_client
44
+
45
+
46
+ @validate_call
47
+ def batch_query(
48
+ self,
49
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
50
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
51
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> TwinGraphHash:
65
+ """(Deprecated) Run a query on a graph instance and return the result as a zip file in async mode
66
+
67
+ Run a query on a graph instance and return the result as a zip file in async mode
68
+
69
+ :param organization_id: the Organization identifier (required)
70
+ :type organization_id: str
71
+ :param graph_id: the Graph Identifier (required)
72
+ :type graph_id: str
73
+ :param twin_graph_query: the query to run (required)
74
+ :type twin_graph_query: TwinGraphQuery
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch-query is deprecated.", DeprecationWarning)
97
+
98
+ _param = self._batch_query_serialize(
99
+ organization_id=organization_id,
100
+ graph_id=graph_id,
101
+ twin_graph_query=twin_graph_query,
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': "TwinGraphHash",
110
+ }
111
+ response_data = self.api_client.call_api(
112
+ *_param,
113
+ _request_timeout=_request_timeout
114
+ )
115
+ response_data.read()
116
+ return self.api_client.response_deserialize(
117
+ response_data=response_data,
118
+ response_types_map=_response_types_map,
119
+ ).data
120
+
121
+
122
+ @validate_call
123
+ def batch_query_with_http_info(
124
+ self,
125
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
126
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
127
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
128
+ _request_timeout: Union[
129
+ None,
130
+ Annotated[StrictFloat, Field(gt=0)],
131
+ Tuple[
132
+ Annotated[StrictFloat, Field(gt=0)],
133
+ Annotated[StrictFloat, Field(gt=0)]
134
+ ]
135
+ ] = None,
136
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
137
+ _content_type: Optional[StrictStr] = None,
138
+ _headers: Optional[Dict[StrictStr, Any]] = None,
139
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
140
+ ) -> ApiResponse[TwinGraphHash]:
141
+ """(Deprecated) Run a query on a graph instance and return the result as a zip file in async mode
142
+
143
+ Run a query on a graph instance and return the result as a zip file in async mode
144
+
145
+ :param organization_id: the Organization identifier (required)
146
+ :type organization_id: str
147
+ :param graph_id: the Graph Identifier (required)
148
+ :type graph_id: str
149
+ :param twin_graph_query: the query to run (required)
150
+ :type twin_graph_query: TwinGraphQuery
151
+ :param _request_timeout: timeout setting for this request. If one
152
+ number provided, it will be total request
153
+ timeout. It can also be a pair (tuple) of
154
+ (connection, read) timeouts.
155
+ :type _request_timeout: int, tuple(int, int), optional
156
+ :param _request_auth: set to override the auth_settings for an a single
157
+ request; this effectively ignores the
158
+ authentication in the spec for a single request.
159
+ :type _request_auth: dict, optional
160
+ :param _content_type: force content-type for the request.
161
+ :type _content_type: str, Optional
162
+ :param _headers: set to override the headers for a single
163
+ request; this effectively ignores the headers
164
+ in the spec for a single request.
165
+ :type _headers: dict, optional
166
+ :param _host_index: set to override the host_index for a single
167
+ request; this effectively ignores the host_index
168
+ in the spec for a single request.
169
+ :type _host_index: int, optional
170
+ :return: Returns the result object.
171
+ """ # noqa: E501
172
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch-query is deprecated.", DeprecationWarning)
173
+
174
+ _param = self._batch_query_serialize(
175
+ organization_id=organization_id,
176
+ graph_id=graph_id,
177
+ twin_graph_query=twin_graph_query,
178
+ _request_auth=_request_auth,
179
+ _content_type=_content_type,
180
+ _headers=_headers,
181
+ _host_index=_host_index
182
+ )
183
+
184
+ _response_types_map: Dict[str, Optional[str]] = {
185
+ '200': "TwinGraphHash",
186
+ }
187
+ response_data = self.api_client.call_api(
188
+ *_param,
189
+ _request_timeout=_request_timeout
190
+ )
191
+ response_data.read()
192
+ return self.api_client.response_deserialize(
193
+ response_data=response_data,
194
+ response_types_map=_response_types_map,
195
+ )
196
+
197
+
198
+ @validate_call
199
+ def batch_query_without_preload_content(
200
+ self,
201
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
202
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
203
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
204
+ _request_timeout: Union[
205
+ None,
206
+ Annotated[StrictFloat, Field(gt=0)],
207
+ Tuple[
208
+ Annotated[StrictFloat, Field(gt=0)],
209
+ Annotated[StrictFloat, Field(gt=0)]
210
+ ]
211
+ ] = None,
212
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
213
+ _content_type: Optional[StrictStr] = None,
214
+ _headers: Optional[Dict[StrictStr, Any]] = None,
215
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
216
+ ) -> RESTResponseType:
217
+ """(Deprecated) Run a query on a graph instance and return the result as a zip file in async mode
218
+
219
+ Run a query on a graph instance and return the result as a zip file in async mode
220
+
221
+ :param organization_id: the Organization identifier (required)
222
+ :type organization_id: str
223
+ :param graph_id: the Graph Identifier (required)
224
+ :type graph_id: str
225
+ :param twin_graph_query: the query to run (required)
226
+ :type twin_graph_query: TwinGraphQuery
227
+ :param _request_timeout: timeout setting for this request. If one
228
+ number provided, it will be total request
229
+ timeout. It can also be a pair (tuple) of
230
+ (connection, read) timeouts.
231
+ :type _request_timeout: int, tuple(int, int), optional
232
+ :param _request_auth: set to override the auth_settings for an a single
233
+ request; this effectively ignores the
234
+ authentication in the spec for a single request.
235
+ :type _request_auth: dict, optional
236
+ :param _content_type: force content-type for the request.
237
+ :type _content_type: str, Optional
238
+ :param _headers: set to override the headers for a single
239
+ request; this effectively ignores the headers
240
+ in the spec for a single request.
241
+ :type _headers: dict, optional
242
+ :param _host_index: set to override the host_index for a single
243
+ request; this effectively ignores the host_index
244
+ in the spec for a single request.
245
+ :type _host_index: int, optional
246
+ :return: Returns the result object.
247
+ """ # noqa: E501
248
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch-query is deprecated.", DeprecationWarning)
249
+
250
+ _param = self._batch_query_serialize(
251
+ organization_id=organization_id,
252
+ graph_id=graph_id,
253
+ twin_graph_query=twin_graph_query,
254
+ _request_auth=_request_auth,
255
+ _content_type=_content_type,
256
+ _headers=_headers,
257
+ _host_index=_host_index
258
+ )
259
+
260
+ _response_types_map: Dict[str, Optional[str]] = {
261
+ '200': "TwinGraphHash",
262
+ }
263
+ response_data = self.api_client.call_api(
264
+ *_param,
265
+ _request_timeout=_request_timeout
266
+ )
267
+ return response_data.response
268
+
269
+
270
+ def _batch_query_serialize(
271
+ self,
272
+ organization_id,
273
+ graph_id,
274
+ twin_graph_query,
275
+ _request_auth,
276
+ _content_type,
277
+ _headers,
278
+ _host_index,
279
+ ) -> RequestSerialized:
280
+
281
+ _host = None
282
+
283
+ _collection_formats: Dict[str, str] = {
284
+ }
285
+
286
+ _path_params: Dict[str, str] = {}
287
+ _query_params: List[Tuple[str, str]] = []
288
+ _header_params: Dict[str, Optional[str]] = _headers or {}
289
+ _form_params: List[Tuple[str, str]] = []
290
+ _files: Dict[str, str] = {}
291
+ _body_params: Optional[bytes] = None
292
+
293
+ # process the path parameters
294
+ if organization_id is not None:
295
+ _path_params['organization_id'] = organization_id
296
+ if graph_id is not None:
297
+ _path_params['graph_id'] = graph_id
298
+ # process the query parameters
299
+ # process the header parameters
300
+ # process the form parameters
301
+ # process the body parameter
302
+ if twin_graph_query is not None:
303
+ _body_params = twin_graph_query
304
+
305
+
306
+ # set the HTTP header `Accept`
307
+ _header_params['Accept'] = self.api_client.select_header_accept(
308
+ [
309
+ 'application/json'
310
+ ]
311
+ )
312
+
313
+ # set the HTTP header `Content-Type`
314
+ if _content_type:
315
+ _header_params['Content-Type'] = _content_type
316
+ else:
317
+ _default_content_type = (
318
+ self.api_client.select_header_content_type(
319
+ [
320
+ 'application/json'
321
+ ]
322
+ )
323
+ )
324
+ if _default_content_type is not None:
325
+ _header_params['Content-Type'] = _default_content_type
326
+
327
+ # authentication setting
328
+ _auth_settings: List[str] = [
329
+ 'oAuth2AuthCode'
330
+ ]
331
+
332
+ return self.api_client.param_serialize(
333
+ method='POST',
334
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/batch-query',
335
+ path_params=_path_params,
336
+ query_params=_query_params,
337
+ header_params=_header_params,
338
+ body=_body_params,
339
+ post_params=_form_params,
340
+ files=_files,
341
+ auth_settings=_auth_settings,
342
+ collection_formats=_collection_formats,
343
+ _host=_host,
344
+ _request_auth=_request_auth
345
+ )
346
+
347
+
348
+
349
+
350
+ @validate_call
351
+ def batch_upload_update(
352
+ self,
353
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
354
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
355
+ twin_graph_query: TwinGraphQuery,
356
+ body: Union[StrictBytes, StrictStr],
357
+ _request_timeout: Union[
358
+ None,
359
+ Annotated[StrictFloat, Field(gt=0)],
360
+ Tuple[
361
+ Annotated[StrictFloat, Field(gt=0)],
362
+ Annotated[StrictFloat, Field(gt=0)]
363
+ ]
364
+ ] = None,
365
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
366
+ _content_type: Optional[StrictStr] = None,
367
+ _headers: Optional[Dict[StrictStr, Any]] = None,
368
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
369
+ ) -> TwinGraphBatchResult:
370
+ """(Deprecated) Async batch update by loading a CSV file on a graph instance
371
+
372
+ Async batch update by loading a CSV file on a graph instance
373
+
374
+ :param organization_id: the Organization identifier (required)
375
+ :type organization_id: str
376
+ :param graph_id: the Graph Identifier (required)
377
+ :type graph_id: str
378
+ :param twin_graph_query: (required)
379
+ :type twin_graph_query: TwinGraphQuery
380
+ :param body: (required)
381
+ :type body: bytearray
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
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch is deprecated.", DeprecationWarning)
404
+
405
+ _param = self._batch_upload_update_serialize(
406
+ organization_id=organization_id,
407
+ graph_id=graph_id,
408
+ twin_graph_query=twin_graph_query,
409
+ body=body,
410
+ _request_auth=_request_auth,
411
+ _content_type=_content_type,
412
+ _headers=_headers,
413
+ _host_index=_host_index
414
+ )
415
+
416
+ _response_types_map: Dict[str, Optional[str]] = {
417
+ '200': "TwinGraphBatchResult",
418
+ '400': None,
419
+ }
420
+ response_data = self.api_client.call_api(
421
+ *_param,
422
+ _request_timeout=_request_timeout
423
+ )
424
+ 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
+ def batch_upload_update_with_http_info(
433
+ self,
434
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
435
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
436
+ twin_graph_query: TwinGraphQuery,
437
+ body: Union[StrictBytes, StrictStr],
438
+ _request_timeout: Union[
439
+ None,
440
+ Annotated[StrictFloat, Field(gt=0)],
441
+ Tuple[
442
+ Annotated[StrictFloat, Field(gt=0)],
443
+ Annotated[StrictFloat, Field(gt=0)]
444
+ ]
445
+ ] = None,
446
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
447
+ _content_type: Optional[StrictStr] = None,
448
+ _headers: Optional[Dict[StrictStr, Any]] = None,
449
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
450
+ ) -> ApiResponse[TwinGraphBatchResult]:
451
+ """(Deprecated) Async batch update by loading a CSV file on a graph instance
452
+
453
+ Async batch update by loading a CSV file on a graph instance
454
+
455
+ :param organization_id: the Organization identifier (required)
456
+ :type organization_id: str
457
+ :param graph_id: the Graph Identifier (required)
458
+ :type graph_id: str
459
+ :param twin_graph_query: (required)
460
+ :type twin_graph_query: TwinGraphQuery
461
+ :param body: (required)
462
+ :type body: bytearray
463
+ :param _request_timeout: timeout setting for this request. If one
464
+ number provided, it will be total request
465
+ timeout. It can also be a pair (tuple) of
466
+ (connection, read) timeouts.
467
+ :type _request_timeout: int, tuple(int, int), optional
468
+ :param _request_auth: set to override the auth_settings for an a single
469
+ request; this effectively ignores the
470
+ authentication in the spec for a single request.
471
+ :type _request_auth: dict, optional
472
+ :param _content_type: force content-type for the request.
473
+ :type _content_type: str, Optional
474
+ :param _headers: set to override the headers for a single
475
+ request; this effectively ignores the headers
476
+ in the spec for a single request.
477
+ :type _headers: dict, optional
478
+ :param _host_index: set to override the host_index for a single
479
+ request; this effectively ignores the host_index
480
+ in the spec for a single request.
481
+ :type _host_index: int, optional
482
+ :return: Returns the result object.
483
+ """ # noqa: E501
484
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch is deprecated.", DeprecationWarning)
485
+
486
+ _param = self._batch_upload_update_serialize(
487
+ organization_id=organization_id,
488
+ graph_id=graph_id,
489
+ twin_graph_query=twin_graph_query,
490
+ body=body,
491
+ _request_auth=_request_auth,
492
+ _content_type=_content_type,
493
+ _headers=_headers,
494
+ _host_index=_host_index
495
+ )
496
+
497
+ _response_types_map: Dict[str, Optional[str]] = {
498
+ '200': "TwinGraphBatchResult",
499
+ '400': None,
500
+ }
501
+ response_data = self.api_client.call_api(
502
+ *_param,
503
+ _request_timeout=_request_timeout
504
+ )
505
+ response_data.read()
506
+ return self.api_client.response_deserialize(
507
+ response_data=response_data,
508
+ response_types_map=_response_types_map,
509
+ )
510
+
511
+
512
+ @validate_call
513
+ def batch_upload_update_without_preload_content(
514
+ self,
515
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
516
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
517
+ twin_graph_query: TwinGraphQuery,
518
+ body: Union[StrictBytes, StrictStr],
519
+ _request_timeout: Union[
520
+ None,
521
+ Annotated[StrictFloat, Field(gt=0)],
522
+ Tuple[
523
+ Annotated[StrictFloat, Field(gt=0)],
524
+ Annotated[StrictFloat, Field(gt=0)]
525
+ ]
526
+ ] = None,
527
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
528
+ _content_type: Optional[StrictStr] = None,
529
+ _headers: Optional[Dict[StrictStr, Any]] = None,
530
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
531
+ ) -> RESTResponseType:
532
+ """(Deprecated) Async batch update by loading a CSV file on a graph instance
533
+
534
+ Async batch update by loading a CSV file on a graph instance
535
+
536
+ :param organization_id: the Organization identifier (required)
537
+ :type organization_id: str
538
+ :param graph_id: the Graph Identifier (required)
539
+ :type graph_id: str
540
+ :param twin_graph_query: (required)
541
+ :type twin_graph_query: TwinGraphQuery
542
+ :param body: (required)
543
+ :type body: bytearray
544
+ :param _request_timeout: timeout setting for this request. If one
545
+ number provided, it will be total request
546
+ timeout. It can also be a pair (tuple) of
547
+ (connection, read) timeouts.
548
+ :type _request_timeout: int, tuple(int, int), optional
549
+ :param _request_auth: set to override the auth_settings for an a single
550
+ request; this effectively ignores the
551
+ authentication in the spec for a single request.
552
+ :type _request_auth: dict, optional
553
+ :param _content_type: force content-type for the request.
554
+ :type _content_type: str, Optional
555
+ :param _headers: set to override the headers for a single
556
+ request; this effectively ignores the headers
557
+ in the spec for a single request.
558
+ :type _headers: dict, optional
559
+ :param _host_index: set to override the host_index for a single
560
+ request; this effectively ignores the host_index
561
+ in the spec for a single request.
562
+ :type _host_index: int, optional
563
+ :return: Returns the result object.
564
+ """ # noqa: E501
565
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/batch is deprecated.", DeprecationWarning)
566
+
567
+ _param = self._batch_upload_update_serialize(
568
+ organization_id=organization_id,
569
+ graph_id=graph_id,
570
+ twin_graph_query=twin_graph_query,
571
+ body=body,
572
+ _request_auth=_request_auth,
573
+ _content_type=_content_type,
574
+ _headers=_headers,
575
+ _host_index=_host_index
576
+ )
577
+
578
+ _response_types_map: Dict[str, Optional[str]] = {
579
+ '200': "TwinGraphBatchResult",
580
+ '400': None,
581
+ }
582
+ response_data = self.api_client.call_api(
583
+ *_param,
584
+ _request_timeout=_request_timeout
585
+ )
586
+ return response_data.response
587
+
588
+
589
+ def _batch_upload_update_serialize(
590
+ self,
591
+ organization_id,
592
+ graph_id,
593
+ twin_graph_query,
594
+ body,
595
+ _request_auth,
596
+ _content_type,
597
+ _headers,
598
+ _host_index,
599
+ ) -> RequestSerialized:
600
+
601
+ _host = None
602
+
603
+ _collection_formats: Dict[str, str] = {
604
+ }
605
+
606
+ _path_params: Dict[str, str] = {}
607
+ _query_params: List[Tuple[str, str]] = []
608
+ _header_params: Dict[str, Optional[str]] = _headers or {}
609
+ _form_params: List[Tuple[str, str]] = []
610
+ _files: Dict[str, str] = {}
611
+ _body_params: Optional[bytes] = None
612
+
613
+ # process the path parameters
614
+ if organization_id is not None:
615
+ _path_params['organization_id'] = organization_id
616
+ if graph_id is not None:
617
+ _path_params['graph_id'] = graph_id
618
+ # process the query parameters
619
+ if twin_graph_query is not None:
620
+
621
+ _query_params.append(('twinGraphQuery', twin_graph_query))
622
+
623
+ # process the header parameters
624
+ # process the form parameters
625
+ # process the body parameter
626
+ if body is not None:
627
+ # convert to byte array if the input is a file name (str)
628
+ if isinstance(body, str):
629
+ with open(body, "rb") as _fp:
630
+ _body_params = _fp.read()
631
+ else:
632
+ _body_params = body
633
+
634
+
635
+ # set the HTTP header `Accept`
636
+ _header_params['Accept'] = self.api_client.select_header_accept(
637
+ [
638
+ 'application/json'
639
+ ]
640
+ )
641
+
642
+ # set the HTTP header `Content-Type`
643
+ if _content_type:
644
+ _header_params['Content-Type'] = _content_type
645
+ else:
646
+ _default_content_type = (
647
+ self.api_client.select_header_content_type(
648
+ [
649
+ 'text/csv',
650
+ 'application/octet-stream'
651
+ ]
652
+ )
653
+ )
654
+ if _default_content_type is not None:
655
+ _header_params['Content-Type'] = _default_content_type
656
+
657
+ # authentication setting
658
+ _auth_settings: List[str] = [
659
+ 'oAuth2AuthCode'
660
+ ]
661
+
662
+ return self.api_client.param_serialize(
663
+ method='POST',
664
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/batch',
665
+ path_params=_path_params,
666
+ query_params=_query_params,
667
+ header_params=_header_params,
668
+ body=_body_params,
669
+ post_params=_form_params,
670
+ files=_files,
671
+ auth_settings=_auth_settings,
672
+ collection_formats=_collection_formats,
673
+ _host=_host,
674
+ _request_auth=_request_auth
675
+ )
676
+
677
+
678
+
679
+
680
+ @validate_call
681
+ def create_entities(
682
+ self,
683
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
684
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
685
+ type: Annotated[StrictStr, Field(description="the entity model type")],
686
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to create")],
687
+ _request_timeout: Union[
688
+ None,
689
+ Annotated[StrictFloat, Field(gt=0)],
690
+ Tuple[
691
+ Annotated[StrictFloat, Field(gt=0)],
692
+ Annotated[StrictFloat, Field(gt=0)]
693
+ ]
694
+ ] = None,
695
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
696
+ _content_type: Optional[StrictStr] = None,
697
+ _headers: Optional[Dict[StrictStr, Any]] = None,
698
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
699
+ ) -> str:
700
+ """(Deprecated) Create new entities in a graph instance
701
+
702
+ create new entities in a graph instance
703
+
704
+ :param organization_id: the Organization identifier (required)
705
+ :type organization_id: str
706
+ :param graph_id: the Graph Identifier (required)
707
+ :type graph_id: str
708
+ :param type: the entity model type (required)
709
+ :type type: str
710
+ :param graph_properties: the entities to create (required)
711
+ :type graph_properties: List[GraphProperties]
712
+ :param _request_timeout: timeout setting for this request. If one
713
+ number provided, it will be total request
714
+ timeout. It can also be a pair (tuple) of
715
+ (connection, read) timeouts.
716
+ :type _request_timeout: int, tuple(int, int), optional
717
+ :param _request_auth: set to override the auth_settings for an a single
718
+ request; this effectively ignores the
719
+ authentication in the spec for a single request.
720
+ :type _request_auth: dict, optional
721
+ :param _content_type: force content-type for the request.
722
+ :type _content_type: str, Optional
723
+ :param _headers: set to override the headers for a single
724
+ request; this effectively ignores the headers
725
+ in the spec for a single request.
726
+ :type _headers: dict, optional
727
+ :param _host_index: set to override the host_index for a single
728
+ request; this effectively ignores the host_index
729
+ in the spec for a single request.
730
+ :type _host_index: int, optional
731
+ :return: Returns the result object.
732
+ """ # noqa: E501
733
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
734
+
735
+ _param = self._create_entities_serialize(
736
+ organization_id=organization_id,
737
+ graph_id=graph_id,
738
+ type=type,
739
+ graph_properties=graph_properties,
740
+ _request_auth=_request_auth,
741
+ _content_type=_content_type,
742
+ _headers=_headers,
743
+ _host_index=_host_index
744
+ )
745
+
746
+ _response_types_map: Dict[str, Optional[str]] = {
747
+ '200': "str",
748
+ }
749
+ response_data = self.api_client.call_api(
750
+ *_param,
751
+ _request_timeout=_request_timeout
752
+ )
753
+ response_data.read()
754
+ return self.api_client.response_deserialize(
755
+ response_data=response_data,
756
+ response_types_map=_response_types_map,
757
+ ).data
758
+
759
+
760
+ @validate_call
761
+ def create_entities_with_http_info(
762
+ self,
763
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
764
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
765
+ type: Annotated[StrictStr, Field(description="the entity model type")],
766
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to create")],
767
+ _request_timeout: Union[
768
+ None,
769
+ Annotated[StrictFloat, Field(gt=0)],
770
+ Tuple[
771
+ Annotated[StrictFloat, Field(gt=0)],
772
+ Annotated[StrictFloat, Field(gt=0)]
773
+ ]
774
+ ] = None,
775
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
776
+ _content_type: Optional[StrictStr] = None,
777
+ _headers: Optional[Dict[StrictStr, Any]] = None,
778
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
779
+ ) -> ApiResponse[str]:
780
+ """(Deprecated) Create new entities in a graph instance
781
+
782
+ create new entities in a graph instance
783
+
784
+ :param organization_id: the Organization identifier (required)
785
+ :type organization_id: str
786
+ :param graph_id: the Graph Identifier (required)
787
+ :type graph_id: str
788
+ :param type: the entity model type (required)
789
+ :type type: str
790
+ :param graph_properties: the entities to create (required)
791
+ :type graph_properties: List[GraphProperties]
792
+ :param _request_timeout: timeout setting for this request. If one
793
+ number provided, it will be total request
794
+ timeout. It can also be a pair (tuple) of
795
+ (connection, read) timeouts.
796
+ :type _request_timeout: int, tuple(int, int), optional
797
+ :param _request_auth: set to override the auth_settings for an a single
798
+ request; this effectively ignores the
799
+ authentication in the spec for a single request.
800
+ :type _request_auth: dict, optional
801
+ :param _content_type: force content-type for the request.
802
+ :type _content_type: str, Optional
803
+ :param _headers: set to override the headers for a single
804
+ request; this effectively ignores the headers
805
+ in the spec for a single request.
806
+ :type _headers: dict, optional
807
+ :param _host_index: set to override the host_index for a single
808
+ request; this effectively ignores the host_index
809
+ in the spec for a single request.
810
+ :type _host_index: int, optional
811
+ :return: Returns the result object.
812
+ """ # noqa: E501
813
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
814
+
815
+ _param = self._create_entities_serialize(
816
+ organization_id=organization_id,
817
+ graph_id=graph_id,
818
+ type=type,
819
+ graph_properties=graph_properties,
820
+ _request_auth=_request_auth,
821
+ _content_type=_content_type,
822
+ _headers=_headers,
823
+ _host_index=_host_index
824
+ )
825
+
826
+ _response_types_map: Dict[str, Optional[str]] = {
827
+ '200': "str",
828
+ }
829
+ response_data = self.api_client.call_api(
830
+ *_param,
831
+ _request_timeout=_request_timeout
832
+ )
833
+ response_data.read()
834
+ return self.api_client.response_deserialize(
835
+ response_data=response_data,
836
+ response_types_map=_response_types_map,
837
+ )
838
+
839
+
840
+ @validate_call
841
+ def create_entities_without_preload_content(
842
+ self,
843
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
844
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
845
+ type: Annotated[StrictStr, Field(description="the entity model type")],
846
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to create")],
847
+ _request_timeout: Union[
848
+ None,
849
+ Annotated[StrictFloat, Field(gt=0)],
850
+ Tuple[
851
+ Annotated[StrictFloat, Field(gt=0)],
852
+ Annotated[StrictFloat, Field(gt=0)]
853
+ ]
854
+ ] = None,
855
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
856
+ _content_type: Optional[StrictStr] = None,
857
+ _headers: Optional[Dict[StrictStr, Any]] = None,
858
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
859
+ ) -> RESTResponseType:
860
+ """(Deprecated) Create new entities in a graph instance
861
+
862
+ create new entities in a graph instance
863
+
864
+ :param organization_id: the Organization identifier (required)
865
+ :type organization_id: str
866
+ :param graph_id: the Graph Identifier (required)
867
+ :type graph_id: str
868
+ :param type: the entity model type (required)
869
+ :type type: str
870
+ :param graph_properties: the entities to create (required)
871
+ :type graph_properties: List[GraphProperties]
872
+ :param _request_timeout: timeout setting for this request. If one
873
+ number provided, it will be total request
874
+ timeout. It can also be a pair (tuple) of
875
+ (connection, read) timeouts.
876
+ :type _request_timeout: int, tuple(int, int), optional
877
+ :param _request_auth: set to override the auth_settings for an a single
878
+ request; this effectively ignores the
879
+ authentication in the spec for a single request.
880
+ :type _request_auth: dict, optional
881
+ :param _content_type: force content-type for the request.
882
+ :type _content_type: str, Optional
883
+ :param _headers: set to override the headers for a single
884
+ request; this effectively ignores the headers
885
+ in the spec for a single request.
886
+ :type _headers: dict, optional
887
+ :param _host_index: set to override the host_index for a single
888
+ request; this effectively ignores the host_index
889
+ in the spec for a single request.
890
+ :type _host_index: int, optional
891
+ :return: Returns the result object.
892
+ """ # noqa: E501
893
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
894
+
895
+ _param = self._create_entities_serialize(
896
+ organization_id=organization_id,
897
+ graph_id=graph_id,
898
+ type=type,
899
+ graph_properties=graph_properties,
900
+ _request_auth=_request_auth,
901
+ _content_type=_content_type,
902
+ _headers=_headers,
903
+ _host_index=_host_index
904
+ )
905
+
906
+ _response_types_map: Dict[str, Optional[str]] = {
907
+ '200': "str",
908
+ }
909
+ response_data = self.api_client.call_api(
910
+ *_param,
911
+ _request_timeout=_request_timeout
912
+ )
913
+ return response_data.response
914
+
915
+
916
+ def _create_entities_serialize(
917
+ self,
918
+ organization_id,
919
+ graph_id,
920
+ type,
921
+ graph_properties,
922
+ _request_auth,
923
+ _content_type,
924
+ _headers,
925
+ _host_index,
926
+ ) -> RequestSerialized:
927
+
928
+ _host = None
929
+
930
+ _collection_formats: Dict[str, str] = {
931
+ 'GraphProperties': '',
932
+ }
933
+
934
+ _path_params: Dict[str, str] = {}
935
+ _query_params: List[Tuple[str, str]] = []
936
+ _header_params: Dict[str, Optional[str]] = _headers or {}
937
+ _form_params: List[Tuple[str, str]] = []
938
+ _files: Dict[str, str] = {}
939
+ _body_params: Optional[bytes] = None
940
+
941
+ # process the path parameters
942
+ if organization_id is not None:
943
+ _path_params['organization_id'] = organization_id
944
+ if graph_id is not None:
945
+ _path_params['graph_id'] = graph_id
946
+ if type is not None:
947
+ _path_params['type'] = type
948
+ # process the query parameters
949
+ # process the header parameters
950
+ # process the form parameters
951
+ # process the body parameter
952
+ if graph_properties is not None:
953
+ _body_params = graph_properties
954
+
955
+
956
+ # set the HTTP header `Accept`
957
+ _header_params['Accept'] = self.api_client.select_header_accept(
958
+ [
959
+ 'application/json'
960
+ ]
961
+ )
962
+
963
+ # set the HTTP header `Content-Type`
964
+ if _content_type:
965
+ _header_params['Content-Type'] = _content_type
966
+ else:
967
+ _default_content_type = (
968
+ self.api_client.select_header_content_type(
969
+ [
970
+ 'application/json'
971
+ ]
972
+ )
973
+ )
974
+ if _default_content_type is not None:
975
+ _header_params['Content-Type'] = _default_content_type
976
+
977
+ # authentication setting
978
+ _auth_settings: List[str] = [
979
+ 'oAuth2AuthCode'
980
+ ]
981
+
982
+ return self.api_client.param_serialize(
983
+ method='POST',
984
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/entity/{type}',
985
+ path_params=_path_params,
986
+ query_params=_query_params,
987
+ header_params=_header_params,
988
+ body=_body_params,
989
+ post_params=_form_params,
990
+ files=_files,
991
+ auth_settings=_auth_settings,
992
+ collection_formats=_collection_formats,
993
+ _host=_host,
994
+ _request_auth=_request_auth
995
+ )
996
+
997
+
998
+
999
+
1000
+ @validate_call
1001
+ def create_graph(
1002
+ self,
1003
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1004
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1005
+ body: Optional[Union[StrictBytes, StrictStr]] = None,
1006
+ _request_timeout: Union[
1007
+ None,
1008
+ Annotated[StrictFloat, Field(gt=0)],
1009
+ Tuple[
1010
+ Annotated[StrictFloat, Field(gt=0)],
1011
+ Annotated[StrictFloat, Field(gt=0)]
1012
+ ]
1013
+ ] = None,
1014
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1015
+ _content_type: Optional[StrictStr] = None,
1016
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1017
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1018
+ ) -> None:
1019
+ """(Deprecated) Create a new graph
1020
+
1021
+ To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * id those colomns represent * The source of the edge * The target of the edge * The id of the edge All following columns content are up to you.
1022
+
1023
+ :param organization_id: the Organization identifier (required)
1024
+ :type organization_id: str
1025
+ :param graph_id: the Graph Identifier (required)
1026
+ :type graph_id: str
1027
+ :param body:
1028
+ :type body: bytearray
1029
+ :param _request_timeout: timeout setting for this request. If one
1030
+ number provided, it will be total request
1031
+ timeout. It can also be a pair (tuple) of
1032
+ (connection, read) timeouts.
1033
+ :type _request_timeout: int, tuple(int, int), optional
1034
+ :param _request_auth: set to override the auth_settings for an a single
1035
+ request; this effectively ignores the
1036
+ authentication in the spec for a single request.
1037
+ :type _request_auth: dict, optional
1038
+ :param _content_type: force content-type for the request.
1039
+ :type _content_type: str, Optional
1040
+ :param _headers: set to override the headers for a single
1041
+ request; this effectively ignores the headers
1042
+ in the spec for a single request.
1043
+ :type _headers: dict, optional
1044
+ :param _host_index: set to override the host_index for a single
1045
+ request; this effectively ignores the host_index
1046
+ in the spec for a single request.
1047
+ :type _host_index: int, optional
1048
+ :return: Returns the result object.
1049
+ """ # noqa: E501
1050
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1051
+
1052
+ _param = self._create_graph_serialize(
1053
+ organization_id=organization_id,
1054
+ graph_id=graph_id,
1055
+ body=body,
1056
+ _request_auth=_request_auth,
1057
+ _content_type=_content_type,
1058
+ _headers=_headers,
1059
+ _host_index=_host_index
1060
+ )
1061
+
1062
+ _response_types_map: Dict[str, Optional[str]] = {
1063
+ '204': None,
1064
+ }
1065
+ response_data = self.api_client.call_api(
1066
+ *_param,
1067
+ _request_timeout=_request_timeout
1068
+ )
1069
+ response_data.read()
1070
+ return self.api_client.response_deserialize(
1071
+ response_data=response_data,
1072
+ response_types_map=_response_types_map,
1073
+ ).data
1074
+
1075
+
1076
+ @validate_call
1077
+ def create_graph_with_http_info(
1078
+ self,
1079
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1080
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1081
+ body: Optional[Union[StrictBytes, StrictStr]] = None,
1082
+ _request_timeout: Union[
1083
+ None,
1084
+ Annotated[StrictFloat, Field(gt=0)],
1085
+ Tuple[
1086
+ Annotated[StrictFloat, Field(gt=0)],
1087
+ Annotated[StrictFloat, Field(gt=0)]
1088
+ ]
1089
+ ] = None,
1090
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1091
+ _content_type: Optional[StrictStr] = None,
1092
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1093
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1094
+ ) -> ApiResponse[None]:
1095
+ """(Deprecated) Create a new graph
1096
+
1097
+ To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * id those colomns represent * The source of the edge * The target of the edge * The id of the edge All following columns content are up to you.
1098
+
1099
+ :param organization_id: the Organization identifier (required)
1100
+ :type organization_id: str
1101
+ :param graph_id: the Graph Identifier (required)
1102
+ :type graph_id: str
1103
+ :param body:
1104
+ :type body: bytearray
1105
+ :param _request_timeout: timeout setting for this request. If one
1106
+ number provided, it will be total request
1107
+ timeout. It can also be a pair (tuple) of
1108
+ (connection, read) timeouts.
1109
+ :type _request_timeout: int, tuple(int, int), optional
1110
+ :param _request_auth: set to override the auth_settings for an a single
1111
+ request; this effectively ignores the
1112
+ authentication in the spec for a single request.
1113
+ :type _request_auth: dict, optional
1114
+ :param _content_type: force content-type for the request.
1115
+ :type _content_type: str, Optional
1116
+ :param _headers: set to override the headers for a single
1117
+ request; this effectively ignores the headers
1118
+ in the spec for a single request.
1119
+ :type _headers: dict, optional
1120
+ :param _host_index: set to override the host_index for a single
1121
+ request; this effectively ignores the host_index
1122
+ in the spec for a single request.
1123
+ :type _host_index: int, optional
1124
+ :return: Returns the result object.
1125
+ """ # noqa: E501
1126
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1127
+
1128
+ _param = self._create_graph_serialize(
1129
+ organization_id=organization_id,
1130
+ graph_id=graph_id,
1131
+ body=body,
1132
+ _request_auth=_request_auth,
1133
+ _content_type=_content_type,
1134
+ _headers=_headers,
1135
+ _host_index=_host_index
1136
+ )
1137
+
1138
+ _response_types_map: Dict[str, Optional[str]] = {
1139
+ '204': None,
1140
+ }
1141
+ response_data = self.api_client.call_api(
1142
+ *_param,
1143
+ _request_timeout=_request_timeout
1144
+ )
1145
+ response_data.read()
1146
+ return self.api_client.response_deserialize(
1147
+ response_data=response_data,
1148
+ response_types_map=_response_types_map,
1149
+ )
1150
+
1151
+
1152
+ @validate_call
1153
+ def create_graph_without_preload_content(
1154
+ self,
1155
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1156
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1157
+ body: Optional[Union[StrictBytes, StrictStr]] = None,
1158
+ _request_timeout: Union[
1159
+ None,
1160
+ Annotated[StrictFloat, Field(gt=0)],
1161
+ Tuple[
1162
+ Annotated[StrictFloat, Field(gt=0)],
1163
+ Annotated[StrictFloat, Field(gt=0)]
1164
+ ]
1165
+ ] = None,
1166
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1167
+ _content_type: Optional[StrictStr] = None,
1168
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1169
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1170
+ ) -> RESTResponseType:
1171
+ """(Deprecated) Create a new graph
1172
+
1173
+ To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * id those colomns represent * The source of the edge * The target of the edge * The id of the edge All following columns content are up to you.
1174
+
1175
+ :param organization_id: the Organization identifier (required)
1176
+ :type organization_id: str
1177
+ :param graph_id: the Graph Identifier (required)
1178
+ :type graph_id: str
1179
+ :param body:
1180
+ :type body: bytearray
1181
+ :param _request_timeout: timeout setting for this request. If one
1182
+ number provided, it will be total request
1183
+ timeout. It can also be a pair (tuple) of
1184
+ (connection, read) timeouts.
1185
+ :type _request_timeout: int, tuple(int, int), optional
1186
+ :param _request_auth: set to override the auth_settings for an a single
1187
+ request; this effectively ignores the
1188
+ authentication in the spec for a single request.
1189
+ :type _request_auth: dict, optional
1190
+ :param _content_type: force content-type for the request.
1191
+ :type _content_type: str, Optional
1192
+ :param _headers: set to override the headers for a single
1193
+ request; this effectively ignores the headers
1194
+ in the spec for a single request.
1195
+ :type _headers: dict, optional
1196
+ :param _host_index: set to override the host_index for a single
1197
+ request; this effectively ignores the host_index
1198
+ in the spec for a single request.
1199
+ :type _host_index: int, optional
1200
+ :return: Returns the result object.
1201
+ """ # noqa: E501
1202
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1203
+
1204
+ _param = self._create_graph_serialize(
1205
+ organization_id=organization_id,
1206
+ graph_id=graph_id,
1207
+ body=body,
1208
+ _request_auth=_request_auth,
1209
+ _content_type=_content_type,
1210
+ _headers=_headers,
1211
+ _host_index=_host_index
1212
+ )
1213
+
1214
+ _response_types_map: Dict[str, Optional[str]] = {
1215
+ '204': None,
1216
+ }
1217
+ response_data = self.api_client.call_api(
1218
+ *_param,
1219
+ _request_timeout=_request_timeout
1220
+ )
1221
+ return response_data.response
1222
+
1223
+
1224
+ def _create_graph_serialize(
1225
+ self,
1226
+ organization_id,
1227
+ graph_id,
1228
+ body,
1229
+ _request_auth,
1230
+ _content_type,
1231
+ _headers,
1232
+ _host_index,
1233
+ ) -> RequestSerialized:
1234
+
1235
+ _host = None
1236
+
1237
+ _collection_formats: Dict[str, str] = {
1238
+ }
1239
+
1240
+ _path_params: Dict[str, str] = {}
1241
+ _query_params: List[Tuple[str, str]] = []
1242
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1243
+ _form_params: List[Tuple[str, str]] = []
1244
+ _files: Dict[str, str] = {}
1245
+ _body_params: Optional[bytes] = None
1246
+
1247
+ # process the path parameters
1248
+ if organization_id is not None:
1249
+ _path_params['organization_id'] = organization_id
1250
+ if graph_id is not None:
1251
+ _path_params['graph_id'] = graph_id
1252
+ # process the query parameters
1253
+ # process the header parameters
1254
+ # process the form parameters
1255
+ # process the body parameter
1256
+ if body is not None:
1257
+ # convert to byte array if the input is a file name (str)
1258
+ if isinstance(body, str):
1259
+ with open(body, "rb") as _fp:
1260
+ _body_params = _fp.read()
1261
+ else:
1262
+ _body_params = body
1263
+
1264
+
1265
+
1266
+ # set the HTTP header `Content-Type`
1267
+ if _content_type:
1268
+ _header_params['Content-Type'] = _content_type
1269
+ else:
1270
+ _default_content_type = (
1271
+ self.api_client.select_header_content_type(
1272
+ [
1273
+ 'application/octet-stream'
1274
+ ]
1275
+ )
1276
+ )
1277
+ if _default_content_type is not None:
1278
+ _header_params['Content-Type'] = _default_content_type
1279
+
1280
+ # authentication setting
1281
+ _auth_settings: List[str] = [
1282
+ 'oAuth2AuthCode'
1283
+ ]
1284
+
1285
+ return self.api_client.param_serialize(
1286
+ method='POST',
1287
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}',
1288
+ path_params=_path_params,
1289
+ query_params=_query_params,
1290
+ header_params=_header_params,
1291
+ body=_body_params,
1292
+ post_params=_form_params,
1293
+ files=_files,
1294
+ auth_settings=_auth_settings,
1295
+ collection_formats=_collection_formats,
1296
+ _host=_host,
1297
+ _request_auth=_request_auth
1298
+ )
1299
+
1300
+
1301
+
1302
+
1303
+ @validate_call
1304
+ def delete(
1305
+ self,
1306
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1307
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1308
+ _request_timeout: Union[
1309
+ None,
1310
+ Annotated[StrictFloat, Field(gt=0)],
1311
+ Tuple[
1312
+ Annotated[StrictFloat, Field(gt=0)],
1313
+ Annotated[StrictFloat, Field(gt=0)]
1314
+ ]
1315
+ ] = None,
1316
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1317
+ _content_type: Optional[StrictStr] = None,
1318
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1319
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1320
+ ) -> None:
1321
+ """(Deprecated) Delete all versions of a graph and his metadatas
1322
+
1323
+ Delete all versions of a graph and his metadatas
1324
+
1325
+ :param organization_id: the Organization identifier (required)
1326
+ :type organization_id: str
1327
+ :param graph_id: the Graph Identifier (required)
1328
+ :type graph_id: str
1329
+ :param _request_timeout: timeout setting for this request. If one
1330
+ number provided, it will be total request
1331
+ timeout. It can also be a pair (tuple) of
1332
+ (connection, read) timeouts.
1333
+ :type _request_timeout: int, tuple(int, int), optional
1334
+ :param _request_auth: set to override the auth_settings for an a single
1335
+ request; this effectively ignores the
1336
+ authentication in the spec for a single request.
1337
+ :type _request_auth: dict, optional
1338
+ :param _content_type: force content-type for the request.
1339
+ :type _content_type: str, Optional
1340
+ :param _headers: set to override the headers for a single
1341
+ request; this effectively ignores the headers
1342
+ in the spec for a single request.
1343
+ :type _headers: dict, optional
1344
+ :param _host_index: set to override the host_index for a single
1345
+ request; this effectively ignores the host_index
1346
+ in the spec for a single request.
1347
+ :type _host_index: int, optional
1348
+ :return: Returns the result object.
1349
+ """ # noqa: E501
1350
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1351
+
1352
+ _param = self._delete_serialize(
1353
+ organization_id=organization_id,
1354
+ graph_id=graph_id,
1355
+ _request_auth=_request_auth,
1356
+ _content_type=_content_type,
1357
+ _headers=_headers,
1358
+ _host_index=_host_index
1359
+ )
1360
+
1361
+ _response_types_map: Dict[str, Optional[str]] = {
1362
+ '204': None,
1363
+ }
1364
+ response_data = self.api_client.call_api(
1365
+ *_param,
1366
+ _request_timeout=_request_timeout
1367
+ )
1368
+ response_data.read()
1369
+ return self.api_client.response_deserialize(
1370
+ response_data=response_data,
1371
+ response_types_map=_response_types_map,
1372
+ ).data
1373
+
1374
+
1375
+ @validate_call
1376
+ def delete_with_http_info(
1377
+ self,
1378
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1379
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1380
+ _request_timeout: Union[
1381
+ None,
1382
+ Annotated[StrictFloat, Field(gt=0)],
1383
+ Tuple[
1384
+ Annotated[StrictFloat, Field(gt=0)],
1385
+ Annotated[StrictFloat, Field(gt=0)]
1386
+ ]
1387
+ ] = None,
1388
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1389
+ _content_type: Optional[StrictStr] = None,
1390
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1391
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1392
+ ) -> ApiResponse[None]:
1393
+ """(Deprecated) Delete all versions of a graph and his metadatas
1394
+
1395
+ Delete all versions of a graph and his metadatas
1396
+
1397
+ :param organization_id: the Organization identifier (required)
1398
+ :type organization_id: str
1399
+ :param graph_id: the Graph Identifier (required)
1400
+ :type graph_id: str
1401
+ :param _request_timeout: timeout setting for this request. If one
1402
+ number provided, it will be total request
1403
+ timeout. It can also be a pair (tuple) of
1404
+ (connection, read) timeouts.
1405
+ :type _request_timeout: int, tuple(int, int), optional
1406
+ :param _request_auth: set to override the auth_settings for an a single
1407
+ request; this effectively ignores the
1408
+ authentication in the spec for a single request.
1409
+ :type _request_auth: dict, optional
1410
+ :param _content_type: force content-type for the request.
1411
+ :type _content_type: str, Optional
1412
+ :param _headers: set to override the headers for a single
1413
+ request; this effectively ignores the headers
1414
+ in the spec for a single request.
1415
+ :type _headers: dict, optional
1416
+ :param _host_index: set to override the host_index for a single
1417
+ request; this effectively ignores the host_index
1418
+ in the spec for a single request.
1419
+ :type _host_index: int, optional
1420
+ :return: Returns the result object.
1421
+ """ # noqa: E501
1422
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1423
+
1424
+ _param = self._delete_serialize(
1425
+ organization_id=organization_id,
1426
+ graph_id=graph_id,
1427
+ _request_auth=_request_auth,
1428
+ _content_type=_content_type,
1429
+ _headers=_headers,
1430
+ _host_index=_host_index
1431
+ )
1432
+
1433
+ _response_types_map: Dict[str, Optional[str]] = {
1434
+ '204': None,
1435
+ }
1436
+ response_data = self.api_client.call_api(
1437
+ *_param,
1438
+ _request_timeout=_request_timeout
1439
+ )
1440
+ response_data.read()
1441
+ return self.api_client.response_deserialize(
1442
+ response_data=response_data,
1443
+ response_types_map=_response_types_map,
1444
+ )
1445
+
1446
+
1447
+ @validate_call
1448
+ def delete_without_preload_content(
1449
+ self,
1450
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1451
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1452
+ _request_timeout: Union[
1453
+ None,
1454
+ Annotated[StrictFloat, Field(gt=0)],
1455
+ Tuple[
1456
+ Annotated[StrictFloat, Field(gt=0)],
1457
+ Annotated[StrictFloat, Field(gt=0)]
1458
+ ]
1459
+ ] = None,
1460
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1461
+ _content_type: Optional[StrictStr] = None,
1462
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1463
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1464
+ ) -> RESTResponseType:
1465
+ """(Deprecated) Delete all versions of a graph and his metadatas
1466
+
1467
+ Delete all versions of a graph and his metadatas
1468
+
1469
+ :param organization_id: the Organization identifier (required)
1470
+ :type organization_id: str
1471
+ :param graph_id: the Graph Identifier (required)
1472
+ :type graph_id: str
1473
+ :param _request_timeout: timeout setting for this request. If one
1474
+ number provided, it will be total request
1475
+ timeout. It can also be a pair (tuple) of
1476
+ (connection, read) timeouts.
1477
+ :type _request_timeout: int, tuple(int, int), optional
1478
+ :param _request_auth: set to override the auth_settings for an a single
1479
+ request; this effectively ignores the
1480
+ authentication in the spec for a single request.
1481
+ :type _request_auth: dict, optional
1482
+ :param _content_type: force content-type for the request.
1483
+ :type _content_type: str, Optional
1484
+ :param _headers: set to override the headers for a single
1485
+ request; this effectively ignores the headers
1486
+ in the spec for a single request.
1487
+ :type _headers: dict, optional
1488
+ :param _host_index: set to override the host_index for a single
1489
+ request; this effectively ignores the host_index
1490
+ in the spec for a single request.
1491
+ :type _host_index: int, optional
1492
+ :return: Returns the result object.
1493
+ """ # noqa: E501
1494
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id} is deprecated.", DeprecationWarning)
1495
+
1496
+ _param = self._delete_serialize(
1497
+ organization_id=organization_id,
1498
+ graph_id=graph_id,
1499
+ _request_auth=_request_auth,
1500
+ _content_type=_content_type,
1501
+ _headers=_headers,
1502
+ _host_index=_host_index
1503
+ )
1504
+
1505
+ _response_types_map: Dict[str, Optional[str]] = {
1506
+ '204': None,
1507
+ }
1508
+ response_data = self.api_client.call_api(
1509
+ *_param,
1510
+ _request_timeout=_request_timeout
1511
+ )
1512
+ return response_data.response
1513
+
1514
+
1515
+ def _delete_serialize(
1516
+ self,
1517
+ organization_id,
1518
+ graph_id,
1519
+ _request_auth,
1520
+ _content_type,
1521
+ _headers,
1522
+ _host_index,
1523
+ ) -> RequestSerialized:
1524
+
1525
+ _host = None
1526
+
1527
+ _collection_formats: Dict[str, str] = {
1528
+ }
1529
+
1530
+ _path_params: Dict[str, str] = {}
1531
+ _query_params: List[Tuple[str, str]] = []
1532
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1533
+ _form_params: List[Tuple[str, str]] = []
1534
+ _files: Dict[str, str] = {}
1535
+ _body_params: Optional[bytes] = None
1536
+
1537
+ # process the path parameters
1538
+ if organization_id is not None:
1539
+ _path_params['organization_id'] = organization_id
1540
+ if graph_id is not None:
1541
+ _path_params['graph_id'] = graph_id
1542
+ # process the query parameters
1543
+ # process the header parameters
1544
+ # process the form parameters
1545
+ # process the body parameter
1546
+
1547
+
1548
+
1549
+
1550
+ # authentication setting
1551
+ _auth_settings: List[str] = [
1552
+ 'oAuth2AuthCode'
1553
+ ]
1554
+
1555
+ return self.api_client.param_serialize(
1556
+ method='DELETE',
1557
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}',
1558
+ path_params=_path_params,
1559
+ query_params=_query_params,
1560
+ header_params=_header_params,
1561
+ body=_body_params,
1562
+ post_params=_form_params,
1563
+ files=_files,
1564
+ auth_settings=_auth_settings,
1565
+ collection_formats=_collection_formats,
1566
+ _host=_host,
1567
+ _request_auth=_request_auth
1568
+ )
1569
+
1570
+
1571
+
1572
+
1573
+ @validate_call
1574
+ def delete_entities(
1575
+ self,
1576
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1577
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1578
+ type: Annotated[StrictStr, Field(description="the entity model type")],
1579
+ ids: Annotated[List[StrictStr], Field(description="the entities to delete")],
1580
+ _request_timeout: Union[
1581
+ None,
1582
+ Annotated[StrictFloat, Field(gt=0)],
1583
+ Tuple[
1584
+ Annotated[StrictFloat, Field(gt=0)],
1585
+ Annotated[StrictFloat, Field(gt=0)]
1586
+ ]
1587
+ ] = None,
1588
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1589
+ _content_type: Optional[StrictStr] = None,
1590
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1591
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1592
+ ) -> None:
1593
+ """(Deprecated) Delete entities in a graph instance
1594
+
1595
+ delete entities in a graph instance
1596
+
1597
+ :param organization_id: the Organization identifier (required)
1598
+ :type organization_id: str
1599
+ :param graph_id: the Graph Identifier (required)
1600
+ :type graph_id: str
1601
+ :param type: the entity model type (required)
1602
+ :type type: str
1603
+ :param ids: the entities to delete (required)
1604
+ :type ids: List[str]
1605
+ :param _request_timeout: timeout setting for this request. If one
1606
+ number provided, it will be total request
1607
+ timeout. It can also be a pair (tuple) of
1608
+ (connection, read) timeouts.
1609
+ :type _request_timeout: int, tuple(int, int), optional
1610
+ :param _request_auth: set to override the auth_settings for an a single
1611
+ request; this effectively ignores the
1612
+ authentication in the spec for a single request.
1613
+ :type _request_auth: dict, optional
1614
+ :param _content_type: force content-type for the request.
1615
+ :type _content_type: str, Optional
1616
+ :param _headers: set to override the headers for a single
1617
+ request; this effectively ignores the headers
1618
+ in the spec for a single request.
1619
+ :type _headers: dict, optional
1620
+ :param _host_index: set to override the host_index for a single
1621
+ request; this effectively ignores the host_index
1622
+ in the spec for a single request.
1623
+ :type _host_index: int, optional
1624
+ :return: Returns the result object.
1625
+ """ # noqa: E501
1626
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
1627
+
1628
+ _param = self._delete_entities_serialize(
1629
+ organization_id=organization_id,
1630
+ graph_id=graph_id,
1631
+ type=type,
1632
+ ids=ids,
1633
+ _request_auth=_request_auth,
1634
+ _content_type=_content_type,
1635
+ _headers=_headers,
1636
+ _host_index=_host_index
1637
+ )
1638
+
1639
+ _response_types_map: Dict[str, Optional[str]] = {
1640
+ '200': None,
1641
+ }
1642
+ response_data = self.api_client.call_api(
1643
+ *_param,
1644
+ _request_timeout=_request_timeout
1645
+ )
1646
+ response_data.read()
1647
+ return self.api_client.response_deserialize(
1648
+ response_data=response_data,
1649
+ response_types_map=_response_types_map,
1650
+ ).data
1651
+
1652
+
1653
+ @validate_call
1654
+ def delete_entities_with_http_info(
1655
+ self,
1656
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1657
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1658
+ type: Annotated[StrictStr, Field(description="the entity model type")],
1659
+ ids: Annotated[List[StrictStr], Field(description="the entities to delete")],
1660
+ _request_timeout: Union[
1661
+ None,
1662
+ Annotated[StrictFloat, Field(gt=0)],
1663
+ Tuple[
1664
+ Annotated[StrictFloat, Field(gt=0)],
1665
+ Annotated[StrictFloat, Field(gt=0)]
1666
+ ]
1667
+ ] = None,
1668
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1669
+ _content_type: Optional[StrictStr] = None,
1670
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1671
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1672
+ ) -> ApiResponse[None]:
1673
+ """(Deprecated) Delete entities in a graph instance
1674
+
1675
+ delete entities in a graph instance
1676
+
1677
+ :param organization_id: the Organization identifier (required)
1678
+ :type organization_id: str
1679
+ :param graph_id: the Graph Identifier (required)
1680
+ :type graph_id: str
1681
+ :param type: the entity model type (required)
1682
+ :type type: str
1683
+ :param ids: the entities to delete (required)
1684
+ :type ids: List[str]
1685
+ :param _request_timeout: timeout setting for this request. If one
1686
+ number provided, it will be total request
1687
+ timeout. It can also be a pair (tuple) of
1688
+ (connection, read) timeouts.
1689
+ :type _request_timeout: int, tuple(int, int), optional
1690
+ :param _request_auth: set to override the auth_settings for an a single
1691
+ request; this effectively ignores the
1692
+ authentication in the spec for a single request.
1693
+ :type _request_auth: dict, optional
1694
+ :param _content_type: force content-type for the request.
1695
+ :type _content_type: str, Optional
1696
+ :param _headers: set to override the headers for a single
1697
+ request; this effectively ignores the headers
1698
+ in the spec for a single request.
1699
+ :type _headers: dict, optional
1700
+ :param _host_index: set to override the host_index for a single
1701
+ request; this effectively ignores the host_index
1702
+ in the spec for a single request.
1703
+ :type _host_index: int, optional
1704
+ :return: Returns the result object.
1705
+ """ # noqa: E501
1706
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
1707
+
1708
+ _param = self._delete_entities_serialize(
1709
+ organization_id=organization_id,
1710
+ graph_id=graph_id,
1711
+ type=type,
1712
+ ids=ids,
1713
+ _request_auth=_request_auth,
1714
+ _content_type=_content_type,
1715
+ _headers=_headers,
1716
+ _host_index=_host_index
1717
+ )
1718
+
1719
+ _response_types_map: Dict[str, Optional[str]] = {
1720
+ '200': None,
1721
+ }
1722
+ response_data = self.api_client.call_api(
1723
+ *_param,
1724
+ _request_timeout=_request_timeout
1725
+ )
1726
+ response_data.read()
1727
+ return self.api_client.response_deserialize(
1728
+ response_data=response_data,
1729
+ response_types_map=_response_types_map,
1730
+ )
1731
+
1732
+
1733
+ @validate_call
1734
+ def delete_entities_without_preload_content(
1735
+ self,
1736
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1737
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
1738
+ type: Annotated[StrictStr, Field(description="the entity model type")],
1739
+ ids: Annotated[List[StrictStr], Field(description="the entities to delete")],
1740
+ _request_timeout: Union[
1741
+ None,
1742
+ Annotated[StrictFloat, Field(gt=0)],
1743
+ Tuple[
1744
+ Annotated[StrictFloat, Field(gt=0)],
1745
+ Annotated[StrictFloat, Field(gt=0)]
1746
+ ]
1747
+ ] = None,
1748
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1749
+ _content_type: Optional[StrictStr] = None,
1750
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1751
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1752
+ ) -> RESTResponseType:
1753
+ """(Deprecated) Delete entities in a graph instance
1754
+
1755
+ delete entities in a graph instance
1756
+
1757
+ :param organization_id: the Organization identifier (required)
1758
+ :type organization_id: str
1759
+ :param graph_id: the Graph Identifier (required)
1760
+ :type graph_id: str
1761
+ :param type: the entity model type (required)
1762
+ :type type: str
1763
+ :param ids: the entities to delete (required)
1764
+ :type ids: List[str]
1765
+ :param _request_timeout: timeout setting for this request. If one
1766
+ number provided, it will be total request
1767
+ timeout. It can also be a pair (tuple) of
1768
+ (connection, read) timeouts.
1769
+ :type _request_timeout: int, tuple(int, int), optional
1770
+ :param _request_auth: set to override the auth_settings for an a single
1771
+ request; this effectively ignores the
1772
+ authentication in the spec for a single request.
1773
+ :type _request_auth: dict, optional
1774
+ :param _content_type: force content-type for the request.
1775
+ :type _content_type: str, Optional
1776
+ :param _headers: set to override the headers for a single
1777
+ request; this effectively ignores the headers
1778
+ in the spec for a single request.
1779
+ :type _headers: dict, optional
1780
+ :param _host_index: set to override the host_index for a single
1781
+ request; this effectively ignores the host_index
1782
+ in the spec for a single request.
1783
+ :type _host_index: int, optional
1784
+ :return: Returns the result object.
1785
+ """ # noqa: E501
1786
+ warnings.warn("DELETE /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
1787
+
1788
+ _param = self._delete_entities_serialize(
1789
+ organization_id=organization_id,
1790
+ graph_id=graph_id,
1791
+ type=type,
1792
+ ids=ids,
1793
+ _request_auth=_request_auth,
1794
+ _content_type=_content_type,
1795
+ _headers=_headers,
1796
+ _host_index=_host_index
1797
+ )
1798
+
1799
+ _response_types_map: Dict[str, Optional[str]] = {
1800
+ '200': None,
1801
+ }
1802
+ response_data = self.api_client.call_api(
1803
+ *_param,
1804
+ _request_timeout=_request_timeout
1805
+ )
1806
+ return response_data.response
1807
+
1808
+
1809
+ def _delete_entities_serialize(
1810
+ self,
1811
+ organization_id,
1812
+ graph_id,
1813
+ type,
1814
+ ids,
1815
+ _request_auth,
1816
+ _content_type,
1817
+ _headers,
1818
+ _host_index,
1819
+ ) -> RequestSerialized:
1820
+
1821
+ _host = None
1822
+
1823
+ _collection_formats: Dict[str, str] = {
1824
+ 'ids': 'multi',
1825
+ }
1826
+
1827
+ _path_params: Dict[str, str] = {}
1828
+ _query_params: List[Tuple[str, str]] = []
1829
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1830
+ _form_params: List[Tuple[str, str]] = []
1831
+ _files: Dict[str, str] = {}
1832
+ _body_params: Optional[bytes] = None
1833
+
1834
+ # process the path parameters
1835
+ if organization_id is not None:
1836
+ _path_params['organization_id'] = organization_id
1837
+ if graph_id is not None:
1838
+ _path_params['graph_id'] = graph_id
1839
+ if type is not None:
1840
+ _path_params['type'] = type
1841
+ # process the query parameters
1842
+ if ids is not None:
1843
+
1844
+ _query_params.append(('ids', ids))
1845
+
1846
+ # process the header parameters
1847
+ # process the form parameters
1848
+ # process the body parameter
1849
+
1850
+
1851
+
1852
+
1853
+ # authentication setting
1854
+ _auth_settings: List[str] = [
1855
+ 'oAuth2AuthCode'
1856
+ ]
1857
+
1858
+ return self.api_client.param_serialize(
1859
+ method='DELETE',
1860
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/entity/{type}',
1861
+ path_params=_path_params,
1862
+ query_params=_query_params,
1863
+ header_params=_header_params,
1864
+ body=_body_params,
1865
+ post_params=_form_params,
1866
+ files=_files,
1867
+ auth_settings=_auth_settings,
1868
+ collection_formats=_collection_formats,
1869
+ _host=_host,
1870
+ _request_auth=_request_auth
1871
+ )
1872
+
1873
+
1874
+
1875
+
1876
+ @validate_call
1877
+ def download_graph(
1878
+ self,
1879
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1880
+ hash: Annotated[StrictStr, Field(description="the Graph download identifier")],
1881
+ _request_timeout: Union[
1882
+ None,
1883
+ Annotated[StrictFloat, Field(gt=0)],
1884
+ Tuple[
1885
+ Annotated[StrictFloat, Field(gt=0)],
1886
+ Annotated[StrictFloat, Field(gt=0)]
1887
+ ]
1888
+ ] = None,
1889
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1890
+ _content_type: Optional[StrictStr] = None,
1891
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1892
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1893
+ ) -> bytearray:
1894
+ """(Deprecated) Download a graph compressed in a zip file
1895
+
1896
+ Download a graph compressed in a zip file
1897
+
1898
+ :param organization_id: the Organization identifier (required)
1899
+ :type organization_id: str
1900
+ :param hash: the Graph download identifier (required)
1901
+ :type hash: str
1902
+ :param _request_timeout: timeout setting for this request. If one
1903
+ number provided, it will be total request
1904
+ timeout. It can also be a pair (tuple) of
1905
+ (connection, read) timeouts.
1906
+ :type _request_timeout: int, tuple(int, int), optional
1907
+ :param _request_auth: set to override the auth_settings for an a single
1908
+ request; this effectively ignores the
1909
+ authentication in the spec for a single request.
1910
+ :type _request_auth: dict, optional
1911
+ :param _content_type: force content-type for the request.
1912
+ :type _content_type: str, Optional
1913
+ :param _headers: set to override the headers for a single
1914
+ request; this effectively ignores the headers
1915
+ in the spec for a single request.
1916
+ :type _headers: dict, optional
1917
+ :param _host_index: set to override the host_index for a single
1918
+ request; this effectively ignores the host_index
1919
+ in the spec for a single request.
1920
+ :type _host_index: int, optional
1921
+ :return: Returns the result object.
1922
+ """ # noqa: E501
1923
+ warnings.warn("GET /organizations/{organization_id}/twingraph/download/{hash} is deprecated.", DeprecationWarning)
1924
+
1925
+ _param = self._download_graph_serialize(
1926
+ organization_id=organization_id,
1927
+ hash=hash,
1928
+ _request_auth=_request_auth,
1929
+ _content_type=_content_type,
1930
+ _headers=_headers,
1931
+ _host_index=_host_index
1932
+ )
1933
+
1934
+ _response_types_map: Dict[str, Optional[str]] = {
1935
+ '200': "bytearray",
1936
+ }
1937
+ response_data = self.api_client.call_api(
1938
+ *_param,
1939
+ _request_timeout=_request_timeout
1940
+ )
1941
+ response_data.read()
1942
+ return self.api_client.response_deserialize(
1943
+ response_data=response_data,
1944
+ response_types_map=_response_types_map,
1945
+ ).data
1946
+
1947
+
1948
+ @validate_call
1949
+ def download_graph_with_http_info(
1950
+ self,
1951
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1952
+ hash: Annotated[StrictStr, Field(description="the Graph download identifier")],
1953
+ _request_timeout: Union[
1954
+ None,
1955
+ Annotated[StrictFloat, Field(gt=0)],
1956
+ Tuple[
1957
+ Annotated[StrictFloat, Field(gt=0)],
1958
+ Annotated[StrictFloat, Field(gt=0)]
1959
+ ]
1960
+ ] = None,
1961
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1962
+ _content_type: Optional[StrictStr] = None,
1963
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1964
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1965
+ ) -> ApiResponse[bytearray]:
1966
+ """(Deprecated) Download a graph compressed in a zip file
1967
+
1968
+ Download a graph compressed in a zip file
1969
+
1970
+ :param organization_id: the Organization identifier (required)
1971
+ :type organization_id: str
1972
+ :param hash: the Graph download identifier (required)
1973
+ :type hash: str
1974
+ :param _request_timeout: timeout setting for this request. If one
1975
+ number provided, it will be total request
1976
+ timeout. It can also be a pair (tuple) of
1977
+ (connection, read) timeouts.
1978
+ :type _request_timeout: int, tuple(int, int), optional
1979
+ :param _request_auth: set to override the auth_settings for an a single
1980
+ request; this effectively ignores the
1981
+ authentication in the spec for a single request.
1982
+ :type _request_auth: dict, optional
1983
+ :param _content_type: force content-type for the request.
1984
+ :type _content_type: str, Optional
1985
+ :param _headers: set to override the headers for a single
1986
+ request; this effectively ignores the headers
1987
+ in the spec for a single request.
1988
+ :type _headers: dict, optional
1989
+ :param _host_index: set to override the host_index for a single
1990
+ request; this effectively ignores the host_index
1991
+ in the spec for a single request.
1992
+ :type _host_index: int, optional
1993
+ :return: Returns the result object.
1994
+ """ # noqa: E501
1995
+ warnings.warn("GET /organizations/{organization_id}/twingraph/download/{hash} is deprecated.", DeprecationWarning)
1996
+
1997
+ _param = self._download_graph_serialize(
1998
+ organization_id=organization_id,
1999
+ hash=hash,
2000
+ _request_auth=_request_auth,
2001
+ _content_type=_content_type,
2002
+ _headers=_headers,
2003
+ _host_index=_host_index
2004
+ )
2005
+
2006
+ _response_types_map: Dict[str, Optional[str]] = {
2007
+ '200': "bytearray",
2008
+ }
2009
+ response_data = self.api_client.call_api(
2010
+ *_param,
2011
+ _request_timeout=_request_timeout
2012
+ )
2013
+ response_data.read()
2014
+ return self.api_client.response_deserialize(
2015
+ response_data=response_data,
2016
+ response_types_map=_response_types_map,
2017
+ )
2018
+
2019
+
2020
+ @validate_call
2021
+ def download_graph_without_preload_content(
2022
+ self,
2023
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2024
+ hash: Annotated[StrictStr, Field(description="the Graph download identifier")],
2025
+ _request_timeout: Union[
2026
+ None,
2027
+ Annotated[StrictFloat, Field(gt=0)],
2028
+ Tuple[
2029
+ Annotated[StrictFloat, Field(gt=0)],
2030
+ Annotated[StrictFloat, Field(gt=0)]
2031
+ ]
2032
+ ] = None,
2033
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2034
+ _content_type: Optional[StrictStr] = None,
2035
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2036
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2037
+ ) -> RESTResponseType:
2038
+ """(Deprecated) Download a graph compressed in a zip file
2039
+
2040
+ Download a graph compressed in a zip file
2041
+
2042
+ :param organization_id: the Organization identifier (required)
2043
+ :type organization_id: str
2044
+ :param hash: the Graph download identifier (required)
2045
+ :type hash: str
2046
+ :param _request_timeout: timeout setting for this request. If one
2047
+ number provided, it will be total request
2048
+ timeout. It can also be a pair (tuple) of
2049
+ (connection, read) timeouts.
2050
+ :type _request_timeout: int, tuple(int, int), optional
2051
+ :param _request_auth: set to override the auth_settings for an a single
2052
+ request; this effectively ignores the
2053
+ authentication in the spec for a single request.
2054
+ :type _request_auth: dict, optional
2055
+ :param _content_type: force content-type for the request.
2056
+ :type _content_type: str, Optional
2057
+ :param _headers: set to override the headers for a single
2058
+ request; this effectively ignores the headers
2059
+ in the spec for a single request.
2060
+ :type _headers: dict, optional
2061
+ :param _host_index: set to override the host_index for a single
2062
+ request; this effectively ignores the host_index
2063
+ in the spec for a single request.
2064
+ :type _host_index: int, optional
2065
+ :return: Returns the result object.
2066
+ """ # noqa: E501
2067
+ warnings.warn("GET /organizations/{organization_id}/twingraph/download/{hash} is deprecated.", DeprecationWarning)
2068
+
2069
+ _param = self._download_graph_serialize(
2070
+ organization_id=organization_id,
2071
+ hash=hash,
2072
+ _request_auth=_request_auth,
2073
+ _content_type=_content_type,
2074
+ _headers=_headers,
2075
+ _host_index=_host_index
2076
+ )
2077
+
2078
+ _response_types_map: Dict[str, Optional[str]] = {
2079
+ '200': "bytearray",
2080
+ }
2081
+ response_data = self.api_client.call_api(
2082
+ *_param,
2083
+ _request_timeout=_request_timeout
2084
+ )
2085
+ return response_data.response
2086
+
2087
+
2088
+ def _download_graph_serialize(
2089
+ self,
2090
+ organization_id,
2091
+ hash,
2092
+ _request_auth,
2093
+ _content_type,
2094
+ _headers,
2095
+ _host_index,
2096
+ ) -> RequestSerialized:
2097
+
2098
+ _host = None
2099
+
2100
+ _collection_formats: Dict[str, str] = {
2101
+ }
2102
+
2103
+ _path_params: Dict[str, str] = {}
2104
+ _query_params: List[Tuple[str, str]] = []
2105
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2106
+ _form_params: List[Tuple[str, str]] = []
2107
+ _files: Dict[str, str] = {}
2108
+ _body_params: Optional[bytes] = None
2109
+
2110
+ # process the path parameters
2111
+ if organization_id is not None:
2112
+ _path_params['organization_id'] = organization_id
2113
+ if hash is not None:
2114
+ _path_params['hash'] = hash
2115
+ # process the query parameters
2116
+ # process the header parameters
2117
+ # process the form parameters
2118
+ # process the body parameter
2119
+
2120
+
2121
+ # set the HTTP header `Accept`
2122
+ _header_params['Accept'] = self.api_client.select_header_accept(
2123
+ [
2124
+ 'application/octet-stream'
2125
+ ]
2126
+ )
2127
+
2128
+
2129
+ # authentication setting
2130
+ _auth_settings: List[str] = [
2131
+ 'oAuth2AuthCode'
2132
+ ]
2133
+
2134
+ return self.api_client.param_serialize(
2135
+ method='GET',
2136
+ resource_path='/organizations/{organization_id}/twingraph/download/{hash}',
2137
+ path_params=_path_params,
2138
+ query_params=_query_params,
2139
+ header_params=_header_params,
2140
+ body=_body_params,
2141
+ post_params=_form_params,
2142
+ files=_files,
2143
+ auth_settings=_auth_settings,
2144
+ collection_formats=_collection_formats,
2145
+ _host=_host,
2146
+ _request_auth=_request_auth
2147
+ )
2148
+
2149
+
2150
+
2151
+
2152
+ @validate_call
2153
+ def find_all_twingraphs(
2154
+ self,
2155
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2156
+ _request_timeout: Union[
2157
+ None,
2158
+ Annotated[StrictFloat, Field(gt=0)],
2159
+ Tuple[
2160
+ Annotated[StrictFloat, Field(gt=0)],
2161
+ Annotated[StrictFloat, Field(gt=0)]
2162
+ ]
2163
+ ] = None,
2164
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2165
+ _content_type: Optional[StrictStr] = None,
2166
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2167
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2168
+ ) -> List[str]:
2169
+ """(Deprecated) Return the list of all graphs stored in the organization
2170
+
2171
+ Return the list of all graphs stored in the organization
2172
+
2173
+ :param organization_id: the Organization identifier (required)
2174
+ :type organization_id: str
2175
+ :param _request_timeout: timeout setting for this request. If one
2176
+ number provided, it will be total request
2177
+ timeout. It can also be a pair (tuple) of
2178
+ (connection, read) timeouts.
2179
+ :type _request_timeout: int, tuple(int, int), optional
2180
+ :param _request_auth: set to override the auth_settings for an a single
2181
+ request; this effectively ignores the
2182
+ authentication in the spec for a single request.
2183
+ :type _request_auth: dict, optional
2184
+ :param _content_type: force content-type for the request.
2185
+ :type _content_type: str, Optional
2186
+ :param _headers: set to override the headers for a single
2187
+ request; this effectively ignores the headers
2188
+ in the spec for a single request.
2189
+ :type _headers: dict, optional
2190
+ :param _host_index: set to override the host_index for a single
2191
+ request; this effectively ignores the host_index
2192
+ in the spec for a single request.
2193
+ :type _host_index: int, optional
2194
+ :return: Returns the result object.
2195
+ """ # noqa: E501
2196
+ warnings.warn("GET /organizations/{organization_id}/twingraphs is deprecated.", DeprecationWarning)
2197
+
2198
+ _param = self._find_all_twingraphs_serialize(
2199
+ organization_id=organization_id,
2200
+ _request_auth=_request_auth,
2201
+ _content_type=_content_type,
2202
+ _headers=_headers,
2203
+ _host_index=_host_index
2204
+ )
2205
+
2206
+ _response_types_map: Dict[str, Optional[str]] = {
2207
+ '200': "List[str]",
2208
+ }
2209
+ response_data = self.api_client.call_api(
2210
+ *_param,
2211
+ _request_timeout=_request_timeout
2212
+ )
2213
+ response_data.read()
2214
+ return self.api_client.response_deserialize(
2215
+ response_data=response_data,
2216
+ response_types_map=_response_types_map,
2217
+ ).data
2218
+
2219
+
2220
+ @validate_call
2221
+ def find_all_twingraphs_with_http_info(
2222
+ self,
2223
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2224
+ _request_timeout: Union[
2225
+ None,
2226
+ Annotated[StrictFloat, Field(gt=0)],
2227
+ Tuple[
2228
+ Annotated[StrictFloat, Field(gt=0)],
2229
+ Annotated[StrictFloat, Field(gt=0)]
2230
+ ]
2231
+ ] = None,
2232
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2233
+ _content_type: Optional[StrictStr] = None,
2234
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2235
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2236
+ ) -> ApiResponse[List[str]]:
2237
+ """(Deprecated) Return the list of all graphs stored in the organization
2238
+
2239
+ Return the list of all graphs stored in the organization
2240
+
2241
+ :param organization_id: the Organization identifier (required)
2242
+ :type organization_id: str
2243
+ :param _request_timeout: timeout setting for this request. If one
2244
+ number provided, it will be total request
2245
+ timeout. It can also be a pair (tuple) of
2246
+ (connection, read) timeouts.
2247
+ :type _request_timeout: int, tuple(int, int), optional
2248
+ :param _request_auth: set to override the auth_settings for an a single
2249
+ request; this effectively ignores the
2250
+ authentication in the spec for a single request.
2251
+ :type _request_auth: dict, optional
2252
+ :param _content_type: force content-type for the request.
2253
+ :type _content_type: str, Optional
2254
+ :param _headers: set to override the headers for a single
2255
+ request; this effectively ignores the headers
2256
+ in the spec for a single request.
2257
+ :type _headers: dict, optional
2258
+ :param _host_index: set to override the host_index for a single
2259
+ request; this effectively ignores the host_index
2260
+ in the spec for a single request.
2261
+ :type _host_index: int, optional
2262
+ :return: Returns the result object.
2263
+ """ # noqa: E501
2264
+ warnings.warn("GET /organizations/{organization_id}/twingraphs is deprecated.", DeprecationWarning)
2265
+
2266
+ _param = self._find_all_twingraphs_serialize(
2267
+ organization_id=organization_id,
2268
+ _request_auth=_request_auth,
2269
+ _content_type=_content_type,
2270
+ _headers=_headers,
2271
+ _host_index=_host_index
2272
+ )
2273
+
2274
+ _response_types_map: Dict[str, Optional[str]] = {
2275
+ '200': "List[str]",
2276
+ }
2277
+ response_data = self.api_client.call_api(
2278
+ *_param,
2279
+ _request_timeout=_request_timeout
2280
+ )
2281
+ response_data.read()
2282
+ return self.api_client.response_deserialize(
2283
+ response_data=response_data,
2284
+ response_types_map=_response_types_map,
2285
+ )
2286
+
2287
+
2288
+ @validate_call
2289
+ def find_all_twingraphs_without_preload_content(
2290
+ self,
2291
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2292
+ _request_timeout: Union[
2293
+ None,
2294
+ Annotated[StrictFloat, Field(gt=0)],
2295
+ Tuple[
2296
+ Annotated[StrictFloat, Field(gt=0)],
2297
+ Annotated[StrictFloat, Field(gt=0)]
2298
+ ]
2299
+ ] = None,
2300
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2301
+ _content_type: Optional[StrictStr] = None,
2302
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2303
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2304
+ ) -> RESTResponseType:
2305
+ """(Deprecated) Return the list of all graphs stored in the organization
2306
+
2307
+ Return the list of all graphs stored in the organization
2308
+
2309
+ :param organization_id: the Organization identifier (required)
2310
+ :type organization_id: str
2311
+ :param _request_timeout: timeout setting for this request. If one
2312
+ number provided, it will be total request
2313
+ timeout. It can also be a pair (tuple) of
2314
+ (connection, read) timeouts.
2315
+ :type _request_timeout: int, tuple(int, int), optional
2316
+ :param _request_auth: set to override the auth_settings for an a single
2317
+ request; this effectively ignores the
2318
+ authentication in the spec for a single request.
2319
+ :type _request_auth: dict, optional
2320
+ :param _content_type: force content-type for the request.
2321
+ :type _content_type: str, Optional
2322
+ :param _headers: set to override the headers for a single
2323
+ request; this effectively ignores the headers
2324
+ in the spec for a single request.
2325
+ :type _headers: dict, optional
2326
+ :param _host_index: set to override the host_index for a single
2327
+ request; this effectively ignores the host_index
2328
+ in the spec for a single request.
2329
+ :type _host_index: int, optional
2330
+ :return: Returns the result object.
2331
+ """ # noqa: E501
2332
+ warnings.warn("GET /organizations/{organization_id}/twingraphs is deprecated.", DeprecationWarning)
2333
+
2334
+ _param = self._find_all_twingraphs_serialize(
2335
+ organization_id=organization_id,
2336
+ _request_auth=_request_auth,
2337
+ _content_type=_content_type,
2338
+ _headers=_headers,
2339
+ _host_index=_host_index
2340
+ )
2341
+
2342
+ _response_types_map: Dict[str, Optional[str]] = {
2343
+ '200': "List[str]",
2344
+ }
2345
+ response_data = self.api_client.call_api(
2346
+ *_param,
2347
+ _request_timeout=_request_timeout
2348
+ )
2349
+ return response_data.response
2350
+
2351
+
2352
+ def _find_all_twingraphs_serialize(
2353
+ self,
2354
+ organization_id,
2355
+ _request_auth,
2356
+ _content_type,
2357
+ _headers,
2358
+ _host_index,
2359
+ ) -> RequestSerialized:
2360
+
2361
+ _host = None
2362
+
2363
+ _collection_formats: Dict[str, str] = {
2364
+ }
2365
+
2366
+ _path_params: Dict[str, str] = {}
2367
+ _query_params: List[Tuple[str, str]] = []
2368
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2369
+ _form_params: List[Tuple[str, str]] = []
2370
+ _files: Dict[str, str] = {}
2371
+ _body_params: Optional[bytes] = None
2372
+
2373
+ # process the path parameters
2374
+ if organization_id is not None:
2375
+ _path_params['organization_id'] = organization_id
2376
+ # process the query parameters
2377
+ # process the header parameters
2378
+ # process the form parameters
2379
+ # process the body parameter
2380
+
2381
+
2382
+ # set the HTTP header `Accept`
2383
+ _header_params['Accept'] = self.api_client.select_header_accept(
2384
+ [
2385
+ 'application/json'
2386
+ ]
2387
+ )
2388
+
2389
+
2390
+ # authentication setting
2391
+ _auth_settings: List[str] = [
2392
+ 'oAuth2AuthCode'
2393
+ ]
2394
+
2395
+ return self.api_client.param_serialize(
2396
+ method='GET',
2397
+ resource_path='/organizations/{organization_id}/twingraphs',
2398
+ path_params=_path_params,
2399
+ query_params=_query_params,
2400
+ header_params=_header_params,
2401
+ body=_body_params,
2402
+ post_params=_form_params,
2403
+ files=_files,
2404
+ auth_settings=_auth_settings,
2405
+ collection_formats=_collection_formats,
2406
+ _host=_host,
2407
+ _request_auth=_request_auth
2408
+ )
2409
+
2410
+
2411
+
2412
+
2413
+ @validate_call
2414
+ def get_entities(
2415
+ self,
2416
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2417
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2418
+ type: Annotated[StrictStr, Field(description="the entity model type")],
2419
+ ids: Annotated[List[StrictStr], Field(description="the entities to get")],
2420
+ _request_timeout: Union[
2421
+ None,
2422
+ Annotated[StrictFloat, Field(gt=0)],
2423
+ Tuple[
2424
+ Annotated[StrictFloat, Field(gt=0)],
2425
+ Annotated[StrictFloat, Field(gt=0)]
2426
+ ]
2427
+ ] = None,
2428
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2429
+ _content_type: Optional[StrictStr] = None,
2430
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2431
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2432
+ ) -> str:
2433
+ """(Deprecated) Get entities in a graph instance
2434
+
2435
+ get entities in a graph instance
2436
+
2437
+ :param organization_id: the Organization identifier (required)
2438
+ :type organization_id: str
2439
+ :param graph_id: the Graph Identifier (required)
2440
+ :type graph_id: str
2441
+ :param type: the entity model type (required)
2442
+ :type type: str
2443
+ :param ids: the entities to get (required)
2444
+ :type ids: List[str]
2445
+ :param _request_timeout: timeout setting for this request. If one
2446
+ number provided, it will be total request
2447
+ timeout. It can also be a pair (tuple) of
2448
+ (connection, read) timeouts.
2449
+ :type _request_timeout: int, tuple(int, int), optional
2450
+ :param _request_auth: set to override the auth_settings for an a single
2451
+ request; this effectively ignores the
2452
+ authentication in the spec for a single request.
2453
+ :type _request_auth: dict, optional
2454
+ :param _content_type: force content-type for the request.
2455
+ :type _content_type: str, Optional
2456
+ :param _headers: set to override the headers for a single
2457
+ request; this effectively ignores the headers
2458
+ in the spec for a single request.
2459
+ :type _headers: dict, optional
2460
+ :param _host_index: set to override the host_index for a single
2461
+ request; this effectively ignores the host_index
2462
+ in the spec for a single request.
2463
+ :type _host_index: int, optional
2464
+ :return: Returns the result object.
2465
+ """ # noqa: E501
2466
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
2467
+
2468
+ _param = self._get_entities_serialize(
2469
+ organization_id=organization_id,
2470
+ graph_id=graph_id,
2471
+ type=type,
2472
+ ids=ids,
2473
+ _request_auth=_request_auth,
2474
+ _content_type=_content_type,
2475
+ _headers=_headers,
2476
+ _host_index=_host_index
2477
+ )
2478
+
2479
+ _response_types_map: Dict[str, Optional[str]] = {
2480
+ '200': "str",
2481
+ }
2482
+ response_data = self.api_client.call_api(
2483
+ *_param,
2484
+ _request_timeout=_request_timeout
2485
+ )
2486
+ response_data.read()
2487
+ return self.api_client.response_deserialize(
2488
+ response_data=response_data,
2489
+ response_types_map=_response_types_map,
2490
+ ).data
2491
+
2492
+
2493
+ @validate_call
2494
+ def get_entities_with_http_info(
2495
+ self,
2496
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2497
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2498
+ type: Annotated[StrictStr, Field(description="the entity model type")],
2499
+ ids: Annotated[List[StrictStr], Field(description="the entities to get")],
2500
+ _request_timeout: Union[
2501
+ None,
2502
+ Annotated[StrictFloat, Field(gt=0)],
2503
+ Tuple[
2504
+ Annotated[StrictFloat, Field(gt=0)],
2505
+ Annotated[StrictFloat, Field(gt=0)]
2506
+ ]
2507
+ ] = None,
2508
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2509
+ _content_type: Optional[StrictStr] = None,
2510
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2511
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2512
+ ) -> ApiResponse[str]:
2513
+ """(Deprecated) Get entities in a graph instance
2514
+
2515
+ get entities in a graph instance
2516
+
2517
+ :param organization_id: the Organization identifier (required)
2518
+ :type organization_id: str
2519
+ :param graph_id: the Graph Identifier (required)
2520
+ :type graph_id: str
2521
+ :param type: the entity model type (required)
2522
+ :type type: str
2523
+ :param ids: the entities to get (required)
2524
+ :type ids: List[str]
2525
+ :param _request_timeout: timeout setting for this request. If one
2526
+ number provided, it will be total request
2527
+ timeout. It can also be a pair (tuple) of
2528
+ (connection, read) timeouts.
2529
+ :type _request_timeout: int, tuple(int, int), optional
2530
+ :param _request_auth: set to override the auth_settings for an a single
2531
+ request; this effectively ignores the
2532
+ authentication in the spec for a single request.
2533
+ :type _request_auth: dict, optional
2534
+ :param _content_type: force content-type for the request.
2535
+ :type _content_type: str, Optional
2536
+ :param _headers: set to override the headers for a single
2537
+ request; this effectively ignores the headers
2538
+ in the spec for a single request.
2539
+ :type _headers: dict, optional
2540
+ :param _host_index: set to override the host_index for a single
2541
+ request; this effectively ignores the host_index
2542
+ in the spec for a single request.
2543
+ :type _host_index: int, optional
2544
+ :return: Returns the result object.
2545
+ """ # noqa: E501
2546
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
2547
+
2548
+ _param = self._get_entities_serialize(
2549
+ organization_id=organization_id,
2550
+ graph_id=graph_id,
2551
+ type=type,
2552
+ ids=ids,
2553
+ _request_auth=_request_auth,
2554
+ _content_type=_content_type,
2555
+ _headers=_headers,
2556
+ _host_index=_host_index
2557
+ )
2558
+
2559
+ _response_types_map: Dict[str, Optional[str]] = {
2560
+ '200': "str",
2561
+ }
2562
+ response_data = self.api_client.call_api(
2563
+ *_param,
2564
+ _request_timeout=_request_timeout
2565
+ )
2566
+ response_data.read()
2567
+ return self.api_client.response_deserialize(
2568
+ response_data=response_data,
2569
+ response_types_map=_response_types_map,
2570
+ )
2571
+
2572
+
2573
+ @validate_call
2574
+ def get_entities_without_preload_content(
2575
+ self,
2576
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2577
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2578
+ type: Annotated[StrictStr, Field(description="the entity model type")],
2579
+ ids: Annotated[List[StrictStr], Field(description="the entities to get")],
2580
+ _request_timeout: Union[
2581
+ None,
2582
+ Annotated[StrictFloat, Field(gt=0)],
2583
+ Tuple[
2584
+ Annotated[StrictFloat, Field(gt=0)],
2585
+ Annotated[StrictFloat, Field(gt=0)]
2586
+ ]
2587
+ ] = None,
2588
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2589
+ _content_type: Optional[StrictStr] = None,
2590
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2591
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2592
+ ) -> RESTResponseType:
2593
+ """(Deprecated) Get entities in a graph instance
2594
+
2595
+ get entities in a graph instance
2596
+
2597
+ :param organization_id: the Organization identifier (required)
2598
+ :type organization_id: str
2599
+ :param graph_id: the Graph Identifier (required)
2600
+ :type graph_id: str
2601
+ :param type: the entity model type (required)
2602
+ :type type: str
2603
+ :param ids: the entities to get (required)
2604
+ :type ids: List[str]
2605
+ :param _request_timeout: timeout setting for this request. If one
2606
+ number provided, it will be total request
2607
+ timeout. It can also be a pair (tuple) of
2608
+ (connection, read) timeouts.
2609
+ :type _request_timeout: int, tuple(int, int), optional
2610
+ :param _request_auth: set to override the auth_settings for an a single
2611
+ request; this effectively ignores the
2612
+ authentication in the spec for a single request.
2613
+ :type _request_auth: dict, optional
2614
+ :param _content_type: force content-type for the request.
2615
+ :type _content_type: str, Optional
2616
+ :param _headers: set to override the headers for a single
2617
+ request; this effectively ignores the headers
2618
+ in the spec for a single request.
2619
+ :type _headers: dict, optional
2620
+ :param _host_index: set to override the host_index for a single
2621
+ request; this effectively ignores the host_index
2622
+ in the spec for a single request.
2623
+ :type _host_index: int, optional
2624
+ :return: Returns the result object.
2625
+ """ # noqa: E501
2626
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
2627
+
2628
+ _param = self._get_entities_serialize(
2629
+ organization_id=organization_id,
2630
+ graph_id=graph_id,
2631
+ type=type,
2632
+ ids=ids,
2633
+ _request_auth=_request_auth,
2634
+ _content_type=_content_type,
2635
+ _headers=_headers,
2636
+ _host_index=_host_index
2637
+ )
2638
+
2639
+ _response_types_map: Dict[str, Optional[str]] = {
2640
+ '200': "str",
2641
+ }
2642
+ response_data = self.api_client.call_api(
2643
+ *_param,
2644
+ _request_timeout=_request_timeout
2645
+ )
2646
+ return response_data.response
2647
+
2648
+
2649
+ def _get_entities_serialize(
2650
+ self,
2651
+ organization_id,
2652
+ graph_id,
2653
+ type,
2654
+ ids,
2655
+ _request_auth,
2656
+ _content_type,
2657
+ _headers,
2658
+ _host_index,
2659
+ ) -> RequestSerialized:
2660
+
2661
+ _host = None
2662
+
2663
+ _collection_formats: Dict[str, str] = {
2664
+ 'ids': 'multi',
2665
+ }
2666
+
2667
+ _path_params: Dict[str, str] = {}
2668
+ _query_params: List[Tuple[str, str]] = []
2669
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2670
+ _form_params: List[Tuple[str, str]] = []
2671
+ _files: Dict[str, str] = {}
2672
+ _body_params: Optional[bytes] = None
2673
+
2674
+ # process the path parameters
2675
+ if organization_id is not None:
2676
+ _path_params['organization_id'] = organization_id
2677
+ if graph_id is not None:
2678
+ _path_params['graph_id'] = graph_id
2679
+ if type is not None:
2680
+ _path_params['type'] = type
2681
+ # process the query parameters
2682
+ if ids is not None:
2683
+
2684
+ _query_params.append(('ids', ids))
2685
+
2686
+ # process the header parameters
2687
+ # process the form parameters
2688
+ # process the body parameter
2689
+
2690
+
2691
+ # set the HTTP header `Accept`
2692
+ _header_params['Accept'] = self.api_client.select_header_accept(
2693
+ [
2694
+ 'application/json'
2695
+ ]
2696
+ )
2697
+
2698
+
2699
+ # authentication setting
2700
+ _auth_settings: List[str] = [
2701
+ 'oAuth2AuthCode'
2702
+ ]
2703
+
2704
+ return self.api_client.param_serialize(
2705
+ method='GET',
2706
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/entity/{type}',
2707
+ path_params=_path_params,
2708
+ query_params=_query_params,
2709
+ header_params=_header_params,
2710
+ body=_body_params,
2711
+ post_params=_form_params,
2712
+ files=_files,
2713
+ auth_settings=_auth_settings,
2714
+ collection_formats=_collection_formats,
2715
+ _host=_host,
2716
+ _request_auth=_request_auth
2717
+ )
2718
+
2719
+
2720
+
2721
+
2722
+ @validate_call
2723
+ def get_graph_meta_data(
2724
+ self,
2725
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2726
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2727
+ _request_timeout: Union[
2728
+ None,
2729
+ Annotated[StrictFloat, Field(gt=0)],
2730
+ Tuple[
2731
+ Annotated[StrictFloat, Field(gt=0)],
2732
+ Annotated[StrictFloat, Field(gt=0)]
2733
+ ]
2734
+ ] = None,
2735
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2736
+ _content_type: Optional[StrictStr] = None,
2737
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2738
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2739
+ ) -> object:
2740
+ """(Deprecated) Return the metaData of the specified graph
2741
+
2742
+ Return the metaData of the specified graph
2743
+
2744
+ :param organization_id: the Organization identifier (required)
2745
+ :type organization_id: str
2746
+ :param graph_id: the Graph Identifier (required)
2747
+ :type graph_id: str
2748
+ :param _request_timeout: timeout setting for this request. If one
2749
+ number provided, it will be total request
2750
+ timeout. It can also be a pair (tuple) of
2751
+ (connection, read) timeouts.
2752
+ :type _request_timeout: int, tuple(int, int), optional
2753
+ :param _request_auth: set to override the auth_settings for an a single
2754
+ request; this effectively ignores the
2755
+ authentication in the spec for a single request.
2756
+ :type _request_auth: dict, optional
2757
+ :param _content_type: force content-type for the request.
2758
+ :type _content_type: str, Optional
2759
+ :param _headers: set to override the headers for a single
2760
+ request; this effectively ignores the headers
2761
+ in the spec for a single request.
2762
+ :type _headers: dict, optional
2763
+ :param _host_index: set to override the host_index for a single
2764
+ request; this effectively ignores the host_index
2765
+ in the spec for a single request.
2766
+ :type _host_index: int, optional
2767
+ :return: Returns the result object.
2768
+ """ # noqa: E501
2769
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
2770
+
2771
+ _param = self._get_graph_meta_data_serialize(
2772
+ organization_id=organization_id,
2773
+ graph_id=graph_id,
2774
+ _request_auth=_request_auth,
2775
+ _content_type=_content_type,
2776
+ _headers=_headers,
2777
+ _host_index=_host_index
2778
+ )
2779
+
2780
+ _response_types_map: Dict[str, Optional[str]] = {
2781
+ '200': "object",
2782
+ }
2783
+ response_data = self.api_client.call_api(
2784
+ *_param,
2785
+ _request_timeout=_request_timeout
2786
+ )
2787
+ response_data.read()
2788
+ return self.api_client.response_deserialize(
2789
+ response_data=response_data,
2790
+ response_types_map=_response_types_map,
2791
+ ).data
2792
+
2793
+
2794
+ @validate_call
2795
+ def get_graph_meta_data_with_http_info(
2796
+ self,
2797
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2798
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2799
+ _request_timeout: Union[
2800
+ None,
2801
+ Annotated[StrictFloat, Field(gt=0)],
2802
+ Tuple[
2803
+ Annotated[StrictFloat, Field(gt=0)],
2804
+ Annotated[StrictFloat, Field(gt=0)]
2805
+ ]
2806
+ ] = None,
2807
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2808
+ _content_type: Optional[StrictStr] = None,
2809
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2810
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2811
+ ) -> ApiResponse[object]:
2812
+ """(Deprecated) Return the metaData of the specified graph
2813
+
2814
+ Return the metaData of the specified graph
2815
+
2816
+ :param organization_id: the Organization identifier (required)
2817
+ :type organization_id: str
2818
+ :param graph_id: the Graph Identifier (required)
2819
+ :type graph_id: str
2820
+ :param _request_timeout: timeout setting for this request. If one
2821
+ number provided, it will be total request
2822
+ timeout. It can also be a pair (tuple) of
2823
+ (connection, read) timeouts.
2824
+ :type _request_timeout: int, tuple(int, int), optional
2825
+ :param _request_auth: set to override the auth_settings for an a single
2826
+ request; this effectively ignores the
2827
+ authentication in the spec for a single request.
2828
+ :type _request_auth: dict, optional
2829
+ :param _content_type: force content-type for the request.
2830
+ :type _content_type: str, Optional
2831
+ :param _headers: set to override the headers for a single
2832
+ request; this effectively ignores the headers
2833
+ in the spec for a single request.
2834
+ :type _headers: dict, optional
2835
+ :param _host_index: set to override the host_index for a single
2836
+ request; this effectively ignores the host_index
2837
+ in the spec for a single request.
2838
+ :type _host_index: int, optional
2839
+ :return: Returns the result object.
2840
+ """ # noqa: E501
2841
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
2842
+
2843
+ _param = self._get_graph_meta_data_serialize(
2844
+ organization_id=organization_id,
2845
+ graph_id=graph_id,
2846
+ _request_auth=_request_auth,
2847
+ _content_type=_content_type,
2848
+ _headers=_headers,
2849
+ _host_index=_host_index
2850
+ )
2851
+
2852
+ _response_types_map: Dict[str, Optional[str]] = {
2853
+ '200': "object",
2854
+ }
2855
+ response_data = self.api_client.call_api(
2856
+ *_param,
2857
+ _request_timeout=_request_timeout
2858
+ )
2859
+ response_data.read()
2860
+ return self.api_client.response_deserialize(
2861
+ response_data=response_data,
2862
+ response_types_map=_response_types_map,
2863
+ )
2864
+
2865
+
2866
+ @validate_call
2867
+ def get_graph_meta_data_without_preload_content(
2868
+ self,
2869
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2870
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
2871
+ _request_timeout: Union[
2872
+ None,
2873
+ Annotated[StrictFloat, Field(gt=0)],
2874
+ Tuple[
2875
+ Annotated[StrictFloat, Field(gt=0)],
2876
+ Annotated[StrictFloat, Field(gt=0)]
2877
+ ]
2878
+ ] = None,
2879
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2880
+ _content_type: Optional[StrictStr] = None,
2881
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2882
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2883
+ ) -> RESTResponseType:
2884
+ """(Deprecated) Return the metaData of the specified graph
2885
+
2886
+ Return the metaData of the specified graph
2887
+
2888
+ :param organization_id: the Organization identifier (required)
2889
+ :type organization_id: str
2890
+ :param graph_id: the Graph Identifier (required)
2891
+ :type graph_id: str
2892
+ :param _request_timeout: timeout setting for this request. If one
2893
+ number provided, it will be total request
2894
+ timeout. It can also be a pair (tuple) of
2895
+ (connection, read) timeouts.
2896
+ :type _request_timeout: int, tuple(int, int), optional
2897
+ :param _request_auth: set to override the auth_settings for an a single
2898
+ request; this effectively ignores the
2899
+ authentication in the spec for a single request.
2900
+ :type _request_auth: dict, optional
2901
+ :param _content_type: force content-type for the request.
2902
+ :type _content_type: str, Optional
2903
+ :param _headers: set to override the headers for a single
2904
+ request; this effectively ignores the headers
2905
+ in the spec for a single request.
2906
+ :type _headers: dict, optional
2907
+ :param _host_index: set to override the host_index for a single
2908
+ request; this effectively ignores the host_index
2909
+ in the spec for a single request.
2910
+ :type _host_index: int, optional
2911
+ :return: Returns the result object.
2912
+ """ # noqa: E501
2913
+ warnings.warn("GET /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
2914
+
2915
+ _param = self._get_graph_meta_data_serialize(
2916
+ organization_id=organization_id,
2917
+ graph_id=graph_id,
2918
+ _request_auth=_request_auth,
2919
+ _content_type=_content_type,
2920
+ _headers=_headers,
2921
+ _host_index=_host_index
2922
+ )
2923
+
2924
+ _response_types_map: Dict[str, Optional[str]] = {
2925
+ '200': "object",
2926
+ }
2927
+ response_data = self.api_client.call_api(
2928
+ *_param,
2929
+ _request_timeout=_request_timeout
2930
+ )
2931
+ return response_data.response
2932
+
2933
+
2934
+ def _get_graph_meta_data_serialize(
2935
+ self,
2936
+ organization_id,
2937
+ graph_id,
2938
+ _request_auth,
2939
+ _content_type,
2940
+ _headers,
2941
+ _host_index,
2942
+ ) -> RequestSerialized:
2943
+
2944
+ _host = None
2945
+
2946
+ _collection_formats: Dict[str, str] = {
2947
+ }
2948
+
2949
+ _path_params: Dict[str, str] = {}
2950
+ _query_params: List[Tuple[str, str]] = []
2951
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2952
+ _form_params: List[Tuple[str, str]] = []
2953
+ _files: Dict[str, str] = {}
2954
+ _body_params: Optional[bytes] = None
2955
+
2956
+ # process the path parameters
2957
+ if organization_id is not None:
2958
+ _path_params['organization_id'] = organization_id
2959
+ if graph_id is not None:
2960
+ _path_params['graph_id'] = graph_id
2961
+ # process the query parameters
2962
+ # process the header parameters
2963
+ # process the form parameters
2964
+ # process the body parameter
2965
+
2966
+
2967
+ # set the HTTP header `Accept`
2968
+ _header_params['Accept'] = self.api_client.select_header_accept(
2969
+ [
2970
+ 'application/json'
2971
+ ]
2972
+ )
2973
+
2974
+
2975
+ # authentication setting
2976
+ _auth_settings: List[str] = [
2977
+ 'oAuth2AuthCode'
2978
+ ]
2979
+
2980
+ return self.api_client.param_serialize(
2981
+ method='GET',
2982
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/metadata',
2983
+ path_params=_path_params,
2984
+ query_params=_query_params,
2985
+ header_params=_header_params,
2986
+ body=_body_params,
2987
+ post_params=_form_params,
2988
+ files=_files,
2989
+ auth_settings=_auth_settings,
2990
+ collection_formats=_collection_formats,
2991
+ _host=_host,
2992
+ _request_auth=_request_auth
2993
+ )
2994
+
2995
+
2996
+
2997
+
2998
+ @validate_call
2999
+ def job_status(
3000
+ self,
3001
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3002
+ job_id: Annotated[StrictStr, Field(description="the job identifier")],
3003
+ _request_timeout: Union[
3004
+ None,
3005
+ Annotated[StrictFloat, Field(gt=0)],
3006
+ Tuple[
3007
+ Annotated[StrictFloat, Field(gt=0)],
3008
+ Annotated[StrictFloat, Field(gt=0)]
3009
+ ]
3010
+ ] = None,
3011
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3012
+ _content_type: Optional[StrictStr] = None,
3013
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3014
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3015
+ ) -> str:
3016
+ """(Deprecated) Get the status of a job
3017
+
3018
+ Get the status of a job
3019
+
3020
+ :param organization_id: the Organization identifier (required)
3021
+ :type organization_id: str
3022
+ :param job_id: the job identifier (required)
3023
+ :type job_id: str
3024
+ :param _request_timeout: timeout setting for this request. If one
3025
+ number provided, it will be total request
3026
+ timeout. It can also be a pair (tuple) of
3027
+ (connection, read) timeouts.
3028
+ :type _request_timeout: int, tuple(int, int), optional
3029
+ :param _request_auth: set to override the auth_settings for an a single
3030
+ request; this effectively ignores the
3031
+ authentication in the spec for a single request.
3032
+ :type _request_auth: dict, optional
3033
+ :param _content_type: force content-type for the request.
3034
+ :type _content_type: str, Optional
3035
+ :param _headers: set to override the headers for a single
3036
+ request; this effectively ignores the headers
3037
+ in the spec for a single request.
3038
+ :type _headers: dict, optional
3039
+ :param _host_index: set to override the host_index for a single
3040
+ request; this effectively ignores the host_index
3041
+ in the spec for a single request.
3042
+ :type _host_index: int, optional
3043
+ :return: Returns the result object.
3044
+ """ # noqa: E501
3045
+ warnings.warn("GET /organizations/{organization_id}/job/{job_id}/status is deprecated.", DeprecationWarning)
3046
+
3047
+ _param = self._job_status_serialize(
3048
+ organization_id=organization_id,
3049
+ job_id=job_id,
3050
+ _request_auth=_request_auth,
3051
+ _content_type=_content_type,
3052
+ _headers=_headers,
3053
+ _host_index=_host_index
3054
+ )
3055
+
3056
+ _response_types_map: Dict[str, Optional[str]] = {
3057
+ '200': "str",
3058
+ }
3059
+ response_data = self.api_client.call_api(
3060
+ *_param,
3061
+ _request_timeout=_request_timeout
3062
+ )
3063
+ response_data.read()
3064
+ return self.api_client.response_deserialize(
3065
+ response_data=response_data,
3066
+ response_types_map=_response_types_map,
3067
+ ).data
3068
+
3069
+
3070
+ @validate_call
3071
+ def job_status_with_http_info(
3072
+ self,
3073
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3074
+ job_id: Annotated[StrictStr, Field(description="the job identifier")],
3075
+ _request_timeout: Union[
3076
+ None,
3077
+ Annotated[StrictFloat, Field(gt=0)],
3078
+ Tuple[
3079
+ Annotated[StrictFloat, Field(gt=0)],
3080
+ Annotated[StrictFloat, Field(gt=0)]
3081
+ ]
3082
+ ] = None,
3083
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3084
+ _content_type: Optional[StrictStr] = None,
3085
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3086
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3087
+ ) -> ApiResponse[str]:
3088
+ """(Deprecated) Get the status of a job
3089
+
3090
+ Get the status of a job
3091
+
3092
+ :param organization_id: the Organization identifier (required)
3093
+ :type organization_id: str
3094
+ :param job_id: the job identifier (required)
3095
+ :type job_id: str
3096
+ :param _request_timeout: timeout setting for this request. If one
3097
+ number provided, it will be total request
3098
+ timeout. It can also be a pair (tuple) of
3099
+ (connection, read) timeouts.
3100
+ :type _request_timeout: int, tuple(int, int), optional
3101
+ :param _request_auth: set to override the auth_settings for an a single
3102
+ request; this effectively ignores the
3103
+ authentication in the spec for a single request.
3104
+ :type _request_auth: dict, optional
3105
+ :param _content_type: force content-type for the request.
3106
+ :type _content_type: str, Optional
3107
+ :param _headers: set to override the headers for a single
3108
+ request; this effectively ignores the headers
3109
+ in the spec for a single request.
3110
+ :type _headers: dict, optional
3111
+ :param _host_index: set to override the host_index for a single
3112
+ request; this effectively ignores the host_index
3113
+ in the spec for a single request.
3114
+ :type _host_index: int, optional
3115
+ :return: Returns the result object.
3116
+ """ # noqa: E501
3117
+ warnings.warn("GET /organizations/{organization_id}/job/{job_id}/status is deprecated.", DeprecationWarning)
3118
+
3119
+ _param = self._job_status_serialize(
3120
+ organization_id=organization_id,
3121
+ job_id=job_id,
3122
+ _request_auth=_request_auth,
3123
+ _content_type=_content_type,
3124
+ _headers=_headers,
3125
+ _host_index=_host_index
3126
+ )
3127
+
3128
+ _response_types_map: Dict[str, Optional[str]] = {
3129
+ '200': "str",
3130
+ }
3131
+ response_data = self.api_client.call_api(
3132
+ *_param,
3133
+ _request_timeout=_request_timeout
3134
+ )
3135
+ response_data.read()
3136
+ return self.api_client.response_deserialize(
3137
+ response_data=response_data,
3138
+ response_types_map=_response_types_map,
3139
+ )
3140
+
3141
+
3142
+ @validate_call
3143
+ def job_status_without_preload_content(
3144
+ self,
3145
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3146
+ job_id: Annotated[StrictStr, Field(description="the job identifier")],
3147
+ _request_timeout: Union[
3148
+ None,
3149
+ Annotated[StrictFloat, Field(gt=0)],
3150
+ Tuple[
3151
+ Annotated[StrictFloat, Field(gt=0)],
3152
+ Annotated[StrictFloat, Field(gt=0)]
3153
+ ]
3154
+ ] = None,
3155
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3156
+ _content_type: Optional[StrictStr] = None,
3157
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3158
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3159
+ ) -> RESTResponseType:
3160
+ """(Deprecated) Get the status of a job
3161
+
3162
+ Get the status of a job
3163
+
3164
+ :param organization_id: the Organization identifier (required)
3165
+ :type organization_id: str
3166
+ :param job_id: the job identifier (required)
3167
+ :type job_id: str
3168
+ :param _request_timeout: timeout setting for this request. If one
3169
+ number provided, it will be total request
3170
+ timeout. It can also be a pair (tuple) of
3171
+ (connection, read) timeouts.
3172
+ :type _request_timeout: int, tuple(int, int), optional
3173
+ :param _request_auth: set to override the auth_settings for an a single
3174
+ request; this effectively ignores the
3175
+ authentication in the spec for a single request.
3176
+ :type _request_auth: dict, optional
3177
+ :param _content_type: force content-type for the request.
3178
+ :type _content_type: str, Optional
3179
+ :param _headers: set to override the headers for a single
3180
+ request; this effectively ignores the headers
3181
+ in the spec for a single request.
3182
+ :type _headers: dict, optional
3183
+ :param _host_index: set to override the host_index for a single
3184
+ request; this effectively ignores the host_index
3185
+ in the spec for a single request.
3186
+ :type _host_index: int, optional
3187
+ :return: Returns the result object.
3188
+ """ # noqa: E501
3189
+ warnings.warn("GET /organizations/{organization_id}/job/{job_id}/status is deprecated.", DeprecationWarning)
3190
+
3191
+ _param = self._job_status_serialize(
3192
+ organization_id=organization_id,
3193
+ job_id=job_id,
3194
+ _request_auth=_request_auth,
3195
+ _content_type=_content_type,
3196
+ _headers=_headers,
3197
+ _host_index=_host_index
3198
+ )
3199
+
3200
+ _response_types_map: Dict[str, Optional[str]] = {
3201
+ '200': "str",
3202
+ }
3203
+ response_data = self.api_client.call_api(
3204
+ *_param,
3205
+ _request_timeout=_request_timeout
3206
+ )
3207
+ return response_data.response
3208
+
3209
+
3210
+ def _job_status_serialize(
3211
+ self,
3212
+ organization_id,
3213
+ job_id,
3214
+ _request_auth,
3215
+ _content_type,
3216
+ _headers,
3217
+ _host_index,
3218
+ ) -> RequestSerialized:
3219
+
3220
+ _host = None
3221
+
3222
+ _collection_formats: Dict[str, str] = {
3223
+ }
3224
+
3225
+ _path_params: Dict[str, str] = {}
3226
+ _query_params: List[Tuple[str, str]] = []
3227
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3228
+ _form_params: List[Tuple[str, str]] = []
3229
+ _files: Dict[str, str] = {}
3230
+ _body_params: Optional[bytes] = None
3231
+
3232
+ # process the path parameters
3233
+ if organization_id is not None:
3234
+ _path_params['organization_id'] = organization_id
3235
+ if job_id is not None:
3236
+ _path_params['job_id'] = job_id
3237
+ # process the query parameters
3238
+ # process the header parameters
3239
+ # process the form parameters
3240
+ # process the body parameter
3241
+
3242
+
3243
+ # set the HTTP header `Accept`
3244
+ _header_params['Accept'] = self.api_client.select_header_accept(
3245
+ [
3246
+ 'application/yaml',
3247
+ 'application/json'
3248
+ ]
3249
+ )
3250
+
3251
+
3252
+ # authentication setting
3253
+ _auth_settings: List[str] = [
3254
+ 'oAuth2AuthCode'
3255
+ ]
3256
+
3257
+ return self.api_client.param_serialize(
3258
+ method='GET',
3259
+ resource_path='/organizations/{organization_id}/job/{job_id}/status',
3260
+ path_params=_path_params,
3261
+ query_params=_query_params,
3262
+ header_params=_header_params,
3263
+ body=_body_params,
3264
+ post_params=_form_params,
3265
+ files=_files,
3266
+ auth_settings=_auth_settings,
3267
+ collection_formats=_collection_formats,
3268
+ _host=_host,
3269
+ _request_auth=_request_auth
3270
+ )
3271
+
3272
+
3273
+
3274
+
3275
+ @validate_call
3276
+ def query(
3277
+ self,
3278
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3279
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3280
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
3281
+ _request_timeout: Union[
3282
+ None,
3283
+ Annotated[StrictFloat, Field(gt=0)],
3284
+ Tuple[
3285
+ Annotated[StrictFloat, Field(gt=0)],
3286
+ Annotated[StrictFloat, Field(gt=0)]
3287
+ ]
3288
+ ] = None,
3289
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3290
+ _content_type: Optional[StrictStr] = None,
3291
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3292
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3293
+ ) -> str:
3294
+ """(Deprecated) Run a query on a graph instance
3295
+
3296
+ Run a query on a graph instance
3297
+
3298
+ :param organization_id: the Organization identifier (required)
3299
+ :type organization_id: str
3300
+ :param graph_id: the Graph Identifier (required)
3301
+ :type graph_id: str
3302
+ :param twin_graph_query: the query to run (required)
3303
+ :type twin_graph_query: TwinGraphQuery
3304
+ :param _request_timeout: timeout setting for this request. If one
3305
+ number provided, it will be total request
3306
+ timeout. It can also be a pair (tuple) of
3307
+ (connection, read) timeouts.
3308
+ :type _request_timeout: int, tuple(int, int), optional
3309
+ :param _request_auth: set to override the auth_settings for an a single
3310
+ request; this effectively ignores the
3311
+ authentication in the spec for a single request.
3312
+ :type _request_auth: dict, optional
3313
+ :param _content_type: force content-type for the request.
3314
+ :type _content_type: str, Optional
3315
+ :param _headers: set to override the headers for a single
3316
+ request; this effectively ignores the headers
3317
+ in the spec for a single request.
3318
+ :type _headers: dict, optional
3319
+ :param _host_index: set to override the host_index for a single
3320
+ request; this effectively ignores the host_index
3321
+ in the spec for a single request.
3322
+ :type _host_index: int, optional
3323
+ :return: Returns the result object.
3324
+ """ # noqa: E501
3325
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/query is deprecated.", DeprecationWarning)
3326
+
3327
+ _param = self._query_serialize(
3328
+ organization_id=organization_id,
3329
+ graph_id=graph_id,
3330
+ twin_graph_query=twin_graph_query,
3331
+ _request_auth=_request_auth,
3332
+ _content_type=_content_type,
3333
+ _headers=_headers,
3334
+ _host_index=_host_index
3335
+ )
3336
+
3337
+ _response_types_map: Dict[str, Optional[str]] = {
3338
+ '200': "str",
3339
+ }
3340
+ response_data = self.api_client.call_api(
3341
+ *_param,
3342
+ _request_timeout=_request_timeout
3343
+ )
3344
+ response_data.read()
3345
+ return self.api_client.response_deserialize(
3346
+ response_data=response_data,
3347
+ response_types_map=_response_types_map,
3348
+ ).data
3349
+
3350
+
3351
+ @validate_call
3352
+ def query_with_http_info(
3353
+ self,
3354
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3355
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3356
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
3357
+ _request_timeout: Union[
3358
+ None,
3359
+ Annotated[StrictFloat, Field(gt=0)],
3360
+ Tuple[
3361
+ Annotated[StrictFloat, Field(gt=0)],
3362
+ Annotated[StrictFloat, Field(gt=0)]
3363
+ ]
3364
+ ] = None,
3365
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3366
+ _content_type: Optional[StrictStr] = None,
3367
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3368
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3369
+ ) -> ApiResponse[str]:
3370
+ """(Deprecated) Run a query on a graph instance
3371
+
3372
+ Run a query on a graph instance
3373
+
3374
+ :param organization_id: the Organization identifier (required)
3375
+ :type organization_id: str
3376
+ :param graph_id: the Graph Identifier (required)
3377
+ :type graph_id: str
3378
+ :param twin_graph_query: the query to run (required)
3379
+ :type twin_graph_query: TwinGraphQuery
3380
+ :param _request_timeout: timeout setting for this request. If one
3381
+ number provided, it will be total request
3382
+ timeout. It can also be a pair (tuple) of
3383
+ (connection, read) timeouts.
3384
+ :type _request_timeout: int, tuple(int, int), optional
3385
+ :param _request_auth: set to override the auth_settings for an a single
3386
+ request; this effectively ignores the
3387
+ authentication in the spec for a single request.
3388
+ :type _request_auth: dict, optional
3389
+ :param _content_type: force content-type for the request.
3390
+ :type _content_type: str, Optional
3391
+ :param _headers: set to override the headers for a single
3392
+ request; this effectively ignores the headers
3393
+ in the spec for a single request.
3394
+ :type _headers: dict, optional
3395
+ :param _host_index: set to override the host_index for a single
3396
+ request; this effectively ignores the host_index
3397
+ in the spec for a single request.
3398
+ :type _host_index: int, optional
3399
+ :return: Returns the result object.
3400
+ """ # noqa: E501
3401
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/query is deprecated.", DeprecationWarning)
3402
+
3403
+ _param = self._query_serialize(
3404
+ organization_id=organization_id,
3405
+ graph_id=graph_id,
3406
+ twin_graph_query=twin_graph_query,
3407
+ _request_auth=_request_auth,
3408
+ _content_type=_content_type,
3409
+ _headers=_headers,
3410
+ _host_index=_host_index
3411
+ )
3412
+
3413
+ _response_types_map: Dict[str, Optional[str]] = {
3414
+ '200': "str",
3415
+ }
3416
+ response_data = self.api_client.call_api(
3417
+ *_param,
3418
+ _request_timeout=_request_timeout
3419
+ )
3420
+ response_data.read()
3421
+ return self.api_client.response_deserialize(
3422
+ response_data=response_data,
3423
+ response_types_map=_response_types_map,
3424
+ )
3425
+
3426
+
3427
+ @validate_call
3428
+ def query_without_preload_content(
3429
+ self,
3430
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3431
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3432
+ twin_graph_query: Annotated[TwinGraphQuery, Field(description="the query to run")],
3433
+ _request_timeout: Union[
3434
+ None,
3435
+ Annotated[StrictFloat, Field(gt=0)],
3436
+ Tuple[
3437
+ Annotated[StrictFloat, Field(gt=0)],
3438
+ Annotated[StrictFloat, Field(gt=0)]
3439
+ ]
3440
+ ] = None,
3441
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3442
+ _content_type: Optional[StrictStr] = None,
3443
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3444
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3445
+ ) -> RESTResponseType:
3446
+ """(Deprecated) Run a query on a graph instance
3447
+
3448
+ Run a query on a graph instance
3449
+
3450
+ :param organization_id: the Organization identifier (required)
3451
+ :type organization_id: str
3452
+ :param graph_id: the Graph Identifier (required)
3453
+ :type graph_id: str
3454
+ :param twin_graph_query: the query to run (required)
3455
+ :type twin_graph_query: TwinGraphQuery
3456
+ :param _request_timeout: timeout setting for this request. If one
3457
+ number provided, it will be total request
3458
+ timeout. It can also be a pair (tuple) of
3459
+ (connection, read) timeouts.
3460
+ :type _request_timeout: int, tuple(int, int), optional
3461
+ :param _request_auth: set to override the auth_settings for an a single
3462
+ request; this effectively ignores the
3463
+ authentication in the spec for a single request.
3464
+ :type _request_auth: dict, optional
3465
+ :param _content_type: force content-type for the request.
3466
+ :type _content_type: str, Optional
3467
+ :param _headers: set to override the headers for a single
3468
+ request; this effectively ignores the headers
3469
+ in the spec for a single request.
3470
+ :type _headers: dict, optional
3471
+ :param _host_index: set to override the host_index for a single
3472
+ request; this effectively ignores the host_index
3473
+ in the spec for a single request.
3474
+ :type _host_index: int, optional
3475
+ :return: Returns the result object.
3476
+ """ # noqa: E501
3477
+ warnings.warn("POST /organizations/{organization_id}/twingraph/{graph_id}/query is deprecated.", DeprecationWarning)
3478
+
3479
+ _param = self._query_serialize(
3480
+ organization_id=organization_id,
3481
+ graph_id=graph_id,
3482
+ twin_graph_query=twin_graph_query,
3483
+ _request_auth=_request_auth,
3484
+ _content_type=_content_type,
3485
+ _headers=_headers,
3486
+ _host_index=_host_index
3487
+ )
3488
+
3489
+ _response_types_map: Dict[str, Optional[str]] = {
3490
+ '200': "str",
3491
+ }
3492
+ response_data = self.api_client.call_api(
3493
+ *_param,
3494
+ _request_timeout=_request_timeout
3495
+ )
3496
+ return response_data.response
3497
+
3498
+
3499
+ def _query_serialize(
3500
+ self,
3501
+ organization_id,
3502
+ graph_id,
3503
+ twin_graph_query,
3504
+ _request_auth,
3505
+ _content_type,
3506
+ _headers,
3507
+ _host_index,
3508
+ ) -> RequestSerialized:
3509
+
3510
+ _host = None
3511
+
3512
+ _collection_formats: Dict[str, str] = {
3513
+ }
3514
+
3515
+ _path_params: Dict[str, str] = {}
3516
+ _query_params: List[Tuple[str, str]] = []
3517
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3518
+ _form_params: List[Tuple[str, str]] = []
3519
+ _files: Dict[str, str] = {}
3520
+ _body_params: Optional[bytes] = None
3521
+
3522
+ # process the path parameters
3523
+ if organization_id is not None:
3524
+ _path_params['organization_id'] = organization_id
3525
+ if graph_id is not None:
3526
+ _path_params['graph_id'] = graph_id
3527
+ # process the query parameters
3528
+ # process the header parameters
3529
+ # process the form parameters
3530
+ # process the body parameter
3531
+ if twin_graph_query is not None:
3532
+ _body_params = twin_graph_query
3533
+
3534
+
3535
+ # set the HTTP header `Accept`
3536
+ _header_params['Accept'] = self.api_client.select_header_accept(
3537
+ [
3538
+ 'application/json'
3539
+ ]
3540
+ )
3541
+
3542
+ # set the HTTP header `Content-Type`
3543
+ if _content_type:
3544
+ _header_params['Content-Type'] = _content_type
3545
+ else:
3546
+ _default_content_type = (
3547
+ self.api_client.select_header_content_type(
3548
+ [
3549
+ 'application/json',
3550
+ 'application/yaml'
3551
+ ]
3552
+ )
3553
+ )
3554
+ if _default_content_type is not None:
3555
+ _header_params['Content-Type'] = _default_content_type
3556
+
3557
+ # authentication setting
3558
+ _auth_settings: List[str] = [
3559
+ 'oAuth2AuthCode'
3560
+ ]
3561
+
3562
+ return self.api_client.param_serialize(
3563
+ method='POST',
3564
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/query',
3565
+ path_params=_path_params,
3566
+ query_params=_query_params,
3567
+ header_params=_header_params,
3568
+ body=_body_params,
3569
+ post_params=_form_params,
3570
+ files=_files,
3571
+ auth_settings=_auth_settings,
3572
+ collection_formats=_collection_formats,
3573
+ _host=_host,
3574
+ _request_auth=_request_auth
3575
+ )
3576
+
3577
+
3578
+
3579
+
3580
+ @validate_call
3581
+ def update_entities(
3582
+ self,
3583
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3584
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3585
+ type: Annotated[StrictStr, Field(description="the entity model type")],
3586
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to update")],
3587
+ _request_timeout: Union[
3588
+ None,
3589
+ Annotated[StrictFloat, Field(gt=0)],
3590
+ Tuple[
3591
+ Annotated[StrictFloat, Field(gt=0)],
3592
+ Annotated[StrictFloat, Field(gt=0)]
3593
+ ]
3594
+ ] = None,
3595
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3596
+ _content_type: Optional[StrictStr] = None,
3597
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3598
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3599
+ ) -> str:
3600
+ """(Deprecated) Update entities in a graph instance
3601
+
3602
+ update entities in a graph instance
3603
+
3604
+ :param organization_id: the Organization identifier (required)
3605
+ :type organization_id: str
3606
+ :param graph_id: the Graph Identifier (required)
3607
+ :type graph_id: str
3608
+ :param type: the entity model type (required)
3609
+ :type type: str
3610
+ :param graph_properties: the entities to update (required)
3611
+ :type graph_properties: List[GraphProperties]
3612
+ :param _request_timeout: timeout setting for this request. If one
3613
+ number provided, it will be total request
3614
+ timeout. It can also be a pair (tuple) of
3615
+ (connection, read) timeouts.
3616
+ :type _request_timeout: int, tuple(int, int), optional
3617
+ :param _request_auth: set to override the auth_settings for an a single
3618
+ request; this effectively ignores the
3619
+ authentication in the spec for a single request.
3620
+ :type _request_auth: dict, optional
3621
+ :param _content_type: force content-type for the request.
3622
+ :type _content_type: str, Optional
3623
+ :param _headers: set to override the headers for a single
3624
+ request; this effectively ignores the headers
3625
+ in the spec for a single request.
3626
+ :type _headers: dict, optional
3627
+ :param _host_index: set to override the host_index for a single
3628
+ request; this effectively ignores the host_index
3629
+ in the spec for a single request.
3630
+ :type _host_index: int, optional
3631
+ :return: Returns the result object.
3632
+ """ # noqa: E501
3633
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
3634
+
3635
+ _param = self._update_entities_serialize(
3636
+ organization_id=organization_id,
3637
+ graph_id=graph_id,
3638
+ type=type,
3639
+ graph_properties=graph_properties,
3640
+ _request_auth=_request_auth,
3641
+ _content_type=_content_type,
3642
+ _headers=_headers,
3643
+ _host_index=_host_index
3644
+ )
3645
+
3646
+ _response_types_map: Dict[str, Optional[str]] = {
3647
+ '200': "str",
3648
+ }
3649
+ response_data = self.api_client.call_api(
3650
+ *_param,
3651
+ _request_timeout=_request_timeout
3652
+ )
3653
+ response_data.read()
3654
+ return self.api_client.response_deserialize(
3655
+ response_data=response_data,
3656
+ response_types_map=_response_types_map,
3657
+ ).data
3658
+
3659
+
3660
+ @validate_call
3661
+ def update_entities_with_http_info(
3662
+ self,
3663
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3664
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3665
+ type: Annotated[StrictStr, Field(description="the entity model type")],
3666
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to update")],
3667
+ _request_timeout: Union[
3668
+ None,
3669
+ Annotated[StrictFloat, Field(gt=0)],
3670
+ Tuple[
3671
+ Annotated[StrictFloat, Field(gt=0)],
3672
+ Annotated[StrictFloat, Field(gt=0)]
3673
+ ]
3674
+ ] = None,
3675
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3676
+ _content_type: Optional[StrictStr] = None,
3677
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3678
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3679
+ ) -> ApiResponse[str]:
3680
+ """(Deprecated) Update entities in a graph instance
3681
+
3682
+ update entities in a graph instance
3683
+
3684
+ :param organization_id: the Organization identifier (required)
3685
+ :type organization_id: str
3686
+ :param graph_id: the Graph Identifier (required)
3687
+ :type graph_id: str
3688
+ :param type: the entity model type (required)
3689
+ :type type: str
3690
+ :param graph_properties: the entities to update (required)
3691
+ :type graph_properties: List[GraphProperties]
3692
+ :param _request_timeout: timeout setting for this request. If one
3693
+ number provided, it will be total request
3694
+ timeout. It can also be a pair (tuple) of
3695
+ (connection, read) timeouts.
3696
+ :type _request_timeout: int, tuple(int, int), optional
3697
+ :param _request_auth: set to override the auth_settings for an a single
3698
+ request; this effectively ignores the
3699
+ authentication in the spec for a single request.
3700
+ :type _request_auth: dict, optional
3701
+ :param _content_type: force content-type for the request.
3702
+ :type _content_type: str, Optional
3703
+ :param _headers: set to override the headers for a single
3704
+ request; this effectively ignores the headers
3705
+ in the spec for a single request.
3706
+ :type _headers: dict, optional
3707
+ :param _host_index: set to override the host_index for a single
3708
+ request; this effectively ignores the host_index
3709
+ in the spec for a single request.
3710
+ :type _host_index: int, optional
3711
+ :return: Returns the result object.
3712
+ """ # noqa: E501
3713
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
3714
+
3715
+ _param = self._update_entities_serialize(
3716
+ organization_id=organization_id,
3717
+ graph_id=graph_id,
3718
+ type=type,
3719
+ graph_properties=graph_properties,
3720
+ _request_auth=_request_auth,
3721
+ _content_type=_content_type,
3722
+ _headers=_headers,
3723
+ _host_index=_host_index
3724
+ )
3725
+
3726
+ _response_types_map: Dict[str, Optional[str]] = {
3727
+ '200': "str",
3728
+ }
3729
+ response_data = self.api_client.call_api(
3730
+ *_param,
3731
+ _request_timeout=_request_timeout
3732
+ )
3733
+ response_data.read()
3734
+ return self.api_client.response_deserialize(
3735
+ response_data=response_data,
3736
+ response_types_map=_response_types_map,
3737
+ )
3738
+
3739
+
3740
+ @validate_call
3741
+ def update_entities_without_preload_content(
3742
+ self,
3743
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3744
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3745
+ type: Annotated[StrictStr, Field(description="the entity model type")],
3746
+ graph_properties: Annotated[List[GraphProperties], Field(description="the entities to update")],
3747
+ _request_timeout: Union[
3748
+ None,
3749
+ Annotated[StrictFloat, Field(gt=0)],
3750
+ Tuple[
3751
+ Annotated[StrictFloat, Field(gt=0)],
3752
+ Annotated[StrictFloat, Field(gt=0)]
3753
+ ]
3754
+ ] = None,
3755
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3756
+ _content_type: Optional[StrictStr] = None,
3757
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3758
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3759
+ ) -> RESTResponseType:
3760
+ """(Deprecated) Update entities in a graph instance
3761
+
3762
+ update entities in a graph instance
3763
+
3764
+ :param organization_id: the Organization identifier (required)
3765
+ :type organization_id: str
3766
+ :param graph_id: the Graph Identifier (required)
3767
+ :type graph_id: str
3768
+ :param type: the entity model type (required)
3769
+ :type type: str
3770
+ :param graph_properties: the entities to update (required)
3771
+ :type graph_properties: List[GraphProperties]
3772
+ :param _request_timeout: timeout setting for this request. If one
3773
+ number provided, it will be total request
3774
+ timeout. It can also be a pair (tuple) of
3775
+ (connection, read) timeouts.
3776
+ :type _request_timeout: int, tuple(int, int), optional
3777
+ :param _request_auth: set to override the auth_settings for an a single
3778
+ request; this effectively ignores the
3779
+ authentication in the spec for a single request.
3780
+ :type _request_auth: dict, optional
3781
+ :param _content_type: force content-type for the request.
3782
+ :type _content_type: str, Optional
3783
+ :param _headers: set to override the headers for a single
3784
+ request; this effectively ignores the headers
3785
+ in the spec for a single request.
3786
+ :type _headers: dict, optional
3787
+ :param _host_index: set to override the host_index for a single
3788
+ request; this effectively ignores the host_index
3789
+ in the spec for a single request.
3790
+ :type _host_index: int, optional
3791
+ :return: Returns the result object.
3792
+ """ # noqa: E501
3793
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} is deprecated.", DeprecationWarning)
3794
+
3795
+ _param = self._update_entities_serialize(
3796
+ organization_id=organization_id,
3797
+ graph_id=graph_id,
3798
+ type=type,
3799
+ graph_properties=graph_properties,
3800
+ _request_auth=_request_auth,
3801
+ _content_type=_content_type,
3802
+ _headers=_headers,
3803
+ _host_index=_host_index
3804
+ )
3805
+
3806
+ _response_types_map: Dict[str, Optional[str]] = {
3807
+ '200': "str",
3808
+ }
3809
+ response_data = self.api_client.call_api(
3810
+ *_param,
3811
+ _request_timeout=_request_timeout
3812
+ )
3813
+ return response_data.response
3814
+
3815
+
3816
+ def _update_entities_serialize(
3817
+ self,
3818
+ organization_id,
3819
+ graph_id,
3820
+ type,
3821
+ graph_properties,
3822
+ _request_auth,
3823
+ _content_type,
3824
+ _headers,
3825
+ _host_index,
3826
+ ) -> RequestSerialized:
3827
+
3828
+ _host = None
3829
+
3830
+ _collection_formats: Dict[str, str] = {
3831
+ 'GraphProperties': '',
3832
+ }
3833
+
3834
+ _path_params: Dict[str, str] = {}
3835
+ _query_params: List[Tuple[str, str]] = []
3836
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3837
+ _form_params: List[Tuple[str, str]] = []
3838
+ _files: Dict[str, str] = {}
3839
+ _body_params: Optional[bytes] = None
3840
+
3841
+ # process the path parameters
3842
+ if organization_id is not None:
3843
+ _path_params['organization_id'] = organization_id
3844
+ if graph_id is not None:
3845
+ _path_params['graph_id'] = graph_id
3846
+ if type is not None:
3847
+ _path_params['type'] = type
3848
+ # process the query parameters
3849
+ # process the header parameters
3850
+ # process the form parameters
3851
+ # process the body parameter
3852
+ if graph_properties is not None:
3853
+ _body_params = graph_properties
3854
+
3855
+
3856
+ # set the HTTP header `Accept`
3857
+ _header_params['Accept'] = self.api_client.select_header_accept(
3858
+ [
3859
+ 'application/json'
3860
+ ]
3861
+ )
3862
+
3863
+ # set the HTTP header `Content-Type`
3864
+ if _content_type:
3865
+ _header_params['Content-Type'] = _content_type
3866
+ else:
3867
+ _default_content_type = (
3868
+ self.api_client.select_header_content_type(
3869
+ [
3870
+ 'application/json'
3871
+ ]
3872
+ )
3873
+ )
3874
+ if _default_content_type is not None:
3875
+ _header_params['Content-Type'] = _default_content_type
3876
+
3877
+ # authentication setting
3878
+ _auth_settings: List[str] = [
3879
+ 'oAuth2AuthCode'
3880
+ ]
3881
+
3882
+ return self.api_client.param_serialize(
3883
+ method='PATCH',
3884
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/entity/{type}',
3885
+ path_params=_path_params,
3886
+ query_params=_query_params,
3887
+ header_params=_header_params,
3888
+ body=_body_params,
3889
+ post_params=_form_params,
3890
+ files=_files,
3891
+ auth_settings=_auth_settings,
3892
+ collection_formats=_collection_formats,
3893
+ _host=_host,
3894
+ _request_auth=_request_auth
3895
+ )
3896
+
3897
+
3898
+
3899
+
3900
+ @validate_call
3901
+ def update_graph_meta_data(
3902
+ self,
3903
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3904
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3905
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the metaData to update")],
3906
+ _request_timeout: Union[
3907
+ None,
3908
+ Annotated[StrictFloat, Field(gt=0)],
3909
+ Tuple[
3910
+ Annotated[StrictFloat, Field(gt=0)],
3911
+ Annotated[StrictFloat, Field(gt=0)]
3912
+ ]
3913
+ ] = None,
3914
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3915
+ _content_type: Optional[StrictStr] = None,
3916
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3917
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3918
+ ) -> object:
3919
+ """(Deprecated) Update the metaData of the specified graph
3920
+
3921
+ Update the metaData of the specified graph
3922
+
3923
+ :param organization_id: the Organization identifier (required)
3924
+ :type organization_id: str
3925
+ :param graph_id: the Graph Identifier (required)
3926
+ :type graph_id: str
3927
+ :param request_body: the metaData to update (required)
3928
+ :type request_body: Dict[str, str]
3929
+ :param _request_timeout: timeout setting for this request. If one
3930
+ number provided, it will be total request
3931
+ timeout. It can also be a pair (tuple) of
3932
+ (connection, read) timeouts.
3933
+ :type _request_timeout: int, tuple(int, int), optional
3934
+ :param _request_auth: set to override the auth_settings for an a single
3935
+ request; this effectively ignores the
3936
+ authentication in the spec for a single request.
3937
+ :type _request_auth: dict, optional
3938
+ :param _content_type: force content-type for the request.
3939
+ :type _content_type: str, Optional
3940
+ :param _headers: set to override the headers for a single
3941
+ request; this effectively ignores the headers
3942
+ in the spec for a single request.
3943
+ :type _headers: dict, optional
3944
+ :param _host_index: set to override the host_index for a single
3945
+ request; this effectively ignores the host_index
3946
+ in the spec for a single request.
3947
+ :type _host_index: int, optional
3948
+ :return: Returns the result object.
3949
+ """ # noqa: E501
3950
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
3951
+
3952
+ _param = self._update_graph_meta_data_serialize(
3953
+ organization_id=organization_id,
3954
+ graph_id=graph_id,
3955
+ request_body=request_body,
3956
+ _request_auth=_request_auth,
3957
+ _content_type=_content_type,
3958
+ _headers=_headers,
3959
+ _host_index=_host_index
3960
+ )
3961
+
3962
+ _response_types_map: Dict[str, Optional[str]] = {
3963
+ '200': "object",
3964
+ }
3965
+ response_data = self.api_client.call_api(
3966
+ *_param,
3967
+ _request_timeout=_request_timeout
3968
+ )
3969
+ response_data.read()
3970
+ return self.api_client.response_deserialize(
3971
+ response_data=response_data,
3972
+ response_types_map=_response_types_map,
3973
+ ).data
3974
+
3975
+
3976
+ @validate_call
3977
+ def update_graph_meta_data_with_http_info(
3978
+ self,
3979
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
3980
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
3981
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the metaData to update")],
3982
+ _request_timeout: Union[
3983
+ None,
3984
+ Annotated[StrictFloat, Field(gt=0)],
3985
+ Tuple[
3986
+ Annotated[StrictFloat, Field(gt=0)],
3987
+ Annotated[StrictFloat, Field(gt=0)]
3988
+ ]
3989
+ ] = None,
3990
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3991
+ _content_type: Optional[StrictStr] = None,
3992
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3993
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3994
+ ) -> ApiResponse[object]:
3995
+ """(Deprecated) Update the metaData of the specified graph
3996
+
3997
+ Update the metaData of the specified graph
3998
+
3999
+ :param organization_id: the Organization identifier (required)
4000
+ :type organization_id: str
4001
+ :param graph_id: the Graph Identifier (required)
4002
+ :type graph_id: str
4003
+ :param request_body: the metaData to update (required)
4004
+ :type request_body: Dict[str, str]
4005
+ :param _request_timeout: timeout setting for this request. If one
4006
+ number provided, it will be total request
4007
+ timeout. It can also be a pair (tuple) of
4008
+ (connection, read) timeouts.
4009
+ :type _request_timeout: int, tuple(int, int), optional
4010
+ :param _request_auth: set to override the auth_settings for an a single
4011
+ request; this effectively ignores the
4012
+ authentication in the spec for a single request.
4013
+ :type _request_auth: dict, optional
4014
+ :param _content_type: force content-type for the request.
4015
+ :type _content_type: str, Optional
4016
+ :param _headers: set to override the headers for a single
4017
+ request; this effectively ignores the headers
4018
+ in the spec for a single request.
4019
+ :type _headers: dict, optional
4020
+ :param _host_index: set to override the host_index for a single
4021
+ request; this effectively ignores the host_index
4022
+ in the spec for a single request.
4023
+ :type _host_index: int, optional
4024
+ :return: Returns the result object.
4025
+ """ # noqa: E501
4026
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
4027
+
4028
+ _param = self._update_graph_meta_data_serialize(
4029
+ organization_id=organization_id,
4030
+ graph_id=graph_id,
4031
+ request_body=request_body,
4032
+ _request_auth=_request_auth,
4033
+ _content_type=_content_type,
4034
+ _headers=_headers,
4035
+ _host_index=_host_index
4036
+ )
4037
+
4038
+ _response_types_map: Dict[str, Optional[str]] = {
4039
+ '200': "object",
4040
+ }
4041
+ response_data = self.api_client.call_api(
4042
+ *_param,
4043
+ _request_timeout=_request_timeout
4044
+ )
4045
+ response_data.read()
4046
+ return self.api_client.response_deserialize(
4047
+ response_data=response_data,
4048
+ response_types_map=_response_types_map,
4049
+ )
4050
+
4051
+
4052
+ @validate_call
4053
+ def update_graph_meta_data_without_preload_content(
4054
+ self,
4055
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
4056
+ graph_id: Annotated[StrictStr, Field(description="the Graph Identifier")],
4057
+ request_body: Annotated[Dict[str, StrictStr], Field(description="the metaData to update")],
4058
+ _request_timeout: Union[
4059
+ None,
4060
+ Annotated[StrictFloat, Field(gt=0)],
4061
+ Tuple[
4062
+ Annotated[StrictFloat, Field(gt=0)],
4063
+ Annotated[StrictFloat, Field(gt=0)]
4064
+ ]
4065
+ ] = None,
4066
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4067
+ _content_type: Optional[StrictStr] = None,
4068
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4069
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4070
+ ) -> RESTResponseType:
4071
+ """(Deprecated) Update the metaData of the specified graph
4072
+
4073
+ Update the metaData of the specified graph
4074
+
4075
+ :param organization_id: the Organization identifier (required)
4076
+ :type organization_id: str
4077
+ :param graph_id: the Graph Identifier (required)
4078
+ :type graph_id: str
4079
+ :param request_body: the metaData to update (required)
4080
+ :type request_body: Dict[str, str]
4081
+ :param _request_timeout: timeout setting for this request. If one
4082
+ number provided, it will be total request
4083
+ timeout. It can also be a pair (tuple) of
4084
+ (connection, read) timeouts.
4085
+ :type _request_timeout: int, tuple(int, int), optional
4086
+ :param _request_auth: set to override the auth_settings for an a single
4087
+ request; this effectively ignores the
4088
+ authentication in the spec for a single request.
4089
+ :type _request_auth: dict, optional
4090
+ :param _content_type: force content-type for the request.
4091
+ :type _content_type: str, Optional
4092
+ :param _headers: set to override the headers for a single
4093
+ request; this effectively ignores the headers
4094
+ in the spec for a single request.
4095
+ :type _headers: dict, optional
4096
+ :param _host_index: set to override the host_index for a single
4097
+ request; this effectively ignores the host_index
4098
+ in the spec for a single request.
4099
+ :type _host_index: int, optional
4100
+ :return: Returns the result object.
4101
+ """ # noqa: E501
4102
+ warnings.warn("PATCH /organizations/{organization_id}/twingraph/{graph_id}/metadata is deprecated.", DeprecationWarning)
4103
+
4104
+ _param = self._update_graph_meta_data_serialize(
4105
+ organization_id=organization_id,
4106
+ graph_id=graph_id,
4107
+ request_body=request_body,
4108
+ _request_auth=_request_auth,
4109
+ _content_type=_content_type,
4110
+ _headers=_headers,
4111
+ _host_index=_host_index
4112
+ )
4113
+
4114
+ _response_types_map: Dict[str, Optional[str]] = {
4115
+ '200': "object",
4116
+ }
4117
+ response_data = self.api_client.call_api(
4118
+ *_param,
4119
+ _request_timeout=_request_timeout
4120
+ )
4121
+ return response_data.response
4122
+
4123
+
4124
+ def _update_graph_meta_data_serialize(
4125
+ self,
4126
+ organization_id,
4127
+ graph_id,
4128
+ request_body,
4129
+ _request_auth,
4130
+ _content_type,
4131
+ _headers,
4132
+ _host_index,
4133
+ ) -> RequestSerialized:
4134
+
4135
+ _host = None
4136
+
4137
+ _collection_formats: Dict[str, str] = {
4138
+ }
4139
+
4140
+ _path_params: Dict[str, str] = {}
4141
+ _query_params: List[Tuple[str, str]] = []
4142
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4143
+ _form_params: List[Tuple[str, str]] = []
4144
+ _files: Dict[str, str] = {}
4145
+ _body_params: Optional[bytes] = None
4146
+
4147
+ # process the path parameters
4148
+ if organization_id is not None:
4149
+ _path_params['organization_id'] = organization_id
4150
+ if graph_id is not None:
4151
+ _path_params['graph_id'] = graph_id
4152
+ # process the query parameters
4153
+ # process the header parameters
4154
+ # process the form parameters
4155
+ # process the body parameter
4156
+ if request_body is not None:
4157
+ _body_params = request_body
4158
+
4159
+
4160
+ # set the HTTP header `Accept`
4161
+ _header_params['Accept'] = self.api_client.select_header_accept(
4162
+ [
4163
+ 'application/json'
4164
+ ]
4165
+ )
4166
+
4167
+ # set the HTTP header `Content-Type`
4168
+ if _content_type:
4169
+ _header_params['Content-Type'] = _content_type
4170
+ else:
4171
+ _default_content_type = (
4172
+ self.api_client.select_header_content_type(
4173
+ [
4174
+ 'application/json'
4175
+ ]
4176
+ )
4177
+ )
4178
+ if _default_content_type is not None:
4179
+ _header_params['Content-Type'] = _default_content_type
4180
+
4181
+ # authentication setting
4182
+ _auth_settings: List[str] = [
4183
+ 'oAuth2AuthCode'
4184
+ ]
4185
+
4186
+ return self.api_client.param_serialize(
4187
+ method='PATCH',
4188
+ resource_path='/organizations/{organization_id}/twingraph/{graph_id}/metadata',
4189
+ path_params=_path_params,
4190
+ query_params=_query_params,
4191
+ header_params=_header_params,
4192
+ body=_body_params,
4193
+ post_params=_form_params,
4194
+ files=_files,
4195
+ auth_settings=_auth_settings,
4196
+ collection_formats=_collection_formats,
4197
+ _host=_host,
4198
+ _request_auth=_request_auth
4199
+ )
4200
+
4201
+