instana-client 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (515) hide show
  1. instana_client/__init__.py +534 -0
  2. instana_client/api/__init__.py +58 -0
  3. instana_client/api/action_catalog_api.py +1380 -0
  4. instana_client/api/action_history_api.py +1793 -0
  5. instana_client/api/apdex_report_api.py +338 -0
  6. instana_client/api/apdex_settings_api.py +1353 -0
  7. instana_client/api/api_token_api.py +1370 -0
  8. instana_client/api/application_alert_configuration_api.py +2865 -0
  9. instana_client/api/application_analyze_api.py +2017 -0
  10. instana_client/api/application_catalog_api.py +885 -0
  11. instana_client/api/application_metrics_api.py +1211 -0
  12. instana_client/api/application_resources_api.py +1487 -0
  13. instana_client/api/application_settings_api.py +7261 -0
  14. instana_client/api/application_topology_api.py +354 -0
  15. instana_client/api/audit_log_api.py +635 -0
  16. instana_client/api/authentication_api.py +1008 -0
  17. instana_client/api/business_monitoring_api.py +2177 -0
  18. instana_client/api/custom_dashboards_api.py +1930 -0
  19. instana_client/api/event_settings_api.py +14613 -0
  20. instana_client/api/events_api.py +1654 -0
  21. instana_client/api/global_application_alert_configuration_api.py +2606 -0
  22. instana_client/api/groups_api.py +4078 -0
  23. instana_client/api/health_api.py +527 -0
  24. instana_client/api/host_agent_api.py +2120 -0
  25. instana_client/api/infrastructure_alert_configuration_api.py +2524 -0
  26. instana_client/api/infrastructure_analyze_api.py +1141 -0
  27. instana_client/api/infrastructure_catalog_api.py +1822 -0
  28. instana_client/api/infrastructure_metrics_api.py +331 -0
  29. instana_client/api/infrastructure_resources_api.py +1880 -0
  30. instana_client/api/infrastructure_topology_api.py +595 -0
  31. instana_client/api/log_alert_configuration_api.py +2524 -0
  32. instana_client/api/maintenance_configuration_api.py +2683 -0
  33. instana_client/api/mobile_app_analyze_api.py +613 -0
  34. instana_client/api/mobile_app_catalog_api.py +825 -0
  35. instana_client/api/mobile_app_configuration_api.py +2847 -0
  36. instana_client/api/mobile_app_metrics_api.py +892 -0
  37. instana_client/api/policies_api.py +1755 -0
  38. instana_client/api/releases_api.py +1408 -0
  39. instana_client/api/service_levels_alert_configuration_api.py +2577 -0
  40. instana_client/api/service_levels_objective_slo_configurations_api.py +1825 -0
  41. instana_client/api/service_levels_objective_slo_report_api.py +335 -0
  42. instana_client/api/session_settings_api.py +801 -0
  43. instana_client/api/sli_report_api.py +352 -0
  44. instana_client/api/sli_settings_api.py +2677 -0
  45. instana_client/api/synthetic_alert_configuration_api.py +2606 -0
  46. instana_client/api/synthetic_calls_api.py +789 -0
  47. instana_client/api/synthetic_catalog_api.py +543 -0
  48. instana_client/api/synthetic_metrics_api.py +322 -0
  49. instana_client/api/synthetic_settings_api.py +5144 -0
  50. instana_client/api/synthetic_test_playback_results_api.py +2142 -0
  51. instana_client/api/usage_api.py +1404 -0
  52. instana_client/api/user_api.py +2404 -0
  53. instana_client/api/website_analyze_api.py +619 -0
  54. instana_client/api/website_catalog_api.py +832 -0
  55. instana_client/api/website_configuration_api.py +3745 -0
  56. instana_client/api/website_metrics_api.py +889 -0
  57. instana_client/api_client.py +798 -0
  58. instana_client/api_response.py +21 -0
  59. instana_client/configuration.py +616 -0
  60. instana_client/exceptions.py +217 -0
  61. instana_client/models/__init__.py +464 -0
  62. instana_client/models/abstract_integration.py +155 -0
  63. instana_client/models/abstract_rule.py +124 -0
  64. instana_client/models/access_log_entry.py +105 -0
  65. instana_client/models/access_log_response.py +98 -0
  66. instana_client/models/access_rule.py +107 -0
  67. instana_client/models/action.py +135 -0
  68. instana_client/models/action_configuration.py +104 -0
  69. instana_client/models/action_instance.py +185 -0
  70. instana_client/models/action_instance_metadata_entry.py +90 -0
  71. instana_client/models/action_instance_parameter.py +94 -0
  72. instana_client/models/action_instance_request.py +108 -0
  73. instana_client/models/action_instance_request_parameters.py +92 -0
  74. instana_client/models/action_match.py +98 -0
  75. instana_client/models/action_search_space.py +94 -0
  76. instana_client/models/adaptive_baseline.py +92 -0
  77. instana_client/models/adaptive_threshold_rule.py +91 -0
  78. instana_client/models/adjusted_timeframe.py +91 -0
  79. instana_client/models/agent_configuration_update.py +93 -0
  80. instana_client/models/alerting_configuration.py +113 -0
  81. instana_client/models/alerting_configuration_with_last_updated.py +115 -0
  82. instana_client/models/alerting_time_window.py +109 -0
  83. instana_client/models/apdex_configuration.py +99 -0
  84. instana_client/models/apdex_configuration_input.py +95 -0
  85. instana_client/models/apdex_entity.py +119 -0
  86. instana_client/models/apdex_report.py +94 -0
  87. instana_client/models/api_create_group.py +104 -0
  88. instana_client/models/api_group.py +107 -0
  89. instana_client/models/api_member.py +90 -0
  90. instana_client/models/api_permission_set.py +178 -0
  91. instana_client/models/api_restricted_application_filter.py +108 -0
  92. instana_client/models/api_token.py +250 -0
  93. instana_client/models/app_data_metric_configuration.py +105 -0
  94. instana_client/models/application.py +104 -0
  95. instana_client/models/application_alert_config.py +203 -0
  96. instana_client/models/application_alert_config_with_metadata.py +213 -0
  97. instana_client/models/application_alert_rule.py +135 -0
  98. instana_client/models/application_apdex_entity.py +111 -0
  99. instana_client/models/application_config.py +131 -0
  100. instana_client/models/application_event_result.py +108 -0
  101. instana_client/models/application_item.py +94 -0
  102. instana_client/models/application_metric_result.py +109 -0
  103. instana_client/models/application_node.py +106 -0
  104. instana_client/models/application_result.py +102 -0
  105. instana_client/models/application_scope.py +89 -0
  106. instana_client/models/application_scope_with_metadata.py +90 -0
  107. instana_client/models/application_sli_entity.py +103 -0
  108. instana_client/models/application_slo_entity.py +112 -0
  109. instana_client/models/application_time_threshold.py +115 -0
  110. instana_client/models/audit_log_entry.py +102 -0
  111. instana_client/models/audit_log_ui_response.py +98 -0
  112. instana_client/models/author.py +100 -0
  113. instana_client/models/availability_blueprint_indicator.py +106 -0
  114. instana_client/models/availability_sli_entity.py +138 -0
  115. instana_client/models/available_metrics.py +96 -0
  116. instana_client/models/available_plugins.py +88 -0
  117. instana_client/models/backend_trace_reference.py +88 -0
  118. instana_client/models/binary_operator_dto.py +107 -0
  119. instana_client/models/browser_script_configuration.py +127 -0
  120. instana_client/models/built_in_event_specification.py +123 -0
  121. instana_client/models/built_in_event_specification_with_last_updated.py +125 -0
  122. instana_client/models/business_activity.py +132 -0
  123. instana_client/models/business_perspective_config.py +99 -0
  124. instana_client/models/call_groups_item.py +95 -0
  125. instana_client/models/call_groups_result.py +111 -0
  126. instana_client/models/call_relation.py +100 -0
  127. instana_client/models/change_summary.py +101 -0
  128. instana_client/models/cloudfoundry_physical_context.py +104 -0
  129. instana_client/models/condition.py +88 -0
  130. instana_client/models/config_version.py +101 -0
  131. instana_client/models/crash_mobile_app_alert_rule.py +90 -0
  132. instana_client/models/cursor_paginated_business_activity_item.py +96 -0
  133. instana_client/models/cursor_pagination.py +93 -0
  134. instana_client/models/cursor_pagination_infra_explore_cursor.py +90 -0
  135. instana_client/models/custom_blueprint_indicator.py +104 -0
  136. instana_client/models/custom_dashboard.py +111 -0
  137. instana_client/models/custom_dashboard_preview.py +103 -0
  138. instana_client/models/custom_email_subject_prefix.py +94 -0
  139. instana_client/models/custom_event_mobile_app_alert_rule.py +92 -0
  140. instana_client/models/custom_event_specification.py +133 -0
  141. instana_client/models/custom_event_specification_with_last_updated.py +143 -0
  142. instana_client/models/custom_event_website_alert_rule.py +92 -0
  143. instana_client/models/custom_payload_configuration.py +97 -0
  144. instana_client/models/custom_payload_field.py +112 -0
  145. instana_client/models/custom_payload_with_last_updated.py +99 -0
  146. instana_client/models/dashboard_api_token.py +90 -0
  147. instana_client/models/database_integration.py +90 -0
  148. instana_client/models/deprecated_tag_filter.py +111 -0
  149. instana_client/models/dns_action_configuration.py +134 -0
  150. instana_client/models/dns_action_filter_query_time.py +99 -0
  151. instana_client/models/dns_action_filter_target_value.py +106 -0
  152. instana_client/models/duration.py +98 -0
  153. instana_client/models/dynamic_field.py +95 -0
  154. instana_client/models/dynamic_field_value.py +90 -0
  155. instana_client/models/dynamic_parameter.py +94 -0
  156. instana_client/models/edit_user.py +88 -0
  157. instana_client/models/email_integration.py +98 -0
  158. instana_client/models/empty_configuration.py +92 -0
  159. instana_client/models/endpoint.py +131 -0
  160. instana_client/models/endpoint_config.py +112 -0
  161. instana_client/models/endpoint_event_result.py +112 -0
  162. instana_client/models/endpoint_item.py +94 -0
  163. instana_client/models/endpoint_metric_result.py +109 -0
  164. instana_client/models/endpoint_node.py +91 -0
  165. instana_client/models/endpoint_result.py +102 -0
  166. instana_client/models/endpoint_simple.py +102 -0
  167. instana_client/models/entity_count_rule.py +100 -0
  168. instana_client/models/entity_count_verification_rule.py +114 -0
  169. instana_client/models/entity_health_info.py +99 -0
  170. instana_client/models/entity_id.py +92 -0
  171. instana_client/models/entity_verification_rule.py +105 -0
  172. instana_client/models/error_budget_alert_rule.py +97 -0
  173. instana_client/models/errors_application_alert_rule.py +90 -0
  174. instana_client/models/event.py +127 -0
  175. instana_client/models/event_filtering_configuration.py +106 -0
  176. instana_client/models/event_result.py +145 -0
  177. instana_client/models/event_specification_info.py +114 -0
  178. instana_client/models/extended_service.py +123 -0
  179. instana_client/models/failure_synthetic_alert_rule.py +90 -0
  180. instana_client/models/fixed_http_path_segment_matching_rule.py +90 -0
  181. instana_client/models/fixed_time_window.py +93 -0
  182. instana_client/models/full_trace.py +97 -0
  183. instana_client/models/generic_infra_alert_rule.py +93 -0
  184. instana_client/models/geo_location_configuration.py +106 -0
  185. instana_client/models/geo_mapping_rule.py +120 -0
  186. instana_client/models/geo_subdivision.py +91 -0
  187. instana_client/models/get_activities.py +115 -0
  188. instana_client/models/get_application_metrics.py +112 -0
  189. instana_client/models/get_applications.py +150 -0
  190. instana_client/models/get_available_metrics_query.py +103 -0
  191. instana_client/models/get_available_plugins_query.py +98 -0
  192. instana_client/models/get_call_groups.py +141 -0
  193. instana_client/models/get_combined_metrics.py +103 -0
  194. instana_client/models/get_dynamic_parameter_values.py +100 -0
  195. instana_client/models/get_endpoints.py +150 -0
  196. instana_client/models/get_infrastructure_groups_query.py +127 -0
  197. instana_client/models/get_infrastructure_query.py +127 -0
  198. instana_client/models/get_metrics_result.py +128 -0
  199. instana_client/models/get_mobile_app_beacon_groups.py +146 -0
  200. instana_client/models/get_mobile_app_beacons.py +118 -0
  201. instana_client/models/get_mobile_app_metrics.py +122 -0
  202. instana_client/models/get_mobile_app_metrics_v2.py +118 -0
  203. instana_client/models/get_payload_keys_result.py +88 -0
  204. instana_client/models/get_services.py +147 -0
  205. instana_client/models/get_snapshots_query.py +95 -0
  206. instana_client/models/get_test_result.py +139 -0
  207. instana_client/models/get_test_result_base.py +120 -0
  208. instana_client/models/get_test_result_list.py +125 -0
  209. instana_client/models/get_test_summary_result.py +130 -0
  210. instana_client/models/get_trace_download_result_item.py +114 -0
  211. instana_client/models/get_trace_groups.py +141 -0
  212. instana_client/models/get_traces.py +125 -0
  213. instana_client/models/get_website_beacon_groups.py +146 -0
  214. instana_client/models/get_website_beacons.py +118 -0
  215. instana_client/models/get_website_metrics.py +122 -0
  216. instana_client/models/get_website_metrics_v2.py +118 -0
  217. instana_client/models/global_application_alert_config_with_metadata.py +205 -0
  218. instana_client/models/global_applications_alert_config.py +191 -0
  219. instana_client/models/google_chat_integration.py +92 -0
  220. instana_client/models/graph_edge.py +102 -0
  221. instana_client/models/graph_node.py +100 -0
  222. instana_client/models/group.py +100 -0
  223. instana_client/models/group_by_tag.py +90 -0
  224. instana_client/models/group_mapping.py +95 -0
  225. instana_client/models/health_state.py +100 -0
  226. instana_client/models/historic_baseline.py +105 -0
  227. instana_client/models/host_availability_rule.py +100 -0
  228. instana_client/models/http_action_configuration.py +127 -0
  229. instana_client/models/http_endpoint_config.py +103 -0
  230. instana_client/models/http_endpoint_rule.py +101 -0
  231. instana_client/models/http_path_segment_matching_rule.py +124 -0
  232. instana_client/models/http_script_configuration.py +113 -0
  233. instana_client/models/hyper_param.py +111 -0
  234. instana_client/models/identity_provider_patch.py +88 -0
  235. instana_client/models/infra_alert_config.py +166 -0
  236. instana_client/models/infra_alert_config_with_metadata.py +176 -0
  237. instana_client/models/infra_alert_rule.py +133 -0
  238. instana_client/models/infra_event_result.py +109 -0
  239. instana_client/models/infra_metric_configuration.py +115 -0
  240. instana_client/models/infra_time_threshold.py +109 -0
  241. instana_client/models/infrastructure_entities_result.py +109 -0
  242. instana_client/models/infrastructure_group.py +92 -0
  243. instana_client/models/infrastructure_groups_result.py +109 -0
  244. instana_client/models/infrastructure_item.py +104 -0
  245. instana_client/models/infrastructure_metric_result.py +96 -0
  246. instana_client/models/instana_version_info.py +92 -0
  247. instana_client/models/integration_overview.py +94 -0
  248. instana_client/models/invitation.py +94 -0
  249. instana_client/models/invitation_response.py +96 -0
  250. instana_client/models/invitation_result.py +100 -0
  251. instana_client/models/ip_masking_configuration.py +95 -0
  252. instana_client/models/js_stack_trace_line.py +99 -0
  253. instana_client/models/kubernetes_physical_context.py +107 -0
  254. instana_client/models/latency_blueprint_indicator.py +106 -0
  255. instana_client/models/location_status.py +96 -0
  256. instana_client/models/log_alert_config.py +154 -0
  257. instana_client/models/log_alert_config_with_metadata.py +164 -0
  258. instana_client/models/log_alert_rule.py +120 -0
  259. instana_client/models/log_count_alert_rule.py +90 -0
  260. instana_client/models/log_entry_actor.py +101 -0
  261. instana_client/models/log_event_result.py +107 -0
  262. instana_client/models/log_time_threshold.py +109 -0
  263. instana_client/models/logs_application_alert_rule.py +122 -0
  264. instana_client/models/maintenance_config.py +103 -0
  265. instana_client/models/maintenance_config_scheduling.py +118 -0
  266. instana_client/models/maintenance_config_v2.py +111 -0
  267. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +131 -0
  268. instana_client/models/maintenance_config_with_last_updated.py +105 -0
  269. instana_client/models/maintenance_window.py +93 -0
  270. instana_client/models/manual_alerting_channel_configuration.py +99 -0
  271. instana_client/models/manual_close_info.py +99 -0
  272. instana_client/models/manual_service_config.py +103 -0
  273. instana_client/models/match_all_http_path_segment_matching_rule.py +88 -0
  274. instana_client/models/match_expression_dto.py +111 -0
  275. instana_client/models/meta_data.py +96 -0
  276. instana_client/models/metric_api_result.py +94 -0
  277. instana_client/models/metric_config.py +99 -0
  278. instana_client/models/metric_configuration.py +103 -0
  279. instana_client/models/metric_description.py +116 -0
  280. instana_client/models/metric_instance.py +105 -0
  281. instana_client/models/metric_item.py +102 -0
  282. instana_client/models/metric_metadata.py +132 -0
  283. instana_client/models/metric_pattern.py +101 -0
  284. instana_client/models/metrics_result.py +96 -0
  285. instana_client/models/metrics_result_item.py +100 -0
  286. instana_client/models/metrics_test_result_item.py +102 -0
  287. instana_client/models/mobile_app.py +91 -0
  288. instana_client/models/mobile_app_alert_config.py +162 -0
  289. instana_client/models/mobile_app_alert_rule.py +129 -0
  290. instana_client/models/mobile_app_beacon_groups_item.py +95 -0
  291. instana_client/models/mobile_app_beacon_groups_result.py +111 -0
  292. instana_client/models/mobile_app_beacon_result.py +111 -0
  293. instana_client/models/mobile_app_beacon_tag_group.py +100 -0
  294. instana_client/models/mobile_app_beacons_item.py +94 -0
  295. instana_client/models/mobile_app_event_result.py +108 -0
  296. instana_client/models/mobile_app_metric_result.py +88 -0
  297. instana_client/models/mobile_app_monitoring_beacon.py +259 -0
  298. instana_client/models/mobile_app_monitoring_metric_description.py +123 -0
  299. instana_client/models/mobile_app_monitoring_metrics_configuration.py +105 -0
  300. instana_client/models/mobile_app_time_threshold.py +115 -0
  301. instana_client/models/model_field.py +96 -0
  302. instana_client/models/monitoring_state.py +92 -0
  303. instana_client/models/multiple_scripts_configuration.py +90 -0
  304. instana_client/models/new_application_config.py +129 -0
  305. instana_client/models/new_business_perspective_config.py +97 -0
  306. instana_client/models/new_manual_service_config.py +100 -0
  307. instana_client/models/occurrence.py +91 -0
  308. instana_client/models/office365_integration.py +92 -0
  309. instana_client/models/one_time_maintenance_window.py +94 -0
  310. instana_client/models/opsgenie_integration.py +105 -0
  311. instana_client/models/order.py +99 -0
  312. instana_client/models/pagerduty_integration.py +92 -0
  313. instana_client/models/paginated_result.py +95 -0
  314. instana_client/models/pagination.py +91 -0
  315. instana_client/models/parameter.py +102 -0
  316. instana_client/models/parameter_value.py +90 -0
  317. instana_client/models/path_parameter_http_path_segment_matching_rule.py +90 -0
  318. instana_client/models/physical_context.py +119 -0
  319. instana_client/models/plugin_result.py +90 -0
  320. instana_client/models/policy.py +113 -0
  321. instana_client/models/policy_runnable.py +103 -0
  322. instana_client/models/post_snapshots_result.py +98 -0
  323. instana_client/models/problem.py +95 -0
  324. instana_client/models/prometheus_webhook_integration.py +94 -0
  325. instana_client/models/recurrent_maintenance_window.py +98 -0
  326. instana_client/models/release.py +111 -0
  327. instana_client/models/release_scope.py +94 -0
  328. instana_client/models/release_with_metadata.py +125 -0
  329. instana_client/models/rolling_time_window.py +90 -0
  330. instana_client/models/rule_input.py +98 -0
  331. instana_client/models/rule_with_threshold_application_alert_rule.py +116 -0
  332. instana_client/models/rule_with_threshold_infra_alert_rule.py +116 -0
  333. instana_client/models/rule_with_threshold_log_alert_rule.py +116 -0
  334. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +116 -0
  335. instana_client/models/rule_with_threshold_website_alert_rule.py +116 -0
  336. instana_client/models/run_configuration.py +96 -0
  337. instana_client/models/salesforce_integration.py +98 -0
  338. instana_client/models/scope_binding.py +91 -0
  339. instana_client/models/search_field_result.py +116 -0
  340. instana_client/models/service.py +116 -0
  341. instana_client/models/service_config.py +107 -0
  342. instana_client/models/service_event_result.py +110 -0
  343. instana_client/models/service_item.py +94 -0
  344. instana_client/models/service_level_indicator.py +172 -0
  345. instana_client/models/service_level_objective_alert_rule.py +100 -0
  346. instana_client/models/service_level_objective_configuration.py +118 -0
  347. instana_client/models/service_levels_alert_config.py +133 -0
  348. instana_client/models/service_levels_alert_rule.py +111 -0
  349. instana_client/models/service_levels_burn_rate_time_windows.py +97 -0
  350. instana_client/models/service_levels_time_threshold.py +90 -0
  351. instana_client/models/service_levelse_alert_config_with_metadata.py +143 -0
  352. instana_client/models/service_map.py +106 -0
  353. instana_client/models/service_map_connection.py +97 -0
  354. instana_client/models/service_matching_rule.py +90 -0
  355. instana_client/models/service_metric_result.py +109 -0
  356. instana_client/models/service_node.py +106 -0
  357. instana_client/models/service_now_enhanced_integration.py +116 -0
  358. instana_client/models/service_now_integration.py +98 -0
  359. instana_client/models/service_result.py +102 -0
  360. instana_client/models/service_scope.py +95 -0
  361. instana_client/models/service_scope_with_metadata.py +96 -0
  362. instana_client/models/service_scoped_to.py +97 -0
  363. instana_client/models/service_scoped_to_with_metadata.py +97 -0
  364. instana_client/models/service_simple.py +90 -0
  365. instana_client/models/session_settings.py +91 -0
  366. instana_client/models/slack_integration.py +98 -0
  367. instana_client/models/sli_configuration.py +105 -0
  368. instana_client/models/sli_configuration_with_last_updated.py +107 -0
  369. instana_client/models/sli_entity.py +117 -0
  370. instana_client/models/sli_report.py +100 -0
  371. instana_client/models/slo_entity.py +119 -0
  372. instana_client/models/slo_report.py +112 -0
  373. instana_client/models/slowness_application_alert_rule.py +90 -0
  374. instana_client/models/slowness_website_alert_rule.py +90 -0
  375. instana_client/models/snapshot_item.py +102 -0
  376. instana_client/models/snapshot_preview.py +97 -0
  377. instana_client/models/snapshot_result.py +96 -0
  378. instana_client/models/software_user.py +94 -0
  379. instana_client/models/software_version.py +124 -0
  380. instana_client/models/source_map_file_blob.py +92 -0
  381. instana_client/models/source_map_file_meta.py +115 -0
  382. instana_client/models/source_map_upload_config.py +106 -0
  383. instana_client/models/span.py +156 -0
  384. instana_client/models/span_excerpt.py +132 -0
  385. instana_client/models/span_relation.py +114 -0
  386. instana_client/models/specific_js_errors_website_alert_rule.py +101 -0
  387. instana_client/models/splunk_integration.py +94 -0
  388. instana_client/models/ssl_certificate_configuration.py +99 -0
  389. instana_client/models/stack_trace_item.py +92 -0
  390. instana_client/models/stack_trace_line.py +99 -0
  391. instana_client/models/static_baseline_threshold_rule.py +102 -0
  392. instana_client/models/static_string_field.py +91 -0
  393. instana_client/models/static_threshold.py +94 -0
  394. instana_client/models/static_threshold_rule.py +91 -0
  395. instana_client/models/status_code_application_alert_rule.py +95 -0
  396. instana_client/models/status_code_mobile_app_alert_rule.py +101 -0
  397. instana_client/models/status_code_website_alert_rule.py +101 -0
  398. instana_client/models/synthetic_alert_config.py +127 -0
  399. instana_client/models/synthetic_alert_config_with_metadata.py +137 -0
  400. instana_client/models/synthetic_alert_rule.py +120 -0
  401. instana_client/models/synthetic_call_config.py +99 -0
  402. instana_client/models/synthetic_call_rule.py +99 -0
  403. instana_client/models/synthetic_call_with_defaults_config.py +108 -0
  404. instana_client/models/synthetic_credential.py +111 -0
  405. instana_client/models/synthetic_datacenter.py +117 -0
  406. instana_client/models/synthetic_datacenter_configuration.py +88 -0
  407. instana_client/models/synthetic_geo_point.py +94 -0
  408. instana_client/models/synthetic_location.py +129 -0
  409. instana_client/models/synthetic_location_configuration.py +102 -0
  410. instana_client/models/synthetic_metric_configuration.py +99 -0
  411. instana_client/models/synthetic_metric_tag_group.py +100 -0
  412. instana_client/models/synthetic_playback_capabilities.py +98 -0
  413. instana_client/models/synthetic_slo_entity.py +95 -0
  414. instana_client/models/synthetic_test.py +149 -0
  415. instana_client/models/synthetic_time_threshold.py +110 -0
  416. instana_client/models/synthetic_type_configuration.py +141 -0
  417. instana_client/models/synthetics_event_result.py +110 -0
  418. instana_client/models/system_rule.py +91 -0
  419. instana_client/models/system_rule_label.py +90 -0
  420. instana_client/models/tag.py +123 -0
  421. instana_client/models/tag_catalog.py +106 -0
  422. instana_client/models/tag_filter.py +113 -0
  423. instana_client/models/tag_filter_expression.py +106 -0
  424. instana_client/models/tag_filter_expression_element.py +111 -0
  425. instana_client/models/tag_matcher_dto.py +110 -0
  426. instana_client/models/tag_tree_level.py +109 -0
  427. instana_client/models/tag_tree_node.py +113 -0
  428. instana_client/models/tag_tree_tag.py +103 -0
  429. instana_client/models/test_common_properties.py +136 -0
  430. instana_client/models/test_result.py +105 -0
  431. instana_client/models/test_result_common_properties.py +108 -0
  432. instana_client/models/test_result_detail_data.py +112 -0
  433. instana_client/models/test_result_item.py +106 -0
  434. instana_client/models/test_result_list_item.py +94 -0
  435. instana_client/models/test_result_list_result.py +103 -0
  436. instana_client/models/test_result_metadata.py +94 -0
  437. instana_client/models/test_result_subtransaction.py +90 -0
  438. instana_client/models/threshold.py +122 -0
  439. instana_client/models/threshold_config_rule.py +114 -0
  440. instana_client/models/threshold_rule.py +125 -0
  441. instana_client/models/throughput_application_alert_rule.py +90 -0
  442. instana_client/models/throughput_mobile_app_alert_rule.py +90 -0
  443. instana_client/models/throughput_website_alert_rule.py +90 -0
  444. instana_client/models/time_frame.py +91 -0
  445. instana_client/models/time_window.py +120 -0
  446. instana_client/models/topology.py +106 -0
  447. instana_client/models/trace.py +109 -0
  448. instana_client/models/trace_activity_tree_node_details.py +139 -0
  449. instana_client/models/trace_download_result.py +111 -0
  450. instana_client/models/trace_groups_item.py +95 -0
  451. instana_client/models/trace_groups_result.py +111 -0
  452. instana_client/models/trace_impact_application_time_threshold.py +92 -0
  453. instana_client/models/trace_item.py +94 -0
  454. instana_client/models/trace_result.py +111 -0
  455. instana_client/models/traffic_blueprint_indicator.py +104 -0
  456. instana_client/models/trigger.py +99 -0
  457. instana_client/models/type_configuration.py +107 -0
  458. instana_client/models/unsupported_http_path_segment_matching_rule.py +90 -0
  459. instana_client/models/updated_business_perspective_config.py +97 -0
  460. instana_client/models/usage_result.py +98 -0
  461. instana_client/models/usage_result_items.py +90 -0
  462. instana_client/models/user_basic_result.py +92 -0
  463. instana_client/models/user_impact_mobile_app_time_threshold.py +103 -0
  464. instana_client/models/user_impact_website_time_threshold.py +103 -0
  465. instana_client/models/user_result.py +98 -0
  466. instana_client/models/users_result.py +106 -0
  467. instana_client/models/validated_alerting_channel_input_info.py +123 -0
  468. instana_client/models/validated_alerting_configuration.py +121 -0
  469. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +135 -0
  470. instana_client/models/validated_maintenance_config_with_status.py +116 -0
  471. instana_client/models/victor_ops_integration.py +94 -0
  472. instana_client/models/violations_in_period_application_time_threshold.py +92 -0
  473. instana_client/models/violations_in_period_mobile_app_time_threshold.py +92 -0
  474. instana_client/models/violations_in_period_website_time_threshold.py +92 -0
  475. instana_client/models/violations_in_sequence_application_time_threshold.py +89 -0
  476. instana_client/models/violations_in_sequence_infra_time_threshold.py +89 -0
  477. instana_client/models/violations_in_sequence_log_time_threshold.py +89 -0
  478. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +89 -0
  479. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +89 -0
  480. instana_client/models/violations_in_sequence_website_time_threshold.py +89 -0
  481. instana_client/models/watson_ai_ops_webhook_integration.py +94 -0
  482. instana_client/models/webex_teams_webhook_integration.py +92 -0
  483. instana_client/models/webhook_integration.py +94 -0
  484. instana_client/models/webpage_action_configuration.py +109 -0
  485. instana_client/models/webpage_script_configuration.py +109 -0
  486. instana_client/models/website.py +92 -0
  487. instana_client/models/website_alert_config.py +166 -0
  488. instana_client/models/website_alert_config_with_metadata.py +176 -0
  489. instana_client/models/website_alert_rule.py +132 -0
  490. instana_client/models/website_apdex_entity.py +107 -0
  491. instana_client/models/website_beacon_groups_item.py +95 -0
  492. instana_client/models/website_beacon_groups_result.py +111 -0
  493. instana_client/models/website_beacon_result.py +111 -0
  494. instana_client/models/website_beacon_tag_group.py +100 -0
  495. instana_client/models/website_beacons_item.py +94 -0
  496. instana_client/models/website_event_based_sli_entity.py +110 -0
  497. instana_client/models/website_event_result.py +108 -0
  498. instana_client/models/website_metric_result.py +88 -0
  499. instana_client/models/website_monitoring_beacon.py +301 -0
  500. instana_client/models/website_monitoring_metric_description.py +123 -0
  501. instana_client/models/website_monitoring_metrics_configuration.py +99 -0
  502. instana_client/models/website_slo_entity.py +104 -0
  503. instana_client/models/website_time_based_sli_entity.py +105 -0
  504. instana_client/models/website_time_threshold.py +115 -0
  505. instana_client/models/widget.py +103 -0
  506. instana_client/models/with_metadata.py +172 -0
  507. instana_client/models/with_resolved_name.py +102 -0
  508. instana_client/models/z_chat_ops_integration.py +97 -0
  509. instana_client/py.typed +0 -0
  510. instana_client/rest.py +258 -0
  511. instana_client-1.0.0.dist-info/METADATA +25 -0
  512. instana_client-1.0.0.dist-info/RECORD +515 -0
  513. instana_client-1.0.0.dist-info/WHEEL +5 -0
  514. instana_client-1.0.0.dist-info/licenses/LICENSE +202 -0
  515. instana_client-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2177 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Instana REST API documentation
5
+
6
+ Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f). ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management. ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server. - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00. ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana. ## Getting Started with the REST API ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself. ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call. ```bash curl --request GET \\ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ``` Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example. ```bash curl --request POST \\ --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\ --header 'content-type: application/json' \\ --data '{ \"group\":{ \"groupbyTag\":\"endpoint.name\" }, \"tagFilters\":[ { \"name\":\"call.error.count\", \"value\":\"0\", \"operator\":\"GREATER_THAN\" } ], \"metrics\":[ { \"metric\":\"errors\", \"aggregation\":\"MEAN\" } ] }' ``` ### Generating REST API clients The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml). OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator). #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit: ```bash #!/bin/bash ### This script assumes you have the `java` and `wget` commands on the path export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\" //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\ -o pkg/instana/openapi \\ --skip-validate-spec //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ``` The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above: ```go import instana \"./pkg/instana/openapi\" // readTags will read all available application monitoring tags along with their type and category func readTags() { configuration := instana.NewConfiguration() configuration.Host = \"tenant-unit.instana.io\" configuration.BasePath = \"https://tenant-unit.instana.io\" client := instana.NewAPIClient(configuration) auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{ Key: apiKey, Prefix: \"apiToken\", }) tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth) if err != nil { fmt.Fatalf(\"Error calling the API, aborting.\") } for _, tag := range tags { fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name) } } ``` #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar). Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate ```
7
+
8
+ The version of the OpenAPI document: 1.291.1002
9
+ Contact: support@instana.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 StrictInt, StrictStr, field_validator
21
+ from typing import Optional
22
+ from instana_client.models.business_activity import BusinessActivity
23
+ from instana_client.models.business_perspective_config import BusinessPerspectiveConfig
24
+ from instana_client.models.cursor_paginated_business_activity_item import CursorPaginatedBusinessActivityItem
25
+ from instana_client.models.get_activities import GetActivities
26
+ from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig
27
+ from instana_client.models.tag_catalog import TagCatalog
28
+ from instana_client.models.updated_business_perspective_config import UpdatedBusinessPerspectiveConfig
29
+
30
+ from instana_client.api_client import ApiClient, RequestSerialized
31
+ from instana_client.api_response import ApiResponse
32
+ from instana_client.rest import RESTResponseType
33
+
34
+
35
+ class BusinessMonitoringApi:
36
+ """NOTE: This class is auto generated by OpenAPI Generator
37
+ Ref: https://openapi-generator.tech
38
+
39
+ Do not edit the class manually.
40
+ """
41
+
42
+ def __init__(self, api_client=None) -> None:
43
+ if api_client is None:
44
+ api_client = ApiClient.get_default()
45
+ self.api_client = api_client
46
+
47
+
48
+ @validate_call
49
+ def create_business_perspective(
50
+ self,
51
+ new_business_perspective_config: NewBusinessPerspectiveConfig,
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
+ ) -> BusinessPerspectiveConfig:
65
+ """Create business perspective
66
+
67
+
68
+ :param new_business_perspective_config: (required)
69
+ :type new_business_perspective_config: NewBusinessPerspectiveConfig
70
+ :param _request_timeout: timeout setting for this request. If one
71
+ number provided, it will be total request
72
+ timeout. It can also be a pair (tuple) of
73
+ (connection, read) timeouts.
74
+ :type _request_timeout: int, tuple(int, int), optional
75
+ :param _request_auth: set to override the auth_settings for an a single
76
+ request; this effectively ignores the
77
+ authentication in the spec for a single request.
78
+ :type _request_auth: dict, optional
79
+ :param _content_type: force content-type for the request.
80
+ :type _content_type: str, Optional
81
+ :param _headers: set to override the headers for a single
82
+ request; this effectively ignores the headers
83
+ in the spec for a single request.
84
+ :type _headers: dict, optional
85
+ :param _host_index: set to override the host_index for a single
86
+ request; this effectively ignores the host_index
87
+ in the spec for a single request.
88
+ :type _host_index: int, optional
89
+ :return: Returns the result object.
90
+ """ # noqa: E501
91
+
92
+ _param = self._create_business_perspective_serialize(
93
+ new_business_perspective_config=new_business_perspective_config,
94
+ _request_auth=_request_auth,
95
+ _content_type=_content_type,
96
+ _headers=_headers,
97
+ _host_index=_host_index
98
+ )
99
+
100
+ _response_types_map: Dict[str, Optional[str]] = {
101
+ '200': "BusinessPerspectiveConfig",
102
+ }
103
+ response_data = self.api_client.call_api(
104
+ *_param,
105
+ _request_timeout=_request_timeout
106
+ )
107
+ response_data.read()
108
+ return self.api_client.response_deserialize(
109
+ response_data=response_data,
110
+ response_types_map=_response_types_map,
111
+ ).data
112
+
113
+
114
+ @validate_call
115
+ def create_business_perspective_with_http_info(
116
+ self,
117
+ new_business_perspective_config: NewBusinessPerspectiveConfig,
118
+ _request_timeout: Union[
119
+ None,
120
+ Annotated[StrictFloat, Field(gt=0)],
121
+ Tuple[
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Annotated[StrictFloat, Field(gt=0)]
124
+ ]
125
+ ] = None,
126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
127
+ _content_type: Optional[StrictStr] = None,
128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
+ ) -> ApiResponse[BusinessPerspectiveConfig]:
131
+ """Create business perspective
132
+
133
+
134
+ :param new_business_perspective_config: (required)
135
+ :type new_business_perspective_config: NewBusinessPerspectiveConfig
136
+ :param _request_timeout: timeout setting for this request. If one
137
+ number provided, it will be total request
138
+ timeout. It can also be a pair (tuple) of
139
+ (connection, read) timeouts.
140
+ :type _request_timeout: int, tuple(int, int), optional
141
+ :param _request_auth: set to override the auth_settings for an a single
142
+ request; this effectively ignores the
143
+ authentication in the spec for a single request.
144
+ :type _request_auth: dict, optional
145
+ :param _content_type: force content-type for the request.
146
+ :type _content_type: str, Optional
147
+ :param _headers: set to override the headers for a single
148
+ request; this effectively ignores the headers
149
+ in the spec for a single request.
150
+ :type _headers: dict, optional
151
+ :param _host_index: set to override the host_index for a single
152
+ request; this effectively ignores the host_index
153
+ in the spec for a single request.
154
+ :type _host_index: int, optional
155
+ :return: Returns the result object.
156
+ """ # noqa: E501
157
+
158
+ _param = self._create_business_perspective_serialize(
159
+ new_business_perspective_config=new_business_perspective_config,
160
+ _request_auth=_request_auth,
161
+ _content_type=_content_type,
162
+ _headers=_headers,
163
+ _host_index=_host_index
164
+ )
165
+
166
+ _response_types_map: Dict[str, Optional[str]] = {
167
+ '200': "BusinessPerspectiveConfig",
168
+ }
169
+ response_data = self.api_client.call_api(
170
+ *_param,
171
+ _request_timeout=_request_timeout
172
+ )
173
+ response_data.read()
174
+ return self.api_client.response_deserialize(
175
+ response_data=response_data,
176
+ response_types_map=_response_types_map,
177
+ )
178
+
179
+
180
+ @validate_call
181
+ def create_business_perspective_without_preload_content(
182
+ self,
183
+ new_business_perspective_config: NewBusinessPerspectiveConfig,
184
+ _request_timeout: Union[
185
+ None,
186
+ Annotated[StrictFloat, Field(gt=0)],
187
+ Tuple[
188
+ Annotated[StrictFloat, Field(gt=0)],
189
+ Annotated[StrictFloat, Field(gt=0)]
190
+ ]
191
+ ] = None,
192
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
193
+ _content_type: Optional[StrictStr] = None,
194
+ _headers: Optional[Dict[StrictStr, Any]] = None,
195
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
196
+ ) -> RESTResponseType:
197
+ """Create business perspective
198
+
199
+
200
+ :param new_business_perspective_config: (required)
201
+ :type new_business_perspective_config: NewBusinessPerspectiveConfig
202
+ :param _request_timeout: timeout setting for this request. If one
203
+ number provided, it will be total request
204
+ timeout. It can also be a pair (tuple) of
205
+ (connection, read) timeouts.
206
+ :type _request_timeout: int, tuple(int, int), optional
207
+ :param _request_auth: set to override the auth_settings for an a single
208
+ request; this effectively ignores the
209
+ authentication in the spec for a single request.
210
+ :type _request_auth: dict, optional
211
+ :param _content_type: force content-type for the request.
212
+ :type _content_type: str, Optional
213
+ :param _headers: set to override the headers for a single
214
+ request; this effectively ignores the headers
215
+ in the spec for a single request.
216
+ :type _headers: dict, optional
217
+ :param _host_index: set to override the host_index for a single
218
+ request; this effectively ignores the host_index
219
+ in the spec for a single request.
220
+ :type _host_index: int, optional
221
+ :return: Returns the result object.
222
+ """ # noqa: E501
223
+
224
+ _param = self._create_business_perspective_serialize(
225
+ new_business_perspective_config=new_business_perspective_config,
226
+ _request_auth=_request_auth,
227
+ _content_type=_content_type,
228
+ _headers=_headers,
229
+ _host_index=_host_index
230
+ )
231
+
232
+ _response_types_map: Dict[str, Optional[str]] = {
233
+ '200': "BusinessPerspectiveConfig",
234
+ }
235
+ response_data = self.api_client.call_api(
236
+ *_param,
237
+ _request_timeout=_request_timeout
238
+ )
239
+ return response_data.response
240
+
241
+
242
+ def _create_business_perspective_serialize(
243
+ self,
244
+ new_business_perspective_config,
245
+ _request_auth,
246
+ _content_type,
247
+ _headers,
248
+ _host_index,
249
+ ) -> RequestSerialized:
250
+
251
+ _host = None
252
+
253
+ _collection_formats: Dict[str, str] = {
254
+ }
255
+
256
+ _path_params: Dict[str, str] = {}
257
+ _query_params: List[Tuple[str, str]] = []
258
+ _header_params: Dict[str, Optional[str]] = _headers or {}
259
+ _form_params: List[Tuple[str, str]] = []
260
+ _files: Dict[
261
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
262
+ ] = {}
263
+ _body_params: Optional[bytes] = None
264
+
265
+ # process the path parameters
266
+ # process the query parameters
267
+ # process the header parameters
268
+ # process the form parameters
269
+ # process the body parameter
270
+ if new_business_perspective_config is not None:
271
+ _body_params = new_business_perspective_config
272
+
273
+
274
+ # set the HTTP header `Accept`
275
+ if 'Accept' not in _header_params:
276
+ _header_params['Accept'] = self.api_client.select_header_accept(
277
+ [
278
+ 'application/json'
279
+ ]
280
+ )
281
+
282
+ # set the HTTP header `Content-Type`
283
+ if _content_type:
284
+ _header_params['Content-Type'] = _content_type
285
+ else:
286
+ _default_content_type = (
287
+ self.api_client.select_header_content_type(
288
+ [
289
+ 'application/json'
290
+ ]
291
+ )
292
+ )
293
+ if _default_content_type is not None:
294
+ _header_params['Content-Type'] = _default_content_type
295
+
296
+ # authentication setting
297
+ _auth_settings: List[str] = [
298
+ 'ApiKeyAuth'
299
+ ]
300
+
301
+ return self.api_client.param_serialize(
302
+ method='POST',
303
+ resource_path='/api/business-monitoring/business-perspectives',
304
+ path_params=_path_params,
305
+ query_params=_query_params,
306
+ header_params=_header_params,
307
+ body=_body_params,
308
+ post_params=_form_params,
309
+ files=_files,
310
+ auth_settings=_auth_settings,
311
+ collection_formats=_collection_formats,
312
+ _host=_host,
313
+ _request_auth=_request_auth
314
+ )
315
+
316
+
317
+
318
+
319
+ @validate_call
320
+ def delete_business_perspective(
321
+ self,
322
+ id: StrictStr,
323
+ _request_timeout: Union[
324
+ None,
325
+ Annotated[StrictFloat, Field(gt=0)],
326
+ Tuple[
327
+ Annotated[StrictFloat, Field(gt=0)],
328
+ Annotated[StrictFloat, Field(gt=0)]
329
+ ]
330
+ ] = None,
331
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
332
+ _content_type: Optional[StrictStr] = None,
333
+ _headers: Optional[Dict[StrictStr, Any]] = None,
334
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
335
+ ) -> None:
336
+ """Delete business perspective
337
+
338
+
339
+ :param id: (required)
340
+ :type id: str
341
+ :param _request_timeout: timeout setting for this request. If one
342
+ number provided, it will be total request
343
+ timeout. It can also be a pair (tuple) of
344
+ (connection, read) timeouts.
345
+ :type _request_timeout: int, tuple(int, int), optional
346
+ :param _request_auth: set to override the auth_settings for an a single
347
+ request; this effectively ignores the
348
+ authentication in the spec for a single request.
349
+ :type _request_auth: dict, optional
350
+ :param _content_type: force content-type for the request.
351
+ :type _content_type: str, Optional
352
+ :param _headers: set to override the headers for a single
353
+ request; this effectively ignores the headers
354
+ in the spec for a single request.
355
+ :type _headers: dict, optional
356
+ :param _host_index: set to override the host_index for a single
357
+ request; this effectively ignores the host_index
358
+ in the spec for a single request.
359
+ :type _host_index: int, optional
360
+ :return: Returns the result object.
361
+ """ # noqa: E501
362
+
363
+ _param = self._delete_business_perspective_serialize(
364
+ id=id,
365
+ _request_auth=_request_auth,
366
+ _content_type=_content_type,
367
+ _headers=_headers,
368
+ _host_index=_host_index
369
+ )
370
+
371
+ _response_types_map: Dict[str, Optional[str]] = {
372
+ }
373
+ response_data = self.api_client.call_api(
374
+ *_param,
375
+ _request_timeout=_request_timeout
376
+ )
377
+ response_data.read()
378
+ return self.api_client.response_deserialize(
379
+ response_data=response_data,
380
+ response_types_map=_response_types_map,
381
+ ).data
382
+
383
+
384
+ @validate_call
385
+ def delete_business_perspective_with_http_info(
386
+ self,
387
+ id: StrictStr,
388
+ _request_timeout: Union[
389
+ None,
390
+ Annotated[StrictFloat, Field(gt=0)],
391
+ Tuple[
392
+ Annotated[StrictFloat, Field(gt=0)],
393
+ Annotated[StrictFloat, Field(gt=0)]
394
+ ]
395
+ ] = None,
396
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
397
+ _content_type: Optional[StrictStr] = None,
398
+ _headers: Optional[Dict[StrictStr, Any]] = None,
399
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
400
+ ) -> ApiResponse[None]:
401
+ """Delete business perspective
402
+
403
+
404
+ :param id: (required)
405
+ :type id: str
406
+ :param _request_timeout: timeout setting for this request. If one
407
+ number provided, it will be total request
408
+ timeout. It can also be a pair (tuple) of
409
+ (connection, read) timeouts.
410
+ :type _request_timeout: int, tuple(int, int), optional
411
+ :param _request_auth: set to override the auth_settings for an a single
412
+ request; this effectively ignores the
413
+ authentication in the spec for a single request.
414
+ :type _request_auth: dict, optional
415
+ :param _content_type: force content-type for the request.
416
+ :type _content_type: str, Optional
417
+ :param _headers: set to override the headers for a single
418
+ request; this effectively ignores the headers
419
+ in the spec for a single request.
420
+ :type _headers: dict, optional
421
+ :param _host_index: set to override the host_index for a single
422
+ request; this effectively ignores the host_index
423
+ in the spec for a single request.
424
+ :type _host_index: int, optional
425
+ :return: Returns the result object.
426
+ """ # noqa: E501
427
+
428
+ _param = self._delete_business_perspective_serialize(
429
+ id=id,
430
+ _request_auth=_request_auth,
431
+ _content_type=_content_type,
432
+ _headers=_headers,
433
+ _host_index=_host_index
434
+ )
435
+
436
+ _response_types_map: Dict[str, Optional[str]] = {
437
+ }
438
+ response_data = self.api_client.call_api(
439
+ *_param,
440
+ _request_timeout=_request_timeout
441
+ )
442
+ response_data.read()
443
+ return self.api_client.response_deserialize(
444
+ response_data=response_data,
445
+ response_types_map=_response_types_map,
446
+ )
447
+
448
+
449
+ @validate_call
450
+ def delete_business_perspective_without_preload_content(
451
+ self,
452
+ id: StrictStr,
453
+ _request_timeout: Union[
454
+ None,
455
+ Annotated[StrictFloat, Field(gt=0)],
456
+ Tuple[
457
+ Annotated[StrictFloat, Field(gt=0)],
458
+ Annotated[StrictFloat, Field(gt=0)]
459
+ ]
460
+ ] = None,
461
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
462
+ _content_type: Optional[StrictStr] = None,
463
+ _headers: Optional[Dict[StrictStr, Any]] = None,
464
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
465
+ ) -> RESTResponseType:
466
+ """Delete business perspective
467
+
468
+
469
+ :param id: (required)
470
+ :type id: str
471
+ :param _request_timeout: timeout setting for this request. If one
472
+ number provided, it will be total request
473
+ timeout. It can also be a pair (tuple) of
474
+ (connection, read) timeouts.
475
+ :type _request_timeout: int, tuple(int, int), optional
476
+ :param _request_auth: set to override the auth_settings for an a single
477
+ request; this effectively ignores the
478
+ authentication in the spec for a single request.
479
+ :type _request_auth: dict, optional
480
+ :param _content_type: force content-type for the request.
481
+ :type _content_type: str, Optional
482
+ :param _headers: set to override the headers for a single
483
+ request; this effectively ignores the headers
484
+ in the spec for a single request.
485
+ :type _headers: dict, optional
486
+ :param _host_index: set to override the host_index for a single
487
+ request; this effectively ignores the host_index
488
+ in the spec for a single request.
489
+ :type _host_index: int, optional
490
+ :return: Returns the result object.
491
+ """ # noqa: E501
492
+
493
+ _param = self._delete_business_perspective_serialize(
494
+ id=id,
495
+ _request_auth=_request_auth,
496
+ _content_type=_content_type,
497
+ _headers=_headers,
498
+ _host_index=_host_index
499
+ )
500
+
501
+ _response_types_map: Dict[str, Optional[str]] = {
502
+ }
503
+ response_data = self.api_client.call_api(
504
+ *_param,
505
+ _request_timeout=_request_timeout
506
+ )
507
+ return response_data.response
508
+
509
+
510
+ def _delete_business_perspective_serialize(
511
+ self,
512
+ id,
513
+ _request_auth,
514
+ _content_type,
515
+ _headers,
516
+ _host_index,
517
+ ) -> RequestSerialized:
518
+
519
+ _host = None
520
+
521
+ _collection_formats: Dict[str, str] = {
522
+ }
523
+
524
+ _path_params: Dict[str, str] = {}
525
+ _query_params: List[Tuple[str, str]] = []
526
+ _header_params: Dict[str, Optional[str]] = _headers or {}
527
+ _form_params: List[Tuple[str, str]] = []
528
+ _files: Dict[
529
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
530
+ ] = {}
531
+ _body_params: Optional[bytes] = None
532
+
533
+ # process the path parameters
534
+ if id is not None:
535
+ _path_params['id'] = id
536
+ # process the query parameters
537
+ # process the header parameters
538
+ # process the form parameters
539
+ # process the body parameter
540
+
541
+
542
+ # set the HTTP header `Accept`
543
+ if 'Accept' not in _header_params:
544
+ _header_params['Accept'] = self.api_client.select_header_accept(
545
+ [
546
+ 'application/json'
547
+ ]
548
+ )
549
+
550
+
551
+ # authentication setting
552
+ _auth_settings: List[str] = [
553
+ 'ApiKeyAuth'
554
+ ]
555
+
556
+ return self.api_client.param_serialize(
557
+ method='DELETE',
558
+ resource_path='/api/business-monitoring/business-perspectives/{id}',
559
+ path_params=_path_params,
560
+ query_params=_query_params,
561
+ header_params=_header_params,
562
+ body=_body_params,
563
+ post_params=_form_params,
564
+ files=_files,
565
+ auth_settings=_auth_settings,
566
+ collection_formats=_collection_formats,
567
+ _host=_host,
568
+ _request_auth=_request_auth
569
+ )
570
+
571
+
572
+
573
+
574
+ @validate_call
575
+ def get_activities(
576
+ self,
577
+ get_activities: Optional[GetActivities] = None,
578
+ _request_timeout: Union[
579
+ None,
580
+ Annotated[StrictFloat, Field(gt=0)],
581
+ Tuple[
582
+ Annotated[StrictFloat, Field(gt=0)],
583
+ Annotated[StrictFloat, Field(gt=0)]
584
+ ]
585
+ ] = None,
586
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
587
+ _content_type: Optional[StrictStr] = None,
588
+ _headers: Optional[Dict[StrictStr, Any]] = None,
589
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
590
+ ) -> CursorPaginatedBusinessActivityItem:
591
+ """Get Business Activities
592
+
593
+
594
+ :param get_activities:
595
+ :type get_activities: GetActivities
596
+ :param _request_timeout: timeout setting for this request. If one
597
+ number provided, it will be total request
598
+ timeout. It can also be a pair (tuple) of
599
+ (connection, read) timeouts.
600
+ :type _request_timeout: int, tuple(int, int), optional
601
+ :param _request_auth: set to override the auth_settings for an a single
602
+ request; this effectively ignores the
603
+ authentication in the spec for a single request.
604
+ :type _request_auth: dict, optional
605
+ :param _content_type: force content-type for the request.
606
+ :type _content_type: str, Optional
607
+ :param _headers: set to override the headers for a single
608
+ request; this effectively ignores the headers
609
+ in the spec for a single request.
610
+ :type _headers: dict, optional
611
+ :param _host_index: set to override the host_index for a single
612
+ request; this effectively ignores the host_index
613
+ in the spec for a single request.
614
+ :type _host_index: int, optional
615
+ :return: Returns the result object.
616
+ """ # noqa: E501
617
+
618
+ _param = self._get_activities_serialize(
619
+ get_activities=get_activities,
620
+ _request_auth=_request_auth,
621
+ _content_type=_content_type,
622
+ _headers=_headers,
623
+ _host_index=_host_index
624
+ )
625
+
626
+ _response_types_map: Dict[str, Optional[str]] = {
627
+ '200': "CursorPaginatedBusinessActivityItem",
628
+ }
629
+ response_data = self.api_client.call_api(
630
+ *_param,
631
+ _request_timeout=_request_timeout
632
+ )
633
+ response_data.read()
634
+ return self.api_client.response_deserialize(
635
+ response_data=response_data,
636
+ response_types_map=_response_types_map,
637
+ ).data
638
+
639
+
640
+ @validate_call
641
+ def get_activities_with_http_info(
642
+ self,
643
+ get_activities: Optional[GetActivities] = None,
644
+ _request_timeout: Union[
645
+ None,
646
+ Annotated[StrictFloat, Field(gt=0)],
647
+ Tuple[
648
+ Annotated[StrictFloat, Field(gt=0)],
649
+ Annotated[StrictFloat, Field(gt=0)]
650
+ ]
651
+ ] = None,
652
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
653
+ _content_type: Optional[StrictStr] = None,
654
+ _headers: Optional[Dict[StrictStr, Any]] = None,
655
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
656
+ ) -> ApiResponse[CursorPaginatedBusinessActivityItem]:
657
+ """Get Business Activities
658
+
659
+
660
+ :param get_activities:
661
+ :type get_activities: GetActivities
662
+ :param _request_timeout: timeout setting for this request. If one
663
+ number provided, it will be total request
664
+ timeout. It can also be a pair (tuple) of
665
+ (connection, read) timeouts.
666
+ :type _request_timeout: int, tuple(int, int), optional
667
+ :param _request_auth: set to override the auth_settings for an a single
668
+ request; this effectively ignores the
669
+ authentication in the spec for a single request.
670
+ :type _request_auth: dict, optional
671
+ :param _content_type: force content-type for the request.
672
+ :type _content_type: str, Optional
673
+ :param _headers: set to override the headers for a single
674
+ request; this effectively ignores the headers
675
+ in the spec for a single request.
676
+ :type _headers: dict, optional
677
+ :param _host_index: set to override the host_index for a single
678
+ request; this effectively ignores the host_index
679
+ in the spec for a single request.
680
+ :type _host_index: int, optional
681
+ :return: Returns the result object.
682
+ """ # noqa: E501
683
+
684
+ _param = self._get_activities_serialize(
685
+ get_activities=get_activities,
686
+ _request_auth=_request_auth,
687
+ _content_type=_content_type,
688
+ _headers=_headers,
689
+ _host_index=_host_index
690
+ )
691
+
692
+ _response_types_map: Dict[str, Optional[str]] = {
693
+ '200': "CursorPaginatedBusinessActivityItem",
694
+ }
695
+ response_data = self.api_client.call_api(
696
+ *_param,
697
+ _request_timeout=_request_timeout
698
+ )
699
+ response_data.read()
700
+ return self.api_client.response_deserialize(
701
+ response_data=response_data,
702
+ response_types_map=_response_types_map,
703
+ )
704
+
705
+
706
+ @validate_call
707
+ def get_activities_without_preload_content(
708
+ self,
709
+ get_activities: Optional[GetActivities] = None,
710
+ _request_timeout: Union[
711
+ None,
712
+ Annotated[StrictFloat, Field(gt=0)],
713
+ Tuple[
714
+ Annotated[StrictFloat, Field(gt=0)],
715
+ Annotated[StrictFloat, Field(gt=0)]
716
+ ]
717
+ ] = None,
718
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
719
+ _content_type: Optional[StrictStr] = None,
720
+ _headers: Optional[Dict[StrictStr, Any]] = None,
721
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
722
+ ) -> RESTResponseType:
723
+ """Get Business Activities
724
+
725
+
726
+ :param get_activities:
727
+ :type get_activities: GetActivities
728
+ :param _request_timeout: timeout setting for this request. If one
729
+ number provided, it will be total request
730
+ timeout. It can also be a pair (tuple) of
731
+ (connection, read) timeouts.
732
+ :type _request_timeout: int, tuple(int, int), optional
733
+ :param _request_auth: set to override the auth_settings for an a single
734
+ request; this effectively ignores the
735
+ authentication in the spec for a single request.
736
+ :type _request_auth: dict, optional
737
+ :param _content_type: force content-type for the request.
738
+ :type _content_type: str, Optional
739
+ :param _headers: set to override the headers for a single
740
+ request; this effectively ignores the headers
741
+ in the spec for a single request.
742
+ :type _headers: dict, optional
743
+ :param _host_index: set to override the host_index for a single
744
+ request; this effectively ignores the host_index
745
+ in the spec for a single request.
746
+ :type _host_index: int, optional
747
+ :return: Returns the result object.
748
+ """ # noqa: E501
749
+
750
+ _param = self._get_activities_serialize(
751
+ get_activities=get_activities,
752
+ _request_auth=_request_auth,
753
+ _content_type=_content_type,
754
+ _headers=_headers,
755
+ _host_index=_host_index
756
+ )
757
+
758
+ _response_types_map: Dict[str, Optional[str]] = {
759
+ '200': "CursorPaginatedBusinessActivityItem",
760
+ }
761
+ response_data = self.api_client.call_api(
762
+ *_param,
763
+ _request_timeout=_request_timeout
764
+ )
765
+ return response_data.response
766
+
767
+
768
+ def _get_activities_serialize(
769
+ self,
770
+ get_activities,
771
+ _request_auth,
772
+ _content_type,
773
+ _headers,
774
+ _host_index,
775
+ ) -> RequestSerialized:
776
+
777
+ _host = None
778
+
779
+ _collection_formats: Dict[str, str] = {
780
+ }
781
+
782
+ _path_params: Dict[str, str] = {}
783
+ _query_params: List[Tuple[str, str]] = []
784
+ _header_params: Dict[str, Optional[str]] = _headers or {}
785
+ _form_params: List[Tuple[str, str]] = []
786
+ _files: Dict[
787
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
788
+ ] = {}
789
+ _body_params: Optional[bytes] = None
790
+
791
+ # process the path parameters
792
+ # process the query parameters
793
+ # process the header parameters
794
+ # process the form parameters
795
+ # process the body parameter
796
+ if get_activities is not None:
797
+ _body_params = get_activities
798
+
799
+
800
+ # set the HTTP header `Accept`
801
+ if 'Accept' not in _header_params:
802
+ _header_params['Accept'] = self.api_client.select_header_accept(
803
+ [
804
+ 'application/json'
805
+ ]
806
+ )
807
+
808
+ # set the HTTP header `Content-Type`
809
+ if _content_type:
810
+ _header_params['Content-Type'] = _content_type
811
+ else:
812
+ _default_content_type = (
813
+ self.api_client.select_header_content_type(
814
+ [
815
+ 'application/json'
816
+ ]
817
+ )
818
+ )
819
+ if _default_content_type is not None:
820
+ _header_params['Content-Type'] = _default_content_type
821
+
822
+ # authentication setting
823
+ _auth_settings: List[str] = [
824
+ 'ApiKeyAuth'
825
+ ]
826
+
827
+ return self.api_client.param_serialize(
828
+ method='POST',
829
+ resource_path='/api/business-monitoring/activities',
830
+ path_params=_path_params,
831
+ query_params=_query_params,
832
+ header_params=_header_params,
833
+ body=_body_params,
834
+ post_params=_form_params,
835
+ files=_files,
836
+ auth_settings=_auth_settings,
837
+ collection_formats=_collection_formats,
838
+ _host=_host,
839
+ _request_auth=_request_auth
840
+ )
841
+
842
+
843
+
844
+
845
+ @validate_call
846
+ def get_activities_csv(
847
+ self,
848
+ get_activities: Optional[GetActivities] = None,
849
+ _request_timeout: Union[
850
+ None,
851
+ Annotated[StrictFloat, Field(gt=0)],
852
+ Tuple[
853
+ Annotated[StrictFloat, Field(gt=0)],
854
+ Annotated[StrictFloat, Field(gt=0)]
855
+ ]
856
+ ] = None,
857
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
858
+ _content_type: Optional[StrictStr] = None,
859
+ _headers: Optional[Dict[StrictStr, Any]] = None,
860
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
861
+ ) -> BusinessActivity:
862
+ """Download Business Activities
863
+
864
+
865
+ :param get_activities:
866
+ :type get_activities: GetActivities
867
+ :param _request_timeout: timeout setting for this request. If one
868
+ number provided, it will be total request
869
+ timeout. It can also be a pair (tuple) of
870
+ (connection, read) timeouts.
871
+ :type _request_timeout: int, tuple(int, int), optional
872
+ :param _request_auth: set to override the auth_settings for an a single
873
+ request; this effectively ignores the
874
+ authentication in the spec for a single request.
875
+ :type _request_auth: dict, optional
876
+ :param _content_type: force content-type for the request.
877
+ :type _content_type: str, Optional
878
+ :param _headers: set to override the headers for a single
879
+ request; this effectively ignores the headers
880
+ in the spec for a single request.
881
+ :type _headers: dict, optional
882
+ :param _host_index: set to override the host_index for a single
883
+ request; this effectively ignores the host_index
884
+ in the spec for a single request.
885
+ :type _host_index: int, optional
886
+ :return: Returns the result object.
887
+ """ # noqa: E501
888
+
889
+ _param = self._get_activities_csv_serialize(
890
+ get_activities=get_activities,
891
+ _request_auth=_request_auth,
892
+ _content_type=_content_type,
893
+ _headers=_headers,
894
+ _host_index=_host_index
895
+ )
896
+
897
+ _response_types_map: Dict[str, Optional[str]] = {
898
+ '200': "BusinessActivity",
899
+ }
900
+ response_data = self.api_client.call_api(
901
+ *_param,
902
+ _request_timeout=_request_timeout
903
+ )
904
+ response_data.read()
905
+ return self.api_client.response_deserialize(
906
+ response_data=response_data,
907
+ response_types_map=_response_types_map,
908
+ ).data
909
+
910
+
911
+ @validate_call
912
+ def get_activities_csv_with_http_info(
913
+ self,
914
+ get_activities: Optional[GetActivities] = None,
915
+ _request_timeout: Union[
916
+ None,
917
+ Annotated[StrictFloat, Field(gt=0)],
918
+ Tuple[
919
+ Annotated[StrictFloat, Field(gt=0)],
920
+ Annotated[StrictFloat, Field(gt=0)]
921
+ ]
922
+ ] = None,
923
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
924
+ _content_type: Optional[StrictStr] = None,
925
+ _headers: Optional[Dict[StrictStr, Any]] = None,
926
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
927
+ ) -> ApiResponse[BusinessActivity]:
928
+ """Download Business Activities
929
+
930
+
931
+ :param get_activities:
932
+ :type get_activities: GetActivities
933
+ :param _request_timeout: timeout setting for this request. If one
934
+ number provided, it will be total request
935
+ timeout. It can also be a pair (tuple) of
936
+ (connection, read) timeouts.
937
+ :type _request_timeout: int, tuple(int, int), optional
938
+ :param _request_auth: set to override the auth_settings for an a single
939
+ request; this effectively ignores the
940
+ authentication in the spec for a single request.
941
+ :type _request_auth: dict, optional
942
+ :param _content_type: force content-type for the request.
943
+ :type _content_type: str, Optional
944
+ :param _headers: set to override the headers for a single
945
+ request; this effectively ignores the headers
946
+ in the spec for a single request.
947
+ :type _headers: dict, optional
948
+ :param _host_index: set to override the host_index for a single
949
+ request; this effectively ignores the host_index
950
+ in the spec for a single request.
951
+ :type _host_index: int, optional
952
+ :return: Returns the result object.
953
+ """ # noqa: E501
954
+
955
+ _param = self._get_activities_csv_serialize(
956
+ get_activities=get_activities,
957
+ _request_auth=_request_auth,
958
+ _content_type=_content_type,
959
+ _headers=_headers,
960
+ _host_index=_host_index
961
+ )
962
+
963
+ _response_types_map: Dict[str, Optional[str]] = {
964
+ '200': "BusinessActivity",
965
+ }
966
+ response_data = self.api_client.call_api(
967
+ *_param,
968
+ _request_timeout=_request_timeout
969
+ )
970
+ response_data.read()
971
+ return self.api_client.response_deserialize(
972
+ response_data=response_data,
973
+ response_types_map=_response_types_map,
974
+ )
975
+
976
+
977
+ @validate_call
978
+ def get_activities_csv_without_preload_content(
979
+ self,
980
+ get_activities: Optional[GetActivities] = None,
981
+ _request_timeout: Union[
982
+ None,
983
+ Annotated[StrictFloat, Field(gt=0)],
984
+ Tuple[
985
+ Annotated[StrictFloat, Field(gt=0)],
986
+ Annotated[StrictFloat, Field(gt=0)]
987
+ ]
988
+ ] = None,
989
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
990
+ _content_type: Optional[StrictStr] = None,
991
+ _headers: Optional[Dict[StrictStr, Any]] = None,
992
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
993
+ ) -> RESTResponseType:
994
+ """Download Business Activities
995
+
996
+
997
+ :param get_activities:
998
+ :type get_activities: GetActivities
999
+ :param _request_timeout: timeout setting for this request. If one
1000
+ number provided, it will be total request
1001
+ timeout. It can also be a pair (tuple) of
1002
+ (connection, read) timeouts.
1003
+ :type _request_timeout: int, tuple(int, int), optional
1004
+ :param _request_auth: set to override the auth_settings for an a single
1005
+ request; this effectively ignores the
1006
+ authentication in the spec for a single request.
1007
+ :type _request_auth: dict, optional
1008
+ :param _content_type: force content-type for the request.
1009
+ :type _content_type: str, Optional
1010
+ :param _headers: set to override the headers for a single
1011
+ request; this effectively ignores the headers
1012
+ in the spec for a single request.
1013
+ :type _headers: dict, optional
1014
+ :param _host_index: set to override the host_index for a single
1015
+ request; this effectively ignores the host_index
1016
+ in the spec for a single request.
1017
+ :type _host_index: int, optional
1018
+ :return: Returns the result object.
1019
+ """ # noqa: E501
1020
+
1021
+ _param = self._get_activities_csv_serialize(
1022
+ get_activities=get_activities,
1023
+ _request_auth=_request_auth,
1024
+ _content_type=_content_type,
1025
+ _headers=_headers,
1026
+ _host_index=_host_index
1027
+ )
1028
+
1029
+ _response_types_map: Dict[str, Optional[str]] = {
1030
+ '200': "BusinessActivity",
1031
+ }
1032
+ response_data = self.api_client.call_api(
1033
+ *_param,
1034
+ _request_timeout=_request_timeout
1035
+ )
1036
+ return response_data.response
1037
+
1038
+
1039
+ def _get_activities_csv_serialize(
1040
+ self,
1041
+ get_activities,
1042
+ _request_auth,
1043
+ _content_type,
1044
+ _headers,
1045
+ _host_index,
1046
+ ) -> RequestSerialized:
1047
+
1048
+ _host = None
1049
+
1050
+ _collection_formats: Dict[str, str] = {
1051
+ }
1052
+
1053
+ _path_params: Dict[str, str] = {}
1054
+ _query_params: List[Tuple[str, str]] = []
1055
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1056
+ _form_params: List[Tuple[str, str]] = []
1057
+ _files: Dict[
1058
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1059
+ ] = {}
1060
+ _body_params: Optional[bytes] = None
1061
+
1062
+ # process the path parameters
1063
+ # process the query parameters
1064
+ # process the header parameters
1065
+ # process the form parameters
1066
+ # process the body parameter
1067
+ if get_activities is not None:
1068
+ _body_params = get_activities
1069
+
1070
+
1071
+ # set the HTTP header `Accept`
1072
+ if 'Accept' not in _header_params:
1073
+ _header_params['Accept'] = self.api_client.select_header_accept(
1074
+ [
1075
+ 'text/csv'
1076
+ ]
1077
+ )
1078
+
1079
+ # set the HTTP header `Content-Type`
1080
+ if _content_type:
1081
+ _header_params['Content-Type'] = _content_type
1082
+ else:
1083
+ _default_content_type = (
1084
+ self.api_client.select_header_content_type(
1085
+ [
1086
+ 'application/json'
1087
+ ]
1088
+ )
1089
+ )
1090
+ if _default_content_type is not None:
1091
+ _header_params['Content-Type'] = _default_content_type
1092
+
1093
+ # authentication setting
1094
+ _auth_settings: List[str] = [
1095
+ 'ApiKeyAuth'
1096
+ ]
1097
+
1098
+ return self.api_client.param_serialize(
1099
+ method='POST',
1100
+ resource_path='/api/business-monitoring/activities/csv',
1101
+ path_params=_path_params,
1102
+ query_params=_query_params,
1103
+ header_params=_header_params,
1104
+ body=_body_params,
1105
+ post_params=_form_params,
1106
+ files=_files,
1107
+ auth_settings=_auth_settings,
1108
+ collection_formats=_collection_formats,
1109
+ _host=_host,
1110
+ _request_auth=_request_auth
1111
+ )
1112
+
1113
+
1114
+
1115
+
1116
+ @validate_call
1117
+ def get_business_perspective(
1118
+ self,
1119
+ id: StrictStr,
1120
+ _request_timeout: Union[
1121
+ None,
1122
+ Annotated[StrictFloat, Field(gt=0)],
1123
+ Tuple[
1124
+ Annotated[StrictFloat, Field(gt=0)],
1125
+ Annotated[StrictFloat, Field(gt=0)]
1126
+ ]
1127
+ ] = None,
1128
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1129
+ _content_type: Optional[StrictStr] = None,
1130
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1131
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1132
+ ) -> BusinessPerspectiveConfig:
1133
+ """Get business perspective
1134
+
1135
+
1136
+ :param id: (required)
1137
+ :type id: str
1138
+ :param _request_timeout: timeout setting for this request. If one
1139
+ number provided, it will be total request
1140
+ timeout. It can also be a pair (tuple) of
1141
+ (connection, read) timeouts.
1142
+ :type _request_timeout: int, tuple(int, int), optional
1143
+ :param _request_auth: set to override the auth_settings for an a single
1144
+ request; this effectively ignores the
1145
+ authentication in the spec for a single request.
1146
+ :type _request_auth: dict, optional
1147
+ :param _content_type: force content-type for the request.
1148
+ :type _content_type: str, Optional
1149
+ :param _headers: set to override the headers for a single
1150
+ request; this effectively ignores the headers
1151
+ in the spec for a single request.
1152
+ :type _headers: dict, optional
1153
+ :param _host_index: set to override the host_index for a single
1154
+ request; this effectively ignores the host_index
1155
+ in the spec for a single request.
1156
+ :type _host_index: int, optional
1157
+ :return: Returns the result object.
1158
+ """ # noqa: E501
1159
+
1160
+ _param = self._get_business_perspective_serialize(
1161
+ id=id,
1162
+ _request_auth=_request_auth,
1163
+ _content_type=_content_type,
1164
+ _headers=_headers,
1165
+ _host_index=_host_index
1166
+ )
1167
+
1168
+ _response_types_map: Dict[str, Optional[str]] = {
1169
+ '200': "BusinessPerspectiveConfig",
1170
+ }
1171
+ response_data = self.api_client.call_api(
1172
+ *_param,
1173
+ _request_timeout=_request_timeout
1174
+ )
1175
+ response_data.read()
1176
+ return self.api_client.response_deserialize(
1177
+ response_data=response_data,
1178
+ response_types_map=_response_types_map,
1179
+ ).data
1180
+
1181
+
1182
+ @validate_call
1183
+ def get_business_perspective_with_http_info(
1184
+ self,
1185
+ id: StrictStr,
1186
+ _request_timeout: Union[
1187
+ None,
1188
+ Annotated[StrictFloat, Field(gt=0)],
1189
+ Tuple[
1190
+ Annotated[StrictFloat, Field(gt=0)],
1191
+ Annotated[StrictFloat, Field(gt=0)]
1192
+ ]
1193
+ ] = None,
1194
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1195
+ _content_type: Optional[StrictStr] = None,
1196
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1197
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1198
+ ) -> ApiResponse[BusinessPerspectiveConfig]:
1199
+ """Get business perspective
1200
+
1201
+
1202
+ :param id: (required)
1203
+ :type id: str
1204
+ :param _request_timeout: timeout setting for this request. If one
1205
+ number provided, it will be total request
1206
+ timeout. It can also be a pair (tuple) of
1207
+ (connection, read) timeouts.
1208
+ :type _request_timeout: int, tuple(int, int), optional
1209
+ :param _request_auth: set to override the auth_settings for an a single
1210
+ request; this effectively ignores the
1211
+ authentication in the spec for a single request.
1212
+ :type _request_auth: dict, optional
1213
+ :param _content_type: force content-type for the request.
1214
+ :type _content_type: str, Optional
1215
+ :param _headers: set to override the headers for a single
1216
+ request; this effectively ignores the headers
1217
+ in the spec for a single request.
1218
+ :type _headers: dict, optional
1219
+ :param _host_index: set to override the host_index for a single
1220
+ request; this effectively ignores the host_index
1221
+ in the spec for a single request.
1222
+ :type _host_index: int, optional
1223
+ :return: Returns the result object.
1224
+ """ # noqa: E501
1225
+
1226
+ _param = self._get_business_perspective_serialize(
1227
+ id=id,
1228
+ _request_auth=_request_auth,
1229
+ _content_type=_content_type,
1230
+ _headers=_headers,
1231
+ _host_index=_host_index
1232
+ )
1233
+
1234
+ _response_types_map: Dict[str, Optional[str]] = {
1235
+ '200': "BusinessPerspectiveConfig",
1236
+ }
1237
+ response_data = self.api_client.call_api(
1238
+ *_param,
1239
+ _request_timeout=_request_timeout
1240
+ )
1241
+ response_data.read()
1242
+ return self.api_client.response_deserialize(
1243
+ response_data=response_data,
1244
+ response_types_map=_response_types_map,
1245
+ )
1246
+
1247
+
1248
+ @validate_call
1249
+ def get_business_perspective_without_preload_content(
1250
+ self,
1251
+ id: StrictStr,
1252
+ _request_timeout: Union[
1253
+ None,
1254
+ Annotated[StrictFloat, Field(gt=0)],
1255
+ Tuple[
1256
+ Annotated[StrictFloat, Field(gt=0)],
1257
+ Annotated[StrictFloat, Field(gt=0)]
1258
+ ]
1259
+ ] = None,
1260
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1261
+ _content_type: Optional[StrictStr] = None,
1262
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1263
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1264
+ ) -> RESTResponseType:
1265
+ """Get business perspective
1266
+
1267
+
1268
+ :param id: (required)
1269
+ :type id: str
1270
+ :param _request_timeout: timeout setting for this request. If one
1271
+ number provided, it will be total request
1272
+ timeout. It can also be a pair (tuple) of
1273
+ (connection, read) timeouts.
1274
+ :type _request_timeout: int, tuple(int, int), optional
1275
+ :param _request_auth: set to override the auth_settings for an a single
1276
+ request; this effectively ignores the
1277
+ authentication in the spec for a single request.
1278
+ :type _request_auth: dict, optional
1279
+ :param _content_type: force content-type for the request.
1280
+ :type _content_type: str, Optional
1281
+ :param _headers: set to override the headers for a single
1282
+ request; this effectively ignores the headers
1283
+ in the spec for a single request.
1284
+ :type _headers: dict, optional
1285
+ :param _host_index: set to override the host_index for a single
1286
+ request; this effectively ignores the host_index
1287
+ in the spec for a single request.
1288
+ :type _host_index: int, optional
1289
+ :return: Returns the result object.
1290
+ """ # noqa: E501
1291
+
1292
+ _param = self._get_business_perspective_serialize(
1293
+ id=id,
1294
+ _request_auth=_request_auth,
1295
+ _content_type=_content_type,
1296
+ _headers=_headers,
1297
+ _host_index=_host_index
1298
+ )
1299
+
1300
+ _response_types_map: Dict[str, Optional[str]] = {
1301
+ '200': "BusinessPerspectiveConfig",
1302
+ }
1303
+ response_data = self.api_client.call_api(
1304
+ *_param,
1305
+ _request_timeout=_request_timeout
1306
+ )
1307
+ return response_data.response
1308
+
1309
+
1310
+ def _get_business_perspective_serialize(
1311
+ self,
1312
+ id,
1313
+ _request_auth,
1314
+ _content_type,
1315
+ _headers,
1316
+ _host_index,
1317
+ ) -> RequestSerialized:
1318
+
1319
+ _host = None
1320
+
1321
+ _collection_formats: Dict[str, str] = {
1322
+ }
1323
+
1324
+ _path_params: Dict[str, str] = {}
1325
+ _query_params: List[Tuple[str, str]] = []
1326
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1327
+ _form_params: List[Tuple[str, str]] = []
1328
+ _files: Dict[
1329
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1330
+ ] = {}
1331
+ _body_params: Optional[bytes] = None
1332
+
1333
+ # process the path parameters
1334
+ if id is not None:
1335
+ _path_params['id'] = id
1336
+ # process the query parameters
1337
+ # process the header parameters
1338
+ # process the form parameters
1339
+ # process the body parameter
1340
+
1341
+
1342
+ # set the HTTP header `Accept`
1343
+ if 'Accept' not in _header_params:
1344
+ _header_params['Accept'] = self.api_client.select_header_accept(
1345
+ [
1346
+ 'application/json'
1347
+ ]
1348
+ )
1349
+
1350
+
1351
+ # authentication setting
1352
+ _auth_settings: List[str] = [
1353
+ 'ApiKeyAuth'
1354
+ ]
1355
+
1356
+ return self.api_client.param_serialize(
1357
+ method='GET',
1358
+ resource_path='/api/business-monitoring/business-perspectives/{id}',
1359
+ path_params=_path_params,
1360
+ query_params=_query_params,
1361
+ header_params=_header_params,
1362
+ body=_body_params,
1363
+ post_params=_form_params,
1364
+ files=_files,
1365
+ auth_settings=_auth_settings,
1366
+ collection_formats=_collection_formats,
1367
+ _host=_host,
1368
+ _request_auth=_request_auth
1369
+ )
1370
+
1371
+
1372
+
1373
+
1374
+ @validate_call
1375
+ def get_business_perspectives(
1376
+ self,
1377
+ _request_timeout: Union[
1378
+ None,
1379
+ Annotated[StrictFloat, Field(gt=0)],
1380
+ Tuple[
1381
+ Annotated[StrictFloat, Field(gt=0)],
1382
+ Annotated[StrictFloat, Field(gt=0)]
1383
+ ]
1384
+ ] = None,
1385
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1386
+ _content_type: Optional[StrictStr] = None,
1387
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1388
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1389
+ ) -> BusinessPerspectiveConfig:
1390
+ """Get all business perspectives
1391
+
1392
+
1393
+ :param _request_timeout: timeout setting for this request. If one
1394
+ number provided, it will be total request
1395
+ timeout. It can also be a pair (tuple) of
1396
+ (connection, read) timeouts.
1397
+ :type _request_timeout: int, tuple(int, int), optional
1398
+ :param _request_auth: set to override the auth_settings for an a single
1399
+ request; this effectively ignores the
1400
+ authentication in the spec for a single request.
1401
+ :type _request_auth: dict, optional
1402
+ :param _content_type: force content-type for the request.
1403
+ :type _content_type: str, Optional
1404
+ :param _headers: set to override the headers for a single
1405
+ request; this effectively ignores the headers
1406
+ in the spec for a single request.
1407
+ :type _headers: dict, optional
1408
+ :param _host_index: set to override the host_index for a single
1409
+ request; this effectively ignores the host_index
1410
+ in the spec for a single request.
1411
+ :type _host_index: int, optional
1412
+ :return: Returns the result object.
1413
+ """ # noqa: E501
1414
+
1415
+ _param = self._get_business_perspectives_serialize(
1416
+ _request_auth=_request_auth,
1417
+ _content_type=_content_type,
1418
+ _headers=_headers,
1419
+ _host_index=_host_index
1420
+ )
1421
+
1422
+ _response_types_map: Dict[str, Optional[str]] = {
1423
+ '200': "BusinessPerspectiveConfig",
1424
+ }
1425
+ response_data = self.api_client.call_api(
1426
+ *_param,
1427
+ _request_timeout=_request_timeout
1428
+ )
1429
+ response_data.read()
1430
+ return self.api_client.response_deserialize(
1431
+ response_data=response_data,
1432
+ response_types_map=_response_types_map,
1433
+ ).data
1434
+
1435
+
1436
+ @validate_call
1437
+ def get_business_perspectives_with_http_info(
1438
+ self,
1439
+ _request_timeout: Union[
1440
+ None,
1441
+ Annotated[StrictFloat, Field(gt=0)],
1442
+ Tuple[
1443
+ Annotated[StrictFloat, Field(gt=0)],
1444
+ Annotated[StrictFloat, Field(gt=0)]
1445
+ ]
1446
+ ] = None,
1447
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1448
+ _content_type: Optional[StrictStr] = None,
1449
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1450
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1451
+ ) -> ApiResponse[BusinessPerspectiveConfig]:
1452
+ """Get all business perspectives
1453
+
1454
+
1455
+ :param _request_timeout: timeout setting for this request. If one
1456
+ number provided, it will be total request
1457
+ timeout. It can also be a pair (tuple) of
1458
+ (connection, read) timeouts.
1459
+ :type _request_timeout: int, tuple(int, int), optional
1460
+ :param _request_auth: set to override the auth_settings for an a single
1461
+ request; this effectively ignores the
1462
+ authentication in the spec for a single request.
1463
+ :type _request_auth: dict, optional
1464
+ :param _content_type: force content-type for the request.
1465
+ :type _content_type: str, Optional
1466
+ :param _headers: set to override the headers for a single
1467
+ request; this effectively ignores the headers
1468
+ in the spec for a single request.
1469
+ :type _headers: dict, optional
1470
+ :param _host_index: set to override the host_index for a single
1471
+ request; this effectively ignores the host_index
1472
+ in the spec for a single request.
1473
+ :type _host_index: int, optional
1474
+ :return: Returns the result object.
1475
+ """ # noqa: E501
1476
+
1477
+ _param = self._get_business_perspectives_serialize(
1478
+ _request_auth=_request_auth,
1479
+ _content_type=_content_type,
1480
+ _headers=_headers,
1481
+ _host_index=_host_index
1482
+ )
1483
+
1484
+ _response_types_map: Dict[str, Optional[str]] = {
1485
+ '200': "BusinessPerspectiveConfig",
1486
+ }
1487
+ response_data = self.api_client.call_api(
1488
+ *_param,
1489
+ _request_timeout=_request_timeout
1490
+ )
1491
+ response_data.read()
1492
+ return self.api_client.response_deserialize(
1493
+ response_data=response_data,
1494
+ response_types_map=_response_types_map,
1495
+ )
1496
+
1497
+
1498
+ @validate_call
1499
+ def get_business_perspectives_without_preload_content(
1500
+ self,
1501
+ _request_timeout: Union[
1502
+ None,
1503
+ Annotated[StrictFloat, Field(gt=0)],
1504
+ Tuple[
1505
+ Annotated[StrictFloat, Field(gt=0)],
1506
+ Annotated[StrictFloat, Field(gt=0)]
1507
+ ]
1508
+ ] = None,
1509
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1510
+ _content_type: Optional[StrictStr] = None,
1511
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1512
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1513
+ ) -> RESTResponseType:
1514
+ """Get all business perspectives
1515
+
1516
+
1517
+ :param _request_timeout: timeout setting for this request. If one
1518
+ number provided, it will be total request
1519
+ timeout. It can also be a pair (tuple) of
1520
+ (connection, read) timeouts.
1521
+ :type _request_timeout: int, tuple(int, int), optional
1522
+ :param _request_auth: set to override the auth_settings for an a single
1523
+ request; this effectively ignores the
1524
+ authentication in the spec for a single request.
1525
+ :type _request_auth: dict, optional
1526
+ :param _content_type: force content-type for the request.
1527
+ :type _content_type: str, Optional
1528
+ :param _headers: set to override the headers for a single
1529
+ request; this effectively ignores the headers
1530
+ in the spec for a single request.
1531
+ :type _headers: dict, optional
1532
+ :param _host_index: set to override the host_index for a single
1533
+ request; this effectively ignores the host_index
1534
+ in the spec for a single request.
1535
+ :type _host_index: int, optional
1536
+ :return: Returns the result object.
1537
+ """ # noqa: E501
1538
+
1539
+ _param = self._get_business_perspectives_serialize(
1540
+ _request_auth=_request_auth,
1541
+ _content_type=_content_type,
1542
+ _headers=_headers,
1543
+ _host_index=_host_index
1544
+ )
1545
+
1546
+ _response_types_map: Dict[str, Optional[str]] = {
1547
+ '200': "BusinessPerspectiveConfig",
1548
+ }
1549
+ response_data = self.api_client.call_api(
1550
+ *_param,
1551
+ _request_timeout=_request_timeout
1552
+ )
1553
+ return response_data.response
1554
+
1555
+
1556
+ def _get_business_perspectives_serialize(
1557
+ self,
1558
+ _request_auth,
1559
+ _content_type,
1560
+ _headers,
1561
+ _host_index,
1562
+ ) -> RequestSerialized:
1563
+
1564
+ _host = None
1565
+
1566
+ _collection_formats: Dict[str, str] = {
1567
+ }
1568
+
1569
+ _path_params: Dict[str, str] = {}
1570
+ _query_params: List[Tuple[str, str]] = []
1571
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1572
+ _form_params: List[Tuple[str, str]] = []
1573
+ _files: Dict[
1574
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1575
+ ] = {}
1576
+ _body_params: Optional[bytes] = None
1577
+
1578
+ # process the path parameters
1579
+ # process the query parameters
1580
+ # process the header parameters
1581
+ # process the form parameters
1582
+ # process the body parameter
1583
+
1584
+
1585
+ # set the HTTP header `Accept`
1586
+ if 'Accept' not in _header_params:
1587
+ _header_params['Accept'] = self.api_client.select_header_accept(
1588
+ [
1589
+ 'application/json'
1590
+ ]
1591
+ )
1592
+
1593
+
1594
+ # authentication setting
1595
+ _auth_settings: List[str] = [
1596
+ 'ApiKeyAuth'
1597
+ ]
1598
+
1599
+ return self.api_client.param_serialize(
1600
+ method='GET',
1601
+ resource_path='/api/business-monitoring/business-perspectives',
1602
+ path_params=_path_params,
1603
+ query_params=_query_params,
1604
+ header_params=_header_params,
1605
+ body=_body_params,
1606
+ post_params=_form_params,
1607
+ files=_files,
1608
+ auth_settings=_auth_settings,
1609
+ collection_formats=_collection_formats,
1610
+ _host=_host,
1611
+ _request_auth=_request_auth
1612
+ )
1613
+
1614
+
1615
+
1616
+
1617
+ @validate_call
1618
+ def get_business_tag_catalog(
1619
+ self,
1620
+ var_from: Optional[StrictInt] = None,
1621
+ use_case: Optional[StrictStr] = None,
1622
+ _request_timeout: Union[
1623
+ None,
1624
+ Annotated[StrictFloat, Field(gt=0)],
1625
+ Tuple[
1626
+ Annotated[StrictFloat, Field(gt=0)],
1627
+ Annotated[StrictFloat, Field(gt=0)]
1628
+ ]
1629
+ ] = None,
1630
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1631
+ _content_type: Optional[StrictStr] = None,
1632
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1633
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1634
+ ) -> TagCatalog:
1635
+ """Get business tag catalog
1636
+
1637
+
1638
+ :param var_from:
1639
+ :type var_from: int
1640
+ :param use_case:
1641
+ :type use_case: str
1642
+ :param _request_timeout: timeout setting for this request. If one
1643
+ number provided, it will be total request
1644
+ timeout. It can also be a pair (tuple) of
1645
+ (connection, read) timeouts.
1646
+ :type _request_timeout: int, tuple(int, int), optional
1647
+ :param _request_auth: set to override the auth_settings for an a single
1648
+ request; this effectively ignores the
1649
+ authentication in the spec for a single request.
1650
+ :type _request_auth: dict, optional
1651
+ :param _content_type: force content-type for the request.
1652
+ :type _content_type: str, Optional
1653
+ :param _headers: set to override the headers for a single
1654
+ request; this effectively ignores the headers
1655
+ in the spec for a single request.
1656
+ :type _headers: dict, optional
1657
+ :param _host_index: set to override the host_index for a single
1658
+ request; this effectively ignores the host_index
1659
+ in the spec for a single request.
1660
+ :type _host_index: int, optional
1661
+ :return: Returns the result object.
1662
+ """ # noqa: E501
1663
+
1664
+ _param = self._get_business_tag_catalog_serialize(
1665
+ var_from=var_from,
1666
+ use_case=use_case,
1667
+ _request_auth=_request_auth,
1668
+ _content_type=_content_type,
1669
+ _headers=_headers,
1670
+ _host_index=_host_index
1671
+ )
1672
+
1673
+ _response_types_map: Dict[str, Optional[str]] = {
1674
+ '200': "TagCatalog",
1675
+ }
1676
+ response_data = self.api_client.call_api(
1677
+ *_param,
1678
+ _request_timeout=_request_timeout
1679
+ )
1680
+ response_data.read()
1681
+ return self.api_client.response_deserialize(
1682
+ response_data=response_data,
1683
+ response_types_map=_response_types_map,
1684
+ ).data
1685
+
1686
+
1687
+ @validate_call
1688
+ def get_business_tag_catalog_with_http_info(
1689
+ self,
1690
+ var_from: Optional[StrictInt] = None,
1691
+ use_case: Optional[StrictStr] = None,
1692
+ _request_timeout: Union[
1693
+ None,
1694
+ Annotated[StrictFloat, Field(gt=0)],
1695
+ Tuple[
1696
+ Annotated[StrictFloat, Field(gt=0)],
1697
+ Annotated[StrictFloat, Field(gt=0)]
1698
+ ]
1699
+ ] = None,
1700
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1701
+ _content_type: Optional[StrictStr] = None,
1702
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1703
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1704
+ ) -> ApiResponse[TagCatalog]:
1705
+ """Get business tag catalog
1706
+
1707
+
1708
+ :param var_from:
1709
+ :type var_from: int
1710
+ :param use_case:
1711
+ :type use_case: str
1712
+ :param _request_timeout: timeout setting for this request. If one
1713
+ number provided, it will be total request
1714
+ timeout. It can also be a pair (tuple) of
1715
+ (connection, read) timeouts.
1716
+ :type _request_timeout: int, tuple(int, int), optional
1717
+ :param _request_auth: set to override the auth_settings for an a single
1718
+ request; this effectively ignores the
1719
+ authentication in the spec for a single request.
1720
+ :type _request_auth: dict, optional
1721
+ :param _content_type: force content-type for the request.
1722
+ :type _content_type: str, Optional
1723
+ :param _headers: set to override the headers for a single
1724
+ request; this effectively ignores the headers
1725
+ in the spec for a single request.
1726
+ :type _headers: dict, optional
1727
+ :param _host_index: set to override the host_index for a single
1728
+ request; this effectively ignores the host_index
1729
+ in the spec for a single request.
1730
+ :type _host_index: int, optional
1731
+ :return: Returns the result object.
1732
+ """ # noqa: E501
1733
+
1734
+ _param = self._get_business_tag_catalog_serialize(
1735
+ var_from=var_from,
1736
+ use_case=use_case,
1737
+ _request_auth=_request_auth,
1738
+ _content_type=_content_type,
1739
+ _headers=_headers,
1740
+ _host_index=_host_index
1741
+ )
1742
+
1743
+ _response_types_map: Dict[str, Optional[str]] = {
1744
+ '200': "TagCatalog",
1745
+ }
1746
+ response_data = self.api_client.call_api(
1747
+ *_param,
1748
+ _request_timeout=_request_timeout
1749
+ )
1750
+ response_data.read()
1751
+ return self.api_client.response_deserialize(
1752
+ response_data=response_data,
1753
+ response_types_map=_response_types_map,
1754
+ )
1755
+
1756
+
1757
+ @validate_call
1758
+ def get_business_tag_catalog_without_preload_content(
1759
+ self,
1760
+ var_from: Optional[StrictInt] = None,
1761
+ use_case: Optional[StrictStr] = None,
1762
+ _request_timeout: Union[
1763
+ None,
1764
+ Annotated[StrictFloat, Field(gt=0)],
1765
+ Tuple[
1766
+ Annotated[StrictFloat, Field(gt=0)],
1767
+ Annotated[StrictFloat, Field(gt=0)]
1768
+ ]
1769
+ ] = None,
1770
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1771
+ _content_type: Optional[StrictStr] = None,
1772
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1773
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1774
+ ) -> RESTResponseType:
1775
+ """Get business tag catalog
1776
+
1777
+
1778
+ :param var_from:
1779
+ :type var_from: int
1780
+ :param use_case:
1781
+ :type use_case: str
1782
+ :param _request_timeout: timeout setting for this request. If one
1783
+ number provided, it will be total request
1784
+ timeout. It can also be a pair (tuple) of
1785
+ (connection, read) timeouts.
1786
+ :type _request_timeout: int, tuple(int, int), optional
1787
+ :param _request_auth: set to override the auth_settings for an a single
1788
+ request; this effectively ignores the
1789
+ authentication in the spec for a single request.
1790
+ :type _request_auth: dict, optional
1791
+ :param _content_type: force content-type for the request.
1792
+ :type _content_type: str, Optional
1793
+ :param _headers: set to override the headers for a single
1794
+ request; this effectively ignores the headers
1795
+ in the spec for a single request.
1796
+ :type _headers: dict, optional
1797
+ :param _host_index: set to override the host_index for a single
1798
+ request; this effectively ignores the host_index
1799
+ in the spec for a single request.
1800
+ :type _host_index: int, optional
1801
+ :return: Returns the result object.
1802
+ """ # noqa: E501
1803
+
1804
+ _param = self._get_business_tag_catalog_serialize(
1805
+ var_from=var_from,
1806
+ use_case=use_case,
1807
+ _request_auth=_request_auth,
1808
+ _content_type=_content_type,
1809
+ _headers=_headers,
1810
+ _host_index=_host_index
1811
+ )
1812
+
1813
+ _response_types_map: Dict[str, Optional[str]] = {
1814
+ '200': "TagCatalog",
1815
+ }
1816
+ response_data = self.api_client.call_api(
1817
+ *_param,
1818
+ _request_timeout=_request_timeout
1819
+ )
1820
+ return response_data.response
1821
+
1822
+
1823
+ def _get_business_tag_catalog_serialize(
1824
+ self,
1825
+ var_from,
1826
+ use_case,
1827
+ _request_auth,
1828
+ _content_type,
1829
+ _headers,
1830
+ _host_index,
1831
+ ) -> RequestSerialized:
1832
+
1833
+ _host = None
1834
+
1835
+ _collection_formats: Dict[str, str] = {
1836
+ }
1837
+
1838
+ _path_params: Dict[str, str] = {}
1839
+ _query_params: List[Tuple[str, str]] = []
1840
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1841
+ _form_params: List[Tuple[str, str]] = []
1842
+ _files: Dict[
1843
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1844
+ ] = {}
1845
+ _body_params: Optional[bytes] = None
1846
+
1847
+ # process the path parameters
1848
+ # process the query parameters
1849
+ if var_from is not None:
1850
+
1851
+ _query_params.append(('from', var_from))
1852
+
1853
+ if use_case is not None:
1854
+
1855
+ _query_params.append(('useCase', use_case))
1856
+
1857
+ # process the header parameters
1858
+ # process the form parameters
1859
+ # process the body parameter
1860
+
1861
+
1862
+ # set the HTTP header `Accept`
1863
+ if 'Accept' not in _header_params:
1864
+ _header_params['Accept'] = self.api_client.select_header_accept(
1865
+ [
1866
+ 'application/json'
1867
+ ]
1868
+ )
1869
+
1870
+
1871
+ # authentication setting
1872
+ _auth_settings: List[str] = [
1873
+ 'ApiKeyAuth'
1874
+ ]
1875
+
1876
+ return self.api_client.param_serialize(
1877
+ method='GET',
1878
+ resource_path='/api/business-monitoring/catalog',
1879
+ path_params=_path_params,
1880
+ query_params=_query_params,
1881
+ header_params=_header_params,
1882
+ body=_body_params,
1883
+ post_params=_form_params,
1884
+ files=_files,
1885
+ auth_settings=_auth_settings,
1886
+ collection_formats=_collection_formats,
1887
+ _host=_host,
1888
+ _request_auth=_request_auth
1889
+ )
1890
+
1891
+
1892
+
1893
+
1894
+ @validate_call
1895
+ def update_business_perspective(
1896
+ self,
1897
+ id: StrictStr,
1898
+ updated_business_perspective_config: UpdatedBusinessPerspectiveConfig,
1899
+ _request_timeout: Union[
1900
+ None,
1901
+ Annotated[StrictFloat, Field(gt=0)],
1902
+ Tuple[
1903
+ Annotated[StrictFloat, Field(gt=0)],
1904
+ Annotated[StrictFloat, Field(gt=0)]
1905
+ ]
1906
+ ] = None,
1907
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1908
+ _content_type: Optional[StrictStr] = None,
1909
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1910
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1911
+ ) -> BusinessPerspectiveConfig:
1912
+ """Update business perspective
1913
+
1914
+
1915
+ :param id: (required)
1916
+ :type id: str
1917
+ :param updated_business_perspective_config: (required)
1918
+ :type updated_business_perspective_config: UpdatedBusinessPerspectiveConfig
1919
+ :param _request_timeout: timeout setting for this request. If one
1920
+ number provided, it will be total request
1921
+ timeout. It can also be a pair (tuple) of
1922
+ (connection, read) timeouts.
1923
+ :type _request_timeout: int, tuple(int, int), optional
1924
+ :param _request_auth: set to override the auth_settings for an a single
1925
+ request; this effectively ignores the
1926
+ authentication in the spec for a single request.
1927
+ :type _request_auth: dict, optional
1928
+ :param _content_type: force content-type for the request.
1929
+ :type _content_type: str, Optional
1930
+ :param _headers: set to override the headers for a single
1931
+ request; this effectively ignores the headers
1932
+ in the spec for a single request.
1933
+ :type _headers: dict, optional
1934
+ :param _host_index: set to override the host_index for a single
1935
+ request; this effectively ignores the host_index
1936
+ in the spec for a single request.
1937
+ :type _host_index: int, optional
1938
+ :return: Returns the result object.
1939
+ """ # noqa: E501
1940
+
1941
+ _param = self._update_business_perspective_serialize(
1942
+ id=id,
1943
+ updated_business_perspective_config=updated_business_perspective_config,
1944
+ _request_auth=_request_auth,
1945
+ _content_type=_content_type,
1946
+ _headers=_headers,
1947
+ _host_index=_host_index
1948
+ )
1949
+
1950
+ _response_types_map: Dict[str, Optional[str]] = {
1951
+ '200': "BusinessPerspectiveConfig",
1952
+ }
1953
+ response_data = self.api_client.call_api(
1954
+ *_param,
1955
+ _request_timeout=_request_timeout
1956
+ )
1957
+ response_data.read()
1958
+ return self.api_client.response_deserialize(
1959
+ response_data=response_data,
1960
+ response_types_map=_response_types_map,
1961
+ ).data
1962
+
1963
+
1964
+ @validate_call
1965
+ def update_business_perspective_with_http_info(
1966
+ self,
1967
+ id: StrictStr,
1968
+ updated_business_perspective_config: UpdatedBusinessPerspectiveConfig,
1969
+ _request_timeout: Union[
1970
+ None,
1971
+ Annotated[StrictFloat, Field(gt=0)],
1972
+ Tuple[
1973
+ Annotated[StrictFloat, Field(gt=0)],
1974
+ Annotated[StrictFloat, Field(gt=0)]
1975
+ ]
1976
+ ] = None,
1977
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1978
+ _content_type: Optional[StrictStr] = None,
1979
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1980
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1981
+ ) -> ApiResponse[BusinessPerspectiveConfig]:
1982
+ """Update business perspective
1983
+
1984
+
1985
+ :param id: (required)
1986
+ :type id: str
1987
+ :param updated_business_perspective_config: (required)
1988
+ :type updated_business_perspective_config: UpdatedBusinessPerspectiveConfig
1989
+ :param _request_timeout: timeout setting for this request. If one
1990
+ number provided, it will be total request
1991
+ timeout. It can also be a pair (tuple) of
1992
+ (connection, read) timeouts.
1993
+ :type _request_timeout: int, tuple(int, int), optional
1994
+ :param _request_auth: set to override the auth_settings for an a single
1995
+ request; this effectively ignores the
1996
+ authentication in the spec for a single request.
1997
+ :type _request_auth: dict, optional
1998
+ :param _content_type: force content-type for the request.
1999
+ :type _content_type: str, Optional
2000
+ :param _headers: set to override the headers for a single
2001
+ request; this effectively ignores the headers
2002
+ in the spec for a single request.
2003
+ :type _headers: dict, optional
2004
+ :param _host_index: set to override the host_index for a single
2005
+ request; this effectively ignores the host_index
2006
+ in the spec for a single request.
2007
+ :type _host_index: int, optional
2008
+ :return: Returns the result object.
2009
+ """ # noqa: E501
2010
+
2011
+ _param = self._update_business_perspective_serialize(
2012
+ id=id,
2013
+ updated_business_perspective_config=updated_business_perspective_config,
2014
+ _request_auth=_request_auth,
2015
+ _content_type=_content_type,
2016
+ _headers=_headers,
2017
+ _host_index=_host_index
2018
+ )
2019
+
2020
+ _response_types_map: Dict[str, Optional[str]] = {
2021
+ '200': "BusinessPerspectiveConfig",
2022
+ }
2023
+ response_data = self.api_client.call_api(
2024
+ *_param,
2025
+ _request_timeout=_request_timeout
2026
+ )
2027
+ response_data.read()
2028
+ return self.api_client.response_deserialize(
2029
+ response_data=response_data,
2030
+ response_types_map=_response_types_map,
2031
+ )
2032
+
2033
+
2034
+ @validate_call
2035
+ def update_business_perspective_without_preload_content(
2036
+ self,
2037
+ id: StrictStr,
2038
+ updated_business_perspective_config: UpdatedBusinessPerspectiveConfig,
2039
+ _request_timeout: Union[
2040
+ None,
2041
+ Annotated[StrictFloat, Field(gt=0)],
2042
+ Tuple[
2043
+ Annotated[StrictFloat, Field(gt=0)],
2044
+ Annotated[StrictFloat, Field(gt=0)]
2045
+ ]
2046
+ ] = None,
2047
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2048
+ _content_type: Optional[StrictStr] = None,
2049
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2050
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2051
+ ) -> RESTResponseType:
2052
+ """Update business perspective
2053
+
2054
+
2055
+ :param id: (required)
2056
+ :type id: str
2057
+ :param updated_business_perspective_config: (required)
2058
+ :type updated_business_perspective_config: UpdatedBusinessPerspectiveConfig
2059
+ :param _request_timeout: timeout setting for this request. If one
2060
+ number provided, it will be total request
2061
+ timeout. It can also be a pair (tuple) of
2062
+ (connection, read) timeouts.
2063
+ :type _request_timeout: int, tuple(int, int), optional
2064
+ :param _request_auth: set to override the auth_settings for an a single
2065
+ request; this effectively ignores the
2066
+ authentication in the spec for a single request.
2067
+ :type _request_auth: dict, optional
2068
+ :param _content_type: force content-type for the request.
2069
+ :type _content_type: str, Optional
2070
+ :param _headers: set to override the headers for a single
2071
+ request; this effectively ignores the headers
2072
+ in the spec for a single request.
2073
+ :type _headers: dict, optional
2074
+ :param _host_index: set to override the host_index for a single
2075
+ request; this effectively ignores the host_index
2076
+ in the spec for a single request.
2077
+ :type _host_index: int, optional
2078
+ :return: Returns the result object.
2079
+ """ # noqa: E501
2080
+
2081
+ _param = self._update_business_perspective_serialize(
2082
+ id=id,
2083
+ updated_business_perspective_config=updated_business_perspective_config,
2084
+ _request_auth=_request_auth,
2085
+ _content_type=_content_type,
2086
+ _headers=_headers,
2087
+ _host_index=_host_index
2088
+ )
2089
+
2090
+ _response_types_map: Dict[str, Optional[str]] = {
2091
+ '200': "BusinessPerspectiveConfig",
2092
+ }
2093
+ response_data = self.api_client.call_api(
2094
+ *_param,
2095
+ _request_timeout=_request_timeout
2096
+ )
2097
+ return response_data.response
2098
+
2099
+
2100
+ def _update_business_perspective_serialize(
2101
+ self,
2102
+ id,
2103
+ updated_business_perspective_config,
2104
+ _request_auth,
2105
+ _content_type,
2106
+ _headers,
2107
+ _host_index,
2108
+ ) -> RequestSerialized:
2109
+
2110
+ _host = None
2111
+
2112
+ _collection_formats: Dict[str, str] = {
2113
+ }
2114
+
2115
+ _path_params: Dict[str, str] = {}
2116
+ _query_params: List[Tuple[str, str]] = []
2117
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2118
+ _form_params: List[Tuple[str, str]] = []
2119
+ _files: Dict[
2120
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2121
+ ] = {}
2122
+ _body_params: Optional[bytes] = None
2123
+
2124
+ # process the path parameters
2125
+ if id is not None:
2126
+ _path_params['id'] = id
2127
+ # process the query parameters
2128
+ # process the header parameters
2129
+ # process the form parameters
2130
+ # process the body parameter
2131
+ if updated_business_perspective_config is not None:
2132
+ _body_params = updated_business_perspective_config
2133
+
2134
+
2135
+ # set the HTTP header `Accept`
2136
+ if 'Accept' not in _header_params:
2137
+ _header_params['Accept'] = self.api_client.select_header_accept(
2138
+ [
2139
+ 'application/json'
2140
+ ]
2141
+ )
2142
+
2143
+ # set the HTTP header `Content-Type`
2144
+ if _content_type:
2145
+ _header_params['Content-Type'] = _content_type
2146
+ else:
2147
+ _default_content_type = (
2148
+ self.api_client.select_header_content_type(
2149
+ [
2150
+ 'application/json'
2151
+ ]
2152
+ )
2153
+ )
2154
+ if _default_content_type is not None:
2155
+ _header_params['Content-Type'] = _default_content_type
2156
+
2157
+ # authentication setting
2158
+ _auth_settings: List[str] = [
2159
+ 'ApiKeyAuth'
2160
+ ]
2161
+
2162
+ return self.api_client.param_serialize(
2163
+ method='PUT',
2164
+ resource_path='/api/business-monitoring/business-perspectives/{id}',
2165
+ path_params=_path_params,
2166
+ query_params=_query_params,
2167
+ header_params=_header_params,
2168
+ body=_body_params,
2169
+ post_params=_form_params,
2170
+ files=_files,
2171
+ auth_settings=_auth_settings,
2172
+ collection_formats=_collection_formats,
2173
+ _host=_host,
2174
+ _request_auth=_request_auth
2175
+ )
2176
+
2177
+